sample.env

# ====================================
# ADDITIONS to BigBlueButton
# ====================================
# (place a '#' before to disable them)

# HTTPS Proxy
# fully automated Lets Encrypt certificates
ENABLE_HTTPS_PROXY=true
LETSENCRYPT_EMAIL=test@example.net

# Greenlight Frontend
# https://docs.bigbluebutton.org/greenlight/gl-overview.html
ENABLE_GREENLIGHT=true


# Collabora
# Enable Collabora service
# Deactivate if you use an external collabora server
# https://www.collaboraonline.com/
ENABLE_COLLABORA=true
COLLABORA_URL=https://collabora:9980/cool

# Coturn
# Enable Coturn service
# Deactivate if you use an external coturn server
# https://github.com/coturn/coturn
ENABLE_COTURN=true

# Enable Webhooks
# used by some integrations
#ENABLE_WEBHOOKS=true

# Prometheus Exporter
# serves the bigbluebutton-exporter under following URL:
# https://yourdomain/bbb-exporter
#ENABLE_PROMETHEUS_EXPORTER=true
#ENABLE_PROMETHEUS_EXPORTER_OPTIMIZATION=true

# Recording
# IMPORTANT: this is currently a big privacy issues, because it will
# record everything which happens in the conference, even when the button
# suggets, that it does not.
# https://github.com/bigbluebutton/bigbluebutton/issues/9202
# make sure that you get peoples consent, before they join a room
#ENABLE_RECORDING=true
#REMOVE_OLD_RECORDING=false
#RECORDING_MAX_AGE_DAYS=14

# ====================================
# SECRETS
# ====================================
# important! change these to any random values
SHARED_SECRET=SuperSecret
ETHERPAD_API_KEY=SuperEtherpadKey
RAILS_SECRET=SuperRailsSecret_SuperRailsSecret
POSTGRESQL_SECRET=SuperPostgresSecret
FSESL_PASSWORD=SuperFreeswitchESLPassword
TURN_SECRET=SuperTurnSecret



# ====================================
# CONNECTION
# ====================================

DOMAIN=bbb.example.com

# Coolify deployment mode (see docs/COOLIFY.md)
# true: bridge networking for ALL services (no network_mode: host), published
#       UDP port ranges, Coolify/Traefik terminates TLS and proxies to nginx:48087.
#       Required for deployment as a Coolify Compose resource.
# false/empty: upstream default (media services use host networking).
COOLIFY_MODE=true

# Root directory for all BBB data volumes (recordings, presentations,
# freeswitch meetings, mediasoup state, ...). Defaults to ./data (relative to the
# compose file). Set this to a path backed by object storage (e.g. an rclone or
# s3fs FUSE mount) to keep recordings in S3/MinIO/etc. See docs/COOLIFY.md.
# BBB_DATA_DIR=/mnt/bbb-object-storage

# RTP UDP range published for the WebRTC SFU (mediasoup), sized for the expected
# concurrent load. Each participant typically uses 2-4 ports (audio+video send/recv,
# plus screenshare for presenters), so ~100 concurrent users need ~300-500 ports.
# Must match the host firewall rules. Range must not overlap COTURN_PORT_RANGE_*.
RTP_PORT_RANGE_START=24577
RTP_PORT_RANGE_END=25000

# TURN relay UDP range published for coturn. Only used when a client cannot reach
# the media servers directly (NAT/blocked UDP), so it can be smaller than RTP range.
# Must not overlap RTP_PORT_RANGE_*.
COTURN_PORT_RANGE_START=32769
COTURN_PORT_RANGE_END=33268

EXTERNAL_IPv4=144.76.97.10
EXTERNAL_IPv6=

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

# TURN SERVER
# uncomment and adjust following two lines to add an external TURN server
#TURN_EXT_SERVER=turns:example.org:443?transport=tcp
#TURN_EXT_SECRET=

# Allowed SIP IPs
# due to high traffic caused by bots, by default the SIP port is blocked.
# but you can allow access by your providers IP or IP ranges (comma seperated)
# Hint: if you want to allow requests from every IP, you can use 0.0.0.0/0
SIP_IP_ALLOWLIST=


# ====================================
# CUSTOMIZATION
# ====================================

# use following lines to replace the default welcome message and footer
WELCOME_MESSAGE="Welcome to <b>%%CONFNAME%%</b>!<br><br>For help on using BigBlueButton see these (short) <a href='https://www.bigbluebutton.org/html5' target='_blank'><u>tutorial videos</u></a>.<br><br>To join the audio bridge click the speaker button.  Use a headset to avoid causing background noise for others."
WELCOME_FOOTER="This server is running <a href='https://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='https://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."

# for a different default presentation, place the pdf file in ./conf/ and
# adjust the following path
DEFAULT_PRESENTATION=./mod/nginx/default.pdf

# language of sound announcements
# options:
# - en-ca-june - EN Canadian June
# - en-us-allison - US English Allison
# - en-us-callie - US English Callie (default)
# - de-de-daedalus3 - German by Daedalus3 (https://github.com/Daedalus3/freeswitch-german-soundfiles)
# - es-ar-mario - Spanish/Argentina Mario
# - fr-ca-june - FR Canadian June
# - pt-br-karina - Brazilian Portuguese Karina
# - ru-RU-elena - RU Russian Elena
# - ru-RU-kirill - RU Russian Kirill
# - ru-RU-vika - RU Russian Viktoriya
# - sv-se-jakob - Swedish (Sweden) Jakob
# - zh-cn-sinmei - Chinese/China Sinmei
# - zh-hk-sinmei - Chinese/Hong Kong Sinmei
SOUNDS_LANGUAGE=en-us-callie

# set to true to disable announcements "You are now (un-)muted"
DISABLE_SOUND_MUTED=false

# set to true to disable announcement "You are the only person in this conference"
DISABLE_SOUND_ALONE=false

# set to false to disable the learning dashboard
ENABLE_LEARNING_DASHBOARD=true

# ====================================
# GREENLIGHT CONFIGURATION
# ====================================

### 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
#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
#
#OPENID_CONNECT_CLIENT_ID=
#OPENID_CONNECT_CLIENT_SECRET=
#OPENID_CONNECT_ISSUER=
#OPENID_CONNECT_REDIRECT=

# To enable hCaptcha on the user sign up and sign in, define these 2 keys
#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=

# Define the default locale language code (i.e. 'en' for English) from the fallowing list:
#  [en, ar, fr, es]
#DEFAULT_LOCALE=en