docs(config): eine .env.example statt zweier, die auseinanderliefen

Es gab sie doppelt: schlank im Wurzelverzeichnis (für den Betrieb) und
vollständig unter deploy/ (für die Entwicklung). Gedacht war das als
Arbeitsteilung, geworden ist es Drift. Der produktiven fehlten zwölf
Schlüssel – darunter SESSION_MAX_AGE, STORAGE_PATH und die
HoneyOS-Leiste –, und sie empfahl für OFFICE_WOPI_URL weiterhin
app:8080, also genau den Wert, an dem Collabora den Rahmen verweigert.

Jetzt eine Datei im Wurzelverzeichnis für beides, nach Abschnitten
geordnet, mit einem eigenen Abschnitt für die vier Werte, die nur den
Entwicklungs-Compose betreffen. deploy/.env.example ist weg, die
Verweise in README, TESTING und deploy/docker-compose.yml zeigen auf die
verbliebene Datei.

Gegengeprüft: Jeder Schlüssel, den config.go liest, kommt darin vor
(40 Stück, kein Rest). Ein Container mit dieser Datei als env_file
liefert die erwarteten Werte, auch den maskierten OFFICE_ALIASGROUP.

Dabei selbst in die dokumentierte Falle getappt und wieder heraus:
"OFFICE_PROVIDER=  # collabora | onlyoffice" macht den Kommentar zum
Wert. Der Test aus TESTING.md hat es gefunden.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
marcandClaude Opus 5 committed 2026-09-02 00:59:00 +02:00
1 parent aa8af418f2
commit a7a67da040
5 files changed
+135 -189

No files matched your search

