forked from External/greenlight
177 lines
6.8 KiB
Bash
177 lines
6.8 KiB
Bash
# This is a sample of the environment variables you will need
|
|
# To use, copy this file to .env `cp sample.env .env`
|
|
|
|
# Create a secret key for rails
|
|
#
|
|
# You can generate a secure one through the Greenlight docker image
|
|
# with with the command
|
|
#
|
|
# docker run --rm bigbluebutton/greenlight rake secret
|
|
#
|
|
SECRET_KEY_BASE=
|
|
|
|
# For either developent or production
|
|
|
|
# Enter credentials for your BigBlueButton Server
|
|
#
|
|
# The endpoint and secret from your bigbluebutton server. To get these values, run
|
|
# the following command on your BigBlueButton server
|
|
#
|
|
# bbb-conf --secret
|
|
#
|
|
# and uncomment the following two variables
|
|
# BIGBLUEBUTTON_ENDPOINT=
|
|
# BIGBLUEBUTTON_SECRET=
|
|
|
|
# Set default client (optional)
|
|
#
|
|
# By default, GreenLight will join users to a BigBlueButton session using the Flash
|
|
# client. By setting USE_HTML5_BY_DEFAULT to true, you can configure GreenLight to
|
|
# use the HTML5 client by default. GreenLight will only use the default for
|
|
# non-authenticated users. Users who have authenticated are able to set their
|
|
# prefered client under preferences. Also note that if the HTML5 client is not
|
|
# running on a BigBlueButton server, all clients will be joined using Flash
|
|
# regardless on any settings.
|
|
USE_HTML5_BY_DEFAULT=false
|
|
|
|
# Twitter Login Provider (optional)
|
|
#
|
|
# You will need to register the app at https://apps.twitter.com/
|
|
# For the callback URL use 'http://<your hostname:port>/auth/twitter/callback'
|
|
# Once registered copy the ID and Secret here
|
|
#
|
|
TWITTER_ID=
|
|
TWITTER_SECRET=
|
|
|
|
# Google Login Provider (optional)
|
|
#
|
|
# To setup the credentials, see docs at
|
|
# http://docs.bigbluebutton.org/install/green-light.html#6-configure-oauth2-optional
|
|
#
|
|
# The GOOGLE_OAUTH2_HD variable is used to limit sign-in to a particular Google Apps hosted domain. This
|
|
# can be a string such as, 'domain.com'. If left blank, GreenLight will allow sign-in from all Google Apps hosted
|
|
# domains.
|
|
#
|
|
GOOGLE_OAUTH2_ID=
|
|
GOOGLE_OAUTH2_SECRET=
|
|
GOOGLE_OAUTH2_HD=
|
|
|
|
# LDAP Login Provider (optional)
|
|
#
|
|
# You can enable LDAP authentication by providing values for the variables below.
|
|
# For information about setting up LDAP, see:
|
|
# http://docs.bigbluebutton.org/install/green-light.html#ldap-oauth
|
|
#
|
|
LDAP_SERVER=
|
|
LDAP_PORT=
|
|
LDAP_METHOD=
|
|
LDAP_UID=
|
|
LDAP_BASE=
|
|
LDAP_BIND_DN=
|
|
LDAP_PASSWORD=
|
|
|
|
# SAML2 Login Provider (optional)
|
|
#
|
|
# You can use SAML authentication by providing the values below.
|
|
# SAML_ISSUER is the name of your application. Some identity providers might need this to establish the identity of the service provider requesting the login.
|
|
# The location of this SP's metadata can be used here; For example : https://bigbluebutton.yourdomain.tld/auth/saml/metadata
|
|
# SAML_IDP_URL is the URL to which the authentication request should be sent. This would be on the identity provider. It can be found in the
|
|
# IDP's metadata in the <md:SingleSignOnService> tag
|
|
# SAML_IDP_CERT_FINFERPRINT is the fingerprint of the certificate used by the IDP, for example "25:72:85:66:C9:94:22:98:36:84:11:E1:88:C7:AC:40:98:F9:E7:82".
|
|
# You can get the fingerprint by downloading the IDP's certificate and running :
|
|
# openssl x509 -noout -in torproject.pem -fingerprint -sha1
|
|
# SAML_NAME_IDENTIFIER describes the format of the username required by this application.
|
|
# If you need the email address, use "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress". See http://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf section 8.3
|
|
# for other options. Note that the identity provider might not support all options. If not specified, the IdP is free to choose the name identifier format used in the response
|
|
# SAML_...._ATTRIBUTE : Attributes from the SAML response should be mapped to the attributes used by greenlight. The defaults are based upon https://wiki.surfnet.nl/display/surfconextdev/Attributes+in+SURFconext
|
|
#
|
|
# The information about this SP (metadata) can be found on your server http://<example.com>/auth/saml/metadata
|
|
#
|
|
# SAML_ISSUER=
|
|
# SAML_IDP_URL=
|
|
# SAML_IDP_CERT_FINGERPRINT=
|
|
# SAML_NAME_IDENTIFIER=
|
|
# SAML_UID_ATTRIBUTE=
|
|
# SAML_USERNAME_ATTRIBUTE=
|
|
# SAML_EMAIL_ATTRIBUTE=
|
|
# SAML_LASTNAME_ATTRIBUTE=
|
|
# SAML_FIRTSNAME_ATTRIBUTE=
|
|
# SAML_COMMOMNAME_ATTRIBUTE=
|
|
|
|
# If "true", GreenLight will register a webhook callback for each meeting
|
|
# created. This callback is called for all events that happen in the meeting,
|
|
# including the processing of its recording. These events are used to update
|
|
# the web page dynamically as things happen in the server.
|
|
# If not "true", the application will add a metadata to the meetings with this same
|
|
# callback URL. Scripts can then be added to BigBlueButton to call this callback
|
|
# URL and send specific events to GreenLight (e.g. a post publish script to warn
|
|
# the application when recordings are done).
|
|
# GREENLIGHT_USE_WEBHOOKS=true
|
|
|
|
# Enable uploading to Youtube (optional)
|
|
#
|
|
# When this is enabled, users will be able to directly upload their recordings
|
|
# to Youtube. If you plan to enable this, you should follow the steps outlined
|
|
# in our docs for setting up the Youtube data API.
|
|
#
|
|
# http://docs.bigbluebutton.org/install/green-light.html#8-enabling-uploading-to-youtube-optional
|
|
#
|
|
ENABLE_YOUTUBE_UPLOADING=false
|
|
|
|
# Slack Integration (optional)
|
|
#
|
|
# You will need to register an incoming-webhook for your slack channel
|
|
# in order for GreenLight to post to it. You can do this by going
|
|
# to https://slack.com/apps/A0F7XDUAZ-incoming-webhooks, selecting your
|
|
# team and then selecting "Add Incoming WebHooks integration" on the
|
|
# desired channel. You will then need to paste the webhook below.
|
|
#
|
|
SLACK_WEBHOOK=
|
|
SLACK_CHANNEL=
|
|
|
|
# Landing Background (optional)
|
|
#
|
|
# Supply a URL to an image to change the landing background. If no
|
|
# URL is provided GreenLight will use a default image. If you
|
|
# supply a path that does not lead to an image, no landing image
|
|
# will appear.
|
|
#
|
|
LANDING_BACKGROUND=
|
|
|
|
# SMTP Mailer (optional)
|
|
#
|
|
GREENLIGHT_MAIL_NOTIFICATIONS=true
|
|
# In the format [localhost.localdomain]
|
|
GREENLIGHT_DOMAIN=localhost-lxc.org
|
|
SMTP_FROM=youremail@gmail.com
|
|
SMTP_SERVER=smtp.gmail.com
|
|
SMTP_PORT=587
|
|
SMTP_DOMAIN=gmail.com
|
|
SMTP_USERNAME=youremail@gmail.com
|
|
SMTP_PASSWORD=yourpassword
|
|
# SMTP_TLS=false
|
|
# SMTP_AUTH=login
|
|
# SMTP_STARTTLS_AUTO=true
|
|
|
|
# Enable QR Code generation (optional)
|
|
#
|
|
# When this is enabled, users will be able to generate a QR code for direct access
|
|
# to a meeting room that can be shared as the URL link.
|
|
#
|
|
ENABLE_QRCODE_GENERATION=false
|
|
|
|
|
|
# Prefix for the application's root URL
|
|
# Useful for deploying the application to a subdirectory
|
|
#
|
|
# default is '/b' (recommended)
|
|
#
|
|
# RELATIVE_URL_ROOT=/b
|
|
|
|
# Uncomment and set to 'true' to only allow users to create meetings when authenticated.
|
|
# Unauthenticated users are still able to join meetings through invites.
|
|
# DISABLE_GUEST_ACCESS=false
|
|
|
|
# Comment this out to send logs to STDOUT in production instead of log/production.log .
|
|
DISABLE_RAILS_LOG_TO_STDOUT=true
|