Repository navigation
Expand file tree
/
Copy path.env.example
More file actions
130 lines (113 loc) · 6.3 KB
/
Copy path.env.example
File metadata and controls
130 lines (113 loc) · 6.3 KB
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
PORT=4000
VERSION=0.0.1
# Browser-facing URL of the web client, advertised in the service map on GET /.
# WEB_URL=https://web.strafe.chat
# Logging: off, error, warn, info, debug. Use "off" in production to silence logs.
# LOG_LEVEL=info
# Stargate (separate process, e.g. stargate.strafe.chat):
# STARGATE_PORT=4001
# STARGATE_REGION=default
# STARGATE_ALLOWED_ORIGINS=https://strafe.chat,https://app.strafe.chat
# Browser-facing gateway URL advertised on GET / (falls back to FEDERATION_GATEWAY_URL).
# STARGATE_PUBLIC_URL=wss://chat.example.com/gateway/events
# Features:
CAPTCHA=false
INVITE_ONLY=false
# Who may START a direct message (or add someone to a group DM). "shared" (default): only
# friends and people who share a space with you - the right setting for a public instance,
# it is what stops strangers from spamming. "open": anyone can message anyone. Existing
# conversations are never affected; blocks are enforced in both modes.
PM_POLICY=shared
# Registration refuses throwaway-mail addresses (mailinator, yopmail, 10minutemail, ...)
# from the bundled list unless this is false. EMAIL_BLOCKED_DOMAINS adds your own, comma
# separated; a domain covers its subdomains.
EMAIL_BLOCK_DISPOSABLE=true
# EMAIL_BLOCKED_DOMAINS=spammers.example,other.example
# Outbound email: the verification link a new account gets and password-reset links.
# Off unless SMTP_HOST is set. Any SMTP server works; the compose deployment (deploy/)
# bundles a send-only relay. WEB_URL must be set too - every link points at the web client.
# SMTP_HOST=mail
# SMTP_PORT=587 # default 587 (465 when SMTP_TLS=tls)
# SMTP_TLS=starttls # starttls (required STARTTLS, default) | tls (implicit) | none (private network only)
# SMTP_USERNAME= # both or neither
# SMTP_PASSWORD=
# MAIL_FROM=noreply@chat.example.com # defaults to noreply@<FEDERATION_DOMAIN or WEB_URL host>
# MAIL_FROM_NAME=StrafeChat
# Require a verified address to sign in. New accounts get a link at registration; accounts
# from before the switch are asked to verify once at their next sign-in. Needs SMTP_HOST.
# EMAIL_VERIFICATION=false
# Registration captcha (only read when CAPTCHA=true). Starting with CAPTCHA=true and the
# chosen provider's keys missing is a hard config error rather than a silent pass.
# altcha self-hosted proof-of-work; needs only a random key (openssl rand -hex 32)
# cap self-hosted Cap (trycap.dev) in its own container; site + secret key from
# its dashboard, plus the URL browsers solve against
# friendly Friendly Captcha v2; site key + API key from friendlycaptcha.com
# turnstile Cloudflare Turnstile; site key + secret key from the Cloudflare dashboard
# CAPTCHA_PROVIDER=altcha
# ALTCHA_HMAC_KEY=
# FRIENDLY_CAPTCHA_SITE_KEY=
# FRIENDLY_CAPTCHA_API_KEY=
# TURNSTILE_SITE_KEY=
# TURNSTILE_SECRET_KEY=
# cap: CAP_API_URL is public (the browser fetches its challenge from it); CAP_INTERNAL_URL
# is how this server reaches Cap and defaults to CAP_API_URL.
# CAP_API_URL=http://localhost:3000
# CAP_INTERNAL_URL=http://cap:3000
# CAP_SITE_KEY=
# CAP_SECRET_KEY=
# Sessions (optional):
# SESSION_TTL_SECONDS=604800
# SESSION_TOKEN_BYTES=32
# Two-factor auth: TOTP_ENCRYPTION_KEY wraps every user's authenticator secret at rest and
# is required (32 bytes, hex - openssl rand -hex 32). It cannot change once anyone has
# enrolled: swapping it makes every stored secret undecryptable, i.e. everyone's
# authenticator app starts rejecting valid codes.
TOTP_ENCRYPTION_KEY=
# Passkeys (WebAuthn) additionally need WEB_URL set above - a passkey is bound to the exact
# browser origin it was created on, so that is where the relying-party id comes from. TOTP
# authenticator codes and recovery codes work regardless.
# Database:
SCYLLA_HOSTS=
SCYLLA_KEYSPACE=
# Redis (Stargate Pub/Sub + optional cache):
# REDIS_ADDR=localhost:6379
# REDIS_POOL_SIZE=10
# REDIS_CACHE_ENABLED=true
# REDIS_CACHE_PREFIX=equinox:
# Uploads (Nebula). HTTP_BODY_LIMIT_KB must cover the largest multipart upload (attachments: 25 MB by default).
# HTTP_BODY_LIMIT_KB=27648
# NEBULA_BASE_URL=http://localhost:4010
# NEBULA_PUBLIC_URL=http://localhost:4010
# NEBULA_UPLOAD_SECRET=
# NEBULA_AVATAR_MAX_MB=8
# NEBULA_ATTACHMENT_MAX_MB=25
# NEBULA_EMOJI_MAX_KB=512
# Voice/video (LiveKit). Enabled when all three are set; a partial config refuses to boot.
# Development: `docker compose up -d livekit` in the repository root, then
# LIVEKIT_URL=ws://<your LAN IP>:7880 LIVEKIT_API_KEY=devkey
# LIVEKIT_API_SECRET=devsecretdevsecretdevsecretdevsecret (the dev compose's key pair).
# LIVEKIT_URL=wss://chat.example.com/livekit # what browsers connect to
# LIVEKIT_INTERNAL_URL=http://livekit:7880 # server API; defaults to LIVEKIT_URL with ws->http
# LIVEKIT_API_KEY=
# LIVEKIT_API_SECRET= # 32+ characters (openssl rand -hex 32)
# GIF search for the composer's picker. The API searches the provider for the client
# (GET /gifs/search, /gifs/trending), so these keys are used only by this server and never
# reach a browser; the picker offers only the providers that have one. The old names
# STRAFE_GIPHY_API_KEY / STRAFE_HEYPSTER_API_KEY are read as a fallback. A key an older
# version published in the web client's config.js was public - rotate it.
# GIPHY_API_KEY= # developers.giphy.com
# HEYPSTER_API_KEY= # heypster.com (GIPHY-compatible API)
# Federation (instances talking to each other). Enabled when FEDERATION_DOMAIN is set.
# FEDERATION_DOMAIN=chat.example.com
# FEDERATION_PUBLIC_URL=https://chat.example.com/api
# FEDERATION_GATEWAY_URL=wss://chat.example.com/gateway/events
# FEDERATION_KEY_FILE=./federation.key # auto-generated Ed25519 seed
# FEDERATION_SIGNING_KEY= # or provide the base64 seed directly
# FEDERATION_ALLOWLIST= # comma-separated; non-empty = only these
# FEDERATION_BLOCKLIST=
# FEDERATION_MEMBER_PAGE=1000 # members per page when another instance mirrors a space hosted here
# Development only: static peers and plain http.
# FEDERATION_STATIC_PEERS=b.local=http://127.0.0.1:4100
# FEDERATION_ALLOW_INSECURE=true
# REDIS_DB=0 # separate Redis db per instance on one host
# SNOWFLAKE_NODE_ID=1 # unique per instance