Files
notes/docs/home-server/deployment.md
T
2026-10-26 12:10:24 +00:00

6.9 KiB

schema_version, id, type, scope, sensitivity, last_reviewed, sources, related, update_triggers, unknowns
schema_version id type scope sensitivity last_reviewed sources related update_triggers unknowns
1 home-server.deployment reference
jupiter
portainer
github
stack-deployment
secrets
private-infrastructure 2026-10-26
kind reference
owner-report AirVPN local downloads and public authenticated qBittorrent UI live; Ultra.cc/rclone retired; encrypted download-state/secret backups not yet added, 2026-10-26
kind repository revision base_revision paths
repository jupiter-stacks working-tree 631e4fdfa4c7122e5eff38e11b070c17ff7a4a2a
stacks/downloads/docker-compose.yml
stacks/downloads/README.md
stacks/sonarr/docker-compose.yml
stacks/radarr/docker-compose.yml
stacks/prowlarr/docker-compose.yml
stacks/traefik/docker-compose.yml
kind repository revision paths
repository jupiter-stacks 026cfa58b601165342b278401183c5fed5a50db2
stacks/homarr/docker-compose.yml
stacks/authentik/docker-compose.yml
stacks/authentik/blueprints/jupiter.yaml
stacks/authentik/.env.example
kind reference
owner-report Portainer GitHub/main/PAT configuration, environment management and manual pull/redeploy workflow, 2026-10-06
kind reference
owner-report No independent credential recovery; operational rules not established, 2026-10-06
kind reference
owner-report Authentik fully deployed with all listed application integrations; Authelia retired; independent recovery custody unchanged, 2026-10-16
kind repository revision paths
repository jupiter-stacks d09df456ad331b8beb9a40615114ea8aae2dced5
stacks/authentik/docker-compose.yml
stacks/authentik/blueprints/jupiter.yaml
stacks/authentik/.env.example
stacks/beszel/docker-compose.yml
stacks/gitea/docker-compose.yml
stacks/immich/docker-compose.yml
stacks/paperless-ngx/docker-compose.yml
home-server.reference
home-server.host
home-server.portainer
home-server.authentication
home-server.backups
home-server.operations
home-server.notes
home-server.downloads
deployment-workflow-change
repository-change
credential-rotation
rollback-policy-change
github-pat-scopes-and-expiration
post-deployment-health-criteria

Deployment

Setting Source / workflow
Stack definitions https://github.com/jayo60013/jupiter-stacks
Git ref main
Repository authentication GitHub PAT configured in Portainer
Environment values/secrets Portainer stack environment settings; AirVPN keys use root-restricted host secret files
Deployment Manually pull/redeploy each affected stack in Portainer
Portainer itself Host shell script, not a managed Compose stack
Compose change -> push main -> manual Portainer pull/redeploy -> running stack

A Git commit is not deployment proof. Installed host Compose version is not proof of Portainer's Compose implementation.

Recovering deployment requires Portainer state or independently retrievable repository credentials and stack environment values. Portainer backups exist; credential/state restoration is untested. Do not put secret values in this site or Git.

No independent recovery arrangement exists for the PAT or stack secrets. Rollback, health-check gates, approval rules and UI-versus-Git drift policy are not established; do not assume permission to deploy, stop or delete services.

Local downloads deployment / recovery

The owner confirms qBittorrent/Gluetun through AirVPN live on 2026-10-26, including both Arr import workflows and the authenticated public UI. Use the linked stack runbook for reconstruction, not the retired seedbox.

Deploy Downloads before its consumers: it creates the external downloads network used by Sonarr, Radarr, Prowlarr and Traefik. Prepare the bind-mounted files under /data/qbittorrent/{config,defaults} and /data/gluetun/secrets first. AirVPN private/preshared keys are root-restricted host files mounted as Compose secrets, not Portainer environment values; the tunnel address, country and reserved peer port are stack environment values.

Arr client credentials, categories, library roots, remote-path mappings and hardlink settings are database/UI state, not reproduced by pulling Compose. The public UI also depends on the persisted qBittorrent Server domains setting, the host-side Authentik blueprint and Traefik's downloads network attachment. Recreate Gluetun and qBittorrent together when replacing their shared namespace.

Full isolation exercises remain outstanding, and the new client state/defaults and VPN secrets are not yet backed up. See Backups.

Notes deployment

The Notes reference covers notes_builder, notes_web, host bind mounts, the signed Gitea webhook and the shared static volume. Deploy Gitea before Notes: Gitea owns the notes_build network that the Notes stack consumes.

Authentik configuration surfaces

The owner reports the Authelia-to-Authentik migration complete. Rebuilding it requires more than pulling Compose:

Surface Required state
Portainer environment Authentik persistent key, database password, eight provider client secrets; matching application secrets/overrides
Host files Copy repository stacks/authentik/blueprints/jupiter.yaml into /data/authentik/blueprints; Git checkout alone does not populate this bind mount
Authentik database Administrator, MFA enrolment, group memberships, applied providers/application policies
Application databases/UIs Beszel, Gitea, Immich and Portainer OIDC setup/account linking
Application Compose Dozzle, Homarr, Paperless and Wardrowbe OIDC settings; five proxy-protected routers use authentik@docker

Homarr uses the same OIDC_HOMARR_SECRET in both stack environments. Its account-linking steps include verified email and duplicate-account cleanup; redeploying Compose alone does not complete linking.

For initial setup, keep AUTHENTIK_PUBLIC_ROUTING=false and access the loopback-published 127.0.0.1:9000 privately, for example through SSH forwarding. Secure the administrator account and prepare MFA, groups and blueprint policy before enabling public routing. Enable routing and establish working OIDC account links before disabling any local application login; Beszel/Paperless flags default to preserving it. The retired Authelia service is not a replacement recovery path.

Redeploying the Authentik stack alone does not copy changed host blueprints or reproduce database-backed application settings. Keep provider/client secrets matched across both sides. Preserve deployed Authentik container names or update the Backrest hooks when recreating containers.

Host apt packages, fstab, RAID assembly, systemd units and Mercury nginx are outside the Compose deployment workflow.