Refresh the self-hosting guide for the first public release (#320) #321

fable-5 · 2026-08-03T12:34:48+02:00

fable-5 commented

2026-08-03 12:34:48 +02:00

Closes #320.

Doc + reference-config refresh so the self-hosting guide can be published and walked through as the install path for third parties:

TAG guidance: pin release tags (v0.14.0); test/int are stage tags.
Concrete curl commands for the three reference files.
Backup wording names all four data volumes of the restore set (uploads, plugins, custom fonts, branding -- apps/backup/src/data-dirs.ts).
Updating section: back-up-first step + link to docs/operations/update-runbook.md.
NEW: the external-auth variables (OIDC_, AUTH_LOCAL_ENABLED, AUTH_PROXY_) are now passed through the reference compose and documented in .env.example. They were documented in security.md and the hardening guide but never reached the api container from .env. Empty = unset (loadApiEnv), so the block is inert until configured; no new switches, both hardening-guide rows exist already.
Neutral APP_BASE_URL example (wiki.example.com instead of test.dorfteich.cloud).

Verified: docker compose config --quiet green on the reference compose; full lint (ESLint + Prettier) and typecheck green.

Note for deploy: CD does not sync stage composes -- after merge the added env pass-through lines should be mirrored into the stage composes on ONE at the next opportunity (inert while the variables are unset).

Publishing prerequisite (out of scope, see #320): repo and registry currently answer 404/401 anonymously.

🤖 Generated with Claude Code

https://claude.ai/code/session_017aviRTgWCcAHUh1SBoxf6P

Closes #320. Doc + reference-config refresh so the self-hosting guide can be published and walked through as the install path for third parties: - TAG guidance: pin release tags (v0.14.0); `test`/`int` are stage tags. - Concrete curl commands for the three reference files. - Backup wording names all four data volumes of the restore set (uploads, plugins, custom fonts, branding -- apps/backup/src/data-dirs.ts). - Updating section: back-up-first step + link to docs/operations/update-runbook.md. - NEW: the external-auth variables (OIDC_*, AUTH_LOCAL_ENABLED, AUTH_PROXY_*) are now passed through the reference compose and documented in .env.example. They were documented in security.md and the hardening guide but never reached the api container from .env. Empty = unset (loadApiEnv), so the block is inert until configured; no new switches, both hardening-guide rows exist already. - Neutral APP_BASE_URL example (wiki.example.com instead of test.dorfteich.cloud). Verified: `docker compose config --quiet` green on the reference compose; full lint (ESLint + Prettier) and typecheck green. Note for deploy: CD does not sync stage composes -- after merge the added env pass-through lines should be mirrored into the stage composes on ONE at the next opportunity (inert while the variables are unset). Publishing prerequisite (out of scope, see #320): repo and registry currently answer 404/401 anonymously. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_017aviRTgWCcAHUh1SBoxf6P

fable-5 added 1 commit 2026-08-03 12:34:48 +02:00

Refresh the self-hosting guide for the first public release (#320 )

CI / Lint, typecheck, test (pull_request) Successful in 6m43s

Details

CI / Build container images (pull_request) Successful in 1m13s

Details

CI / Auth e2e pack (pull_request) Successful in 8m52s

Details

CI / Import/export fidelity gate (pull_request) Successful in 58s

Details

CD / Build and push images (push) Successful in 16s

Details

CD / Deploy to Test (push) Successful in 17s

Details

CD / Smoke tests against Test (push) Successful in 1m25s

Details

CD / Promote to Int (push) Successful in 13s

Details

CI / Lint, typecheck, test (push) Successful in 6m54s

Details

CI / Build container images (push) Has been skipped

Details

CI / Auth e2e pack (push) Successful in 8m42s

Details

CI / Import/export fidelity gate (push) Successful in 58s

Details

d2be1116bc

- TAG guidance points at pinned release tags (e.g. v0.14.0) instead of
  the pre-release `test` tag; concrete curl commands fetch the three
  reference files.
- Backup wording (guide + .env.example) names all four data volumes in
  the restore set (uploads, plugins, custom fonts, branding).
- Updating section states the back-up-first step and links the update
  runbook.
- Pass the external-authentication variables (OIDC_*, AUTH_LOCAL_ENABLED,
  AUTH_PROXY_*) through the reference compose and document them in
  .env.example: they were documented in security.md but unreachable from
  .env. Empty values count as unset (app-config.service.ts), so the block
  is inert until configured.
- New guide section "External authentication (optional)"; neutral
  APP_BASE_URL example.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017aviRTgWCcAHUh1SBoxf6P

fable-5 merged commit d2be1116bc into main

2026-08-03 13:01:03 +02:00

Sign in to join this conversation.

No reviewers