Files
oikos/containers/124-authentik.md
dtoro 2762dcbdb8 arch-migration P1: dedicated forward-auth outpost (LXC 106)
- containers/106-auth-outpost.md: new LAN outpost page
- 124-authentik: forward-auth cut over, Authentik stopped (DNS-only now)
- investigation: forward-auth outpost marked RESOLVED

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-01 00:33:26 +02:00

15 KiB
Raw Blame History

124 — authentik

⚠️ MIGRATED 2026-05-31 — Authentik now runs on the VPS (82.165.190.79), not this LXC. This page's Authentik sections describe the legacy instance. The live IdP is the VPS stack (/opt/docker-compose.yml, image 2026.5.2, Postgres + Redis on the auth Docker net). auth.hubris.network resolves to the VPS now. See 2026-05-31 migration investigation. dnsmasq is unaffected — it still runs here. LXC 124 Authentik is kept for a ~2-week dual-run, then decommissioned.

Central Identity Provider for the lab. Also runs the split-horizon dnsmasq — ergo "the SSO and DNS box" (DNS only, post-migration).

At a glance

  • Hostname: authentik
  • IP: 192.168.8.180 (statically configured — the only LXC with a static IP)
  • Privilege: privileged
  • Resources: 2 cores / 4 GiB RAM / 20 GiB rootfs
  • Mounts: none from /mnt/library
  • Public hostname: auth.hubris.networkcaddy (121):9000
  • Container DNS (in /etc/pve/lxc/124.conf): 192.168.8.1 1.1.1.1 (router DNS plus a fallback added 2026-04-21 because router DNS flakes intermittently — Authentik is the resolver itself for the rest of the LAN, but its own LXC uses upstream).

Authentik stack (/opt/authentik/)

