Skip to content

Environment variables ​

Gulfstream reads one required configuration path and expands ${NAME} placeholders inside TOML basic strings.

VariablePurpose
GULFSTREAM_CONFIGPath to the active TOML file; may be replaced by --config
GULFSTREAM_ADMIN_TOKENRegistration secret when mode is admin_token
GULFSTREAM_PASSWORD_PEPPERServer-side password pepper
GULFSTREAM_SESSION_SIGNING_KEYBrowser-session and CSRF verifier key
GULFSTREAM_API_KEY_PEPPERAPI-key verifier pepper
GULFSTREAM_PLAYBACK_SIGNING_KEYPrivate playback-token signer
GULFSTREAM_VIEWER_HASH_KEYKey for privacy-preserving viewer identifiers

The names above are conventions used by the example configuration. Placeholders can refer to differently named variables when the TOML file is customized.

docker-compose.yml also accepts GULFSTREAM_PORT, GULFSTREAM_DATA_DIRECTORY, and GULFSTREAM_CONFIG_FILE for host deployment paths.

Released under the MIT License.