jubnl
6c87bf2f7a
The /help pages fetched their markdown from raw.githubusercontent.com at
runtime, so a self-hosted install was served docs from main rather than the
version it was actually running, and help was unusable without network access.
The wiki/ directory was in the repo the whole time; the bundled-snapshot
fallback the code reached for was gitignored and never populated by any build
step, so it was dead code.
Read wiki/ straight from disk instead. server/{src,dist}/services both sit
three levels under the repo root, so a single __dirname anchor resolves in dev,
a built source install, vitest and Docker with no copy or build step. GitHub is
kept strictly as a fallback for when the directory cannot be resolved, decided
once at load by probing for _Sidebar.md: a page missing from a present wiki is
a genuine 404, since falling back per-file would reintroduce the version skew
this removes.
Ship wiki/ in the image: .dockerignore excluded it outright, so the COPY alone
would have produced an image with no wiki, and the GitHub fallback would have
masked that at runtime. Add a real path-containment check on assets now that
the path becomes a filesystem read rather than a URL, and document
TREK_WIKI_DIR as an off-by-default escape hatch across the deployment configs.
3.2 KiB
Install: Unraid
Install TREK on Unraid via Community Applications or a direct template import.
Prerequisite
Docker must be enabled in Unraid (Settings → Docker → Enable Docker: Yes).
Install via Community Applications
- Open the Apps tab in Unraid.
- Search for TREK.
- Click Install on the TREK result.
If the app does not appear, you can install directly from the template URL. In Docker → Add Container, paste the template URL:
https://raw.githubusercontent.com/mauriceboe/TREK/main/unraid-template.xml
Template Fields
The Unraid template exposes the following fields in the container UI:
Ports & Paths
| Field | Container path | Default host value |
|---|---|---|
| Web UI Port | 3000/tcp |
3000 |
| Data | /app/data |
/mnt/user/appdata/trek/data |
| Uploads | /app/uploads |
/mnt/user/appdata/trek/uploads |
Core Variables (always visible)
| Variable | Default | Notes |
|---|---|---|
ENCRYPTION_KEY |
(empty) | Set on first install. Generate with openssl rand -hex 32 in the Unraid terminal. |
TZ |
UTC |
Timezone for logs, reminders, and scheduled tasks (e.g. Europe/Berlin) |
ALLOWED_ORIGINS |
(empty) | Comma-separated origins for CORS and email notification links, e.g. https://trek.example.com |
APP_URL |
(empty) | Public base URL; required when OIDC is enabled (must match the redirect URI registered with your IdP) |
ADMIN_EMAIL |
(empty) | Email for the first admin account (first-boot only; no effect once any user exists). Must be set together with ADMIN_PASSWORD. |
ADMIN_PASSWORD |
(empty) | Password for the first admin account (first-boot only). Must be set together with ADMIN_EMAIL. If either is omitted, TREK creates the account with email admin@trek.local and a random password printed to the container log. |
Advanced Variables
Additional variables (PORT, NODE_ENV, LOG_LEVEL, TREK_WIKI_DIR, DEFAULT_LANGUAGE, FORCE_HTTPS, TRUST_PROXY, COOKIE_SECURE, ALLOW_INTERNAL_NETWORK, SESSION_DURATION, SESSION_DURATION_REMEMBER, all OIDC variables, MCP_RATE_LIMIT, MCP_MAX_SESSION_PER_USER, DEMO_MODE) are available under Advanced View in the template editor.
Setting the Encryption Key
Generate a key in the Unraid terminal (Tools → Terminal):
openssl rand -hex 32
Copy the output into the ENCRYPTION_KEY field before starting the container for the first time. If you skip this, TREK auto-generates a key and saves it to data/.encryption_key — your data is still protected, but you should record that file in your backups.
After Install
Once the container starts, open your browser at:
http://<unraid-ip>:<port>
On first boot, TREK automatically creates an admin account. The credentials are printed to the container log — check Docker → trek → Log in the Unraid UI. If you set both ADMIN_EMAIL and ADMIN_PASSWORD, those values are used; otherwise the email is admin@trek.local and a random password is generated.
Next Steps
- Environment-Variables — complete variable reference
- Updating — how to pull a new image on Unraid