mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-18 21:16:47 +00:00
Maurice
7da0080557
* docs(wiki): correct the install and operations pages for 4.0.0 Quick Start passed docker an empty ENCRYPTION_KEY: an assignment prefix is not expanded on the same command line, so the server silently generated its own key instead of taking the one the page told you to set. The tag examples pinned to the 3.x line, the documented tmpfs size did not match the shipped compose file, and several .env values were described as reaching the container when compose never interpolates them. * docs(wiki): match the MCP reference to the registered surface The scope table was missing the whole Collections group and the totals said 27 scopes across 13 groups where the code registers 29 across 14. The Cloudflare link on the setup page pointed at an anchor on its own page instead of the heading on Troubleshooting. * docs(wiki): correct the plugin and admin pages Three links to Plugin-Development carried a .md suffix, which does not resolve on the wiki. The admin pages described tabs, permissions and storage behaviour that had moved on. * docs(wiki): bring the feature pages back in line with the app Costs still documented the old panel, where categories could be added, renamed, reordered and deleted; they are fixed now and the panel is a day-grouped ledger with settlements. Trip sharing, journeys, maps, packing, reservations and the account pages had all drifted in the same way. * docs(wiki): cover the pages the first pass did not reach The MCP catalog listed 168 of the 201 registered tools; the settlement tools and rate_place were missing here and the Collections family from the addon page. Several resource rows claimed a trips:* scope where the handler asks for trips:read. * docs(wiki): tighten the corrections a review picked apart The audit-log resource is the row id, not the credential id; an admin password reset does not bump password_version the way the page implied; and a few of the new paragraphs described behaviour more confidently than the code supports. * docs(wiki): fix what a last read-through caught Costs shows every figure in your display currency, not the trip's, and an expense with no payer still counts against the members it is split between. Studio's cutoff is a 1024px viewport rather than phones alone, and the Integrations tab is gated on the providers an admin has configured. * docs(wiki): the last few the review caught A passkey satisfies the MFA policy everywhere except the WebSocket handshake, which still asks for TOTP, so a passkey-only account under that policy gets no live updates. Mobile optimizes a day from two places, not three. The ctx.db row carried an unescaped pipe that split the table, and the Backups table linked with a wiki link whose pipe did the same.
74 lines
3.3 KiB
Markdown
74 lines
3.3 KiB
Markdown
# Install: Unraid
|
|
|
|
Install TREK on Unraid via Community Applications or a direct template import.
|
|
|
|
<!-- TODO: screenshot: Unraid container template settings -->
|
|
|
|
## Prerequisite
|
|
|
|
Docker must be enabled in Unraid (**Settings → Docker → Enable Docker: Yes**).
|
|
|
|
## Install via Community Applications
|
|
|
|
1. Open the **Apps** tab in Unraid.
|
|
2. Search for **TREK**.
|
|
3. 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/liketrek/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` | `admin@trek.local` | Email for the first admin account (first-boot only; no effect once any user exists). Pre-filled by the template — must be set together with `ADMIN_PASSWORD`, otherwise both are ignored. |
|
|
| `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`, `HSTS_INCLUDE_SUBDOMAINS`, `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`, `UNSPLASH_ACCESS_KEY`) are available under **Advanced View** in the template editor.
|
|
|
|
## Setting the Encryption Key
|
|
|
|
Generate a key in the Unraid terminal (**Tools → Terminal**):
|
|
|
|
```bash
|
|
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](Environment-Variables) — complete variable reference
|
|
- [Updating](Updating) — how to pull a new image on Unraid
|