flarum-docker/.env.example at main · linkrobins/flarum-docker · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# ==========================================================================
# Copy this file to `.env` and edit the values, then `docker compose up -d --build`.
# Every value here is read by entrypoint.sh and/or docker-compose.yml.
# ==========================================================================

# ── Forum identity ───────────────────────────────────────────────────────────
# Public base URL of the forum. Use https:// if you terminate TLS in a proxy in
# front of this stack (recommended); the realtime client connects accordingly.
APP_URL=https://forum.example.com
FORUM_TITLE=My Forum

# ── Initial admin account (created on first install only) ─────────────────────
ADMIN_USER=admin
ADMIN_PASS=change-me
ADMIN_EMAIL=admin@example.com

# ── Database (MariaDB) ────────────────────────────────────────────────────────
# DB_HOST must match the mariadb service name in docker-compose.yml.
DB_HOST=mariadb
DB_NAME=flarum
DB_USER=flarum
DB_PASS=change-me
DB_ROOT_PASS=change-me-too

# ── Cache / queue (Valkey, Redis-compatible) ──────────────────────────────────
# REDIS_HOST must match the valkey service name. Leave REDIS_PASSWORD empty for
# no auth, or set it to require a password on Valkey.
REDIS_HOST=valkey
REDIS_PORT=6379
REDIS_PASSWORD=

# ── Outbound email (SMTP) — optional ──────────────────────────────────────────
# Leave MAIL_HOST empty to skip mail setup (Flarum's existing settings, if any,
# are left untouched). Set these to send signup/notification emails.
MAIL_HOST=smtp.example.com
MAIL_PORT=587
MAIL_USERNAME=
MAIL_PASSWORD=
MAIL_ENCRYPTION=tls
MAIL_FROM=forum@example.com

# ── Realtime websocket (flarum/realtime) ──────────────────────────────────────
# true = run the websocket server (proxied at /app and published on :6001).
REALTIME_ENABLED=true

# ── Flarum version constraint (optional) ──────────────────────────────────────
# Leave this unset to install the Flarum baked into the image (recommended: no
# Packagist call on first boot, and the image tag then tells you exactly what
# you get). Set it only to resolve a different 2.x version from Packagist.
#
# Flarum 2.x only. A 1.x constraint is refused with an explanation at startup:
# 1.x cannot install or boot from this image, and 1.8 is near end of life.
# TARGET_FLARUM_VERSION=^2.0

# ── Restore on deploy (optional) ──────────────────────────────────────────────
# On a FRESH deploy, a backup dropped in ./restore (database.sql[.gz] + optional
# storage.tar.gz, as produced by backup.sh) is imported instead of a fresh
# install. The conventional /restore layout is auto-detected; set these only if
# your files live at a different path inside the container.
# RESTORE_DB=/restore/database.sql.gz
# RESTORE_FILES=/restore/storage.tar.gz
#
# To restore into a forum you've ALREADY set up (overwrites it), set this to
# true, put the backup in ./restore, and redeploy. It's one-shot: a restart
# won't re-import the same backup. Leave false for normal operation.
# RESTORE_FORCE=false