diff --git a/docs/self-hosting/authentication.md b/docs/self-hosting/authentication.md index 1e6574c..65c96a4 100644 --- a/docs/self-hosting/authentication.md +++ b/docs/self-hosting/authentication.md @@ -37,9 +37,9 @@ Server supports these variables: | Variable | Required | Default | What it is | | --- | --- | --- | --- | -| `OIDC_ISSUER` | yes | — | Your provider's issuer URL (e.g. `https://id.example.com`). `OIDC_ISSUER_URL` also works. | -| `OIDC_CLIENT_ID` | yes | — | The client ID from your provider | -| `OIDC_CLIENT_SECRET` | yes | — | The client secret from your provider | +| `OIDC_ISSUER` | yes | - | Your provider's issuer URL (e.g. `https://id.example.com`). `OIDC_ISSUER_URL` also works. | +| `OIDC_CLIENT_ID` | yes | - | The client ID from your provider | +| `OIDC_CLIENT_SECRET` | yes | - | The client secret from your provider | | `OIDC_DISCOVERY_URL` | no | `/.well-known/openid-configuration` | Override only if discovery lives elsewhere | | `OIDC_SCOPES` | no | `openid email profile` | Scopes requested | | `OIDC_PROVIDER_NAME` | no | `OIDC` | Name shown on the "Sign in with..." button | diff --git a/docs/self-hosting/introduction.md b/docs/self-hosting/introduction.md index 043ee0f..7de10c4 100644 --- a/docs/self-hosting/introduction.md +++ b/docs/self-hosting/introduction.md @@ -73,18 +73,18 @@ Playback in action: ## How this guide is organised -1. [Architecture](./architecture) — how the pieces communicate, and where data lives. -2. [Security boundaries](./security) — what is public, internal, and browser-backed. -3. [Prerequisites](./prerequisites) — what you need before you start. -4. [Quick start](./quick-start) — the recommended one-command install. -5. [Manual setup](./docker-compose) — the same thing by hand, step by step. -6. [Configuration](./configuration) — every environment variable, explained. -7. [Importing your data](./importing-data) — bring in subscriptions, playlists, history. -8. [Reverse proxy and HTTPS](./reverse-proxy) — exposing it on your domain. -9. [Maintenance](./maintenance) — updates, backups, and logs. -10. [Beta and main](./beta-and-main) — running the stable and preview channels. -11. [Reporting issues](./reporting-issues) — how to report bugs. -12. [Troubleshooting](./troubleshooting) — common issues and fixes. +1. [Architecture](./architecture) - how the pieces communicate, and where data lives. +2. [Security boundaries](./security) - what is public, internal, and browser-backed. +3. [Prerequisites](./prerequisites) - what you need before you start. +4. [Quick start](./quick-start) - the recommended one-command install. +5. [Manual setup](./docker-compose) - the same thing by hand, step by step. +6. [Configuration](./configuration) - every environment variable, explained. +7. [Importing your data](./importing-data) - bring in subscriptions, playlists, history. +8. [Reverse proxy and HTTPS](./reverse-proxy) - exposing it on your domain. +9. [Maintenance](./maintenance) - updates, backups, and logs. +10. [Beta and main](./beta-and-main) - running the stable and preview channels. +11. [Reporting issues](./reporting-issues) - how to report bugs. +12. [Troubleshooting](./troubleshooting) - common issues and fixes. ::: tip Where do the files come from? The `docker-compose.yml`, `.env.example`, and stack scripts referenced throughout diff --git a/docs/self-hosting/reverse-proxy.md b/docs/self-hosting/reverse-proxy.md index 98d3195..bb7d4ae 100644 --- a/docs/self-hosting/reverse-proxy.md +++ b/docs/self-hosting/reverse-proxy.md @@ -19,7 +19,7 @@ internally, including WebSocket upgrades, SABR media, downloads, and large uploa docker compose up -d ``` -## Option A — Caddy (recommended) +## Option A - Caddy (recommended) Caddy obtains and renews TLS certificates automatically. A two-line `Caddyfile` is enough: @@ -32,7 +32,7 @@ watch.example.com { Caddy forwards WebSockets and the right headers out of the box. That is all you need. -## Option B — nginx +## Option B - nginx ```nginx map $http_upgrade $connection_upgrade {