k1nq/TREK

mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-19 05:26:47 +00:00

Files

T

Maurice 58f6a49f32 docs(wiki): document road trip, document sync, the TREK Places API and Dawarich

The 4.3.0 features had no pages, or pages that described an earlier
state. Three new pages and a rewrite:

- Road-Trip: the addon from enabling it to the phone tab, stays and a
  stop's End as the time you leave, pinned times and the backward
  schedule, daily travel times, the three driving limits, search along
  the route, via points, other ways and what avoiding tolls needs,
  following a track, the warning layer, MCP tools and troubleshooting.
- Document-Sync: switching stores on, binding a trip, what each store
  asks for and binds, direction and delete rules, conflicts, the
  mass-delete guard, renames and restores, what needs a look, limits,
  private addresses, and the MCP tools.
- TREK-Places-API: what the index is, where TREK asks it, what leaves
  the instance, switching it off or pointing it at a copy of your own,
  and what happens when it is down.
- Dawarich: brought up to date with suggestions, the journal fold,
  recorded routes, Atlas proposals and the wish list.

Places and search, documents, the addon and admin overviews, MCP
tools, environment variables, internal network access, the sidebar and
home link the new pages, and the in-app help picks them up from the
sidebar.

2026-09-19 21:45:16 +02:00

5.9 KiB

Raw Blame History

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: TREK's own place index and OpenStreetMap, asked together, with no API key and no quota; Google or Amap answer only where both come up empty (see TREK Places API)
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)
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)
Document Sync (admin-enabled): keep a trip's documents in step with a self-hosted Paperless-ngx, Papra, Nextcloud, OpenCloud or Synology NAS, in both directions, under one connection the trip owner sets up for every member (see Document Sync)
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: registration links with configurable max uses (1 to 5, or unlimited) 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)
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
Road trip: plan a trip as one continuous drive, with search along the route, driving limits, daily travel times and avoidance of toll roads, motorways and ferries (see Road Trip)
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: a personal place library that saves places across trips into named lists, copies them into any trip, and shares them with per-member roles (see 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
Dawarich: read the stays and routes your self-hosted Dawarich instance recorded, offered as suggestions you confirm; nothing is written back (see Dawarich)
AI Parsing: LLM fallback that extracts bookings from confirmation files KDE Itinerary cannot read (see AI-Booking-Import)

Dashboard widgets (currency converter and timezone clock) are per-user preferences, not an admin-toggleable addon; see Dashboard-Widgets.

The full addon table, with type and per-addon notes, lives in 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)
Plugin SDK: build and publish plugins with the trek-plugin-sdk npm package, with dev server, preflight, signing and submit (see 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	Install in minutes with a single Docker command
My Trips Dashboard	Start planning your first trip
Admin Panel	Configure your instance
MCP / AI Integration	Connect Claude, Cursor, or any MCP client
Contributing	Guidelines for submitting pull requests
Development Environment	Set up a local dev environment

5.9 KiB Raw Blame History