Skip to main content

Environment Variables

Common Variables (quark)

Applies to both the API and events servers.

NameDescriptionDefault
MONGODBURI of MongoDB servermongodb://localhost
REDIS_URIURI of Redis serverredis://localhost

Additional variables are available from redis-kiss.

API Server (delta)

NameDescriptionDefault
REVOLT_PUBLIC_URLExternal API addressRequired
REVOLT_APP_URLRemote Web App addressRequired
REVOLT_EXTERNAL_WS_URLExternal WebSocket addressRequired
AUTUMN_PUBLIC_URLRemote Autumn hosthttps://example.com
JANUARY_PUBLIC_URLRemote January hosthttps://example.com
VOSO_PUBLIC_URLRemote Vortex hosthttps://example.com
VOSO_WS_HOSTWebSocket host of remote Vortex servicehttps://example.com
VOSO_MANAGE_TOKENToken used for authenticating with Vortex0
REVOLT_HCAPTCHA_KEYhCaptcha private key0x0000000000000000000000000000000000000000
REVOLT_HCAPTCHA_SITEKEYhCaptcha site key10000000-ffff-ffff-ffff-000000000001
REVOLT_VAPID_PRIVATE_KEYPrivate key used for Web Push authentication.
Generate keys.
Required
REVOLT_VAPID_PUBLIC_KEYPublic key used for Web Push authentication.Required
REVOLT_INVITE_ONLYWhether registrations should be restricted to invite-only.0
REVOLT_SMTP_HOSTSMTP HostEmpty
REVOLT_SMTP_USERNAMESMTP UsernameEmpty
REVOLT_SMTP_PASSWORDSMTP PasswordEmpty
REVOLT_SMTP_FROMSMTP From AddressEmpty
REVOLT_MAX_GROUP_SIZEMaximum number of users in group50
REVOLT_MAX_BOT_COUNTMaximum number of bots that can be owned by a user5
REVOLT_MAX_EMBED_COUNTMaximum number of embeds a user can send at once5
REVOLT_MAX_SERVER_COUNTMaximum number of servers a user can be in100
warning

These variables are likely to change as variables are moved into quark.

Events Service (bonfire)

NameDescriptionDefault
HOSTIP and port to bind events service to.0.0.0.0:9000

File Server (autumn)

NameDescriptionDefault
AUTUMN_CONFIGPath to Autumn.tomlAutumn.toml
AUTUMN_HOSTHost to bind toRequired
AUTUMN_MONGO_URIURI of MongoDB serverRequired
AUTUMN_LOCAL_STORAGE_PATHPath to local storage./files
AUTUMN_S3_REGIONS3 regionEmpty
AUTUMN_S3_ENDPOINTS3 endpointEmpty

S3 is automatically enabled when AUTUMN_S3_REGION and AUTUMN_S3_ENDPOINT are set.

Proxy Server (january)

NameDescriptionDefault
JANUARY_HOSTHost to bind toRequired

Voice Server (vortex)

VariableDescriptionExample
HTTP_HOSTHost to bind to to.0.0.0.0:8080 (default)
WS_URLThe websocket URL to advertise.wss://vortex.revolt.chat
MANAGE_TOKENThe token used for communication between Vortex and Delta.<token>
RTC_MIN_PORTThe minimum port to use for WebRTC and RTP.10000 (default)
RTC_MAX_PORTThe maximum port to use for WebRTC and RTP.11000 (default)
DISABLE_RTPDisable RTP. The value 1 disables RTP, all other values or not set will enable RTP.0 (default)
RTC_IPSSemicolon separated list of IPs to use for WebRTC. Hostnames are not supported yet. Either combined or split listen and announce IPs.<combined>;<listen>,<announce>