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

Closed
opened 2026-08-03 12:31:01 +02:00 by fable-5 · 0 comments
Collaborator

The self-hosting guide (docs/self-hosting/README.md, issue #88) predates the first release and the M33 features. Bring it to the v0.14.0 state so it can be published and walked through manually as the install path for third parties:

  • TAG guidance still says "until the first public release, test tracks the latest verified build" -- releases exist now; recommend pinning the latest release tag.
  • Backup wording (guide + .env.example) says the nightly archive covers "the uploads/plugins volumes" -- since #303/#306 the restore set also carries the custom fonts and branding volumes (apps/backup/src/data-dirs.ts).
  • Link the update runbook (docs/operations/update-runbook.md) from the Updating section and state the back-up-first step.
  • Add concrete fetch commands for the three reference files and a short pointer to the optional deploy-level authentication switches (OIDC / perimeter auth / AUTH_LOCAL_ENABLED, security.md).
  • .env.example: use a neutral example APP_BASE_URL instead of test.dorfteich.cloud.

Not in scope here, but a prerequisite for publishing: the repository and the container registry currently answer 404/401 anonymously -- third parties can neither fetch the reference files nor pull images until the repo (and its linked packages) are public.

The self-hosting guide (docs/self-hosting/README.md, issue #88) predates the first release and the M33 features. Bring it to the v0.14.0 state so it can be published and walked through manually as the install path for third parties: - TAG guidance still says "until the first public release, `test` tracks the latest verified build" -- releases exist now; recommend pinning the latest release tag. - Backup wording (guide + .env.example) says the nightly archive covers "the uploads/plugins volumes" -- since #303/#306 the restore set also carries the custom fonts and branding volumes (apps/backup/src/data-dirs.ts). - Link the update runbook (docs/operations/update-runbook.md) from the Updating section and state the back-up-first step. - Add concrete fetch commands for the three reference files and a short pointer to the optional deploy-level authentication switches (OIDC / perimeter auth / AUTH_LOCAL_ENABLED, security.md). - .env.example: use a neutral example APP_BASE_URL instead of test.dorfteich.cloud. Not in scope here, but a prerequisite for publishing: the repository and the container registry currently answer 404/401 anonymously -- third parties can neither fetch the reference files nor pull images until the repo (and its linked packages) are public.
Sign in to join this conversation.
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: stwaidele/dorfteich#320
No description provided.