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.
67 lines
2.5 KiB
Markdown
67 lines
2.5 KiB
Markdown
# Quick Start
|
|
|
|
Get TREK running in under five minutes with a single Docker command.
|
|
|
|
|
|
|
|
## Prerequisites
|
|
|
|
- Docker installed and running on your machine
|
|
- Port `3000` available (or choose a different host port)
|
|
|
|
## Run TREK
|
|
|
|
Generate an encryption key and start the container in one step:
|
|
|
|
```bash
|
|
docker run -d \
|
|
--name trek \
|
|
-p 3000:3000 \
|
|
-e ENCRYPTION_KEY="$(openssl rand -hex 32)" \
|
|
-v ./data:/app/data \
|
|
-v ./uploads:/app/uploads \
|
|
--restart unless-stopped \
|
|
mauriceboe/trek:latest
|
|
```
|
|
|
|
**Flag breakdown:**
|
|
|
|
| Flag | Purpose |
|
|
|---|---|
|
|
| `-d` | Run in the background |
|
|
| `-p 3000:3000` | Map container port 3000 to host port 3000 |
|
|
| `-e ENCRYPTION_KEY=...` | At-rest encryption key for stored secrets |
|
|
| `-v ./data:/app/data` | Persist the database and secrets |
|
|
| `-v ./uploads:/app/uploads` | Persist uploaded files |
|
|
| `--restart unless-stopped` | Auto-restart on reboot |
|
|
|
|
**Why the encryption key?** TREK encrypts stored secrets (API keys, MFA seeds, OIDC credentials) using this key. If you skip it, TREK auto-generates one and saves it to `./data/.encryption_key`. Setting it explicitly means you control the key and can back it up separately. The key generated inline above never gets printed, but TREK writes it to `./data/.encryption_key` on first start, so `cat ./data/.encryption_key` gets it back when you want a copy elsewhere.
|
|
|
|
Generate a standalone key at any time:
|
|
|
|
```bash
|
|
openssl rand -hex 32
|
|
```
|
|
|
|
## Access TREK
|
|
|
|
Open `http://localhost:3000` in your browser.
|
|
|
|
## First User
|
|
|
|
On first boot TREK automatically seeds an admin account before any user registers. The credentials depend on how you start the container:
|
|
|
|
- **With `ADMIN_EMAIL` and `ADMIN_PASSWORD` env vars set:** those values are used directly.
|
|
- **Without those env vars:** TREK creates the account with email `admin@trek.local`, username `admin`, and a randomly generated password. The credentials are printed to the container log — run `docker logs trek` to retrieve them.
|
|
|
|
You will be prompted to change the password on first login.
|
|
|
|
> **Admin:** As admin you unlock the Admin Panel — user management, addon toggles, packing templates, backups, and API key configuration.
|
|
|
|
## Next Steps
|
|
|
|
- [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
|