docker/sample.env

# important! change these to random values
ETHERPAD_API_KEY=NEQKi2eFXSBce4kyGjwAzMn2jeF66peNYQmyFVRr
SHARED_SECRET=w6y7nycPafjPhVz3gZdBpQhR4H4MvEQzcZzia5LT
RAILS_SECRET=cdfbae48b197805a435ab7881da31c642ac1a7d4d5c006441efa8125ae63865ce7c915c651117e0f14358cd98f5287c431929e0f796f4100b2b1c3eb5baad1b0

DOMAIN=bbb.example.com

EXTERNAL_IP=144.76.97.10

# stun.freeswitch.org
STUN_IP=216.93.246.18
STUN_PORT=3478

SCREENSHARE_EXTENSION_KEY=akgoaoikmbmhcopjgakkcepdgdgkjfbc
SCREENSHARE_EXTENSION_LINK=https://chrome.google.com/webstore/detail/bigbluebutton-screenshare/akgoaoikmbmhcopjgakkcepdgdgkjfbc

CLIENT_TITLE=BigBlueButton

WELCOME_FOOTER=This server is running <a href="http://docs.bigbluebutton.org/" target="_blank"><u>BigBlueButton</u></a>.

# use following line for an additional SIP dial-in message
#WELCOME_FOOTER=This server is running <a href="http://docs.bigbluebutton.org/" target="_blank"><u>BigBlueButton</u></a>. <br><br>To join this meeting by phone, dial:<br>  INSERT_YOUR_PHONE_NUMBER_HERE<br>Then enter %%CONFNUM%% as the conference PIN number.

DEFAULT_PRESENTATION=./conf/default.pdf


# -------------------------------
# greenlight configuration
# -------------------------------

# Microsoft Office365 Login Provider (optional)
#
# For in-depth steps on setting up a Office 365 Login Provider, see:
#
#   https://docs.bigbluebutton.org/greenlight/gl-config.html#office365-oauth2
#
OFFICE365_KEY=
OFFICE365_SECRET=
OFFICE365_HD=

# OAUTH2_REDIRECT allows you to specify the redirect_url passed to oauth on sign in.
# It is useful for cases when Greenlight is deployed behind a Network Load Balancer or proxy
OAUTH2_REDIRECT=

# LDAP Login Provider (optional)
#
# You can enable LDAP authentication by providing values for the variables below.
# Configuring LDAP authentication will take precedence over all other providers.
# For information about setting up LDAP, see:
#
#   https://docs.bigbluebutton.org/greenlight/gl-config.html#ldap-auth
#
#   LDAP_SERVER=ldap.example.com
#   LDAP_PORT=389
#   LDAP_METHOD=plain
#   LDAP_UID=uid
#   LDAP_BASE=dc=example,dc=com
#   LDAP_BIND_DN=cn=admin,dc=example,dc=com
#   LDAP_PASSWORD=password
#   LDAP_ROLE_FIELD=ou
LDAP_SERVER=
LDAP_PORT=
LDAP_METHOD=
LDAP_UID=
LDAP_BASE=
LDAP_BIND_DN=
LDAP_PASSWORD=
LDAP_ROLE_FIELD=

# Set this to true if you want GreenLight to support user signup and login without
# Omniauth. For more information, see:
#
#   https://docs.bigbluebutton.org/greenlight/gl-overview.html#accounts-and-profile
#
ALLOW_GREENLIGHT_ACCOUNTS=true


# Set this to true if you want GreenLight to send verification emails upon
# the creation of a new account
#
#   ALLOW_MAIL_NOTIFICATIONS=true
#
# The notifications are sent using sendmail, unless the SMTP_SERVER variable is set.
# In that case, make sure the rest of the variables are properly set.
#
#   SMTP_SERVER=smtp.gmail.com
#   SMTP_PORT=587
#   SMTP_DOMAIN=gmail.com
#   SMTP_USERNAME=<youremail@gmail.com>
#   SMTP_PASSWORD=<yourpassword>
#   SMTP_AUTH=plain
#   SMTP_STARTTLS_AUTO=true
#
SMTP_SERVER=
SMTP_PORT=
SMTP_DOMAIN=
SMTP_USERNAME=
SMTP_PASSWORD=
SMTP_AUTH=
SMTP_STARTTLS_AUTO=

