sample.env

### SECRET KEY BASE
# Verifies the integrity of all secrets created in the application
# Can be generated by running 'docker run --rm --entrypoint /bin/sh bigbluebutton/greenlight:v3 -c "bundle exec rails secret"'
SECRET_KEY_BASE=

### BIGBLUEBUTTON CREDENTIALS
# Set these if you are running GreenLight on a single BigBlueButton server.
# You can retrieve these by running the following command on your BigBlueButton server:
#   bbb-conf --secret
BIGBLUEBUTTON_ENDPOINT=
BIGBLUEBUTTON_SECRET=

### POSTGRES DATABASE URL
# Must be in the format postgres://username:password@host:port/dbname
#   E.g. postgres://postgres:password@postgres:5432/greenlight-v3-production
DATABASE_URL=

### REDIS CACHE URL
# Must be in the format redis://host:port
#   E.g. redis://redis:6379
REDIS_URL=

### OPTIONAL ENV VARS

### SMTP CONFIGURATION
# Emails are required for the basic features of Greenlight to function.
# Please refer to your SMTP provider to get the values for the variables below
# More information: https://docs.bigbluebutton.org/greenlight/v3/install/#email-setup
#SMTP_SENDER_EMAIL=
#SMTP_SENDER_NAME=
#SMTP_SERVER=
#SMTP_PORT=
#SMTP_DOMAIN=
#SMTP_USERNAME=
#SMTP_PASSWORD=
#SMTP_AUTH=
#SMTP_STARTTLS_AUTO=true
#SMTP_STARTTLS=false
#SMTP_TLS=false
#SMTP_SSL_VERIFY=true

### EXTERNAL AUTHENTICATION METHODS
# More information: https://docs.bigbluebutton.org/greenlight/v3/install/#openid-connect-setup
#OPENID_CONNECT_CLIENT_ID=
#OPENID_CONNECT_CLIENT_SECRET=
#OPENID_CONNECT_ISSUER=
#OPENID_CONNECT_REDIRECT=
#OPENID_CONNECT_UID_FIELD=sub

# Uncomment the following flag if you want to use EMAIL as a Unique ID backup, useful for setups with existing users who want to switch to an IDP setup.
# More information: https://github.com/bigbluebutton/greenlight/issues/5872
#USE_EMAIL_AS_EXTERNAL_ID_FALLBACK=true

# To enable hCaptcha on the user sign up and sign in, define these 2 keys
# More information: https://docs.bigbluebutton.org/greenlight/v3/install/#hcaptcha-setup
#HCAPTCHA_SITE_KEY=
#HCAPTCHA_SECRET_KEY=

# Set these if you are using a Simple Storage Service (S3)
# Uncomment S3_ENDPOINT only if you are using a S3 OTHER than Amazon Web Service (AWS) S3.
#S3_ACCESS_KEY_ID=
#S3_SECRET_ACCESS_KEY=
#S3_REGION=
#S3_BUCKET=
#S3_ENDPOINT=
#S3_FORCE_PATH_STYLE=

# Set these environment variables if you are using Google Cloud Storage
#GCS_PROJECT=
#GCS_BUCKET=
#GCS_PROJECT_ID=
#GCS_PRIVATE_KEY_ID=
#GCS_PRIVATE_KEY=
#GCS_CLIENT_EMAIL=
#GCS_CLIENT_ID=
#GCS_CLIENT_CERT=

# Set this to explicitly specify base hostname
#URL_HOST=

# Define the default locale language code (i.e. 'en' for English) from the following list:
#  [en, ar, fr, es, fa_IR]
# The DEFAULT_LOCALE setting specifies the default language, overriding the browser language which is always set.
# More information: https://docs.bigbluebutton.org/greenlight/v3/install/#default-locale-setup
#DEFAULT_LOCALE=en

# Set this if you like to deploy Greenlight on a relative root path other than /
# More information: https://docs.bigbluebutton.org/greenlight/v3/install/#relative-url-root-path-subdirectory-setup
#RELATIVE_URL_ROOT=/gl

## Define log level in production.
# [debug|info|warn|error|fatal]
# Default 'warn'.
LOG_LEVEL=info

## Use to send logs to external repository (Optional)
# RAILS_LOG_REMOTE_NAME=xxx.papertrailapp.com
# RAILS_LOG_REMOTE_PORT=99999
# RAILS_LOG_REMOTE_TAG=greenlight-v3

## ClamAV Virus Scanning
# If you have ClamAV installed on the same machine as your Greenlight deployment, you can enable automatic virus scanning
# for presentations, avatars, and BrandingImage. If a malicious file is detected, the user will be informed and asked
# to check their file.
#CLAMAV_SCANNING=true
#CLAMAV_DAEMONIZE=true

## Support for Tagged Servers
# If your Greenlight instance is connected to Scalelite or another Loadbalancer with enabled support for the 'meta_server-tag'
# parameter on create calls, you can use the following variables to configure support for this feature via the Greenlight UI.
# When this configuration is changed later, disallowed tags can be removed from the DB via `bundle exec rake server_tags_sync`
# For more documentation on the feature, see here: https://github.com/blindsidenetworks/scalelite/blob/master/docs/tags-README.md
# Example configuration (delimiters are , : and /):
# SERVER_TAG_NAMES=tag1:Name 1,tag2:Name2  # defines available tags and their friendly names
# SERVER_TAG_ROLES=tag2:xyz-123-321-aaaa-zyx/abc-321-123-zzzz-cba  # allow tag only for given role ids (see role ids in DB)
# SERVER_TAG_FALLBACK_MODE=required # fallback mode, may be 'desired'/'required' (as global overrides), otherwise room config applies