Move greenlight v3 docs to this repo

As originally planned, the greenlight v3 docs are added to this repo.

See #16667

docs/docs/administration/customize.md

@@ -889,9 +889,9 @@ Change this page to create your own landing page (and keep a back-up copy of it
 
 BigBlueButton comes with Greenlight, a front-end application written in Ruby on Rails that makes it easy for users to create meetings, invite others, start meetings, and manage recordings.
 
-![greenlight-start](/img/greenlight/room.png)
+![greenlight-start](/img/greenlight/v2/room.png)
 
-For more information see [Installing Greenlight](/greenlight/install).
+For more information see [Installing Greenlight](/greenlight/v2/install).
 
 ### Networking
 

docs/docs/administration/install.md

@@ -14,7 +14,7 @@ BigBlueButton 2.6 is under active development. We have tools to make it easy for
 
 We recommend installing BigBlueButton with a 'clean' and dedicated Ubuntu 20.04 64-bit server with no prior software installed. If you want to upgrade from an earlier version of BigBlueButton like 2.4, we recommend setting up a clean server for BigBlueButton 2.6 on Ubuntu 20.04 and, after setup, [migrate over your existing recordings](/administration/customize#transfer-published-recordings-from-another-server). We support upgrading a BigBlueButton 2.5 server to 2.6.
 
-A 'clean' server does not have any previous web servers installed (such as apache) or web applications (such as plesk or webadmin) that are [binding to port 80/443](/support/faq#we-recommend-running-bigbluebutton-on-port-80443). By 'dedicated' we mean that this server won't be used for anything else besides BigBlueButton (and possibly BigBlueButton-related applications such as [Greenlight](/greenlight/install)).
+A 'clean' server does not have any previous web servers installed (such as apache) or web applications (such as plesk or webadmin) that are [binding to port 80/443](/support/faq#we-recommend-running-bigbluebutton-on-port-80443). By 'dedicated' we mean that this server won't be used for anything else besides BigBlueButton (and possibly BigBlueButton-related applications such as [Greenlight](/greenlight/v2/install)).
 
 ### Minimum server requirements
 
@@ -145,7 +145,7 @@ The above link gives detailed information on using the script. As an example, th
 wget -qO- https://ubuntu.bigbluebutton.org/bbb-install-2.6.sh | bash -s -- -v focal-260 -s bbb.example.com -e notice@example.com -g -w
 ```
 
-Note: You can [uninstall Greenlight](/greenlight/install#uninstall) if you do not intend on using it on production.
+Note: You can [uninstall Greenlight](/greenlight/v2/install#uninstall) if you do not intend on using it on production.
 
 After the `bbb-install-2.6.sh` script finishes, you can check the status of your server with `bbb-conf --check`. When you run this command, you should see output similar to the following:
 
@@ -323,7 +323,7 @@ If this server is intended for production, you should also
 
 - [Secure your system -- restrict access to specific ports](/administration/customize#secure-your-system--restrict-access-to-specific-ports)
 - [Configure the server to work behind a firewall](/administration/firewall-configuration) (if you have installed behind a firewall or on a server that has a public/private IP address)
-- [remove Greenlight](/greenlight/install#uninstall) (if you had it installed and is no longer needed)
+- [remove Greenlight](/greenlight/v2/install#uninstall) (if you had it installed and is no longer needed)
 - [Set up a TURN server](/administration/turn-server) (if your server is on the Internet and you have users accessing it from behind restrictive firewalls)
 - Test your HTTPS configuration. A well-respected site that can do a series of automated tests is [https://www.ssllabs.com/ssltest/](https://www.ssllabs.com/ssltest/) - simply enter your server's hostname, optionally check the "Do not show results" check box if you would like to keep it private, then Submit. At time of writing, the configuration shown on this page should achieve an "A" ranking in the SSL Labs test page.
 

docs/docs/development/architecture.md

@@ -75,7 +75,7 @@ BigBlueButton web application is a Java-based application written in Scala. It i
 
 The BigBlueButton API provides a third-party integration (such as the [BigBlueButtonBN plugin](https://moodle.org/plugins/mod_bigbluebuttonbn) for Moodle) with an endpoint to control the BigBlueButton server.
 
-Every access to BigBlueButton comes through a front-end portal (we refer to as a third-party application). BigBlueButton integrates Moodle, Wordpress, Canvas, Sakai, MatterMost, and others (see [third-party integrations](https://bigbluebutton.org/integrations/)). BigBlueButton comes with its own front-end called [Greenlight](/greenlight/install). When using a learning management system (LMS) such as Moodle, teachers can setup BigBlueButton rooms within their course and students can access the rooms and their recordings.
+Every access to BigBlueButton comes through a front-end portal (we refer to as a third-party application). BigBlueButton integrates Moodle, Wordpress, Canvas, Sakai, MatterMost, and others (see [third-party integrations](https://bigbluebutton.org/integrations/)). BigBlueButton comes with its own front-end called [Greenlight](/greenlight/v2/install). When using a learning management system (LMS) such as Moodle, teachers can setup BigBlueButton rooms within their course and students can access the rooms and their recordings.
 
 The BigBlueButton comes with some simple [API demos](/administration/install#install). Regardless of which front-end you use, they all use the [API](/development/api) under the hood.
 

docs/docs/development/dev-guide.md

@@ -43,7 +43,7 @@ The instructions in this guide are step-by-step so you can understand each step
 
 Before you can start developing on BigBlueButton, you must install BigBlueButton (see [installation steps](/administration/install)) and ensure it's working correctly. Make sure there were no errors during the installation and that you can join a session successfully.
 
-We emphasize that your BigBlueButton server must be working **before** you start setting up the development environment. Be sure that you can log in, start sessions, join the audio bridge, share your webcam, and record and play back sessions -- you can verify this if you install [Greenlight](/greenlight/install) or navigate to [API MATE](https://mconf.github.io/api-mate/) using your server's secret and url.
+We emphasize that your BigBlueButton server must be working **before** you start setting up the development environment. Be sure that you can log in, start sessions, join the audio bridge, share your webcam, and record and play back sessions -- you can verify this if you install [Greenlight](/greenlight/v2/install) or navigate to [API MATE](https://mconf.github.io/api-mate/) using your server's secret and url.
 
 By starting with a working BigBlueButton server, you have the ability to switch back-and-forth between the default-packaged components and any modifications you make.
 
@@ -248,7 +248,7 @@ Below is an overview of the different components in a production set-up. When de
 
 ### (Optional) Install Greenlight
 
-Note that at this point we recommend installing and using [Greenlight](/greenlight/install) or using API-MATE (link can be found when you run `$ bbb-conf --salt`).
+Note that at this point we recommend installing and using [Greenlight](/greenlight/v2/install) or using API-MATE (link can be found when you run `$ bbb-conf --salt`).
 
 You can access https://BBB_DOMAIN , and you will be able to join meetings.
 

docs/docs/greenlight/v2/admin.md

@@ -1,6 +1,6 @@
 ---
 id: admin
-slug: /greenlight/admin
+slug: /greenlight/v2/admin
 title: Administration
 sidebar_position: 4
 description: Greenlight Administration
@@ -81,9 +81,9 @@ Greenlight has an administrator account that gives you the ability to manage use
 
 Once you are logged in as an Administrator, you will notice a new item in the Account Dropdown titled **Organization**.
 
-![Greenlight Administrator Access](/img/greenlight/admin_access.png)
+![Greenlight Administrator Access](/img/greenlight/v2/admin_access.png)
 
-![Greenlight Administrator Panel](/img/greenlight/admin_panel.png)
+![Greenlight Administrator Panel](/img/greenlight/v2/admin_panel.png)
 
 ### Managing Users
 
@@ -91,13 +91,13 @@ Through the Manage Users tab, Administrators are able to view and search for all
 
 Administrators are also able to edit each account by clicking on the vertical ellipsis.
 
-![Greenlight Administrator Manage Users](/img/greenlight/admin_manage_users.png)
+![Greenlight Administrator Manage Users](/img/greenlight/v2/admin_manage_users.png)
 
 #### Tabs
 
 To switch between tabs, click on the tab that you want to switch to.
 
-![Greenlight Administrator Manage Users Tabs](/img/greenlight/admin_manage_users_tabs.png)
+![Greenlight Administrator Manage Users Tabs](/img/greenlight/v2/admin_manage_users_tabs.png)
 
 | Tab     | Description                                                       |
 |:------- |:----------------------------------------------------------------- |
@@ -110,11 +110,11 @@ To switch between tabs, click on the tab that you want to switch to.
 
 The search box can be used to filter based on the Name, Username, Authenticator or Creation Date of any user.
 
-![Greenlight Administrator Manage Users Search](/img/greenlight/admin_manage_users_search.png)
+![Greenlight Administrator Manage Users Search](/img/greenlight/v2/admin_manage_users_search.png)
 
 To filter by the Role, click on any of the Role buttons under the Role Column. This will filter the list to show only the users with the clicked Role.
 
-![Greenlight Administrator Manage Users Filter](/img/greenlight/admin_manage_users_filter.png)
+![Greenlight Administrator Manage Users Filter](/img/greenlight/v2/admin_manage_users_filter.png)
 
 #### Deleting Accounts
 
@@ -122,7 +122,7 @@ To delete an account, select Delete from the Account Dropdown.
 
 Once an account gets deleted, the user will be moved to the **Deleted** tab.
 
-![Greenlight Administrator Manage Users Delete](/img/greenlight/admin_delete.png)
+![Greenlight Administrator Manage Users Delete](/img/greenlight/v2/admin_delete.png)
 
 From the **Deleted** tab, an administrator can then either recover the user's account and their associated rooms, or permanently delete the user. If a user is permanently deleted, it will **NOT** be possible to recover the account.
 
@@ -144,7 +144,7 @@ During the merge process, the **Account to be Merged**'s rooms will be transferr
 
 To merge a user, click the Merge action in the Account Dropdown for the user that will be the **Primary Account**. Once the modal appears, you can use the dropdown to search for the **Account to be Merged**. Note that you can search by name or email in the dropdown.
 
-![Greenlight Administrator Merge](/img/greenlight/admin_merge.png)
+![Greenlight Administrator Merge](/img/greenlight/v2/admin_merge.png)
 
 In the above example, if Example3 had 2 rooms, "Home Room" and "Room 1", they will appear in Example4's room list as "(Merged) Home Room" and "(Merged) Room 1". Example4 is free to rename, delete or make any changes to these rooms.
 
@@ -158,7 +158,7 @@ From the edit user view, Administrators are able to edit the name, email, roles,
 
 To edit the role for an account, select Edit for the specified user. This will open the edit user view.
 
-![Greenlight Administrator Edit User Roles](/img/greenlight/admin_edit_user_roles.png)
+![Greenlight Administrator Edit User Roles](/img/greenlight/v2/admin_edit_user_roles.png)
 
 From the edit user view, Administrators are able to assign and remove roles for the given account. To remove a role click the x beside the role. To add a role select the role from the roles dropdown beneath the role tags.
 
@@ -176,7 +176,7 @@ To reset a user's password, select Edit for the specified user. This will open t
 
 Through the Server Rooms tab, Administrators are able to view all of the Greenlight rooms that have been created.
 
-![Greenlight Administrator Server Rooms](/img/greenlight/admin_server_rooms.png)
+![Greenlight Administrator Server Rooms](/img/greenlight/v2/admin_server_rooms.png)
 
 #### Options
 
@@ -189,7 +189,7 @@ As an administrator, there are a variety of options available to you with regard
 | Room Settings | Allows the administrator to make changes to the room settings.                                   |
 | Delete        | Allows the administrator to manually delete an unwanted room. **Home Rooms can not be deleted**  |
 
-![Greenlight Administrator Server Rooms Options](/img/greenlight/admin_server_rooms_options.png)
+![Greenlight Administrator Server Rooms Options](/img/greenlight/v2/admin_server_rooms_options.png)
 
 #### Search
 
@@ -207,13 +207,13 @@ Through the Server Recordings tab, Administrators are able to view all of the re
 
 **NOTE:** Due to limitations on the BigBlueButton API, if your server has many rooms or recordings, the page may not load due to the request timing out.
 
-![Greenlight Administrator Server Recs](/img/greenlight/admin_server_recordings.png)
+![Greenlight Administrator Server Recs](/img/greenlight/v2/admin_server_recordings.png)
 
 #### Search
 
 The search box can be used to filter based on the **Name**, **Length**, **Users**, **Recording Owner**, **Visibility** or **Format** of any user.
 
-![Greenlight Administrator Server Recs Search](/img/greenlight/admin_server_recording_search.png)
+![Greenlight Administrator Server Recs Search](/img/greenlight/v2/admin_server_recording_search.png)
 
 #### Sort
 
@@ -223,31 +223,31 @@ It is possible to sort recordings by metrics such as **Name**, **User Number**,
 
 This can be done by clicking on the headers of the table (cycles through ascending, descending, and no particular order):
 
-![Greenlight Administrator Server Recs Sort](/img/greenlight/admin_server_recording_sort.png)
+![Greenlight Administrator Server Recs Sort](/img/greenlight/v2/admin_server_recording_sort.png)
 
 ### Site Settings
 
 Administrators are able to customize Greenlight through the Site Settings Tab.
 
-![Greenlight Administrator Site Settings](/img/greenlight/admin_site_settings.png)
+![Greenlight Administrator Site Settings](/img/greenlight/v2/admin_site_settings.png)
 
 #### Change the Branding Image
 
 To change Greenlight’s Branding Image which is displayed in the top left corner, replace the default image with a URL of your image and click Change Image.
 
-![Greenlight Administrator Branding Image](/img/greenlight/admin_branding_image.png)
+![Greenlight Administrator Branding Image](/img/greenlight/v2/admin_branding_image.png)
 
 #### Change the Legal Url
 
 To change Greenlight’s Legal Url which is displayed in the footer, add the desired URL to the field and click Change Url. Setting it to blank will remove the link from the footer.
 
-![Greenlight Administrator Legal Url](/img/greenlight/admin_legal_url.png)
+![Greenlight Administrator Legal Url](/img/greenlight/v2/admin_legal_url.png)
 
 #### Change the Privacy Policy Url
 
 To change Greenlight’s Privacy Policy Url which is displayed in the footer, add the desired URL to the field and click Change Url. Setting it to blank will remove the link from the footer.
 
-![Greenlight Administrator Policy Url](/img/greenlight/admin_priv_url.png)
+![Greenlight Administrator Policy Url](/img/greenlight/v2/admin_priv_url.png)
 
 #### Change the Primary Colour
 
@@ -259,13 +259,13 @@ If you would like to change the Lighten or Darken version, they can be individua
 
 The Primary Colour is the colour that Greenlight uses as a basis for the styling. This includes buttons, links, icons, etc.
 
-![Greenlight Administrator Primary Colour](/img/greenlight/admin_primary_colour.png)
+![Greenlight Administrator Primary Colour](/img/greenlight/v2/admin_primary_colour.png)
 
 #### Registration Methods
 
 Through the Site Settings, you can configure the Registration Method for Greenlight.
 
-![Greenlight Administrator Registration Method](/img/greenlight/admin_registration_method.png)
+![Greenlight Administrator Registration Method](/img/greenlight/v2/admin_registration_method.png)
 
 **Open Registration**
 
@@ -279,13 +279,13 @@ To use Join by Invitation, `ALLOW_MAIL_NOTIFICATIONS` must be set to `true` in t
 
 To invite a user, click in the Invite User button that is beside the Search Bar.
 
-![Greenlight Administrator Invite Button](/img/greenlight/admin_invite_button.png)
+![Greenlight Administrator Invite Button](/img/greenlight/v2/admin_invite_button.png)
 
 To send an email to multiple users, enter their emails separated by a comma. If you would like to invite only 1 user, enter their email with no commas.
 
 The user(s) will receive an email with a button that will link them to the sign up page.
 
-![Greenlight Administrator Invite Modal](/img/greenlight/admin_invite_modal.png)
+![Greenlight Administrator Invite Modal](/img/greenlight/v2/admin_invite_modal.png)
 
 **Approve/Decline**
 
@@ -295,23 +295,23 @@ When a user signs up, they will be set to a Pending state. The Administrator wil
 
 If `ALLOW_MAIL_NOTIFICATIONS` is set to `true` in the `.env` file, then all Administrators will receive an email when a user signs up.
 
-![Greenlight Administrator Pending Users](/img/greenlight/admin_pending_users.png)
+![Greenlight Administrator Pending Users](/img/greenlight/v2/admin_pending_users.png)
 
 Users can either be Approved or Declined by clicking on the Account Dropdown.
 
 If `ALLOW_MAIL_NOTIFICATIONS` is set to `true` in the `.env` file, the user will receive an email informing them that their account has been approved.
 
-![Greenlight Administrator Approve](/img/greenlight/admin_approve.png)
+![Greenlight Administrator Approve](/img/greenlight/v2/admin_approve.png)
 
 If a user sign up is declined, they will be set to the Banned state. A banned user can not sign in or access any of the features in Greenlight.
 
-![Greenlight Administrator Declined](/img/greenlight/admin_decline.png)
+![Greenlight Administrator Declined](/img/greenlight/v2/admin_decline.png)
 
 #### Require Authentication to Join
 
 By default, users that are not signed in can join any Room that has been started by the Room Owner if they are given the invitation link. This can be disabled, meaning that only users that are signed in will be allowed to join a Room.
 
-![Greenlight Administrator Room Authentication](/img/greenlight/admin_room_auth.png)
+![Greenlight Administrator Room Authentication](/img/greenlight/v2/admin_room_auth.png)
 
 #### Allow Users to Share Rooms
 
@@ -319,13 +319,13 @@ By default, all users that are able to create rooms are able to share rooms. Sha
 
 In the Shared Access modal, users can share the room with another user by searching for that user's name or uid. If you do not want a specific role to be searchable in this dropdown, you can hide them from the list in the [Roles Permissions](#editing-an-existing-role).
 
-![Greenlight Administrator Share Access](/img/greenlight/admin_share_access.png)
+![Greenlight Administrator Share Access](/img/greenlight/v2/admin_share_access.png)
 
 #### Allow Users to Preupload Presentations
 
 By default, users will not be able to preupload presentations to their rooms. Administrators can enable or disable this feature based on their use cases.
 
-![Greenlight Administrator Preupload](/img/greenlight/admin_preupload.png)
+![Greenlight Administrator Preupload](/img/greenlight/v2/admin_preupload.png)
 
 #### Recording Default Visibility
 
@@ -335,17 +335,17 @@ Sets the default visibility of room recordings.
 
 **Unlisted**: only users who have the recording link can view it.
 
-![Greenlight Administrator Default Recording](/img/greenlight/admin_recording_vis.png)
+![Greenlight Administrator Default Recording](/img/greenlight/v2/admin_recording_vis.png)
 
 #### Require Room Owner and Joiner Consent to Recording
 
 By default, some information in all rooms is stored on the BigBlueButton server. In some cases (such as places where GDPR is present), users must consent to this before the BigBlueButton server can store information. If this applies to your deployment, set this to `Enabled`. Once set to enabled, it will also unlock a new `Room Configuration` option which will allow you to set how you would like the new `Allow room to be recorded` room setting to behave (Always Enabled, Optional, Disabled)
 
-![Greenlight Administrator Consent](/img/greenlight/admin_require_consent.png)
+![Greenlight Administrator Consent](/img/greenlight/v2/admin_require_consent.png)
 
 If enabled, upon joining a room, users must click the checkbox before being allowed to enter the room.
 
-![Greenlight Room Join Consent](/img/greenlight/room_join_consent.png)
+![Greenlight Room Join Consent](/img/greenlight/v2/room_join_consent.png)
 
 #### Number of Rooms per User
 
@@ -353,7 +353,7 @@ By default, users are allowed to create and manage as many rooms as they like. U
 
 To allow the users to create as many rooms as they would like, select the option furthest to the right (15+).
 
-![Greenlight Administrator Room Limit](/img/greenlight/admin_room_limit.png)
+![Greenlight Administrator Room Limit](/img/greenlight/v2/admin_room_limit.png)
 
 ### Room Configuration
 
@@ -375,7 +375,7 @@ For each room setting, there are 3 options.
 
 Through the Roles tab Administrators are able to edit the roles for their site.
 
-![Greenlight Administrator Edit Roles](/img/greenlight/admin_edit_roles.png)
+![Greenlight Administrator Edit Roles](/img/greenlight/v2/admin_edit_roles.png)
 
 A role's position in the roles list denotes its priority. The higher up on the list the higher the priority of the role.
 
@@ -383,7 +383,7 @@ A role's position in the roles list denotes its priority. The higher up on the l
 
 To create a new role click on the Create a new role button. This will open the create role pop-up where Administrators can specify the new role's name.
 
-![Greenlight Administrator New Roles](/img/greenlight/admin_new_role.png)
+![Greenlight Administrator New Roles](/img/greenlight/v2/admin_new_role.png)
 
 The new role will automatically be created with the second lowest priority only higher than the user role.
 
@@ -399,7 +399,7 @@ To change an existing role's priority drag the role to the position you desire i
 
 To edit the permissions for a role select the role from the list of roles.
 
-![Greenlight Administrator Edit Role Permissions](/img/greenlight/admin_edit_role_permissions.png)
+![Greenlight Administrator Edit Role Permissions](/img/greenlight/v2/admin_edit_role_permissions.png)
 
 Once the administrator has selected the role they are able to update the name for the role as well as the colour associated with the role.
 
@@ -424,7 +424,7 @@ To delete a role click the "Delete the role button". For the role to be successf
 
 See also
 
-* [Overview](/greenlight/overview)
-* [Install](/greenlight/install)
-* [Customize](/greenlight/customize)
-* [Configure](/greenlight/config)
+* [Overview](/greenlight/v2/overview)
+* [Install](/greenlight/v2/install)
+* [Customize](/greenlight/v2/customize)
+* [Configure](/greenlight/v2/config)

docs/docs/greenlight/v2/config.md

@@ -1,6 +1,6 @@
 ---
 id: config
-slug: /greenlight/config
+slug: /greenlight/v2/config
 title: Configuration
 sidebar_position: 3
 description: Greenlight Configuration
@@ -27,7 +27,7 @@ If you are **not** deploying Greenlight on a BigBlueButton server and want the a
 
 ### Setting a Custom Branding Image
 
-You can now setup branding for Greenlight through its [Administrator Interface](/greenlight/admin#site-branding).
+You can now setup branding for Greenlight through its [Administrator Interface](/greenlight/v2/admin#site-branding).
 
 ### User Authentication
 
@@ -666,7 +666,7 @@ docker-compose up -d
 ```
 
 See also
-  * [Overview](/greenlight/overview)
-  * [Install](/greenlight/install)
-  * [Admin Guide](/greenlight/admin)
-  * [Customize](/greenlight/customize)
+  * [Overview](/greenlight/v2/overview)
+  * [Install](/greenlight/v2/install)
+  * [Admin Guide](/greenlight/v2/admin)
+  * [Customize](/greenlight/v2/customize)

docs/docs/greenlight/v2/customize.md

@@ -1,6 +1,6 @@
 ---
 id: customize
-slug: /greenlight/customize
+slug: /greenlight/v2/customize
 title: Customizing
 sidebar_position: 5
 description: Greenlight Customizing
@@ -131,7 +131,7 @@ In your `.env` file, set the `SAFE_HOSTS` to your domain. If Greenlight is acces
 
 Other than the 3 configurations listed above, there are many different options for configuring Greenlight. All possible configurations are listed in the `.env` file.
 
-You can find more info on specific settings that can be configured [here](/greenlight/config).
+You can find more info on specific settings that can be configured [here](/greenlight/v2/config).
 
 #### Verifying Configuration
 
@@ -157,7 +157,7 @@ Verify that the Nginx configuration file (`/etc/bigbluebutton/nginx/greenlight.n
 systemctl restart nginx
 ```
 
-This will routes all requests to `https://<hostname>/b` to the Greenlight application. If you wish to use a different relative root, you can follow the steps outlined [here](/greenlight/config#using-a-different-relative-root).
+This will routes all requests to `https://<hostname>/b` to the Greenlight application. If you wish to use a different relative root, you can follow the steps outlined [here](/greenlight/v2/config#using-a-different-relative-root).
 
 Optionally, if you wish to have the default landing page at the root of your BigBlueButton server redirect to Greenlight, add the following entry to the bottom of `/etc/nginx/sites-available/bigbluebutton` just before the last `}` character.
 
@@ -273,7 +273,7 @@ Once you've merged your code, you should look through the latest version of the
 
 **IMPORTANT**
 
-If you installed using the `bbb-install.sh` script, then you must switch to the [Customize](/greenlight/install#switching-from-install-to-customize) version of Greenlight first, before you proceed.
+If you installed using the `bbb-install.sh` script, then you must switch to the [Customize](/greenlight/v2/install#switching-from-install-to-customize) version of Greenlight first, before you proceed.
 
 ### Updating the code
 
@@ -340,7 +340,7 @@ To change the welcome message, modify the text associated with `landing.welcome`
 
 Save the change to `en.yml`, and [restart Greenlight](#restart-greenlight).  The welcome message should have the new text.
 
-![Updated login](/img/greenlight/gl-welcome-to-my-server.png)
+![Updated login](/img/greenlight/v2/gl-welcome-to-my-server.png)
 
 ## Troubleshooting Greenlight
 
@@ -358,7 +358,7 @@ Docker is always running on a production environment, so the logs will be locate
 
 See also
 
-* [Overview](/greenlight/overview)
-* [Install](/greenlight/install)
-* [Admin Guide](/greenlight/admin)
-* [Configure](/greenlight/config)
+* [Overview](/greenlight/v2/overview)
+* [Install](/greenlight/v2/install)
+* [Admin Guide](/greenlight/v2/admin)
+* [Configure](/greenlight/v2/config)

docs/docs/greenlight/v2/install.md

@@ -1,6 +1,6 @@
 ---
 id: install
-slug: /greenlight/install
+slug: /greenlight/v2/install
 title: Installation
 sidebar_position: 2
 description: Greenlight Installation
@@ -13,7 +13,7 @@ keywords:
 
 To make Greenlight as easy to install as possible, we've created a Docker image that wraps the application. It is **highly** recommended that you use Docker when install Greenlight on a BigBlueButton server.
 
-Following this installation process will install Greenlight with the default settings. Through the [Administrator Interface](/greenlight/admin), you can customize the Branding Image, Primary Color and other Site Settings. If you would like to check out the Greenlight source code and make changes to it, follow these [installation instructions](/greenlight/customize#customizing-greenlight)
+Following this installation process will install Greenlight with the default settings. Through the [Administrator Interface](/greenlight/v2/admin), you can customize the Branding Image, Primary Color and other Site Settings. If you would like to check out the Greenlight source code and make changes to it, follow these [installation instructions](/greenlight/v2/customize#customizing-greenlight)
 
 You should run all commands in this section as `root` on your BigBlueButton server.
 
@@ -85,7 +85,7 @@ In your `.env` file, set the `SAFE_HOSTS` to your domain. If Greenlight is acces
 
 Other than the 3 configurations listed above, there are many different options for configuring Greenlight. All possible configurations are listed in the `.env` file.
 
-You can find more info on specific settings that can be configured [here](/greenlight/config).
+You can find more info on specific settings that can be configured [here](/greenlight/v2/config).
 
 #### Verifying Configuration
 
@@ -111,7 +111,7 @@ Verify that the Nginx configuration file (`/etc/bigbluebutton/nginx/greenlight.n
 sudo systemctl restart nginx
 ```
 
-This will routes all requests to `https://<hostname>/b` to the Greenlight application. If you wish to use a different relative root, you can follow the steps outlined [here](/greenlight/config#using-a-different-relative-root).
+This will routes all requests to `https://<hostname>/b` to the Greenlight application. If you wish to use a different relative root, you can follow the steps outlined [here](/greenlight/v2/config#using-a-different-relative-root).
 
 Optionally, if you wish to have the default landing page at the root of your BigBlueButton server redirect to Greenlight, add the following entry to the bottom of `/etc/nginx/sites-available/bigbluebutton` just before the last `}` character.
 
@@ -200,7 +200,7 @@ cd ..
 mv greenlight/ greenlight-old/
 ```
 
-Then, install Greenlight by following the `Customize` instructions [here](/greenlight/customize#customizing-greenlight). Don't worry about any of the `.env` configuration, as it will be overwritten by the version you are currently using.
+Then, install Greenlight by following the `Customize` instructions [here](/greenlight/v2/customize#customizing-greenlight). Don't worry about any of the `.env` configuration, as it will be overwritten by the version you are currently using.
 
 Copy over your database file and `.env` file using these commands:
 
@@ -243,7 +243,7 @@ sudo rm -rf greenlight/
 
 See also
 
-* [Overview](/greenlight/overview)
-* [Admin Guide](/greenlight/admin)
-* [Customize](/greenlight/customize)
-* [Configure](/greenlight/config)
+* [Overview](/greenlight/v2/overview)
+* [Admin Guide](/greenlight/v2/admin)
+* [Customize](/greenlight/v2/customize)
+* [Configure](/greenlight/v2/config)

docs/docs/greenlight/v2/overview.md

@@ -1,6 +1,6 @@
 ---
 id: overview
-slug: /greenlight/overview
+slug: /greenlight/v2/overview
 title: Overview
 sidebar_position: 1
 description: Greenlight Overview
@@ -10,7 +10,7 @@ keywords:
 
 Greenlight 2.0 (referred hereafter as simply "Greenlight") is a Ruby on Rails application that provides a simple interface for users to create rooms, start meetings, and manage recordings.
 
-![Greenlight Landing](/img/greenlight/landing.png)
+![Greenlight Landing](/img/greenlight/v2/landing.png)
 
 <center>(the Greenlight home/landing page.)</center>
 
@@ -47,19 +47,19 @@ Greenlight has full support for managing user accounts. It currently supports fo
 * Office365 OAuth2
 * LDAP
 
-![Greenlight Login](/img/greenlight/login.png)
+![Greenlight Login](/img/greenlight/v2/login.png)
 
 All of these authentication providers are configurable and can be turned on/off individually. Turning off In-application authentication will disable user sign up. This allows you to preconfigure accounts for specific users who you want to have access to your server.
 
 Once you are logged in, you'll see your account appear in the top right corner of the screen. Clicking on the navigation items along side it allows you to traverse Greenlight.
 
-![Greenlight Nav](/img/greenlight/nav.png)
+![Greenlight Nav](/img/greenlight/v2/nav.png)
 
 #### Profile
 
 Greenlight also allows users to update their account information at any time, including changing their password, profile image, and language for Greenlight.
 
-![Greenlight Settings](/img/greenlight/settings.png)
+![Greenlight Settings](/img/greenlight/v2/settings.png)
 
 ### Rooms
 
@@ -67,25 +67,25 @@ Greenlight also allows users to update their account information at any time, in
 
 Greenlight is built around the concept of rooms. A room, to the user, is a BigBlueButton session that they "own". A user can add custom room settings, start/stop their room, invite others to their room using a short easily communicable URL, track sessions, and more.
 
-![Greenlight Room](/img/greenlight/room.png)
+![Greenlight Room](/img/greenlight/v2/room.png)
 
 To invite someone to join your room, all you have to do is give them the invite URL on the room page. Once they follow the URL, they'll be presented with an invitation to join your room. If the user doesn't have a Greenlight account, they'll be prompted to enter a name to join the room. Otherwise, Greenlight will use their account name.
 
-![Greenlight Invitation](/img/greenlight/invitation.png)
+![Greenlight Invitation](/img/greenlight/v2/invitation.png)
 
 If the room is running, they'll be instantly join in. However, if the room is not running they'll be added to the wait list. Once the room starts, they'll be automatically joined into the room with the owner. A user can leave the wait list simply by leaving the page.
 
-![Greenlight Waiting](/img/greenlight/waiting.png)
+![Greenlight Waiting](/img/greenlight/v2/waiting.png)
 
 #### Creating New Rooms
 
 When you sign up for Greenlight, the application creates your home room which is named "Home Room". You are free to create as many new rooms as you would like for different purposes. To create a new room, you simply click the "Create a Room" block from your list of rooms. You can configure room specific settings to customize each room. To see what each setting does, see [Room Settings](#room-settings)
 
-![Greenlight Create Room](/img/greenlight/create_room.png)
+![Greenlight Create Room](/img/greenlight/v2/create_room.png)
 
 Your new room will then show under your current room, and you can click to switch between them. Your home room is the one with the home icon. You can delete a room using the room drop-down.
 
-![Greenlight Multiple Rooms](/img/greenlight/multiple_rooms.png)
+![Greenlight Multiple Rooms](/img/greenlight/v2/multiple_rooms.png)
 
 #### Room Settings
 
@@ -106,11 +106,11 @@ Your new room will then show under your current room, and you can click to switc
 
 If you hover over the room name, you should see an edit icon
 
-![Greenlight Room Header Edit Icon](/img/greenlight/room_header_edit_icon.png)
+![Greenlight Room Header Edit Icon](/img/greenlight/v2/room_header_edit_icon.png)
 
 You can either click the **edit** icon or double click the header to enable **editing mode:**
 
-![Greenlight Room Header Editing Mode](/img/greenlight/room_header_editing_mode.png)
+![Greenlight Room Header Editing Mode](/img/greenlight/v2/room_header_editing_mode.png)
 
 Afterwards, you can change the name by clicking anywhere or pressing the enter key.
 
@@ -120,41 +120,41 @@ If you look at a Room block, you will see 3 ellipsis which you can click to view
 
 Afterwards, clicking **Update Room** will save the changes.
 
-![Greenlight Room Block Edit Dropdown](/img/greenlight/room_block_edit_dropdown.png)
+![Greenlight Room Block Edit Dropdown](/img/greenlight/v2/room_block_edit_dropdown.png)
 
-![Greenlight Room Block Editing Mode](/img/greenlight/room_block_editing_mode.png)
+![Greenlight Room Block Editing Mode](/img/greenlight/v2/room_block_editing_mode.png)
 
 #### Manage Access
 
 In the Room actions dropdown, there is a setting that allows users to share rooms.
 
-![Greenlight Room Shared Access](/img/greenlight/room_shared_access.png)
+![Greenlight Room Shared Access](/img/greenlight/v2/room_shared_access.png)
 
 To share a room with another user, click on the dropdown and search for the user using either their **email** or their **uid**.
 
-![Greenlight Room Shared Modal](/img/greenlight/room_shared_access_modal.png)
+![Greenlight Room Shared Modal](/img/greenlight/v2/room_shared_access_modal.png)
 
 Once you click on a user to add, they will be added to the Shared With area in a pending state. No changes will be made unless the **Save Changes** button is clicked.
 
-![Greenlight Room Shared Pending](/img/greenlight/room_shared_pending.png)
+![Greenlight Room Shared Pending](/img/greenlight/v2/room_shared_pending.png)
 
 Users that the room has been shared with will appear in the following state:
 
-![Greenlight Room Shared Added](/img/greenlight/room_shared.png)
+![Greenlight Room Shared Added](/img/greenlight/v2/room_shared.png)
 
 You can unshare a room with a user by clicking the **x** icon. Again, no changes will be save until the **Save Changes** button is clicked.
 
-![Greenlight Room Shared Remove](/img/greenlight/room_shared_remove.png)
+![Greenlight Room Shared Remove](/img/greenlight/v2/room_shared_remove.png)
 
 Once a room is shared, the users that it is shared with will have access to that room in their Room List. They will be able to view/start the meeting and view the recordings. Note that only the room owner can edit/delete the room and the recordings.
 
 For the User that has the room shared with them, the room will now appear in their room list with a share icon and the name of the user that shared the room with them.
 
-![Greenlight Room Shared](/img/greenlight/room_share.png)
+![Greenlight Room Shared](/img/greenlight/v2/room_share.png)
 
 The User also has the option to remove an unwanted shared room from their room list.
 
-![Greenlight Room Remove Shared](/img/greenlight/room_remove_shared.png)
+![Greenlight Room Remove Shared](/img/greenlight/v2/room_remove_shared.png)
 
 ### Recordings
 
@@ -162,7 +162,7 @@ The User also has the option to remove an unwanted shared room from their room l
 
 On your room page, all recordings for that room will be listed at the bottom under the recordings subtitle. This table contains information about the recording, as well as its recorded formats. You can click on any of these formats and you'll open the recording in a new tab.
 
-![Greenlight Recordings](/img/greenlight/recordings.png)
+![Greenlight Recordings](/img/greenlight/v2/recordings.png)
 
 Each recording has a visibility associated with it, which can be changed by clicking on it in the recordings table. By default, it is set to unlisted.
 
@@ -182,11 +182,11 @@ Deleted recordings are **not** recoverable, so be sure when deleting a recording
 
 To edit the recording name directly using the title, you can hover over the title and see an edit icon.
 
-![Greenlight Recording Title Edit Icon](/img/greenlight/recording_title_edit_icon.png)
+![Greenlight Recording Title Edit Icon](/img/greenlight/v2/recording_title_edit_icon.png)
 
 You can either click the **edit** icon or double click the title to enable **editing mode:**
 
-![Greenlight Recording Title Editing Mode](/img/greenlight/recording_title_editing_mode.png)
+![Greenlight Recording Title Editing Mode](/img/greenlight/v2/recording_title_editing_mode.png)
 
 Afterwards, you can change the name by clicking anywhere or pressing the enter key.
 
@@ -196,21 +196,21 @@ It is possible to **sort** recordings by metrics such as **Name**, **User Number
 
 This can be done by clicking on the headers of the table (cycles through **ascending**, **descending**, and **no particular order**):
 
-![Greenlight Recording Sort Asc](/img/greenlight/recording_sort_asc.png)
+![Greenlight Recording Sort Asc](/img/greenlight/v2/recording_sort_asc.png)
 
-![Greenlight Recording Sort Desc](/img/greenlight/recording_sort_desc.png)
+![Greenlight Recording Sort Desc](/img/greenlight/v2/recording_sort_desc.png)
 
 There is also a **live search** that may return any part of the recording name:
 
-![Greenlight Recording Search](/img/greenlight/recording_search.png)
+![Greenlight Recording Search](/img/greenlight/v2/recording_search.png)
 
 **Searching and sorting** can be used in conjunction:
 
-![Greenlight Recording Filter and Search](/img/greenlight/recording_filter_search.png)
+![Greenlight Recording Filter and Search](/img/greenlight/v2/recording_filter_search.png)
 
 See also
 
-* [Install](/greenlight/install)
-* [Admin Guide](/greenlight/admin)
-* [Customize](/greenlight/customize)
-* [Configure](/greenlight/config)
+* [Install](/greenlight/v2/install)
+* [Admin Guide](/greenlight/v2/admin)
+* [Customize](/greenlight/v2/customize)
+* [Configure](/greenlight/v2/config)

docs/docs/greenlight/v3/customize.md

@@ -0,0 +1,76 @@
+---
+id: customize
+slug: /greenlight/v3/customize
+title: Customize Greenlight
+sidebar_position: 3
+description: Greenlight customization
+keywords:
+- greenlight
+- customization
+---
+
+Greenlight v3 can be customized to suit your needs. By default, the applications has a default set of features and settings that can be customized through the Administrator Panel. If you need even more customizations, please follow the steps below.
+
+---
+
+**IMPORTANT NOTE:** While customizing Greenlight v3 can be a great way to tailor the platform to your organization's specific needs, there are also some potential dangers to making custom changes. It's important to be aware of these risks before making any customizations to the platform.
+
+1. Security risks: Custom changes to the platform may inadvertently introduce security vulnerabilities.
+
+2. Compatibility issues: Custom changes may not always be fully compatible with future updates to the platform. This could cause conflicts and errors that could affect the platform's functionality and stability.
+
+3. Support limitations: Making custom changes to the platform may limit the support you can receive from the platform's developers.
+
+4. Maintenance overhead: Custom changes require ongoing maintenance and upkeep.
+
+---
+
+### Text Changes
+
+Greenlight v3 provides the ability to customize all of the strings used in the platform's user interface. This means that you can change any text string, including labels, messages, and notifications, to match your organization's preferred terminology or language.
+
+First, find the file that contains the string you would like to change. Language files can be found in 2 places:
+1. [app/assets/locales](https://github.com/bigbluebutton/greenlight/tree/v3/app/assets/locales)
+2. [config/locales](https://github.com/bigbluebutton/greenlight/tree/v3/config/locales)
+
+For this example, we will be using `en.json` from `app/assets/locales/`, but you can make the changes to any file.
+
+Once you have located the file containing the string you want to modify, copy it into your greenlight-v3 directory and edit it as needed.
+
+Then, edit the docker compose file so that your new file is loaded into the container. To do that, add a line in the `volumes` section.
+
+```yaml
+ volumes:
+  - ./data/greenlight-v3/storage:/usr/src/app/storage
+  - ./en.json:/usr/app/app/assets/locales/en.json
+```
+OR
+```yaml
+ volumes:
+  - ./data/greenlight-v3/storage:/usr/src/app/storage
+  - ./en.json:/usr/app/config/locales/en.json
+```
+
+Finally, restart Greenlight v3 and your new changes should be displayed in Greenlight.
+
+### Code Changes
+
+Customizing the code in Greenlight v3 can provide even greater flexibility and control over the platform's behavior. However, modifying the code can also be complex, and it carries a greater risk of introducing errors or compatibility issues.
+
+If you decide to customize the code, it's important to have a solid understanding of Ruby on Rails and React, the frameworks used to build Greenlight v3. You should also be familiar with the structure of the Greenlight v3 codebase and its dependencies.
+
+First, find the file that you would like to change by searching through the [Greenlight repository](https://github.com/bigbluebutton/greenlight/tree/v3).
+
+Once you have located the file that you want to modify, copy it into your greenlight-v3 directory and edit it as needed.
+
+For this example, we will be using `rooms_controller.rb` from `app/controllers/api/v1/`, but you can make the changes to any file.
+
+Then, edit the docker compose file so that your new file is loaded into the container. To do that, add a line in the `volumes` section.
+
+```yaml
+ volumes:
+  - ./data/greenlight-v3/storage:/usr/src/app/storage
+  - ./rooms_controller.rb:/usr/app/pp/controllers/api/v1/rooms_controller.rb
+```
+
+Finally, restart Greenlight v3 and your new changes should be displayed in Greenlight.

docs/docs/greenlight/v3/external-authentication.md

@@ -0,0 +1,123 @@
+---
+id: external-authentication
+slug: /greenlight/v3/external-authentication
+title: External Authentication
+sidebar_position: 2
+description: Greenlight External Authentication
+keywords:
+- greenlight
+- authentication
+---
+
+## OpenID Connect vs Keycloak
+
+Greenlight v3 offers external authentication support through OpenID Connect. If you have an authentication server that supports this protocol, you can easily connect it to Greenlight v3 using environment variables. For more information, refer to the [OpenID Connect Setup](/greenlight/v3/install#openid-connect-setup) section.
+
+If you do not have an authentication server, Keycloak is a recommended solution. It supports multiple authentication methods, including Google, Microsoft, SAML, and others. For a complete list of supported identity providers, see [Keycloak Identity Providers](https://www.keycloak.org/docs/latest/server_admin/#_General-idp-config).
+
+## Installing Keycloak
+
+If you used the **BigBlueButton Install Script** without passing the `-k` option, you can simply re-run the install script using the same options as before, this time passing `-k` to install Keycloak on your server.
+
+If you used the **Greenlight Install Script** without passing the `-k` option, you can simply re-run the install script using the same options as before, this time passing `-k` to install Keycloak on your server.
+
+## Configuring Keycloak
+---
+
+Once you've completed the Keycloak installation, you'll need to configure Keycloak to suit your needs. This guide will provide you with an example of how to connect to Google Authentication, but you can adapt these steps to suit your deployment.
+
+**IMPORTANT NOTE:** This is a sample configuration meant to be used for testing. For a full production setup, please refer to [Keycloak's documentation](https://www.keycloak.org/docs/latest/server_admin/index.html).
+
+---
+
+Start by accessing the administrator panel by `https://<GREENLIGHT_HOSTNAME>/keycloak`
+
+Select `Administration Console` and sign in using the credentials that were printed during the Keycloak Installation process.
+
+Start by creating a new realm for Greenlight by hovering over the `Master` realm on the top left corner, and clicking on `Create Realm`.
+
+Set the name of the realm to `greenlight` and click create.
+
+![Add Realm](/img/greenlight/v3/keycloak/add-realm.png)
+
+Next, create a new client by clicking the `Clients` tab on the left side and then clicking `Create Client`. Set the `Client type` to `OpenID Connect` and the `Client ID` to `greenlight`. Once you've confirmed the values are correct, click `Next`
+
+![Create Clients](/img/greenlight/v3/keycloak/create-client-2.png)
+
+Set `Client authentication` to `ON` and  and `Valid Redirect URIs` to `https://<GREENLIGHT_URL>/*`. Make sure to click `Save` once you have set the values.
+
+![Valid Redirect](/img/greenlight/v3/keycloak/client-authentication.png)
+
+
+![Valid Redirect](/img/greenlight/v3/keycloak/valid-redirect.png)
+
+While staying in the `Clients` tab, click on the `Credentials` tab near the top of the page and store the `Client secret` variable on the side (this will be the `OPENID_CONNECT_CLIENT_SECRET` later in the `.env`).
+
+![Client Creds](/img/greenlight/v3/keycloak/client-credentials.png)
+
+To add a Identity Provider, click on `Identity Providers` on the left hand side and choose the provider that you would like (we'll be going with Google for this installation).
+
+![Idp](/img/greenlight/v3/keycloak/idp.png)
+
+For Google, follow this guide to obtain the credentials:  [Google OAuth Credentials](https://developers.google.com/workspace/guides/create-credentials#oauth-client-id).
+
+Feel free to use different providers and refer to their documentations on how to create and obtain OpenID credentials.
+
+Once you've obtained your Google credentials, fill in the `Client ID` and `Client Secret` fields and click `Save`.
+
+![Google Creds](/img/greenlight/v3/keycloak/google-creds.png)
+
+Next, we need to make Google our default authentication method to ensure a seamless login process for our users. Click on `Authentication` in the left side menu.
+
+Click on `browser` and then find the  `Identity Provider Redirector` row and click on the settings cog on the far right
+
+![Auth Actions](/img/greenlight/v3/keycloak/actions.png).
+
+![Auth Actions](/img/greenlight/v3/keycloak/actions-2.png).
+
+Set the `Alias` to `Google` and the `Default Identity Provider` to `google` (or whatever identity provider you chose). Once you're done, click `Save`
+
+![Auth Actions](/img/greenlight/v3/keycloak/actions-3.png).
+
+Finally, we need to connect Greenlight to Keycloak using the OpenID Connect `.env` variables.
+
+Go back to `Realm Settings` in the left side menu and click on `OpenID Endpoint Configuration`
+
+![Realm Creds](/img/greenlight/v3/keycloak/realm-creds.png)
+
+Copy the url that appears after `issuer`
+
+![Issuer](/img/greenlight/v3/keycloak/issuer.png)
+
+Now edit your `.env` file and uncomment the following block (remove the `#` before each `OPENID` variable):
+
+```
+### EXTERNAL AUTHENTICATION METHODS
+#
+#OPENID_CONNECT_CLIENT_ID=
+#OPENID_CONNECT_CLIENT_SECRET=
+#OPENID_CONNECT_ISSUER=
+#OPENID_CONNECT_REDIRECT=
+```
+
+Lastly, fill in the credentials as follows:
+-   `<YOUR_SECRET>`  is a placeholder for your OpenID client secret that you stored during the first few steps.
+-   `<ISSUER_URL>`  is a placeholder for your Keycloak issuer realm URL (that you just copied).
+-   `<YOUR_GREENLIGHT_DOMAIN>`  is a placeholder for your Greenlight hostname
+
+Once you're done, it should look something like this:
+
+```
+### EXTERNAL AUTHENTICATION METHODS
+#
+OPENID_CONNECT_CLIENT_ID=greenlight
+OPENID_CONNECT_CLIENT_SECRET=<YOUR_SECRET>
+OPENID_CONNECT_ISSUER=<ISSUER_URL>
+OPENID_CONNECT_REDIRECT=https://<YOUR_GREENLIGHT_DOMAIN>/
+```
+
+All that's left to do is restart Greenlight v3 and it should be connected to Keycloak
+
+```bash
+sudo docker-compose down && sudo docker-compose up -d
+```

docs/docs/greenlight/v3/install.md

@@ -0,0 +1,143 @@
+---
+id: install
+slug: /greenlight/v3/install
+title: Install Greenlight v3
+sidebar_position: 1
+description: Greenlight Installation
+keywords:
+- greenlight
+- installation
+---
+
+## Overview
+Greenlight is an open-source, LGPL-3.0 licensed web application that allows organizations to quickly set up a complete web conferencing platform using their existing BigBlueButton server. It is user-friendly for both regular and advanced users.
+
+Greenlight v3, the latest version, is constructed with the cutting-edge versions of Ruby on Rails and React - a robust technology stack adopted by millions of projects and trusted by major corporations worldwide.
+
+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
+
+## 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).
+
+To install Greenlight, simply run the `bbb-install` command with your chosen configurations, while ensuring that you include `-g` option to include Greenlight.
+
+### Creating an Admin Account
+Once installation is complete, you will need to create an Administrator account to access the administrator panel.
+
+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.
+```bash
+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
+```
+
+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:
+
+```
+-s <hostname>            Configure server with <hostname> (Required)
+
+-b <hostname>:<secret>   The BigBlueButton server credentials (bbb-conf --secret) (Required)
+
+-k                       Install Keycloak - needed for external authentication (Optional)
+
+-d                       Skip SSL certificates generation (Required, if -e is omitted).
+                         * Certificate files(fullchain.pem, privkey.pem) to be used must be placed in /local/certs/
+                         * Cannot be used when -e is used.
+
+-e <email>               Email for Let's Encrypt certbot (Required, if -d is omitted)
+                         * Cannot be used when -d is used.
+```
+
+### 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:
+
+    `-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`
+
+### Running the Script
+
+To run the script, simply run the command below, replacing `[OPTIONS]`, with the values from above.
+
+```bash
+wget -qO- https://raw.githubusercontent.com/bigbluebutton/greenlight/master/gl-install.sh | bash -s -- [OPTIONS]
+```
+
+After the script finishes running, a success message will appear in the console, confirming that Greenlight v3 is now accessible at the URL specified during installation.
+
+### Creating an Admin Account
+Once installation is complete, you will need to create an Administrator account to access the administrator panel.
+
+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.
+```bash
+docker exec -it greenlight-v3 bundle exec rake admin:create
+```
+
+## Optional .env Configurations
+### Default Locale Setup
+
+| Variable Name | Description                                                                                                                           | Default Value |
+|---------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| DEFAULT_LOCALE | The default language for all newly created users. Users will still have the ability to change their language through their profile.  | en |
+
+### Email Setup
+
+SMTP configuration requires following the guidelines provided by your SMTP server's documentation. The specific configuration details will vary based on the SMTP server you are using. It is important to refer to the relevant documentation in order to properly set up SMTP for your needs.
+
+| Variable Name | Description                                                                                                                           | Default Value |
+|---------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| SMTP_SERVER | The address of the remote mailing server having an open SMTP service.  | - |
+| SMTP_PORT | The port on which the SMTP service is accessible through on the remote SMTP_SERVER. Usually, it’s 25 TCP for SMTP and 465 TCP for SMTPS. | - |
+| SMTP_USERNAME | The username of the account to use when authenticating to the SMTP_SERVER. | - |
+| SMTP_PASSWORD | The password of the account to use when authenticating to the SMTP_SERVER. | - |
+| SMTP_AUTH | The authentication type to use to authenticate to the SMTP_SERVER: (plain, login, cram_md5).  | - |
+| SMTP_DOMAIN | The domain_name of the SMTP client. Usually, it’s the domain name portion of the SMTP_SENDER_EMAIL FQDN. | - |
+| SMTP_SENDER_EMAIL | The email sender address that will appear in the FROM section of the emails. | - |
+| SMTP_SENDER_NAME | The email sender name that will appear in the FROM section of the emails. | - |
+| SMTP_STARTTLS_AUTO | Automatically chooses between STARTTLS and plain SMTP depending on your SMTP server| true |
+| SMTP_STARTTLS | Checks if the SMTP_SERVER supports STARTTLS protocol command and uses it to negotiate an upgrade to SMTPS over the initiated unencrypted connection. | false |
+| SMTP_TLS | Use SMTPS when connecting to the SMTP_SERVER. | false |
+| SMTP_SSL_VERIFY | Defines whether or not to enable SSL verification on the certificate of the SMTP_SERVER when connecting through SMTPS. | true |
+
+### OpenID Connect Setup
+
+| Variable Name | Description                                                                                                                           | Default Value |
+|---------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| OPENID_CONNECT_CLIENT_ID | The client ID of the OpenID issuer  | - |
+| OPENID_CONNECT_CLIENT_SECRET | The secret to use to authenticate to the OpenID issuer  | - |
+| OPENID_CONNECT_ISSUER | The URL for the OpenID issuer. It is required to be HTTPS URL using the default HTTPS port (TCP 443)  | - |
+| OPENID_CONNECT_REDIRECT | The Redirect URI after successful authentication. It should be the URL to Greenlight  | - |
+
+### HCaptcha Setup
+
+| Variable Name | Description                                                                                                                           | Default Value |
+|---------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------|
+| HCAPTCHA_SITE_KEY | The site key that links to your hCaptcha site  | - |
+| HCAPTCHA_SECRET_KEY | The secret to use to authenticate with hCaptcha  | - |
+

docs/docs/greenlight/v3/migration.md

@@ -0,0 +1,193 @@
+---
+id: migration
+slug: /greenlight/v3/migration
+title: Migration to v3
+sidebar_position: 4
+description: Greenlight Migration
+keywords:
+- greenlight
+- migration
+---
+
+## Migration
+
+Greenlight v3 is a completely new software application with an updated design and architecture.
+A migration system has been created to move resources from your Greenlight v2 instance to v3.
+
+**The migration system requires both Greenlight v2 and Greenlight v3 and to be deployed, running and accessible through a network.**
+
+The process intends to migrate the following resources:
+- Users
+- Roles & Role Permissions
+- Rooms & Rooms Settings
+- Shared Accesses
+- Rooms Configuration
+- Site Settings
+
+## How It Works
+
+The migration system consists of multiples **rake tasks** and **a restful API**:
+
+- **The rake tasks are to be executed from the Greenlight v2 deployment.**
+- The rake tasks will send the data to the deployed Greenlight v3 server.
+- There are four rake tasks: roles, users, rooms and settings. Maintaining this order during the migration is necessary.
+
+- **The migration endpoints are available as long as the Greenlight v3 server is running.**
+- The restful API will receive and validate the migrated resources.
+
+## Prerequisites
+
+Before the migration process, make sure that the Greenlight v3 server is running and accessible through your network.
+
+### Configuring the Environment
+
+In Greenlight v2 **.env** file, add the following variables:
+- **V3_ENDPOINT**, which points to your Greenlight v3 URL.
+- **V3_SECRET_KEY_BASE**, a copy from Greenlight v3 SECRET_KEY_BASE. It is needed for the encryption process.
+
+![env_migration_endpoints.png](/img/greenlight/v3/migration/env_migration_endpoints.png)
+
+### The rake migration task file
+
+**If your Greenlight v2 deployment is up to date with the official latest release, you can skip to [Migration Steps](#migration-steps).**
+
+Else, you will need to to load the rake migration task file into your directory.
+
+To do so, follow the steps below:
+
+1) Navigate to your Greenlight v2 directory
+
+2) Download the migration rake tasks with the following command:
+
+```bash
+wget -P lib/tasks/migrations https://raw.githubusercontent.com/bigbluebutton/greenlight/master/lib/tasks/migrations/migrations.rake
+```
+
+The file **migrations.rake** should now be present in your **/lib/tasks/migrations** directory.
+
+**To include our changes directly in the Docker container:**
+
+3) Edit the volumes partition in the **docker-compose.yaml** to add the new migration file as follow:
+
+```yaml
+services:
+  app:
+    volumes:
+      - ./log:/usr/src/app/log
+      - ./storage:/usr/src/app/storage
+      - ./lib/tasks/migrations:/usr/src/app/lib/tasks/migrations
+```
+
+
+4) Save the changes and restart Greenlight v2 by running:
+
+```bash
+sudo docker-compose down && sudo docker-compose up -d
+```
+
+## Migration Steps
+
+**It is required to run the migrations in the following order: roles, users, rooms, settings.**
+
+The logs will indicate the status of the migrated resources in real-time, in the console.
+
+Upon the successful migration of a resource, a green success message will be displayed in the console.
+
+![success_migration.png](/img/greenlight/v3/migration/success_migration.png)
+
+In case of an error, a red error message will be displayed in the console and should provide some details concerning the error.
+
+![error_migration.png](/img/greenlight/v3/migration/error_migration.png)
+
+However, a failed migration resource should not hinder the whole migration process - the process should not have failed for all the resources.
+
+**If you have an error, try re-running the migration task to resolve any failed resources migration.**
+
+**If re-running the migration does not solve the issue, the error message should give you a clue of what went wrong.**
+
+### Roles Migration
+
+The custom Roles and the corresponding Role Permissions will be migrated.
+
+Please note that:
+- The default Roles (user, moderator, guest) will not be migrated as they are already present in Greenlight v3.
+- The role color will not be migrated as this feature is not implemented in v3.
+
+**To migrate the Roles & the Role Permissions, run the following command:**
+```bash
+sudo docker exec -it greenlight-v2 bundle exec rake migrations:roles
+```
+
+**If you have an error, try re-running the migration task to resolve any failed resources migration.**
+**Also, make sure that the Greenlight v3 server is running and accessible through your network.**
+
+### Users Migration
+The Users will be migrated with their corresponding role.
+
+Important notes:
+- **Once the Users migration is completed, the migrated users will be prompted to reset their password via an automated email. The accounts passwords can't be migrated from Greenlight v2.**
+- Pending, denied and deleted users will not be migrated to Greenlight v3.
+- Both local and external users will be migrated.
+
+**To migrate all of your v2 users to v3, run the following command:**
+```bash
+sudo docker exec -it greenlight-v2 bundle exec rake migrations:users
+```
+
+**To migrate only a portion of the users starting from *FIRST_USER_ID* to *LAST_USER_ID*, run this command instead:**
+
+```bash
+sudo docker exec -it greenlight-v2 bundle exec rake migrations:users[**FIRST_USER_ID, LAST_USER_ID**]
+```
+
+*Administrators can use the last command to migrate resources in parallel, the same migration task can be run in separate processes each migrating a portion of the resources class simultaneously.*
+
+**If you have an error, try re-running the migration task to resolve any failed resources migration.**
+**Also, make sure that the Roles migration has been successful.**
+
+### Rooms Migration
+The Rooms will be migrated with their corresponding Room Settings. Also, the Shared Accesses will be migrated.
+
+Important notes:
+
+- Only the Rooms of the active users will be migrated
+- The migrated rooms will be assigned to their respective migrated users on v3
+- The presentations will not be migrated - the presentations will need to be re-uploaded to v3 by the room owner or shared access user.
+
+**To migrate the rooms, run the following command:**
+
+```bash
+sudo docker exec -it greenlight-v2 bundle exec rake migrations:rooms
+```
+
+**To migrate only a portion of users starting from **FIRST_ROOM_ID** to **LAST_ROOM_ID**, run this command instead**:**
+
+```bash
+sudo docker exec -it greenlight-v2 bundle exec rake migrations:rooms[**FIRST_ROOM_ID, LAST_ROOM_ID**]
+```
+
+*Note: The partitioning is based on resources id value and not there position in the database, so calling **rake migrations:rooms[1, 100]** will not migrate the first 100 active users rooms but rather active users rooms having an id of 1 to 100 if existed.*
+
+*Administrators can use the last command to migrate resources in parallel, the same migration task can be run in separate processes each migrating a portion of the resources class simultaneously.*
+
+**If you have an error, try re-running the migration task to resolve any failed resources migration.**
+**Also, make sure that the Users migration has been successful.**
+
+### Settings Migration
+The Site Settings and the Rooms Configuration will be migrated.
+
+- The *Site Settings* are customisable settings related to the Greenlight application, such as the Brand colors, the Brand image, the Registration method, the Terms & Conditions.
+
+- The *Rooms Configuration* are the settings that are related to the default configuration of all the rooms, such as *Allow Room to be Recorded*, *Allow any User to Start a Meeting*, *Access Codes*.
+
+Please note that:
+- The Brand image will not be migrated - it will have to be re-uploaded to Greenlight v3 by the administrator.
+- The administrator will need to reassign the Room Limit as a Role Permission (on a per role basis) instead of as a global Site Setting.
+
+**To migrate the settings, run the following command:**
+
+```bash
+sudo docker exec -it greenlight-v2 bundle exec rake migrations:settings
+```
+
+**If you have an error, try re-running the migration task to resolve any failed resources migration.**

docs/docs/release-notes.md

@@ -68,7 +68,7 @@ Major features in this release include:
 
 * **Faster Screen Sharing** - Screen sharing now is faster, works across all browsers (using a Java application that launches outside the browser), and captures the cursor (see [video](https://www.youtube.com/watch?v=xTFuEvmEqB0)).
 
-* **Greenlight** - Administrators can install a new front-end, called Greenlight, that makes it easy for users to quickly creating meetings, invite others, and manage recordings on a BigBlueButton server.  Using Docker, administrators can [install](/greenlight/overview) on the BigBlueButton server itself (no need for a separate server).  Greenlight is written in Rails 5 and can be easily customized by any rails developer (see [source on GitHub](https://github.com/bigbluebutton/greenlight)).
+* **Greenlight** - Administrators can install a new front-end, called Greenlight, that makes it easy for users to quickly creating meetings, invite others, and manage recordings on a BigBlueButton server.  Using Docker, administrators can [install](/greenlight/v2/overview) on the BigBlueButton server itself (no need for a separate server).  Greenlight is written in Rails 5 and can be easily customized by any rails developer (see [source on GitHub](https://github.com/bigbluebutton/greenlight)).
 
 * **Ubuntu 16.04 packages** - This release installs on Ubuntu 16.04 64-bit (the most recent long-term support release from Canonical) and uses `systemd` for new start/stop scripts for individual components.
 

docs/docs/support/faq.md

@@ -448,7 +448,7 @@ Since BigBlueButton is controlled by its [API](/development/api), there isn't an
 
 The most common way to use BigBlueButton is to use an existing application that has a plugin. See [list of integrations](https://bigbluebutton.org/integrations/).
 
-BigBlueButton also comes with an easy-to-use front-end called [Greenlight](/greenlight/overview).
+BigBlueButton also comes with an easy-to-use front-end called [Greenlight](/greenlight/v2/overview).
 
 
 ### Where do I schedule a meeting in BigBlueButton?
@@ -518,7 +518,7 @@ As described above, by saying there are _multiple_ security mechanisms BigBlueBu
 
 #### Does BigBlueButton come with a front end?
 
-![greenlight-start](/img/greenlight/gl-start.png)
+![greenlight-start](/img/greenlight/v2/gl-start.png)
 
 #### Can I run multiple virtual classrooms in a single BigBlueButton server
 
@@ -528,7 +528,7 @@ Absolutely. To see an example of this, check out [GreenLight on our pool of demo
 
 If you are using Sakai, Moodle, Drupal, Joomla, Wordpress or other systems that already have a [BigBlueButton integration](https://bigbluebutton.org/support), then installing the integration provides the easiest way to enable your users to access BigBlueButton sessions.
 
-Alternatively, you can set up [Greenlight](/greenlight/overview) to be able to easily manage classrooms.
+Alternatively, you can set up [Greenlight](/greenlight/v2/overview) to be able to easily manage classrooms.
 
 #### How do I integrate BigBlueButton with my own server
 

docs/docs/support/troubleshooting.md

@@ -1008,7 +1008,7 @@ The script `bbb-install` now creates these overrides by default.
 
 ### 500 Internal Server Error
 
-It is most likely an error on GreenLight. Check the log file according to [Troubleshooting Greenlight](/greenlight/install#troubleshooting-greenlight).
+It is most likely an error on GreenLight. Check the log file according to [Troubleshooting Greenlight](/greenlight/v2/install#troubleshooting-greenlight).
 
 If this error occurrs on just a small number of PCs accessing a BigBlueButton server within a LAN through a proxy server and you find the description "Error::Unsafe Host Error (x.x.x.x is not a safe host)" (where x.x.x.x is an IP address) in the log file, check if the "Don't use the proxy server for local (intranet) addresses" (in the Windows proxy setting) is ticked.
 

docs/docusaurus.config.js

@@ -67,7 +67,7 @@ const config = {
                     {to: '/teaching', label: 'Teaching', position: 'left'},
                     {to: '/development/guide', label: 'Development', position: 'left'},
                     {to: '/administration/install', label: 'Administration', position: 'left'},
-                    {to: '/greenlight/overview', label: 'Greenlight', position: 'left'},
+                    {to: '/greenlight/v2/overview', label: 'Greenlight', position: 'left'},
                     {to: '/new-features', label: 'New Features', position: 'left'},
                     {
                         type: 'docsVersionDropdown',

docs/sidebars.js

@@ -73,7 +73,7 @@ const sidebars = {
             ],
             link: {
                 type: 'doc',
-                id: 'greenlight/overview',
+                id: 'greenlight/v2/overview',
             },
         }
     ],

docs/src/components/HomepageFeatures/index.tsx

@@ -58,7 +58,7 @@ const FeatureList: FeatureItem[] = [
             </>
         ),
         actionText: "Greenlight guide",
-        docId: "/greenlight/overview"
+        docId: "/greenlight/v2/overview"
     },
     {
         title: 'What\'s new?',