# Specify the email address that all mail is sent from
SMTP_SENDER=

# Prefix for the applications root URL.
# Useful for deploying the application to a subdirectory, which is highly recommended
# if deploying on a BigBlueButton server. Keep in mind that if you change this, you'll
# have to update your authentication callback URL's to reflect this change.
#
#   The recommended prefix is "/b".
#
RELATIVE_URL_ROOT=/b

# Specify which settings you would like the users to configure on room creation
# or edit after the room has been created
# By default, all settings are turned OFF.
#
# Current settings available:
#   mute-on-join: Automatically mute users by default when they join a room
#   require-moderator-approval: Require moderators to approve new users before they can join the room
#   anyone-can-start: Allows anyone with the join url to start the room in BigBlueButton
#   all-join-moderator: All users join as moderators in BigBlueButton
ROOM_FEATURES=mute-on-join,require-moderator-approval,anyone-can-start,all-join-moderator

# Specify the maximum number of records to be sent to the BigBlueButton API in one call
# Default is set to 25 records
PAGINATION_NUMBER=25

# Specify the maximum number of rows that should be displayed per page for a paginated table
# Default is set to 25 rows
NUMBER_OF_ROWS=25

# Set the application into Maintenance Mode
#
# Current options supported:
# true: Renders an error page that does not allow users to access any of the features in the application
# false: Application runs normally
MAINTENANCE_MODE=false

# Displays a flash that appears to inform the user of a scheduled maintenance window
# This variable should contain ONLY the date and time of the scheduled maintenance
#
# Ex: MAINTENANCE_WINDOW=Friday August 18 6pm-10pm EST
MAINTENANCE_WINDOW=

# The link to the Report an Issue button that appears on the 500 page and in the Account Dropdown
#
# Defaults to the Github Issues Page for Greenlight
# Button can be disabled by setting the value to blank
REPORT_ISSUE_URL=https://github.com/bigbluebutton/greenlight/issues/new

# Comment this out to send logs to STDOUT in production instead of log/production.log .
#
# RAILS_LOG_TO_STDOUT=true
#
# When using docker-compose the logs can be sent to an centralized repository like PaperTrail
# just by using the built in driver. Make sure to add to docker-compose.yml the next lines:
#
#     logging:
#      driver: $LOG_DRIVER
#      options:
#        syslog-address: $LOG_ADDRESS
#        tag: $LOG_TAG
#
# And set this variables up:
#
# LOG_DRIVER=syslog
# LOG_ADDRESS=udp://logs4.papertrailapp.com:[99999]
# LOG_TAG=greenlight.example.com:v2
#
# Check docker-compose and papertrail documentation for encrypting and
# protecting access to the log repository.
# https://docs.docker.com/config/containers/logging/syslog/#options
# https://help.papertrailapp.com/kb/configuration/encrypting-remote-syslog-with-tls-ssl/
#
# For sending logs to a remote aggregator enable these variables:
#
# RAILS_LOG_REMOTE_NAME=logxx.papertrailapp.com
# RAILS_LOG_REMOTE_PORT=9999
# RAILS_LOG_REMOTE_TAG=greenlight
#

# Specify the default registration to be used by Greenlight until an administrator sets the
# registration method
# Allowed values are:
#   open - For open registration
#   invite - For invite only registration
#   approval - For approve/decline registration
DEFAULT_REGISTRATION=open
created sample.env 2020-04-11 12:01:48 +02:00			`# important! change these to random values`
			`ETHERPAD_API_KEY=NEQKi2eFXSBce4kyGjwAzMn2jeF66peNYQmyFVRr`
			`SHARED_SECRET=w6y7nycPafjPhVz3gZdBpQhR4H4MvEQzcZzia5LT`
added greenlight and api demos 2020-04-12 16:01:57 +02:00			`RAILS_SECRET=cdfbae48b197805a435ab7881da31c642ac1a7d4d5c006441efa8125ae63865ce7c915c651117e0f14358cd98f5287c431929e0f796f4100b2b1c3eb5baad1b0`
created sample.env 2020-04-11 12:01:48 +02:00
			`DOMAIN=bbb.example.com`

			`EXTERNAL_IP=144.76.97.10`

			`# stun.freeswitch.org`
			`STUN_IP=216.93.246.18`
			`STUN_PORT=3478`

			`SCREENSHARE_EXTENSION_KEY=akgoaoikmbmhcopjgakkcepdgdgkjfbc`
			`SCREENSHARE_EXTENSION_LINK=https://chrome.google.com/webstore/detail/bigbluebutton-screenshare/akgoaoikmbmhcopjgakkcepdgdgkjfbc`

			`CLIENT_TITLE=BigBlueButton`

			`WELCOME_FOOTER=This server is running <a href="http://docs.bigbluebutton.org/" target="_blank"><u>BigBlueButton</u></a>.`
