-
-
Notifications
You must be signed in to change notification settings - Fork 565
Quick Start
Get TREK running in under five minutes with a single Docker command.

- Docker installed and running on your machine
- Port
3000available (or choose a different host port)
Generate an encryption key and start the container in one step:
ENCRYPTION_KEY=$(openssl rand -hex 32) docker run -d \
--name trek \
-p 3000:3000 \
-e ENCRYPTION_KEY=$ENCRYPTION_KEY \
-v ./data:/app/data \
-v ./uploads:/app/uploads \
--restart unless-stopped \
mauriceboe/trek:latestFlag 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.
Generate a standalone key at any time:
openssl rand -hex 32Open http://localhost:3000 in your browser.
On first boot TREK automatically seeds an admin account before any user registers. The credentials depend on how you start the container:
-
With
ADMIN_EMAILandADMIN_PASSWORDenv vars set: those values are used directly. -
Without those env vars: TREK creates the account with email
admin@trek.local, usernameadmin, and a randomly generated password. The credentials are printed to the container log — rundocker logs trekto 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.
- Install-Docker-Compose — production setup with security hardening
- Reverse-Proxy — put TREK behind HTTPS (required for PWA install and secure cookies)
- Environment-Variables — full configuration reference
- Admin-Panel-Overview — explore what the admin panel can do
- 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