Skip to content

Environment Reference

Environment variables use the WFM_ prefix. Docker examples live in docker/sqlite/.env.example and docker/postgres/.env.example.

Runtime

VariableMeaning
WFM_DEBUGBackend debug mode.
WFM_ENABLE_DEV_TEST_APIEnables /api/v0 and skips production source guard.
WFM_TIMEZONEDisplay timezone.
WFM_AUTH_TOKEN_EXPIRE_MINUTESAdmin token lifetime.
WFM_AUTH_DOWNLOAD_TOKEN_EXPIRE_MINUTESDownload token lifetime.

Public access

VariableMeaning
WFM_PUBLIC_ORIGINMain public origin.
WFM_EXTRA_ALLOWED_ORIGINSExtra allowed browser origins as JSON array.
WFM_APP_PORTHost Gateway Web port.
WFM_GATEWAY_CLIENT_MAX_BODY_SIZEGateway request body limit.

Database

VariableMeaning
WFM_DATABASESQLAlchemy database URL.
WFM_POSTGRES_DBPostgreSQL database name.
WFM_POSTGRES_USERPostgreSQL user.
WFM_POSTGRES_PASSWORDPostgreSQL password.
WFM_POSTGRES_PORTHost PostgreSQL port.

MQTT / EMQX

VariableMeaning
WFM_ENABLE_MQTT_SERVICESEnables client binding, MQTT, and endpoint control.
COMPOSE_PROFILESCompose profile, usually mqtt.
WFM_MQTT_URLBackend MQTT broker URL.
WFM_MQTT_PUBLIC_PORTClient plaintext MQTT port.
WFM_MQTT_PUBLIC_TLS_PORTClient TLS MQTT port.
WFM_MQTT_TLS_ENABLEDEnables client-facing MQTT TLS.
WFM_EMQX_API_BASE_URLInternal EMQX management API URL.
WFM_EMQX_USERNAMEEMQX admin username.
WFM_EMQX_PASSWORDEMQX admin password.
WFM_EMQX_AUTHZ_SHARED_KEYInternal EMQX authz shared key.
WFM_EMQX_AUTHZ_URLBackend authz callback URL.