From 314486325e6c6deba00b359f08ed44efb398c632 Mon Sep 17 00:00:00 2001 From: jubnl Date: Wed, 22 Apr 2026 19:21:53 +0200 Subject: [PATCH] fix: resolve dead wiki links across install and config pages --- .github/workflows/wiki.yml | 2 +- wiki/Environment-Variables.md | 14 +++++++------- wiki/Install-Docker-Compose.md | 10 +++++----- wiki/Install-Docker.md | 12 ++++++------ wiki/Install-Helm.md | 4 ++-- wiki/Install-Unraid.md | 4 ++-- wiki/Quick-Start.md | 8 ++++---- wiki/Reverse-Proxy.md | 6 +++--- wiki/Updating.md | 10 +++++----- 9 files changed, 35 insertions(+), 35 deletions(-) diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml index 440b6b7a..3526e38e 100644 --- a/.github/workflows/wiki.yml +++ b/.github/workflows/wiki.yml @@ -23,4 +23,4 @@ jobs: - name: Publish to GitHub wiki uses: Andrew-Chen-Wang/github-wiki-action@v5 with: - strategy: init + strategy: clone diff --git a/wiki/Environment-Variables.md b/wiki/Environment-Variables.md index 9f1e658f..3156801b 100644 --- a/wiki/Environment-Variables.md +++ b/wiki/Environment-Variables.md @@ -48,7 +48,7 @@ Verified in `server/src/config.ts` (line 107): ## HTTPS / Proxy -These three variables work together behind a TLS-terminating reverse proxy. See [Reverse-Proxy] for the full explanation. +These three variables work together behind a TLS-terminating reverse proxy. See [Reverse-Proxy](Reverse-Proxy) for the full explanation. | Variable | Description | Default | |---|---|---| @@ -62,7 +62,7 @@ These three variables work together behind a TLS-terminating reverse proxy. See ## OIDC / SSO -For setup instructions, see [OIDC-SSO]. +For setup instructions, see [OIDC-SSO](OIDC-SSO). | Variable | Description | Default | |---|---|---| @@ -110,7 +110,7 @@ Both variables must be set together. If either is omitted, the account is create ## MCP -For setup instructions, see [MCP-Overview]. +For setup instructions, see [MCP-Overview](MCP-Overview). | Variable | Description | Default | |---|---|---| @@ -129,7 +129,7 @@ For setup instructions, see [MCP-Overview]. ## Related Pages -- [Reverse-Proxy] — HTTPS proxy setup and the `FORCE_HTTPS` / `TRUST_PROXY` / `COOKIE_SECURE` trio -- [OIDC-SSO] — complete OIDC configuration guide -- [MCP-Overview] — MCP server setup and rate limiting -- [Encryption-Key-Rotation] — rotating the `ENCRYPTION_KEY` without losing data +- [Reverse-Proxy](Reverse-Proxy) — HTTPS proxy setup and the `FORCE_HTTPS` / `TRUST_PROXY` / `COOKIE_SECURE` trio +- [OIDC-SSO](OIDC-SSO) — complete OIDC configuration guide +- [MCP-Overview](MCP-Overview) — MCP server setup and rate limiting +- [Encryption-Key-Rotation](Encryption-Key-Rotation) — rotating the `ENCRYPTION_KEY` without losing data diff --git a/wiki/Install-Docker-Compose.md b/wiki/Install-Docker-Compose.md index f9344617..16b72821 100644 --- a/wiki/Install-Docker-Compose.md +++ b/wiki/Install-Docker-Compose.md @@ -93,7 +93,7 @@ ALLOWED_ORIGINS=https://trek.example.com APP_URL=https://trek.example.com ``` -Uncomment and fill in the OIDC, initial setup, or MCP variables as needed. For a full description of every variable, see [Environment-Variables]. +Uncomment and fill in the OIDC, initial setup, or MCP variables as needed. For a full description of every variable, see [Environment-Variables](Environment-Variables). ## Start TREK @@ -111,10 +111,10 @@ docker compose logs -f This compose file is designed for deployments where a reverse proxy (nginx, Caddy, Traefik) terminates TLS in front of TREK. To enable HTTPS redirects and secure cookies, uncomment `FORCE_HTTPS=true` and `TRUST_PROXY=1`. -See [Reverse-Proxy] for complete proxy configuration examples. +See [Reverse-Proxy](Reverse-Proxy) for complete proxy configuration examples. ## Next Steps -- [Environment-Variables] — full variable reference -- [Reverse-Proxy] — HTTPS configuration -- [Updating] — how to pull a new image +- [Environment-Variables](Environment-Variables) — full variable reference +- [Reverse-Proxy](Reverse-Proxy) — HTTPS configuration +- [Updating](Updating) — how to pull a new image diff --git a/wiki/Install-Docker.md b/wiki/Install-Docker.md index 17dd3983..62ddbf8d 100644 --- a/wiki/Install-Docker.md +++ b/wiki/Install-Docker.md @@ -32,7 +32,7 @@ Pass additional `-e` flags for timezone and CORS/email link support: -e ALLOWED_ORIGINS=https://trek.example.com \ ``` -See [Environment-Variables] for the full list. +See [Environment-Variables](Environment-Variables) for the full list. ## Volume Reference @@ -66,11 +66,11 @@ docker logs trek ## Limitations of `docker run` -A bare `docker run` command has no built-in secret management and is harder to reproduce after a system reboot. For production, see [Install-Docker-Compose], which adds security hardening (`read_only`, `cap_drop`, `cap_add`, `no-new-privileges`, `tmpfs`) and makes it easy to manage environment variables through a `.env` file. +A bare `docker run` command has no built-in secret management and is harder to reproduce after a system reboot. For production, see [Install-Docker-Compose](Install-Docker-Compose), which adds security hardening (`read_only`, `cap_drop`, `cap_add`, `no-new-privileges`, `tmpfs`) and makes it easy to manage environment variables through a `.env` file. ## Next Steps -- [Reverse-Proxy] — HTTPS is required for PWA install and the `trek_session` cookie `secure` flag -- [Install-Docker-Compose] — recommended for production -- [Environment-Variables] — full list of configurable variables -- [Updating] — how to pull a new image without losing data +- [Reverse-Proxy](Reverse-Proxy) — HTTPS is required for PWA install and the `trek_session` cookie `secure` flag +- [Install-Docker-Compose](Install-Docker-Compose) — recommended for production +- [Environment-Variables](Environment-Variables) — full list of configurable variables +- [Updating](Updating) — how to pull a new image without losing data diff --git a/wiki/Install-Helm.md b/wiki/Install-Helm.md index d0fca6db..1a320a09 100644 --- a/wiki/Install-Helm.md +++ b/wiki/Install-Helm.md @@ -191,5 +191,5 @@ See the [`charts/README.md`](https://github.com/mauriceboe/TREK/blob/main/charts ## Next Steps -- [Environment-Variables] — full variable reference -- [Reverse-Proxy] — proxy configuration for non-Kubernetes deployments +- [Environment-Variables](Environment-Variables) — full variable reference +- [Reverse-Proxy](Reverse-Proxy) — proxy configuration for non-Kubernetes deployments diff --git a/wiki/Install-Unraid.md b/wiki/Install-Unraid.md index 83e1706f..0edf49d6 100644 --- a/wiki/Install-Unraid.md +++ b/wiki/Install-Unraid.md @@ -69,5 +69,5 @@ On first boot, TREK automatically creates an admin account. The credentials are ## Next Steps -- [Environment-Variables] — complete variable reference -- [Updating] — how to pull a new image on Unraid +- [Environment-Variables](Environment-Variables) — complete variable reference +- [Updating](Updating) — how to pull a new image on Unraid diff --git a/wiki/Quick-Start.md b/wiki/Quick-Start.md index 786af51d..17e7b970 100644 --- a/wiki/Quick-Start.md +++ b/wiki/Quick-Start.md @@ -60,7 +60,7 @@ You will be prompted to change the password on first login. ## Next Steps -- [Install-Docker-Compose] — production setup with security hardening -- [Reverse-Proxy] — put TREK behind HTTPS (required for PWA install and secure cookies) -- [Environment-Variables] — full configuration reference -- [Admin-Panel-Overview] — explore what the admin panel can do +- [Install-Docker-Compose](Install-Docker-Compose) — production setup with security hardening +- [Reverse-Proxy](Reverse-Proxy) — put TREK behind HTTPS (required for PWA install and secure cookies) +- [Environment-Variables](Environment-Variables) — full configuration reference +- [Admin-Panel-Overview](Admin-Panel-Overview) — explore what the admin panel can do diff --git a/wiki/Reverse-Proxy.md b/wiki/Reverse-Proxy.md index a9993960..526472ee 100644 --- a/wiki/Reverse-Proxy.md +++ b/wiki/Reverse-Proxy.md @@ -98,9 +98,9 @@ Four variables control how TREK behaves behind a proxy. They work as a group: If you access TREK directly on `http://:3000` without a proxy, leave `FORCE_HTTPS` unset and do not set `TRUST_PROXY`. -See [Environment-Variables] for full documentation of these and all other variables. +See [Environment-Variables](Environment-Variables) for full documentation of these and all other variables. ## Next Steps -- [Environment-Variables] — full variable reference including OIDC -- [Install-Docker-Compose] — production compose file with proxy-ready env vars +- [Environment-Variables](Environment-Variables) — full variable reference including OIDC +- [Install-Docker-Compose](Install-Docker-Compose) — production compose file with proxy-ready env vars diff --git a/wiki/Updating.md b/wiki/Updating.md index 46e45ba9..2e63c91d 100644 --- a/wiki/Updating.md +++ b/wiki/Updating.md @@ -4,7 +4,7 @@ How to update TREK to a newer version without losing data. ## Before You Update -Back up your data first. Go to Admin Panel → Backups and create a manual backup, or copy your `./data` and `./uploads` directories to a safe location. See [Backups] for details. +Back up your data first. Go to Admin Panel → Backups and create a manual backup, or copy your `./data` and `./uploads` directories to a safe location. See [Backups](Backups) for details. ## Docker Compose (Recommended) @@ -42,7 +42,7 @@ TREK runs any pending database migrations automatically at startup. No manual mi If you are upgrading from a version that predates the dedicated `ENCRYPTION_KEY` (i.e. you have no `ENCRYPTION_KEY` environment variable set), TREK automatically falls back to `./data/.jwt_secret` on startup and immediately promotes it to `./data/.encryption_key`. No manual steps are required — the transition is handled at first boot after the upgrade. -If you want to rotate to a new key at any point (not required for a normal update), see [Encryption-Key-Rotation] for the full procedure. +If you want to rotate to a new key at any point (not required for a normal update), see [Encryption-Key-Rotation](Encryption-Key-Rotation) for the full procedure. ## Unraid @@ -50,6 +50,6 @@ In the Unraid Docker tab, click the TREK container and select **Update**. Unraid ## Next Steps -- [Backups] — schedule automatic backups so you always have a restore point before updates -- [Encryption-Key-Rotation] — if you need to rotate or migrate the encryption key -- [Install-Docker-Compose] — switch to Compose for easier future updates +- [Backups](Backups) — schedule automatic backups so you always have a restore point before updates +- [Encryption-Key-Rotation](Encryption-Key-Rotation) — if you need to rotate or migrate the encryption key +- [Install-Docker-Compose](Install-Docker-Compose) — switch to Compose for easier future updates