[doc] move multitenancy settings to config readme (#966)

Mariam05 · farhatahmad · web-flow · commit 169672c56cdf · 2023-11-10T10:19:59.000-05:00
Co-authored-by: Ahmad Farhat &lt;ahmad.af.farhat@gmail.com&gt;
diff --git a/docs/configuration-README.md b/docs/configuration-README.md
@@ -108,3 +108,112 @@ Additionally, these options can be set:
 * `pool`: The number of connections in the pool (should match number of threads). Defaults to `RAILS_MAX_THREADS` environment variable, otherwise 5.
 * `pool_timeout`: Amount of time (seconds) to wait if all connections in the pool are in use. Defaults to 5.
 * `namespace`: An optional prefix to apply to all keys stored in Redis.
+
+### Multitenancy
+
+Scalelite supports multitenancy using subdomains for each tenant. By using subdomains, you can easily isolate each tenant's data and ensure that they can only access their own meetings and recordings.
+
+To access their deployment, each tenant can use the following URL format: `tenant_name.sl.example.com`. Here, `tenant_name` refers to the name of the tenant, and `sl.example.com` is the domain where Scalelite is deployed.
+
+To ensure the security of each tenant's data, we recommend using either a wildcard SSL/TLS certificate or separate DNS entries for each tenant. This will prevent unauthorized access to other tenants' data.
+
+Each tenant will have access only to their own meetings and recordings. They will not be able to receive any information on other tenants or make any changes or actions to other tenants' resources.
+
+To enable multitenancy in Scalelite, you only need to set `MULTITENANCY_ENABLED=true` in your environment variables.
+
+#### Sample Tenant Setup
+To create new tenants, we've added a few rake tasks to help. First, add the new tenants and secrets to Scalelite:
+```sh  
+docker exec -it scalelite-api /bin/bash
+./bin/rake tenants:add[tenant1,secret1]
+./bin/rake tenants:add[tenant2,secret2:secret2a:secret2b]
+./bin/rake tenants #confirm tenants
+```  
+Once you have created multiple tenants in Scalelite, you will need to update the endpoint and secret for each tenant in any BigBlueButton front-end that you are using (such as Greenlight or Moodle).
+
+To do this, you will need to set the following environment variables / configuration variables in your BigBlueButton front-end:
+
+1.  `BIGBLUEBUTTON_ENDPOINT: tenant1.sl.example.com` - Replace `tenant1.sl.example.com` with the subdomain URL for the specific tenant.
+
+2.  `BIGBLUEBUTTON_SECRET: secret1` - Replace `secret1` with the secret for the specific tenant.
+
+Note that you will need to set these environment variables for each tenant in your BigBlueButton front-end. This ensures that each tenant's meetings and recordings are directed to their specific Scalelite deployment.
+
+#### Add Tenant
+`./bin/rake tenants:add[id,secrets]`
+
+If you need to add multiple secrets for a tenant, you can provide a colon-separated (`:`) list of secrets when creating the tenant in Scalelite.
+
+When you run this command, Scalelite will print out the ID of the newly created tenant, followed by `OK` if the operation was successful.
+
+#### Update Tenant
+`./bin/rake tenants:update[id,name,secrets]`
+
+You can update an existing tenants name or secrets using this rake command.
+
+When you run this command, Scalelite will print out the ID of the updated tenant, followed by `OK` if the operation was successful.
+
+#### Remove Tenant
+`./bin/rake tenants:remove[id]`
+
+Warning: Removing a tenant with data still in the database may cause some inconsistencies.
+
+#### Show Tenants
+`./bin/rake tenants`
+
+When you run this command, Scalelite will return a list of all tenants, along with their IDs, names, and secrets. For example:
+
+```
+id: 9a870f45-ec23-4d29-828b-4673f3536d7b
+        name: tenant1
+        secrets: secret1
+id: 4f3e4bb8-2a4e-41a6-9af8-0678c651777f
+        name: tenant2
+        secrets: secret2:secret2a:secret2b
+```
+#### Associate Old Recordings with a Tenant
+`./bin/rake recordings:addToTenant[tenant-id]`
+
+If you are switching over from single-tenancy to multitenancy, the existing recordings will have to be transferred to the new tenant. The above task updates the recordings' metadata with the tenant id.
+
+### Tenant Settings
+
+If you have enabled multitenancy for your Scalelite deployment, you gain the ability to customize the parameters passed into the `create` and `join` calls on a per-tenant basis. This functionality empowers you to tailor the user experience according to the specific needs and preferences of each tenant.
+
+By customizing these parameters for each tenant, you can modify various aspects of the meeting experience, such as recording settings, welcome messages, and lock settings, among others. This level of customization ensures that each tenant receives a unique and tailored experience within the Scalelite platform.
+
+#### Add Tenant Setting
+`./bin/rake tenantSettings:add[tenant_id,param,value,override]`
+
+To add a new TenantSetting, Scalelite requires 4 values:
+1. `tenant_id`: This is the unique identifier of the tenant to which you want to add the setting.
+2. `param`: Specify the name of the parameter you wish to set. For example, you can use values like record, welcome, or lockSettingsLockOnJoin. To view a comprehensive list of available options, refer to the [create](https://docs.bigbluebutton.org/development/api#create) and [join](https://docs.bigbluebutton.org/development/api#join) documentation.
+3. `value` -> Assign the desired value to the parameter you specified. It can be a boolean value like 'true' or 'false', a numeric value like '5' or a string like 'Welcome to BigBlueButton'.
+4. `override` -> This field should be set to either 'true' or 'false'. If set to 'true', the provided value will override any value passed by the person making the create/join call. If set to 'false', the value will only be applied if the user making the create/join call does not provide any value for the specified parameter.
+
+When you run this command, Scalelite will print out the ID of the newly created setting, followed by `OK` if the operation was successful.
+
+#### Remove Tenant Setting
+`./bin/rake tenantSettings:remove[id]`
+
+#### Show Tenant Settings
+`./bin/rake tenantSettings`
+
+When you run this command, Scalelite will return a list of all settings for all tenants. For example:
+
+```
+Tenant: tenant1
+  id: 18dcd4eb-769b-4c59-a441-5a9f7c0bf209
+        param: param1
+        value: value1
+        override: true
+Tenant: tenant2
+  id: 9867dd51-9065-4486-9216-afb238a04748
+        param: param2
+        value: value2
+        override: false
+  id: ac7d7443-3515-4b02-bdcf-6f6452a3e00a
+        param: param3
+        value: value3
+        override: true
+```
diff --git a/docs/rake-README.md b/docs/rake-README.md
@@ -414,112 +414,3 @@ Meeting ID: 1a813084f7af08b8d19239315c170b3decedfc03-2-1
 		bbb-recording-description: 
 		bbb-origin-tag: moodle-mod_bigbluebuttonbn
 ```
-
-### Multitenancy
-
-Scalelite supports multitenancy using subdomains for each tenant. By using subdomains, you can easily isolate each tenant's data and ensure that they can only access their own meetings and recordings.
-
-To access their deployment, each tenant can use the following URL format: `tenant_name.sl.example.com`. Here, `tenant_name` refers to the name of the tenant, and `sl.example.com` is the domain where Scalelite is deployed.
-
-To ensure the security of each tenant's data, we recommend using either a wildcard SSL/TLS certificate or separate DNS entries for each tenant. This will prevent unauthorized access to other tenants' data.
-
-Each tenant will have access only to their own meetings and recordings. They will not be able to receive any information on other tenants or make any changes or actions to other tenants' resources.
-
-To enable multitenancy in Scalelite, you only need to set `MULTITENANCY_ENABLED=true` in your environment variables.
-
-#### Sample Tenant Setup
-To create new tenants, we've added a few rake tasks to help. First, add the new tenants and secrets to Scalelite:
-```sh  
-docker exec -it scalelite-api /bin/bash
-./bin/rake tenants:add[tenant1,secret1]
-./bin/rake tenants:add[tenant2,secret2:secret2a:secret2b]
-./bin/rake tenants #confirm tenants
-```  
-Once you have created multiple tenants in Scalelite, you will need to update the endpoint and secret for each tenant in any BigBlueButton front-end that you are using (such as Greenlight or Moodle).
-
-To do this, you will need to set the following environment variables / configuration variables in your BigBlueButton front-end:
-
-1.  `BIGBLUEBUTTON_ENDPOINT: tenant1.sl.example.com` - Replace `tenant1.sl.example.com` with the subdomain URL for the specific tenant.
-
-2.  `BIGBLUEBUTTON_SECRET: secret1` - Replace `secret1` with the secret for the specific tenant.
-
-Note that you will need to set these environment variables for each tenant in your BigBlueButton front-end. This ensures that each tenant's meetings and recordings are directed to their specific Scalelite deployment.
-
-#### Add Tenant
-`./bin/rake tenants:add[id,secrets]`
-
-If you need to add multiple secrets for a tenant, you can provide a colon-separated (`:`) list of secrets when creating the tenant in Scalelite.
-
-When you run this command, Scalelite will print out the ID of the newly created tenant, followed by `OK` if the operation was successful.
-
-#### Update Tenant
-`./bin/rake tenants:update[id,name,secrets]`
-
-You can update an existing tenants name or secrets using this rake command.
-
-When you run this command, Scalelite will print out the ID of the updated tenant, followed by `OK` if the operation was successful.
-
-#### Remove Tenant
-`./bin/rake tenants:remove[id]`
-
-Warning: Removing a tenant with data still in the database may cause some inconsistencies.
-
-#### Show Tenants
-`./bin/rake tenants`
-
-When you run this command, Scalelite will return a list of all tenants, along with their IDs, names, and secrets. For example:
-
-```
-id: 9a870f45-ec23-4d29-828b-4673f3536d7b
-        name: tenant1
-        secrets: secret1
-id: 4f3e4bb8-2a4e-41a6-9af8-0678c651777f
-        name: tenant2
-        secrets: secret2:secret2a:secret2b
-```
-#### Associate Old Recordings with a Tenant
-`./bin/rake recordings:addToTenant[tenant-id]`
-
-If you are switching over from single-tenancy to multitenancy, the existing recordings will have to be transferred to the new tenant. The above task updates the recordings' metadata with the tenant id.
-
-### Tenant Settings
-
-If you have enabled multitenancy for your Scalelite deployment, you gain the ability to customize the parameters passed into the `create` and `join` calls on a per-tenant basis. This functionality empowers you to tailor the user experience according to the specific needs and preferences of each tenant.
-
-By customizing these parameters for each tenant, you can modify various aspects of the meeting experience, such as recording settings, welcome messages, and lock settings, among others. This level of customization ensures that each tenant receives a unique and tailored experience within the Scalelite platform.
-
-#### Add Tenant Setting
-`./bin/rake tenantSettings:add[tenant_id,param,value,override]`
-
-To add a new TenantSetting, Scalelite requires 4 values:
-1. `tenant_id`: This is the unique identifier of the tenant to which you want to add the setting.
-2. `param`: Specify the name of the parameter you wish to set. For example, you can use values like record, welcome, or lockSettingsLockOnJoin. To view a comprehensive list of available options, refer to the [create](https://docs.bigbluebutton.org/development/api#create) and [join](https://docs.bigbluebutton.org/development/api#join) documentation.
-3. `value` -> Assign the desired value to the parameter you specified. It can be a boolean value like 'true' or 'false', a numeric value like '5' or a string like 'Welcome to BigBlueButton'.
-4. `override` -> This field should be set to either 'true' or 'false'. If set to 'true', the provided value will override any value passed by the person making the create/join call. If set to 'false', the value will only be applied if the user making the create/join call does not provide any value for the specified parameter.
-
-When you run this command, Scalelite will print out the ID of the newly created setting, followed by `OK` if the operation was successful.
-
-#### Remove Tenant Setting
-`./bin/rake tenantSettings:remove[id]`
-
-#### Show Tenant Settings
-`./bin/rake tenantSettings`
-
-When you run this command, Scalelite will return a list of all settings for all tenants. For example:
-
-```
-Tenant: tenant1
-  id: 18dcd4eb-769b-4c59-a441-5a9f7c0bf209
-        param: param1
-        value: value1
-        override: true
-Tenant: tenant2
-  id: 9867dd51-9065-4486-9216-afb238a04748
-        param: param2
-        value: value2
-        override: false
-  id: ac7d7443-3515-4b02-bdcf-6f6452a3e00a
-        param: param3
-        value: value3
-        override: true
-```
