Greenlight v2.5 (#122)

* Greenlight v2.5

* Changed postgres change instructions

* Update docker-compose change instructions

* Updated install instructions

* Fixed psql url

* Updated role permissions

Author: farhatahmad

_posts/2019-04-15-gl-admin.md

@@ -102,6 +102,18 @@ Once an account gets banned, the user will be moved to the **Banned** tab.
 
 This will remove the account from Greenlight and will also prevent the user from signing up using the same email to Greenlight in the future.
 
+### Merging User Accounts
+
+In the case where 2 accounts need to be merged, there is a Merge action in the Account Dropdown. When merging 2 accounts together, there is a **Account to be Merged** and a **Primary Account**.
+
+During the merge process, the **Account to be Merged**'s rooms will be transferred to the **Primary Account**. Once the transfer is complete, the **Account to be Merged** will be permanently deleted. No other data is transferred to the **Primary Account**.
+
+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](/images/greenlight/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.
+
 ### Editing Accounts
 
 To edit an account, select Edit for the specified user. This will open the edit user view.
@@ -126,6 +138,35 @@ If the user has forgotten their password, the Administrator can send them an ema
 
 To reset a user's password, select Edit for the specified user. This will open the edit user view. From there, the Administrator just needs to click the `Reset user password` button and an email will be sent out to the user with the required instructions.
 
+## Server Rooms
+
+Through the Server Rooms tab, Administrators are able to view all of the Greenlight rooms that have been created.
+
+![Greenlight Administrator Server Rooms](/images/greenlight/admin_server_rooms.png)
+
+### Options
+
+As an administrator, there are a variety of options available to you with regards to interacting with a user's room. You can view all options by clicking the Room Dropdown. 
+
+| Tab               | Description |
+|:-----------------------|:------------|
+| View | Allows the administrator to join the room in the same way that anyother user joins the room. |
+| Start | Allows the administrator to manually start and join the room, even if it is not already running. |
+| 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](/images/greenlight/admin_server_rooms_options.png)
+
+### Search
+
+The search box can be used to filter based on the **Name**, **Owner**, or **Id** of any room.
+
+### Sort 
+
+It is possible to sort rooms by metrics such as **Name**, **Owner**, or **Id**.
+
+This can be done by clicking on the headers of the table (cycles through ascending, descending, and no particular order):
+
 ## Server Recordings
 
 Through the Server Recordings tab, Administrators are able to view all of the recordings that exist on their BigBlueButton server.
@@ -225,6 +266,14 @@ By default, users that are not signed in can join any Room that has been started
 
 ![Greenlight Administrator Room Authentication](/images/greenlight/admin_room_auth.png)
 
+### Allow Users to Share Rooms
+
+By default, all users that are able to create rooms are able to share rooms. Shared rooms can be entirely disabled by setting this setting to **Disabled**.
+
+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](/images/greenlight/admin_share_access.png)
+
 ### Recording Default Visibility
 
 Sets the default visibility of room recordings. 
@@ -278,13 +327,14 @@ Administrators are also able to update the permissions for the role. The followi
 
 | Permission               | Description |
 |:-----------------------|:------------|
-| Can create rooms                                           | This determines whether or not users with this role are able to create their own Greenlight rooms. |
-| Send an email to users when they are assigned this role     | This determines whether or not to send an email to users when they are promoted to this role |
-| Send an email to users when they are removed from this role | This determines whether or not to send an email to users when they are removed from this role |
-| Allow users with this role to edit site settings           | This allows users to access the Server Recordings and Site Settings tabs as if they were administrators |
-| Allow users with this role to edit other roles             | This allows users to access the Roles tab as if they were administrators |
-| Allow users with this role to manage other users           | This allows users to access the Manage Users tab as if they were administrators |
-
+| Can create rooms                                                | This determines whether or not users with this role are able to create their own Greenlight rooms. |
+| Allow users with this role to manage other users                | This allows users to access the Manage Users tab as if they were administrators |
+| Allow users with this role to view server rooms and recordings  | This allows users to access the Site Setting tabs as if they were administrators |
+| Allow users with this role to edit site settings                | This allows users to access the Site Setting tabs as if they were administrators |
+| Allow users with this role to edit other roles                  | This allows users to access the Roles tab as if they were administrators |
+| Include users with this role in the dropdown for sharing rooms  | This includes the user in the dropdown for sharing rooms |
+| Send an email to users when they are assigned this role         | This determines whether or not to send an email to users when they are promoted to this role |
+| Send an email to users when they are removed from this role     | This determines whether or not to send an email to users when they are removed from this role |
 
 **Note:** Administrators are unable to change the name for the user role or any of the permissions associated with the Admin role. Administrators are also only able to edit the permissions for roles with a lower priority than their own role.
 

