Skip to content

Add Security & Authentication page recommending authentik Proxy Provider - #136

Merged
enoch85 merged 9 commits into
mainfrom
copilot/add-security-authentication-page
Aug 4, 2026
Merged

Add Security & Authentication page recommending authentik Proxy Provider#136
enoch85 merged 9 commits into
mainfrom
copilot/add-security-authentication-page

Conversation

Copilot AI commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Maintainerr has no built-in login. On a private network or over a VPN, which is the most common setup, that is completely fine and needs nothing. But if you want to put it directly on the internet, anyone who can reach it can read your saved credentials (for example GET /api/settings/database/download downloads the whole database).

This PR adds a Security & Authentication page for people in that situation. It is advice for anyone who wants to add a login, not a required setup step. The main suggestion is to put authentik in front of it.

New page: docs/Security.md

  • Who the page is for, and a clear note that local or VPN-only setups need none of it
  • How Maintainerr handles your data: local-only storage, no telemetry, verified outbound TLS, secret-masking in logs, parameterized queries, fail-closed deletes, and a non-root image - plus a plain statement that credentials are stored unencrypted at rest
  • What is exposed if you do put Maintainerr on the internet without a login
  • A Docker Compose example with no published port, so only your reverse proxy can reach it
  • How to set up authentik, in both Proxy mode and Forward auth mode, with working nginx and Traefik examples
  • A note that live logs and task progress need proxy_buffering off under nginx forward auth, or the page hangs (Maintainerr does not send the X-Accel-Buffering: no header)
  • What you do not need to leave open: no incoming webhooks, one shared port for the UI and API, and the Docker health check runs inside the container
  • Other options that also work: Authelia, Tinyauth, Cloudflare Access, basic auth, or VPN-only
  • What the API key in Settings is for (internal calls), and why it does not protect anything from outside
  • A hardening checklist (best practices) and a credential-rotation checklist for instances that were actually exposed

Sidebar (sidebars.js)

Added "security" under Getting Started, after "reverseproxy".

docs/API.md

Pointed the existing warning at the new page.

Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
Copilot AI changed the title [WIP] Add security & authentication page recommending authentik Add Security & Authentication page recommending authentik Proxy Provider Aug 4, 2026
Copilot AI requested a review from enoch85 August 4, 2026 20:02
… setup, API key description, and checklist

Co-authored-by: enoch85 <4511254+enoch85@users.noreply.github.com>
@enoch85
enoch85 marked this pull request as ready for review August 4, 2026 20:19
enoch85 added 6 commits August 4, 2026 20:38
…fig link

- Move proxy_buffer_size/proxy_buffers into the outpost location where the
  auth_request subrequest reads the outpost response; keep only
  proxy_buffering off under location / (proxy_buffers is inert there).
- Rotation checklist: drop non-existent "Streamystats credentials" (it stores
  only a URL and auths with the Jellyfin key), add Sportarr and Tracearr keys.
- Add a Traefik forward-auth (single application) example.
- Link the Security page from Configuration for publish-online users.
Frame the page as advice for people who want to expose Maintainerr or add a
login, not a warning for everyone. Local and VPN-only setups (the common case)
need none of it. Rewrite the prose plainly throughout and downgrade the
Configuration callout from danger to info.
Drop the repeated reassurances in the exposure lead, the port section
bridge, the VPN table row, and the rotation intro. The intro callout is
the single source.
Document what Maintainerr actually does to protect data (local-only, no
telemetry, verified TLS, log secret-masking, parameterized queries, fail-closed
deletes, non-root image) and state plainly that credentials are stored
unencrypted at rest. Add an operator hardening checklist.
State plainly that no auth, no rate limiting, and no encryption at rest are
deliberate trusted-network-appliance choices, with security expected at the
network boundary. Reword the container bullet to factual claims only.
@enoch85
enoch85 merged commit 22efa62 into main Aug 4, 2026
3 checks passed
@enoch85
enoch85 deleted the copilot/add-security-authentication-page branch August 4, 2026 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a Security & Authentication page, recommending authentik in front of Maintainerr

2 participants