BigBlueButton/bigbluebutton-Github
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

+ Improvements.

Browse Source
This commit is contained in:
kh-amir-tn 2023-04-07 17:48:53 +01:00
parent 3c96fdbc71
commit e098ea24b0
1 changed files with 41 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
docs/docs/greenlight/v3/install.md
View File

@ -17,14 +17,24 @@ Greenlight v3, the latest version, is constructed with the cutting-edge versions
Greenlight v3 is equipped with local authentication by default. This means that authentication is managed internally within the platform and does not require any external servers or services. For those who need additional authentication options, Greenlight v3 can be configured to connect to external authentication servers through OpenID Connect. For more information see [External Authentication](/greenlight/v3/external-authentication).
There are 2 ways to install Greenlight v3:
1. Installing alongside a BigBlueButton Server
2. Installing on a Standalone Server
1. [Installing alongside a BigBlueButton Server](#installing-alongside-a-bigbluebutton-server).
2. [Installing on a Standalone Server](#installing-on-a-standalone-server).
## Installing alongside a BigBlueButton Server
### bbb-install Script
If your server already contains a BigBlueButton server, or you would like to install a new BigBlueButton server along with Greenlight, please refer to [bbb-install script](https://github.com/bigbluebutton/bbb-install).
If your server already contains a BigBlueButton server that you like to upgrade to v2.6, or you would like to install a new BigBlueButton server on a clean environment along with Greenlight, then please refer to [bbb-install script](https://github.com/bigbluebutton/bbb-install) for guides on the `bbb-install` command and its options.
To install Greenlight, simply run the `bbb-install` command with your chosen configurations, while ensuring that you include `-g` option to include Greenlight.
To install Greenlight, simply run the `bbb-install-2.6` script with your chosen configurations, **while ensuring to include the `-g` option** to install/upgrade Greenlight alongside of your BigBlueButton server.
### Running the Script
To run the script, simply run the command below, replacing `[OPTIONS]`, with the your chosen configurations.
```bash
wget -qO- https://ubuntu.bigbluebutton.org/bbb-install-2.6.sh | bash -s -- [OPTIONS] -g
```
After the script completes, a success message will appear in the console with the URL to access Greenlight confirming that BigBlueButton was installed/upgraded alongside with Greenlight.
### Creating an Admin Account
Once installation is complete, you will need to create an Administrator account to access the administrator panel.
@ -33,7 +43,7 @@ You can do that by running the following command:
```bash
docker exec -it greenlight-v3 bundle exec rake admin:create['name','email','password']
```
You can also run it without any arguments to create the default admin account, which you can then either change the password to, or promote your own account to Administrator and then delete the default account.
You can also run it without any arguments to create the default admin account, which you can either change its password and use, or use it to promote your own account becoming an Administrator and then delete it.
```bash
docker exec -it greenlight-v3 bundle exec rake admin:create
```
@ -41,13 +51,7 @@ docker exec -it greenlight-v3 bundle exec rake admin:create
## Installing on a Standalone Server
### Greenlight Install Script
If you're installing Greenlight on a standalone server (ie a server that doesn't include BigBlueButton), we've created an install script to simplify the steps required to get Greenlight up and running.
First, create the Greenlight directory for its configuration to live in.
```bash
mkdir ~/greenlight && cd ~/greenlight
```
If you're installing Greenlight on a standalone server (a server where you don't want to include BigBlueButton), we've created an install script to simplify the steps required to get Greenlight up and running.
The Greenlight Install Script provides you with a variety of options to suit whatever needs you have. Before running the install script, you must choose which options you would like. Here are the current supported options:
@ -66,16 +70,23 @@ The Greenlight Install Script provides you with a variety of options to suit wha
* Cannot be used when -d is used.
```
And environmental variables:
```
VARIABLES (configure Greenlight):
GL_PATH Configure Greenlight relative URL root path (Optional)
* Use this when deploying Greenlight behind a reverse proxy on a path other than the default '/' e.g. '/gl'.
```
### Sample Configurations
- Sample options to setup a Greenlight 3.x server with a publicly signed SSL certificate for a FQDN of www.example.com and an email
of info@example.com that uses a BigBlueButton server at bbb.example.com with secret SECRET:
of info@example.com that uses a BigBlueButton server at `bbb.example.com` with secret `SECRET`:
`-s www.example.com -e info@example.com -b bbb.example.com:SECRET`
`-s www.example.com -e info@example.com -b bbb.example.com:SECRET`
- Sample options to setup a Greenlight 3.x server with pre-owned SSL certificates for a FQDN of www.example.com that uses a BigBlueButton server at bbb.example.com with secret SECRET:
`-s www.example.com -b bbb.example.com:SECRET -d`
`-s www.example.com -b bbb.example.com:SECRET -d`
### Running the Script
@ -94,7 +105,7 @@ You can do that by running the following command:
```bash
docker exec -it greenlight-v3 bundle exec rake admin:create['name','email','password']
```
You can also run it without any arguments to create the default admin account, which you can then either change the password to, or promote your own account to Administrator and then delete the default account.
You can also run it without any arguments to create the default admin account, which you can either change its password and use, or use it to promote your own account becoming an Administrator and then delete it.
```bash
docker exec -it greenlight-v3 bundle exec rake admin:create
```
@ -144,16 +155,26 @@ SMTP configuration requires following the guidelines provided by your SMTP serve
### Relative URL root path (subdirectory) Setup
Greenlight by default will expect being deployed on the root path **/** of your FQDN (Fully qualified domain name).
If having a custom setup and not willing to deploy the application on the root path one could simply run the `bbb-install` command with the **GL_PATH** variable set to their chosen configuration and **while ensuring to include the -g option** to upgrade Greenlight.
If having a custom setup and not willing to deploy the application on the root path one could simply run the installation scripts (for more details about the installation options kindly check [Overview](#overview)) with the **GL_PATH** variable set to their chosen configuration and upgrade Greenlight.
> An upgrade to Greenlight after a relative URL root path change is mandatory.
> To reflect the relative root path change an upgrade to Greenlight is required.
So, to deploy Greenlight on a relative URL root path of **/gl** one would simply run:
So, to deploy Greenlight on a relative URL root path of **/gl**:
For systems using [BigBlueButton Install Script](#bbb-install-script) one would simply run **while ensuring to include the -g option**:
```bash
GL_PATH=/gl bbb-install-2.6 [options] -g
wget -qO- https://ubuntu.bigbluebutton.org/bbb-install-2.6.sh | GL_PATH=/gl bash -s -- [options] -g
```
For systems using [Greenlight Install Script](#greenlight-install-script) one would simply run:
```bash
wget -qO- https://raw.githubusercontent.com/bigbluebutton/greenlight/master/gl-install.sh | GL_PATH=/gl bash -s -- [options]
```
> Notice the omitting of any trailing slashes in **GL_PATH**.
Alternatively, one could directly update the Greenlight .env file located at `/root/greenlight-v3/.env` and manually set the **RELATIVE_URL_ROOT** variable to match their desired setup and simply re-run afterwards the `bbb-install` command **with the -g option included** but without defining and using the **GL_PATH** variable.
- _We recommend the use of the first approach whenever possible._