_posts/2019-04-15-gl-config.md

@@ -27,6 +27,144 @@ If you are **not** deploying Greenlight on a BigBlueButton server and want the a
 
 You can now setup branding for Greenlight through its [Administrator Interface](gl-admin.html#site-branding). 
 
+## Use PostgreSQL instead of SQLite
+
+Greenlight can be set to use either a local in-memory SQLite database or a production-ready PostgreSQL database.
+
+For any new installs, Greenlight is configured to use PostgreSQL by default.
+
+If you installed Greenlight before v2.5 was released, your deployment is configured to use SQLite by default. If you are using SQLite, we highly recommend that you make the change to PostgreSQL.
+
+### Converting SQLite database to PostgreSQL without losing data
+
+It is possible to convert an existing SQLite database to PostgreSQL without losing any of your data.
+
+You'll need to generate a random password that will be used in 3 different instances. Generate one by running
+```bash
+openssl rand -hex 8
+```
+For the remainder of these instructions, replace **RANDOM_PASSWORD_REPLACE_ME** with the password that was generated with the command from above
+
+First, ensure you are in your Greenlight directory and that Greenlight is not running
+```bash
+cd ~/greenlight
+docker-compose down
+```
+
+Second, replace your `docker-compose.yml` with the new `docker-compose.yml` to include the PostgreSQL container 
+```bash
+docker run --rm bigbluebutton/greenlight:v2 cat ./docker-compose.yml > docker-compose.yml
+```
+
+Next, edit your `docker-compose.yml` to include your SQLite container (You can use vi, vim, nano or any text editor)
+```bash
+vim docker-compose.yml
+```
+
+There are 3 lines that need to be changed. When making the changes, make sure the spacing remains consistent.
+
+- The first change is removing the `#` before 
+```yaml
+#      - ./db/production:/usr/src/app/db/production
+```
+
+- The second change is replacing
+
+  ```yaml
+    - ./db/production:/var/lib/postgresql/data
+  ```
+
+  With
+
+  ```yaml
+    - ./db/production-postgres:/var/lib/postgresql/data
+  ```
+
+- The third change is replacing **RANDOM_PASSWORD_REPLACE_ME** with the password you generated in the earlier step
+
+
+**NOTE:** If you cloned the repository and are building your own image, make sure you also make the change to point to your image instead of the default one. If you are installed using the basic **Install** instructions, you can skip this step.
+```
+services:
+  app:
+    entrypoint: [bin/start]
+    image: <image name>:release-v2
+```
+
+The next step is configuring the `.env` file so that it connects to the PostgreSQL database. Edit your `.env` file
+```bash
+vim .env
+```
+and add the following lines to any part of the `.env` file (Making sure to replace the **RANDOM_PASSWORD_REPLACE_ME**)
+```
+DB_ADAPTER=postgresql
+DB_HOST=db
+DB_NAME=greenlight_production
+DB_USERNAME=postgres
+DB_PASSWORD=RANDOM_PASSWORD_REPLACE_ME
+```
+Next, test your current configuration by running
+```bash
+docker-compose up -d
+```
+If you see the following error, it is due to the spacing of your `docker-compose.yml` file. For reference, the spacing should look like [this](https://github.com/bigbluebutton/greenlight/blob/master/docker-compose.yml#L22) 
+```bash
+ERROR: yaml.parser.ParserError: while parsing a block mapping
+  in "./docker-compose.yml", line 4, column 3
+expected <block end>, but found '<block mapping start>'
+  in "./docker-compose.yml", line 23, column 4
+```
+If no errors appear, continue to the next step.
+Once the containers have spun up, we need to create a new database in PostgreSQL to store our data in  (Making sure to replace the **RANDOM_PASSWORD_REPLACE_ME**)
+``` bash
+docker exec greenlight-v2 psql "postgresql://postgres:RANDOM_PASSWORD_REPLACE_ME@db:5432" -c 'CREATE DATABASE greenlight_production_new'
+```
+Assuming that worked successfully, the console should output:
+```
+CREATE DATABASE
+```
+Finally, copy the SQLite database and convert it to a PostgreSQL database. (Making sure to replace the **RANDOM_PASSWORD_REPLACE_ME**)
+```bash
+docker exec greenlight-v2 bundle exec sequel -C sqlite:///usr/src/app/db/production/production.sqlite3 postgres://postgres:RANDOM_PASSWORD_REPLACE_ME@db:5432/greenlight_production_new
+```
+Assuming that worked successfully, the console should output:
+```
+Databases connections successful
+Migrations dumped successfully
+Tables created
+Begin copying data
+.
+.
+.
+Database copy finished in 2.741942643 seconds
+```
+
+Finally, edit your `.env` file to point at the new database by replacing the line that we added in the earlier step
+```
+DB_NAME=greenlight_production
+```
+With:
+```
+DB_NAME=greenlight_production_new
+```
+
+Now, [restart Greenlight](#applying-env-changes) and you should be good to go.
+
+You can verify that everything went smoothly if you are able to sign into the accounts you had made before starting this process.
+
+### Errors after migration
+
+If you encounter any errors after the migration, you can very easily switch back to your previous setup by removing the `.env` variables that were added during this switch. 
+
+Just remove these lines and restart Greenlight
+
+```
+DB_ADAPTER=postgresql
+DB_HOST=db
+DB_NAME=greenlight_production
+DB_USERNAME=postgres
+DB_PASSWORD=RANDOM_PASSWORD_REPLACE_ME
+```
 
 ## User Authentication
 

_posts/2019-04-15-gl-install.md

@@ -134,7 +134,12 @@ Next, you should copy the `docker-compose.yml` file from the Greenlight image in
 docker run --rm bigbluebutton/greenlight:v2 cat ./docker-compose.yml > docker-compose.yml
 ```
 
-Once you have this file, from the `~/greenlight` directory, start the application using:
+Finally, randomly generate a password for the PostgreSQL databse and replace the entries in the `.env` and `.docker-compose.yml` file with this command
+```bash
+export pass=$(openssl rand -hex 8); sed -i 's/POSTGRES_PASSWORD=password/POSTGRES_PASSWORD='$pass'/g' docker-compose.yml;sed -i 's/DB_PASSWORD=password/DB_PASSWORD='$pass'/g' .env
+```
+
+Once you have completed these steps, from the `~/greenlight` directory, start the application using:
 
 ```bash
 docker-compose up -d

_posts/2019-04-15-gl-overview.md

@@ -125,6 +125,38 @@ Afterwards, clicking **Update Room** will save the changes.
 
 ![Greenlight Room Block Editing Mode](/images/greenlight/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](/images/greenlight/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](/images/greenlight/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](/images/greenlight/room_shared_pending.png)
+
+Users that the room has been shared with will appear in the following state:
+
+![Greenlight Room Shared Added](/images/greenlight/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](/images/greenlight/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](/images/greenlight/room_share.png)
+
+The User also has the option to remove an unwanted shared room from their room list.
+
+![Greenlight Room Remove Shared](/images/greenlight/room_remove_shared.png)
+
 ## Recordings
 
 ### Viewing Recordings