-
-
Notifications
You must be signed in to change notification settings - Fork 565
Install Unraid
Install TREK on Unraid via Community Applications or a direct template import.
Docker must be enabled in Unraid (Settings → Docker → Enable Docker: Yes).
- 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
The Unraid template exposes the following fields in the container UI:
| 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 |
| 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. |
Additional variables (PORT, NODE_ENV, LOG_LEVEL, DEFAULT_LANGUAGE, FORCE_HTTPS, TRUST_PROXY, COOKIE_SECURE, ALLOW_INTERNAL_NETWORK, all OIDC variables, MCP_RATE_LIMIT, MCP_MAX_SESSION_PER_USER, DEMO_MODE) are available under Advanced View in the template editor.
Generate a key in the Unraid terminal (Tools → Terminal):
openssl rand -hex 32Copy 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.
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.
- Environment-Variables — complete variable reference
- Updating — how to pull a new image on Unraid
- Home
- Quick Start
- Install: Docker
- Install: Docker Compose
- Install: Helm
- Install: Proxmox VE (LXC)
- Install: Unraid
- Install: Portainer
- Reverse Proxy
- Environment Variables
- Updating
- Login and Registration
- OIDC SSO
- Two-Factor Authentication
- Password Reset
- User Settings
- Display Settings
- Map Settings
- Notifications
- Offline Mode and PWA
- Languages
- My Trips Dashboard
- Creating a Trip
- Trip Members and Sharing
- Trip Planner Overview
- Places and Search
- Day Plans and Notes
- Map Features
- Route Optimization
- Weather Forecasts
- Reservations and Bookings
- Transport: Flights, Trains, Cars
- Accommodations
- Budget Tracking
- Packing Lists
- Packing Templates
- Todos and Tasks
- Documents and Files
- Tags and Categories
- Real-Time Collaboration
- Collab Chat
- Collab Notes
- Collab Polls
- What's Next Widget
- Public Share Links
- Invite Links