added greenlight and api demos 2020-04-12 16:01:57 +02:00
Configuration for SIP dial in 2020-04-23 14:51:48 +02:00			`# use following line for an additional SIP dial-in message`
			`#WELCOME_FOOTER=This server is running <a href="http://docs.bigbluebutton.org/" target="_blank"><u>BigBlueButton</u></a>. <br><br>To join this meeting by phone, dial:<br> INSERT_YOUR_PHONE_NUMBER_HERE<br>Then enter %%CONFNUM%% as the conference PIN number.`

Add default presentation Polls can only be used when there is a presentation, therefore I think that having the default presentation available can be useful. Note that the current nginx configuration in this repository does not specify where http://DOMAIN/default.pdf actually resides, so nginx's [default](http://nginx.org/en/docs/http/ngx_http_core_module.html#root) `root html` is used. 2020-05-17 12:14:18 +02:00			`DEFAULT_PRESENTATION=./conf/default.pdf`
added greenlight and api demos 2020-04-12 16:01:57 +02:00

			`# -------------------------------`
			`# greenlight configuration`
			`# -------------------------------`

			`# Microsoft Office365 Login Provider (optional)`
			`#`
			`# For in-depth steps on setting up a Office 365 Login Provider, see:`
			`#`
			`# https://docs.bigbluebutton.org/greenlight/gl-config.html#office365-oauth2`
			`#`
			`OFFICE365_KEY=`
			`OFFICE365_SECRET=`
			`OFFICE365_HD=`

			`# OAUTH2_REDIRECT allows you to specify the redirect_url passed to oauth on sign in.`
			`# It is useful for cases when Greenlight is deployed behind a Network Load Balancer or proxy`
			`OAUTH2_REDIRECT=`

			`# LDAP Login Provider (optional)`
			`#`
			`# You can enable LDAP authentication by providing values for the variables below.`
			`# Configuring LDAP authentication will take precedence over all other providers.`
			`# For information about setting up LDAP, see:`
			`#`
			`# https://docs.bigbluebutton.org/greenlight/gl-config.html#ldap-auth`
			`#`
			`# LDAP_SERVER=ldap.example.com`
			`# LDAP_PORT=389`
			`# LDAP_METHOD=plain`
			`# LDAP_UID=uid`
			`# LDAP_BASE=dc=example,dc=com`
			`# LDAP_BIND_DN=cn=admin,dc=example,dc=com`
			`# LDAP_PASSWORD=password`
			`# LDAP_ROLE_FIELD=ou`
			`LDAP_SERVER=`
			`LDAP_PORT=`
			`LDAP_METHOD=`
			`LDAP_UID=`
			`LDAP_BASE=`
			`LDAP_BIND_DN=`
			`LDAP_PASSWORD=`
			`LDAP_ROLE_FIELD=`

			`# Set this to true if you want GreenLight to support user signup and login without`
			`# Omniauth. For more information, see:`
			`#`
			`# https://docs.bigbluebutton.org/greenlight/gl-overview.html#accounts-and-profile`
			`#`
			`ALLOW_GREENLIGHT_ACCOUNTS=true`


			`# Set this to true if you want GreenLight to send verification emails upon`
			`# the creation of a new account`
			`#`
			`# ALLOW_MAIL_NOTIFICATIONS=true`
			`#`
			`# The notifications are sent using sendmail, unless the SMTP_SERVER variable is set.`
			`# In that case, make sure the rest of the variables are properly set.`
			`#`
			`# SMTP_SERVER=smtp.gmail.com`
			`# SMTP_PORT=587`
			`# SMTP_DOMAIN=gmail.com`
			`# SMTP_USERNAME=<youremail@gmail.com>`
			`# SMTP_PASSWORD=<yourpassword>`
			`# SMTP_AUTH=plain`
			`# SMTP_STARTTLS_AUTO=true`
			`#`
			`SMTP_SERVER=`
			`SMTP_PORT=`
			`SMTP_DOMAIN=`
			`SMTP_USERNAME=`
			`SMTP_PASSWORD=`
			`SMTP_AUTH=`
			`SMTP_STARTTLS_AUTO=`

			`# Specify the email address that all mail is sent from`
			`SMTP_SENDER=`

			`# Prefix for the applications root URL.`
			`# Useful for deploying the application to a subdirectory, which is highly recommended`
			`# if deploying on a BigBlueButton server. Keep in mind that if you change this, you'll`
			`# have to update your authentication callback URL's to reflect this change.`
			`#`
			`# The recommended prefix is "/b".`
			`#`
			`RELATIVE_URL_ROOT=/b`

			`# Specify which settings you would like the users to configure on room creation`
			`# or edit after the room has been created`
			`# By default, all settings are turned OFF.`
			`#`
			`# Current settings available:`
			`# mute-on-join: Automatically mute users by default when they join a room`
			`# require-moderator-approval: Require moderators to approve new users before they can join the room`
			`# anyone-can-start: Allows anyone with the join url to start the room in BigBlueButton`
			`# all-join-moderator: All users join as moderators in BigBlueButton`
			`ROOM_FEATURES=mute-on-join,require-moderator-approval,anyone-can-start,all-join-moderator`

			`# Specify the maximum number of records to be sent to the BigBlueButton API in one call`
			`# Default is set to 25 records`
			`PAGINATION_NUMBER=25`

			`# Specify the maximum number of rows that should be displayed per page for a paginated table`
			`# Default is set to 25 rows`
			`NUMBER_OF_ROWS=25`

			`# Set the application into Maintenance Mode`
			`#`
			`# Current options supported:`
			`# true: Renders an error page that does not allow users to access any of the features in the application`
			`# false: Application runs normally`
			`MAINTENANCE_MODE=false`

			`# Displays a flash that appears to inform the user of a scheduled maintenance window`
			`# This variable should contain ONLY the date and time of the scheduled maintenance`
			`#`
			`# Ex: MAINTENANCE_WINDOW=Friday August 18 6pm-10pm EST`
			`MAINTENANCE_WINDOW=`

			`# The link to the Report an Issue button that appears on the 500 page and in the Account Dropdown`
			`#`
			`# Defaults to the Github Issues Page for Greenlight`
			`# Button can be disabled by setting the value to blank`
			`REPORT_ISSUE_URL=https://github.com/bigbluebutton/greenlight/issues/new`

			`# Comment this out to send logs to STDOUT in production instead of log/production.log .`
			`#`
			`# RAILS_LOG_TO_STDOUT=true`
			`#`
			`# When using docker-compose the logs can be sent to an centralized repository like PaperTrail`
			`# just by using the built in driver. Make sure to add to docker-compose.yml the next lines:`
			`#`
			`# logging:`
			`# driver: $LOG_DRIVER`
			`# options:`
			`# syslog-address: $LOG_ADDRESS`
			`# tag: $LOG_TAG`
			`#`
			`# And set this variables up:`
			`#`
			`# LOG_DRIVER=syslog`
			`# LOG_ADDRESS=udp://logs4.papertrailapp.com:[99999]`
			`# LOG_TAG=greenlight.example.com:v2`
			`#`
			`# Check docker-compose and papertrail documentation for encrypting and`
			`# protecting access to the log repository.`
			`# https://docs.docker.com/config/containers/logging/syslog/#options`
			`# https://help.papertrailapp.com/kb/configuration/encrypting-remote-syslog-with-tls-ssl/`
			`#`
			`# For sending logs to a remote aggregator enable these variables:`
			`#`
			`# RAILS_LOG_REMOTE_NAME=logxx.papertrailapp.com`
			`# RAILS_LOG_REMOTE_PORT=9999`
			`# RAILS_LOG_REMOTE_TAG=greenlight`
			`#`

			`# Specify the default registration to be used by Greenlight until an administrator sets the`
			`# registration method`
			`# Allowed values are:`
			`# open - For open registration`
			`# invite - For invite only registration`
			`# approval - For approve/decline registration`
			`DEFAULT_REGISTRATION=open`