mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-06-19 13:21:46 +00:00
fix: resolve dead wiki links across install and config pages
This commit is contained in:
@@ -23,4 +23,4 @@ jobs:
|
|||||||
- name: Publish to GitHub wiki
|
- name: Publish to GitHub wiki
|
||||||
uses: Andrew-Chen-Wang/github-wiki-action@v5
|
uses: Andrew-Chen-Wang/github-wiki-action@v5
|
||||||
with:
|
with:
|
||||||
strategy: init
|
strategy: clone
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ Verified in `server/src/config.ts` (line 107):
|
|||||||
|
|
||||||
## HTTPS / Proxy
|
## 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 |
|
| Variable | Description | Default |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
@@ -62,7 +62,7 @@ These three variables work together behind a TLS-terminating reverse proxy. See
|
|||||||
|
|
||||||
## OIDC / SSO
|
## OIDC / SSO
|
||||||
|
|
||||||
For setup instructions, see [OIDC-SSO].
|
For setup instructions, see [OIDC-SSO](OIDC-SSO).
|
||||||
|
|
||||||
| Variable | Description | Default |
|
| Variable | Description | Default |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
@@ -110,7 +110,7 @@ Both variables must be set together. If either is omitted, the account is create
|
|||||||
|
|
||||||
## MCP
|
## MCP
|
||||||
|
|
||||||
For setup instructions, see [MCP-Overview].
|
For setup instructions, see [MCP-Overview](MCP-Overview).
|
||||||
|
|
||||||
| Variable | Description | Default |
|
| Variable | Description | Default |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
@@ -129,7 +129,7 @@ For setup instructions, see [MCP-Overview].
|
|||||||
|
|
||||||
## Related Pages
|
## Related Pages
|
||||||
|
|
||||||
- [Reverse-Proxy] — HTTPS proxy setup and the `FORCE_HTTPS` / `TRUST_PROXY` / `COOKIE_SECURE` trio
|
- [Reverse-Proxy](Reverse-Proxy) — HTTPS proxy setup and the `FORCE_HTTPS` / `TRUST_PROXY` / `COOKIE_SECURE` trio
|
||||||
- [OIDC-SSO] — complete OIDC configuration guide
|
- [OIDC-SSO](OIDC-SSO) — complete OIDC configuration guide
|
||||||
- [MCP-Overview] — MCP server setup and rate limiting
|
- [MCP-Overview](MCP-Overview) — MCP server setup and rate limiting
|
||||||
- [Encryption-Key-Rotation] — rotating the `ENCRYPTION_KEY` without losing data
|
- [Encryption-Key-Rotation](Encryption-Key-Rotation) — rotating the `ENCRYPTION_KEY` without losing data
|
||||||
|
|||||||
@@ -93,7 +93,7 @@ ALLOWED_ORIGINS=https://trek.example.com
|
|||||||
APP_URL=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
|
## 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`.
|
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
|
## Next Steps
|
||||||
|
|
||||||
- [Environment-Variables] — full variable reference
|
- [Environment-Variables](Environment-Variables) — full variable reference
|
||||||
- [Reverse-Proxy] — HTTPS configuration
|
- [Reverse-Proxy](Reverse-Proxy) — HTTPS configuration
|
||||||
- [Updating] — how to pull a new image
|
- [Updating](Updating) — how to pull a new image
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ Pass additional `-e` flags for timezone and CORS/email link support:
|
|||||||
-e ALLOWED_ORIGINS=https://trek.example.com \
|
-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
|
## Volume Reference
|
||||||
|
|
||||||
@@ -66,11 +66,11 @@ docker logs trek
|
|||||||
|
|
||||||
## Limitations of `docker run`
|
## 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
|
## Next Steps
|
||||||
|
|
||||||
- [Reverse-Proxy] — HTTPS is required for PWA install and the `trek_session` cookie `secure` flag
|
- [Reverse-Proxy](Reverse-Proxy) — HTTPS is required for PWA install and the `trek_session` cookie `secure` flag
|
||||||
- [Install-Docker-Compose] — recommended for production
|
- [Install-Docker-Compose](Install-Docker-Compose) — recommended for production
|
||||||
- [Environment-Variables] — full list of configurable variables
|
- [Environment-Variables](Environment-Variables) — full list of configurable variables
|
||||||
- [Updating] — how to pull a new image without losing data
|
- [Updating](Updating) — how to pull a new image without losing data
|
||||||
|
|||||||
@@ -191,5 +191,5 @@ See the [`charts/README.md`](https://github.com/mauriceboe/TREK/blob/main/charts
|
|||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- [Environment-Variables] — full variable reference
|
- [Environment-Variables](Environment-Variables) — full variable reference
|
||||||
- [Reverse-Proxy] — proxy configuration for non-Kubernetes deployments
|
- [Reverse-Proxy](Reverse-Proxy) — proxy configuration for non-Kubernetes deployments
|
||||||
|
|||||||
@@ -69,5 +69,5 @@ On first boot, TREK automatically creates an admin account. The credentials are
|
|||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- [Environment-Variables] — complete variable reference
|
- [Environment-Variables](Environment-Variables) — complete variable reference
|
||||||
- [Updating] — how to pull a new image on Unraid
|
- [Updating](Updating) — how to pull a new image on Unraid
|
||||||
|
|||||||
+4
-4
@@ -60,7 +60,7 @@ You will be prompted to change the password on first login.
|
|||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- [Install-Docker-Compose] — production setup with security hardening
|
- [Install-Docker-Compose](Install-Docker-Compose) — production setup with security hardening
|
||||||
- [Reverse-Proxy] — put TREK behind HTTPS (required for PWA install and secure cookies)
|
- [Reverse-Proxy](Reverse-Proxy) — put TREK behind HTTPS (required for PWA install and secure cookies)
|
||||||
- [Environment-Variables] — full configuration reference
|
- [Environment-Variables](Environment-Variables) — full configuration reference
|
||||||
- [Admin-Panel-Overview] — explore what the admin panel can do
|
- [Admin-Panel-Overview](Admin-Panel-Overview) — explore what the admin panel can do
|
||||||
|
|||||||
@@ -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://<host>:3000` without a proxy, leave `FORCE_HTTPS` unset and do not set `TRUST_PROXY`.
|
If you access TREK directly on `http://<host>: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
|
## Next Steps
|
||||||
|
|
||||||
- [Environment-Variables] — full variable reference including OIDC
|
- [Environment-Variables](Environment-Variables) — full variable reference including OIDC
|
||||||
- [Install-Docker-Compose] — production compose file with proxy-ready env vars
|
- [Install-Docker-Compose](Install-Docker-Compose) — production compose file with proxy-ready env vars
|
||||||
|
|||||||
+5
-5
@@ -4,7 +4,7 @@ How to update TREK to a newer version without losing data.
|
|||||||
|
|
||||||
## Before You Update
|
## 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)
|
## 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 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
|
## Unraid
|
||||||
|
|
||||||
@@ -50,6 +50,6 @@ In the Unraid Docker tab, click the TREK container and select **Update**. Unraid
|
|||||||
|
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
- [Backups] — schedule automatic backups so you always have a restore point before updates
|
- [Backups](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
|
- [Encryption-Key-Rotation](Encryption-Key-Rotation) — if you need to rotate or migrate the encryption key
|
||||||
- [Install-Docker-Compose] — switch to Compose for easier future updates
|
- [Install-Docker-Compose](Install-Docker-Compose) — switch to Compose for easier future updates
|
||||||
|
|||||||
Reference in New Issue
Block a user