Upstream docker-compose.yml + .env. Services: postgresql (16-alpine), server, worker. Authentik 2026.x dropped the Redis dependency.

  • .env mode 600, untracked, holds AUTHENTIK_SECRET_KEY and PG_PASS.
  • AUTHENTIK_TAG=2026.2.2 — pinned. Don't let it drift to :latest. Telemetry / update-check / error-reporting disabled.
  • Ports: 9000 (http), 9443 (https) on the LXC.
  • Embedded outpost lives at /outpost.goauthentik.io/* on the Authentik host — the forward-auth endpoint Caddy points at.
  • Stack is not git-tracked yet. If/when wiring auto-deploy: mirror the mule-image pattern (webhook receiver outside the app repo at /opt/authentik-deploy/). Repo dtoro/authentik-conf is reserved but not created.

Forward-auth pattern (every gated app)

  • One Proxy Provider per app. Authentik enforces a UNIQUE constraint application.provider_id, so one Provider = one Application. "Domain-level" only means they share the cookie domain. Each provider in "Forward auth (domain level)" mode, External host https://auth.hubris.network, Cookie domain hubris.network. First one was hubris-forward-auth (Paperless).
  • Authentication flow: MUST be default-authentication-flow (NOT default-source-authentication — that's for IdP federation; gives FlowNonApplicableException + 404 on the authorize endpoint).
  • Authorization flow: default-provider-authorization-implicit-consent (or explicit).
  • Application Launch URL MUST be the full public URL https://<sub>.hubris.network/ — outpost matches incoming X-Forwarded-Host against it.
  • Each Application MUST have at least one policy/group/user binding — zero bindings = outpost returns 404 on access.
  • Restart Authentik after binding new apps to the outpost:
    pct exec 124 -- docker compose -f /opt/authentik/docker-compose.yml restart server worker
    

Caddy snippet (authentik) lives at the top of /etc/caddy/Caddyfile. Points at http://192.168.8.180:9000 directly (NOT https://auth.hubris.network) to avoid hairpin TLS round-trip stripping X-Forwarded-Host. Must explicitly set header_up X-Forwarded-Host {host} in the forward-auth block. Used by gated sites with import authentik.

Per-app username override pattern (Authentik)

Used when the app's local user ID doesn't match the user's Authentik username (e.g., Nextcloud's admin ≠ Authentik's dtoro).

  1. On the Authentik user: add attribute <app>_uid: <target_local_username> (YAML, Directory → Users → Edit → Attributes).
  2. Customization → Property Mappings → Create → Scope Mapping (not SAML):
    • Name: <app>-uid-override, Scope name: <app>-uid, Expression:
      return {"nc_uid": user.attributes.get("<app>_uid", user.username)}
      
    • Use a custom claim key (e.g. nc_uid), not preferred_username — the default profile scope mapping emits preferred_username and will overwrite yours depending on ordering.
  3. Attach the new scope to the provider (Providers → app → Scopes).
  4. On the app side, point its OIDC UID-mapping setting at the custom claim.

For Nextcloud:

occ user_oidc:provider <name> --mapping-uid=nc_uid
occ user_oidc:provider <name> --scope="openid profile email <app>-uid"

Bypass forward-auth for API paths (mobile apps)

If the app has its own token-based API auth and a mobile client, API paths must bypass forward-auth — mobile apps can't follow the browser login redirect. Pattern in the Caddyfile site block:

paperless.hubris.network {
    tls { dns ionos {env.IONOS_AUTH_API_TOKEN} }
    @api path /api/*
    handle @api {
        reverse_proxy 192.168.8.130:8000
    }
    handle {
        import authentik
        reverse_proxy 192.168.8.130:8000
    }
}

API paths to bypass per app:

Backend trust of Authentik headers (skip the app's own login after SSO)

  • Paperless: PAPERLESS_ENABLE_HTTP_REMOTE_USER=true and PAPERLESS_HTTP_REMOTE_USER_HEADER_NAME=HTTP_X_AUTHENTIK_USERNAME in /opt/paperless/paperless.conf. Restart paperless-webserver paperless-task-queue paperless-scheduler paperless-consumer. Django auto-creates matching users on first SSO login; promote to superuser via existing admin UI.
  • Apps without header-auth support: users log in twice (SSO + app login). Acceptable but degraded UX.

Per-app integration map

App Type Notes
Paperless (103) Forward-auth + REMOTE_USER /api/* bypass
Nextcloud (114) Native OIDC nc_uid override; local dnsmasq required (Guzzle bypasses /etc/hosts)
mulita (120) Native OIDC extra_hosts override in compose
Booklore (105) Native OIDC Redirect URI /oauth2-callback; extra_hosts
Portainer (105) Native OAuth2 portainer_uid custom claim; --trusted-origins flag
WriteFreely (105) Native OIDC [oauth.generic] block; extra_hosts
qBittorrent (122) Forward-auth via IP whitelist Reverse-proxy support enabled in qBit
Artifacto (105) Forward-auth + gateway-secret auto-login Public /p/* paths bypass
Home Assistant VM (108) HACS christiaangoossens/hass-oidc-auth automatic_user_linking: true, default_redirect: true. Supervisor DNS via ha dns options.

Netbird IdP integration — LANDED 2026-05-21

The combined netbirdio/netbird-server image was replaced with the canonical vanilla stack (mgmt + signal + relay + dashboard 0.71.3) on the VPS so external OIDC actually works. Authentik is now the netbird dashboard's IdP. Full migration context in mesh.md changelog.

Active provider & app:

  • Provider NetBird (OAuth2/OpenID), Client type: Public (PKCE-only — Confidential would break the dashboard SPA's token exchange).
  • Client ID: netbird-dashboard. Client Secret is in /opt/management.json PKCEAuthorizationFlow.ProviderConfig.ClientSecret on the VPS (TODO: sops-encrypt as secrets/netbird-authentik-oidc.yaml).
  • Application NetBird, slug netbird, launch URL https://netbird.hubris.network/.
  • Redirect URIs: https://netbird.hubris.network/peers, /nb-auth, /nb-silent-auth, plus https://netbird.hubris.network/ for post-logout.
  • Scopes enabled on the provider: openid, profile, email.
  • Discovery URL: https://auth.hubris.network/application/o/netbird/.well-known/openid-configuration — netbird mgmt fetches this on startup; logs loaded OIDC configuration from the provided IDP configuration endpoint.

Login flow: netbird dashboard PKCE → Authentik authorize → redirect back to /nb-auth → JS token exchange at Authentik's /token endpoint → mgmt validates the bearer against Authentik's JWKS.

First-time owner promotion gotcha (write-down for future operators):

When a new Authentik user logs in for the first time against an account that already has peers, netbird mgmt adds them as role=user, blocked=1, pending_approval=1. The OLD account-owner (the one in store.db from before the IdP swap) can't be reached anymore, so there's no admin to approve. Recovery is a direct sqlite update on mgmt_data:

docker stop netbird-mgmt
sqlite3 /var/lib/docker/volumes/opt_mgmt_data/_data/store.db \
  "UPDATE users SET role='owner', blocked=0, pending_approval=0 WHERE id='<new authentik sub>';"
docker start netbird-mgmt

The Authentik sub-claim is the value of the id column on the newly-created user row (look for role=user, blocked=1, pending_approval=1).

Device Code grant — configured (2026-05-21)

netbird up (interactive, without --setup-key) works against Authentik. The recipe:

  1. Flow default-device-code-flow (designation: Stage Configuration) with 4 stage bindings in order:
    • 10: default-authentication-identification (username/email lookup)
    • 20: default-authentication-password (password validation)
    • 30: default-authentication-login (attach authenticated user to session)
    • 40: default-provider-authorization-explicit-consent's Consent Stage (default-provider-authorization-consent) — the "Authorize NetBird?" approval
  2. Brand (System → Brands → edit the brand serving auth.hubris.network): set Device code flow field to default-device-code-flow.
  3. No provider-side change is required — Authentik 2026.x routes /device via the brand's device-code flow, not via the OAuth2/OpenID provider's Authorization flow.

Why this matters for the lab: Authentik 2026.x doesn't ship a default device-code flow. Without this configuration, the URL https://auth.hubris.network/device renders blank (the /device endpoint is unrouted), so netbird up device-codes expire without consent → only --setup-key works for onboarding. The above unblocks interactive onboarding.

Verifying from a browser tab: visit https://auth.hubris.network/device. You should see a form with one Code input + Continue button. Then netbird up (no setup-key) end-to-end:

  • CLI prints verification_uri_complete: https://auth.hubris.network/device?code=...
  • Open URL → identification (skipped if logged in) → password (re-auth check) → consent ("Authorize NetBird?") → Continue
  • CLI completes registration with Connected

Self-service onboarding (not yet — future-session)

auth.hubris.network is only reachable from inside the netbird mesh (split-horizon DNS). A brand-new client that isn't on the mesh yet can't OIDC-login → setup-key is the only path. To enable self-service onboarding via Authentik from the public internet:

  • Add a Traefik route on the VPS for auth.hubris.network that forwards via the netbird-routed 192.168.8.0/24 to LXC 124.
  • DNS already points auth.hubris.network → 82.165.190.79 (IONOS wildcard).

Tracked in homelab memory as a queued follow-up.

Old pre-work to remove

The previous Provider for Netbird + netbird app from 2026-04-22 (client ID xZwVTFCsxWdBM3uIGS15wAAcVvsJiTtWdxVCEela, service account netbird-service) is now obsolete — replaced by netbird-dashboard above. Safe to delete from Authentik admin UI; nothing currently uses the old client ID. The service account + API token can also be removed unless we wire IdpManagerConfig in mgmt later (currently ManagerType: none).

DNS responsibility

dnsmasq runs alongside Authentik on this LXC, listening on 192.168.8.180:53 + 127.0.0.1:53, serving every *.hubris.network subdomain → 192.168.8.175. There is no wildcard — every site needs an explicit address= entry. See DNS split-horizon.

Changelog

2026-06-01 — forward-auth outpost cut over to LXC 106; Authentik stopped on 124

The embedded outpost that Caddy called at 192.168.8.180:9000 was replaced by a dedicated LAN outpost on 106 — auth-outpost (192.168.8.6:9000), connected to the VPS core. Authentik (server/worker/postgresql) was stopped on this LXC; forward-auth apps verified working without it. dnsmasq still runs here — 124 stays up as a DNS-only box until DNS is relocated (architecture-migration Phase 2). Once DNS moves, 124 can be fully retired.

2026-05-31 — Authentik migrated to the VPS (this LXC is now legacy)

Resolved a bootstrap deadlock — netbird-mgmt on the VPS couldn't start because it fetches Authentik's OIDC discovery on boot, but Authentik was mesh-only and the mesh was down because mgmt was down. Moved the whole Authentik stack onto the VPS (image 2026.2.22026.5.2, now with Redis, on a dedicated auth Docker network), migrated the full Postgres DB (users/apps/passwords/groups), and added depends_on: service_healthy so the deadlock can't recur. dnsmasq stays on this LXC; its auth.hubris.network entry now points to 82.165.190.79. Along the way: switched redirect URIs to STRICT, ran ak apply_blueprints to fix old return-syntax expression policies, and deleted dead WebAuthn devices. Full writeup: investigation.

2026-05-21 — Netbird IdP swap landed (Phase 6 done)

VPS migrated from combined netbird-server to vanilla mgmt+signal+relay+dashboard 0.71.3 (see mesh.md), enabling Authentik as the dashboard IdP via PKCE. New Provider/App = netbird-dashboard, replacing the deferred pre-work. Device Code Stage still missing — interactive netbird up fails consent; setup-keys are the workaround until that's added.

2026-04-28 — wiki entry created

Initial documentation.

2026-04-22 — Phase 6 (Netbird IdP swap) deferred

Combined netbird-server image couldn't take an external IdP. Pre-work in Authentik kept for later (now superseded by 2026-05-21 above). Netbird mgmt host instead joined its own mesh as a peer (100.122.165.149) for split-horizon DNS access.

2026-04-22 — Artifacto, mulita, WriteFreely, Portainer wired

Native OIDC for mulita / WriteFreely / Portainer; gateway-secret auto-login pattern for Artifacto.

2026-04-21 — deployed; Phases 15 complete

LXC 124 provisioned, stack at /opt/authentik, public URL via Caddy, Paperless + Booklore + Nextcloud + Home Assistant wired. dnsmasq for split-horizon DNS lives on the same LXC.