+113 -35
View File
@@ -1,14 +1,21 @@
# Aether – das Nötigste für eine neue Umgebung. cp .env.example .env
# Aether – alle Einstellungen. cp .env.example .env
#
# Diese Datei gilt für beides: den Betrieb mit dem fertigen Abbild
# (docker-compose.example.yml hier im Wurzelverzeichnis) und die Entwicklung
# aus dem Quelltext (deploy/docker-compose.yml, liest deploy/.env).
# Für die Entwicklung: cp .env.example deploy/.env
#
# Zwei Fallen beim Bearbeiten:
# $ im Wert → als $$ schreiben, sonst schneidet Compose ab
# Kommentar hinter einem LEEREN Wert → der Kommentar wird zum Wert
# Erklärungen: README.md, Abschnitt „Einstellungen"
# Alle Schalter: deploy/.env.example
# Erklärungen und Fallstricke: README.md, Abschnitt „Einstellungen"
# ── Pflicht ───────────────────────────────────────────────────────────────────
APP_ENV=production
# Adresse, unter der der Browser die Cloud sieht. Ohne Schrägstrich am Ende.
# ══ Pflicht ═══════════════════════════════════════════════════════════════════
APP_ENV=production # development | production
# Adresse, unter der der BROWSER die Cloud sieht. Ohne Schrägstrich am Ende.
# Ein falscher Wert startet klaglos und fällt erst auf, wenn ein Freigabe-Link
# oder ein OIDC-Rücksprung ins Leere zeigt.
PUBLIC_URL=https://cloud.example.com
# openssl rand -hex 32
SESSION_SECRET=
@@ -28,57 +35,128 @@ DATA_PATH=/pfad/zu/aether-data
APP_UID=1000
APP_GID=1000
# ── Reverse Proxy ─────────────────────────────────────────────────────────────
# Nur diesen Adressen wird X-Forwarded-For/-Proto geglaubt.
TRUSTED_PROXIES=172.18.0.1
# Port auf dem Wirt. Im Container bleibt es 8080.
APP_PORT=8080
# Wer den Port erreichen darf. 127.0.0.1 = nur dieser Rechner (Vorgabe,
# davor gehört der Proxy). 0.0.0.0 = das ganze Netz – dann unverschlüsselt.
APP_BIND=127.0.0.1
# Wie viele frühere Fassungen einer Datei aufgehoben werden. Gilt nur für
# Dateien, an denen „Keep versions" eingeschaltet ist – Standard ist aus.
MAX_VERSIONS_KEPT=5
# ── Erster Start ──────────────────────────────────────────────────────────────
# Legt den Admin an. Danach ADMIN_PASSWORD leeren.
# ══ Erster Start ══════════════════════════════════════════════════════════════
# Legt den Admin an. Danach ADMIN_PASSWORD leeren – das Konto bleibt.
# Auch hier: ein $ muss $$ heißen (siehe DB_PASSWORD).
ADMIN_USERNAME=admin
ADMIN_PASSWORD=
# ── Anmeldung über einen Identitätsanbieter (optional) ───────────────────────
# Leerer OIDC_ISSUER = aus. Sonst die vollständige Adresse des Anbieters,
# z. B. https://id.example.com – nicht seinen Namen. Falsch gesetzt bricht
# der Start ab.
# ══ Reverse Proxy ═════════════════════════════════════════════════════════════
# IPs/CIDRs der Proxys, denen X-Forwarded-For/-Proto geglaubt wird. Steht hier
# das Falsche, sieht die Anwendung überall die IP des Proxys – Rate-Limit und
# Audit-Log werden damit wertlos, ohne dass etwas nach Fehler aussieht.
TRUSTED_PROXIES=172.18.0.1
# Port auf dem Wirt. Im Container bleibt es 8080.
APP_PORT=8080
# Wer den Port erreichen darf. 127.0.0.1 = nur dieser Rechner (Vorgabe, davor
# gehört der Proxy). 0.0.0.0 = das ganze Netz – dann unverschlüsselt.
APP_BIND=127.0.0.1
APP_LISTEN_ADDR=:8080 # im Container; der Proxy leitet hierher
# ══ Sitzung ═══════════════════════════════════════════════════════════════════
# Wie lange eine Anmeldung gilt – **ab der letzten Benutzung**, nicht ab dem
# Anmelden. Wer die Cloud regelmäßig öffnet, bleibt angemeldet; wer sie so
# lange nicht anfasst, meldet sich neu an. 2592000 = 30 Tage.
#
# Kommentar NIE hinter einen leeren Wert setzen: `OIDC_ISSUER= # text` macht
# den Text zum Wert. Hinter einem gefüllten Wert ist er dagegen harmlos.
# Kürzer ist sinnvoll, wenn mehrere Leute denselben Rechner benutzen. Alle
# Sitzungen sofort beenden: SESSION_SECRET wechseln und neu starten.
SESSION_MAX_AGE=2592000 # Sekunden
# ══ Speicher ══════════════════════════════════════════════════════════════════
STORAGE_PATH=/data # im Container
TMP_PATH=/data/tmp
# Frühere Fassungen je Datei. Greift nur bei eingeschaltetem „Keep versions".
MAX_VERSIONS_KEPT=5
# ══ Anmeldung über einen Identitätsanbieter (optional) ════════════════════════
# Leerer OIDC_ISSUER = aus. Sonst die vollständige ADRESSE des Anbieters,
# z. B. https://id.example.com – nicht seinen Namen. Falsch gesetzt bricht der
# Start ab.
OIDC_ISSUER=
OIDC_CLIENT_ID=aether
OIDC_CLIENT_SECRET=
# Muss exakt <PUBLIC_URL>/api/v1/auth/oidc/callback sein.
# Muss EXAKT <PUBLIC_URL>/api/v1/auth/oidc/callback sein.
OIDC_REDIRECT_URL=https://cloud.example.com/api/v1/auth/oidc/callback
# Bestehendes Konto verbinden statt ein zweites anzulegen.
# VOR der ersten Anmeldung setzen – danach ist es zu spät.
# Bestehendes Konto gleichen Namens mit der Identität verbinden, statt ein
# zweites anzulegen. VOR der ersten Anmeldung setzen – danach ist es zu spät.
# Nur bei einem Anbieter, dem die Namen gehören: Bei freier Registrierung wäre
# es die Übernahme fremder Konten.
OIDC_LINK_BY_USERNAME=false
# Beschriftung des Knopfes auf der Anmeldeseite.
OIDC_BUTTON_LABEL=Sign in with SSO / OIDC
# ── Office (optional) ─────────────────────────────────────────────────────────
# ══ Office (optional) ═════════════════════════════════════════════════════════
# Leer = aus, auch wenn ein Office-Container läuft.
# Schnipsel für Collabora, OnlyOffice und Euro-Office: README.md
# Compose-Schnipsel für Collabora, OnlyOffice und Euro-Office: README.md
# collabora | onlyoffice (auch Euro-Office)
OFFICE_PROVIDER=
# Drei Adressen für drei Richtungen – die häufigste Fehlerquelle.
#
# Backend → Office. Port je nach Anbieter:
# Collabora http://office:9980
# OnlyOffice/Euro-Office http://office
OFFICE_URL=http://office:9980
# Browser → Office. Deine Domain oder LAN-IP, nicht der Compose-Name.
OFFICE_PUBLIC_URL=https://office.example.com
# Office → Aether. Weder localhost noch der veröffentlichte Port.
OFFICE_WOPI_URL=http://app:8080
# Gegen SSRF: was das Backend anfragen darf.
# Office → Aether.
#
# **Bei Collabora die öffentliche Adresse der Cloud**, nicht app:8080: Aus
# diesem Wert baut Collabora sein frame-ancestors, und der Browser darf den
# Rahmen sonst nicht zeigen ("Framing … violates 'frame-ancestors …'").
# Collabora holt die Datei dann über deinen Reverse Proxy.
OFFICE_WOPI_URL=https://cloud.example.com
# Gegen SSRF: was das Backend anfragen darf. Der Host aus OFFICE_URL zählt
# immer dazu.
OFFICE_ALLOWED_HOSTS=office
# Nur OnlyOffice/Euro-Office, mind. 32 Zeichen: openssl rand -hex 32
# Muss mit JWT_SECRET des Office-Containers übereinstimmen. Ohne ihn schlägt
# das Wandeln nach PDF fehl (der Server antwortet `{"error":-8}`). Für den
# WOPI-Weg wird er nicht gebraucht, der hat eigene Token.
OFFICE_JWT_SECRET=
OFFICE_INSECURE_TLS=false # nur für Tests mit selbstsigniertem Zertifikat
# ══ Volltextsuche (OCR) ═══════════════════════════════════════════════════════
# Standardmäßig an; fehlen ocrmypdf/tesseract, schaltet es sich selbst ab.
# OCR_ENABLED=false
# OCR_LANGUAGES=deu+eng # weitere brauchen ein apk-Paket im Dockerfile
# OCR_MAX_PAGES=50 # 0 = unbegrenzt; rund 1 Minute je Seite
# OCR_TIMEOUT=10m # Notbremse je Datei
# ══ App-Umschalter (optional) ═════════════════════════════════════════════════
# Andere selbst gehostete Apps im Menü der Seitenleiste.
# EXTERNAL_APPS=InkNote|https://notes.example.com|📝
# ══ HoneyOS-Leiste (optional) ═════════════════════════════════════════════════
# Ursprung, von dem die Leiste geladen wird. Wird an zwei Stellen gebraucht und
# kommt deshalb aus einer Quelle: die CSP erlaubt ihn (script-src +
# connect-src), und die Oberfläche lädt das Skript von dort nach.
# Wirkt beim **Neustart** – kein Neubau nötig.
# Leer = keine Leiste, und die CSP bleibt so eng wie ohne sie.
HONEYBAR_ORIGIN=
# Ausweis, mit dem sich die Leiste die App-Liste holt. Muss zu HONEYOS_APPS_KEY
# drüben passen. Nur nötig, wenn HoneyOS auf einer anderen Site liegt als
# Aether – dann schickt der Browser die HoneyOS-Sitzung nicht mit.
HONEYBAR_KEY=
# ══ Nur für deploy/docker-compose.yml ═════════════════════════════════════════
# Diese vier steuern den Office-Container aus dem Entwicklungs-Compose. Beim
# Betrieb mit eigenem Office-Container stehen sie in dessen Compose-Datei.
#
# Wer seine Dateien in Collabora öffnen darf – derselbe Host wie in
# OFFICE_WOPI_URL, aber als regulärer Ausdruck: Punkte maskieren, Port
# anhängen. Fehlt er, lehnt Collabora ab:
# "No authorized hosts found matching the target host […] in config"
OFFICE_ALIASGROUP=https://cloud\.example\.com:443
OFFICE_SSL=false
OFFICE_SSL_TERMINATION=false # true nur, wenn davor wirklich HTTPS endet
OFFICE_PORT=9980
# ══ Später ════════════════════════════════════════════════════════════════════
# MEILISEARCH_URL=http://meilisearch:7700
# MEILISEARCH_KEY=
# ══ WebDAV ════════════════════════════════════════════════════════════════════
# Läuft unter /dav/, kein Schalter nötig. Der Proxy muss
# PROPFIND/MKCOL/MOVE/COPY durchreichen. Anmeldung ausschließlich mit
# App-Passwörtern, nie mit dem Kontopasswort.