Environment variables

Every setting is read from .env at runtime. This reference covers the variables that matter when self-hosting. On/off feature switches have their own page: Feature toggles.

Required secrets

The stack refuses to start without these (no defaults):

Variable	Notes
`APP_KEY`	A `base64:`-encoded 32-byte key. Generated for you.
`DB_PASSWORD`	PostgreSQL password. Generated for you.
`MEILISEARCH_KEY`	Meilisearch master key. Generated for you.

Application

Variable	Default	Notes
`APP_URL`	—	Public URL of your instance. Set this.
`APP_NAME`	`The Desk`	Shown in the UI and emails. Served at runtime.
`APP_PORT`	`80`	Host port the web app is published on.
`APP_IMAGE`	`the-desk:latest`	Set to `ghcr.io/emmpaul/the-desk:X.Y.Z` to run the published image instead of building.

Database

Variable	Default	Notes
`DB_DATABASE`	`laravel`	PostgreSQL database name.
`DB_USERNAME`	`laravel`	PostgreSQL user.
`DB_PASSWORD`	—	Required secret (see above).

Mail (SMTP)

Variable	Notes
`MAIL_MAILER`	`smtp` for a real mail server.
`MAIL_HOST`	SMTP host.
`MAIL_PORT`	SMTP port (commonly `587`).
`MAIL_USERNAME`	SMTP username.
`MAIL_PASSWORD`	SMTP password.
`MAIL_FROM_ADDRESS`	From address on outgoing mail.
`MAIL_FROM_NAME`	From name (defaults to `${APP_NAME}`).

Search (Meilisearch)

Variable	Default	Notes
`MEILISEARCH_KEY`	—	Required secret (master key).
`MEILISEARCH_VERSION`	`v1.49`	Pins the image tag and the version-scoped data volume. See Upgrading.
`MEILISEARCH_NO_ANALYTICS`	`true`	Disable Meilisearch usage analytics.

Reverb — server-facing (container)

How the containers reach Reverb. Defaults are correct for the bundled stack.

Variable	Default	Notes
`REVERB_APP_ID`	—	Reverb app id. Generated for you.
`REVERB_APP_KEY`	—	Reverb app key. Generated for you.
`REVERB_APP_SECRET`	—	Reverb app secret. Generated for you.
`REVERB_HOST`	`reverb`	Internal service host.
`REVERB_PORT`	`8080`	Internal (and published) Reverb port.
`REVERB_SCHEME`	`http`	The container speaks plain HTTP.

Reverb — browser-facing (public)

How the browser reaches Reverb through your TLS proxy. Set these for production — see Configuration.

Variable	Set to	Notes
`REVERB_SCHEME_PUBLIC`	`https`	Browser connects over TLS.
`REVERB_PORT_PUBLIC`	`443`	Your proxy terminates `wss` on 443.
`REVERB_HOST_PUBLIC`	(APP_URL host)	Only set for a dedicated WebSocket subdomain.

Feature toggles

Variable	Default	See
`REGISTRATION_ENABLED`	`true`	Feature toggles → Open registration
`EMAIL_VERIFICATION_ENABLED`	`false`	Feature toggles → Email verification
`ACTIVITYLOG_ENABLED`	`true`	Feature toggles → Activity logging
`REVERB_SCALING_ENABLED`	`false`	Feature toggles → Advanced Reverb