mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-23 23:46:35 +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.
79 lines
5.3 KiB
Markdown
79 lines
5.3 KiB
Markdown
# TREK Wiki
|
|
|
|
TREK is a self-hosted, real-time collaborative travel planner licensed under AGPL-3.0.
|
|
|
|
|
|
|
|
## Features
|
|
|
|
### Planning
|
|
- **Drag & Drop Planner** — organize places into day plans with reordering and cross-day moves
|
|
- **Interactive Map** — Leaflet map with photo markers, clustering, route visualization, and customizable tile sources
|
|
- **Place Search** — Google Places (photos, ratings, hours) or OpenStreetMap (free, no API key needed)
|
|
- **Day Notes** — timestamped, icon-tagged notes per day
|
|
- **Route Optimization** — auto-optimize place order and export to Google Maps
|
|
- **Weather Forecasts** — 16-day forecasts via Open-Meteo (no API key required), historical climate averages as fallback
|
|
|
|
### Travel Management
|
|
- **Reservations & Bookings** — track flights, accommodations, restaurants with confirmation numbers and file attachments
|
|
- **Budget Tracking** — category-based expenses with pie chart, per-person/per-day splitting, multi-currency support (see [Currencies](Currencies))
|
|
- **Packing Lists** — category-based checklists with user assignment, templates, and progress tracking
|
|
- **Document Manager** — attach documents, tickets, and PDFs to trips, places, or reservations (up to 50 MB per file)
|
|
- **PDF Export** — export complete trip plans as PDF with cover page, images, and notes
|
|
|
|
### Collaboration
|
|
- **Real-Time Sync** — WebSocket-based live sync; changes appear instantly for all connected users
|
|
- **Multi-User** — invite members with role-based access
|
|
- **Invite Links** — one-time registration links with configurable max uses and expiry
|
|
- **OIDC SSO** — sign in with Google, Apple, Authentik, Keycloak, or any OIDC provider
|
|
- **Two-Factor Authentication** — TOTP-based 2FA with QR code setup
|
|
- **Passkeys** _(admin-enabled)_ — passwordless WebAuthn sign-in with Touch ID, Windows Hello, Android screen lock, or a hardware key; owning one also satisfies the require-2FA policy (see [Passkeys](Passkeys))
|
|
- **Public Share Links** — share a read-only view of any trip
|
|
|
|
### Addons _(admin-toggleable)_
|
|
- **Lists** — packing lists and to-dos with templates, member assignments, optional bag tracking
|
|
- **Costs** — expense tracker with category breakdown, splits, multi-currency
|
|
- **Documents** — file manager for trips, places, and reservations
|
|
- **Collab** — group chat, shared notes, polls, day-by-day attendance
|
|
- **Vacay** — personal vacation day planner with calendar view, public holidays, and carry-over tracking
|
|
- **Atlas** — interactive world map, bucket list, travel stats, continent breakdown
|
|
- **Collections** — personal place library: save places across trips into named lists, copy them into any trip, share with per-member roles (see [Collections](Collections))
|
|
- **Journey** — magazine-style travel journal with entries, photos (via Immich/Synology Photos), maps, and moods
|
|
- **Naver List Import** — import places from shared Naver Maps lists
|
|
- **MCP** — expose TREK to AI assistants via the Model Context Protocol (OAuth 2.1)
|
|
- **AirTrail** — sync flights from your self-hosted AirTrail instance into trips
|
|
- **AI Parsing** — LLM fallback that extracts bookings from confirmation files KDE Itinerary cannot read (see [AI-Booking-Import](AI-Booking-Import))
|
|
|
|
> Dashboard widgets (currency converter and timezone clock) are per-user preferences, not an admin-toggleable addon — see [Dashboard-Widgets](Dashboard-Widgets).
|
|
>
|
|
> The full addon table, with type and per-addon notes, lives in [Addons-Overview](Addons-Overview).
|
|
|
|
### Plugins
|
|
- **Sandboxed Plugin Runtime** — third-party plugins run in a forked child process with permission-gated RPC, install-time manifest and signature checks, and an egress allowlist (see [Plugins](Plugins))
|
|
- **Plugin SDK** — build and publish plugins with the `trek-plugin-sdk` npm package: dev server, preflight, signing, submit (see [Plugin-Development](Plugin-Development))
|
|
|
|
### AI / MCP Integration
|
|
- **MCP Server** — built-in Model Context Protocol server with OAuth 2.1 authentication
|
|
- **150+ Tools** — create trips, plan itineraries, manage budgets, send messages, and more
|
|
- **30 Resources** — read-only `trek://` URIs for trips, days, places, budget, packing, journeys, and more
|
|
- **29 OAuth Scopes** — granular permissions across 14 permission groups
|
|
- **Pre-built Prompts** — `trip-summary`, `packing-list`, and `budget-overview` context loaders
|
|
|
|
### Admin
|
|
- User management, invite links, packing templates, global categories
|
|
- Addon management, API key storage, scheduled auto-backups
|
|
- System notices for onboarding and announcements
|
|
|
|
> **Admin:** Most configuration lives in the Admin Panel. On first boot TREK seeds an admin account automatically — credentials come from `ADMIN_EMAIL` / `ADMIN_PASSWORD` if set, otherwise a random password is printed to the container log.
|
|
|
|
## Get Started
|
|
|
|
| | |
|
|
|---|---|
|
|
| [Quick Start](Quick-Start) | Install in minutes with a single Docker command |
|
|
| [My Trips Dashboard](My-Trips-Dashboard) | Start planning your first trip |
|
|
| [Admin Panel](Admin-Panel-Overview) | Configure your instance |
|
|
| [MCP / AI Integration](MCP-Overview) | Connect Claude, Cursor, or any MCP client |
|
|
| [Contributing](Contributing) | Guidelines for submitting pull requests |
|
|
| [Development Environment](Development-environment) | Set up a local dev environment |
|