Claus Lohmar
f58d33aee1
Document the D-043 deployment: the browser -> Zoraxy (10.1.0.10, TLS) -> app (0.0.0.0:8080, http) topology, the config.yaml, the Zoraxy ProxyHost headers (X-Forwarded-For + X-Forwarded-Proto), the firewall rule, the tunnel-only bootstrap, systemd, and the misconfig warnings. - config.example.yaml: trusted_proxies: ["10.1.0.10"] with the silent-failure and firewall caveats. - deploy/myday.service: the systemd unit (Type=simple, Restart=on-failure, User/WorkingDirectory/ExecStart, After=network-online.target). - docs/deploy-zoraxy.md: the full walkthrough. - README.md: the Deployment section points at the guide. Docs/deploy only — no code change.
70 lines
3.9 KiB
YAML
70 lines
3.9 KiB
YAML
# MyDay — example configuration.
|
|
#
|
|
# Copy to `config.yaml` (gitignored — NEVER committed, D-010) and fill in.
|
|
# Settings live HERE, not in the database (D-035).
|
|
|
|
# ── setup & recovery ─────────────────────────────────────────────────────────
|
|
setup: true # D-015 / D-026 — while true the app serves ONLY /setup.
|
|
# D-025 (revised): the wizard is reachable ONLY over the
|
|
# direct SSH tunnel — a request relayed by a proxy (a
|
|
# loopback peer carrying X-Forwarded-For) is 404'd.
|
|
admin_recovery: false # D-033 — set true + restart to email user 1 an enrolment link
|
|
|
|
# ── server ───────────────────────────────────────────────────────────────────
|
|
# D-043 (deployment behind Zoraxy): TLS terminates at the PROXY, so the app
|
|
# speaks plain HTTP and binds 0.0.0.0:8080. FIREWALL :8080 TO ZORAXY ONLY —
|
|
# anything else that can reach the port bypasses the proxy and its TLS.
|
|
server:
|
|
listen: "0.0.0.0:8080" # D-043 — any bind is allowed (no setup-mode refusal)
|
|
base_url: "https://myday.sechpoint.app" # the PUBLIC origin: invite / recovery links
|
|
# Zoraxy's address — the ONLY peer whose forwarding headers are honoured (A6/D-043).
|
|
# Zoraxy MUST set `X-Forwarded-For` (the setup gate's "no XFF" test relies on it)
|
|
# and `X-Forwarded-Proto`. A WRONG VALUE HERE FAILS SILENTLY: `X-Forwarded-Proto`
|
|
# is then ignored, the session cookie loses `Secure` (and with it the `__Host-`
|
|
# prefix and HSTS), and the audit log records the proxy — not the user — as the
|
|
# client. FIREWALL :8080 TO 10.1.0.10 ONLY: any other host that can reach the
|
|
# port bypasses Zoraxy and its TLS, and is served plain HTTP directly.
|
|
trusted_proxies:
|
|
- "10.1.0.10" # Zoraxy (TLS terminates here)
|
|
|
|
# ── app ──────────────────────────────────────────────────────────────────────
|
|
app:
|
|
locale: "en-GB"
|
|
timezone: "Europe/London"
|
|
|
|
# ── enrollment (A1) ──────────────────────────────────────────────────────────
|
|
# The bounded invite window: outside it, /{GUID} enrollment is refused.
|
|
enrollment:
|
|
window: "72h"
|
|
|
|
# ── database (D-012) ─────────────────────────────────────────────────────────
|
|
database:
|
|
path: "./data/myday.db" # SQLite · WAL · foreign keys ON · one instance only
|
|
|
|
# ── secrets — generate strong random values; never commit (D-010) ────────────
|
|
# A placeholder is replaced with a strong value: at startup in setup mode
|
|
# (so the wizard's ceremony is never signed with a known key) and again by the
|
|
# wizard's `finish`. A restart adopts what `/setup` persisted.
|
|
secrets:
|
|
cookie_secret: "CHANGE_ME_32_BYTES_RANDOM"
|
|
csrf_key: "CHANGE_ME_32_BYTES_RANDOM"
|
|
totp_encryption_key: "CHANGE_ME_32_BYTES_RANDOM" # A9 — TOTP secrets are encrypted at rest
|
|
|
|
# ── mail — invites & recovery ────────────────────────────────────────────────
|
|
mail:
|
|
host: "smtp.example.com"
|
|
port: 587
|
|
username: ""
|
|
password: "CHANGE_ME"
|
|
from: "myday@example.com"
|
|
|
|
# ── modules (D-038) — required modules cannot be disabled ────────────────────
|
|
modules:
|
|
org: true
|
|
time: true
|
|
absence: true
|
|
requests: true # required
|
|
hr: true
|
|
expense: false
|
|
reports: true
|
|
integrations: false
|