Configuration¶
BBBLB can be configured via environment variables or command line parameters. Here is a list of all possible configuration sources, ordered from highest to lowest priority:
Individual settings defined in via command line parameters (e.g.
-c debug=Trueor--config debug=True).Environment variables starting with
BBBLB_(e.g.BBBLB_DEBUG=True).Settings loaded from a file (e.g
-C /etc/bbblb.envor--config-file /etc/bbblb.env).Built-in defaults.
Environment variables must be uppercase and start with BBBLB_ to be recognized (e.g. BBBLB_DEBUG=True). The special environment variable BBBLB_CONFIG can be used instead of the --config-file cli parameter to load values from a file.
The config file should follow a simplified env-file syntax, similar to how variables are defined in shell scripts: One NAME=value pair per line. Empty lines or lines starting with # are ignored. The variable name must be uppercase and can optionally start with BBBLB_. Leading or tailing whitespace is removed from the value. Quotes are also removed, but can be used to preserve whitespace.
Config Options¶
This is an auto-generated list of all available config options, ordered loosely by topic.
CONFIG (type: Path|None, default: None)
A shell or .env style (KEY=VALUE) config file with one option per line. If the CONFIG option is defined (via environment variables or explicitly during initialization) then this file is loaded and parsed. Its content will overwrite other values or defaults.
DOMAIN (type: str, REQUIRED)
Primary domain for this service. This will be added as bbblb-origin metadata to meetings and is used by e.g. the recording upload script to get back at bbblb from the BBB nodes.
SECRET (type: str, REQUIRED)
Secret used to sign and verify API credentials and protected callbacks. This is NOT your BBB API secret.
DB (type: str, default: 'sqlite:////usr/share/bbblb/sqlite.db')
An sqlalchemy compatible database connection string, starting with either
sqlite:// or postgresql://. For example sqlite:////path/to/file.db
or postgresql://user:pass@host/name.
DB_CREATE (type: bool, default: True)
Create database if it does not exist on startup (postgres only).
DB_MIGRATE (type: bool, default: True)
Run database schema migrations automatically on startup.
PATH_DATA (type: Path, default: '/usr/share/bbblb')
The directory where BBBLB stores all its persistent data, including
recordings, lockfiles, logs and more. Must be fully write-able for BBBLB
and the {PATH_DATA}/recordings sub-directory must also be read-able by
your front-end HTTP server, if used. See docs/recording.md for details.
TENANT_HEADER (type: str, default: 'Host')
For each BBB API request, the value of this header is matched against
the tenant realms to find the correct tenant. This defaults to the Host
header, which means each tenant needs to use a different (sub-)domain to
reach BBBLB.
TENANT_CACHE (type: int, default: 10)
Cache tenant info for a couple of seconds before requesting fresh info from the database. Even a short cache time improves API latency by a lot. The only downside is that tenant changes (e.g. new secret) may take a couple of seconds to take effect.
SCOPED_MEETING_IDS (type: bool, default: True)
If true, meeting IDs are scoped with the tenant ID to avoid conflicts between tenants. API clients will still see the unmodified meeting ID, but the scoped ID may end up in recording metadata and logs.
RECORDING_THREADS (type: int, default: 1)
Maximum number of import tasks to perform at the same timer. It is usually not a good idea to increase this too much.
RECORDING_IMPORT_UNPUBLISHED (type: bool, default: False)
BBB publishes new recordings by default. If this setting is True, then BBBLB will import new recordings as 'unpublished' regardless of their original state.
PROTECTED_RECORDINGS (type: bool, default: False)
If enabled, BBBLB will support protected recordings similar to the experimental and unofficial API extention implemented by Scalelite and Greenlight.
For protected recordings, the getRecordings API will replace recording links with a one-time ticket that allow a single user to watch the protected recording for a limited amount of time.
Warning: This feature needs additional configuration if recordings are not served through BBBLB, and does not prevent downloads. Read the documentation to understand requirements and limitations of this feature.
PROTECTED_RECORDINGS_TIMEOUT (type: int, default: 360)
Number of minutes a protected recording can be watched wth a ticket after it has been issued.
PLAYBACK_DOMAIN (type: str, default: '{DOMAIN}')
Domain where recordings are hostet. The wildcards {DOMAIN} or {REALM} can be used to refer to the global DOMAIN config, or the realm of the current tenant.
PLAYBACK_PLAYER_ROOT (type: Path|None, default: None)
Absolute path to a copy of the bbb-playback presentation player. You can leave this blank if you serve the bbb-playback assets via a front-end webserver or CDN.
Defaults to {PATH_DATA}/htdocs/playback/presentation/2.3/
POLL_INTERVAL (type: int, default: 30)
Poll interval in seconds for the background server health and meeting checker. This also defines the timeout for each individual poll, and changes how quickly the POLL_FAIL and POLL_RECOVER watermarks can be reached. The interval should be between 10 (fast) and 60 (very slow) depending on the size of your cluster.
POLL_FAIL (type: int, default: 3)
Number of failed create calls or health checks after which we give up on an UNSTABLE server and mark it as OFFLINE. All remaining meetings are dropped, so they can be re-created on another server.
POLL_RECOVER (type: int, default: 5)
Number of successfull health checks in a row after which an OFFLINE or UNSTABLE server is considered to be AVAILABLE again.
POLL_STATS (type: bool, default: False)
Collect meeting statistics in the database.
WARNING: The meeting_stats table will grow by one row per meeting
per POLL_INTERVAL. Make sure your database can handle the number
of days you configure with POLL_STATS_DAYS.
POLL_STATS_DAYS (type: int, default: 0)
Number of days after which meeting statistics are deleted. Statistics are kept indefinitely by default and the user is expected to clean up statictics data by some other means.
LOAD_BASE (type: float, default: 5.0)
Base load counted for each meeting.
LOAD_USER (type: float, default: 1.0)
Additional load counted for each user in a meeting.
LOAD_VOICE (type: float, default: 0.5)
Additional load counted for each voice user in a meeting.
LOAD_VIDEO (type: float, default: 0.5)
Additional load counted for each video user in a meeting.
LOAD_RESERVED (type: float, default: 20.0)
Reserved seats for new meetings. When new meetings are created, their final user count is still unknown. To avoid uneven meeting distribution during peaks hours, we reserve up to LOAD_RESERVED seats for additional users that are likely to join during the first LOAD_COOLDOWN minutes of a new meeting. The number of reserved seats will slowly decrease over time until LOAD_COOLDOWN minutes have passed.
LOAD_COOLDOWN (type: float, default: 30.0)
Number of minutes after which new meetings are no longer impacted by LOAD_RESERVED. The accounted number of reserved seats decreases linearly over time.
ANALYTICS_STORE (type: bool, default: False)
If true, BBBLB will intercept the analytics-callback-url webhook and dump json files into the {PATH_DATA}/analytics/{tenant}/ folder for later analysis (WIP). The callback is only fired if BBB is configured with defaultKeepEvents=true in bbb-web.properties.
MAX_ITEMS (type: int, default: 1000)
Maximum number of meetings or recordings to return from APIs that potentially return an unlimited amount of data.
MAX_BODY (type: int, default: 1048576)
Maximum body size for BBB API requests, both front-end and back-end. This does not affect presentation uploads, so 1MB should be plenty.
WEBHOOK_RETRY (type: int, default: 3)
How often to retry webhooks if the target fails to respond.
DEBUG (type: bool, default: False)
Enable debug and SQL logs.
WORKER (type: bool, default: True)
Internal. Set to False to disable certain background tasks (e.g. recording importer, server health checks, ...).
