k1nq/TREK

mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-18 21:16:47 +00:00

Files

T

Maurice 44c92052a3 docs(wiki): bring the pages in line with 4.3.0

Every page was read against the code on dev. What changed:

- Pages that described 4.2 behaviour: satellite view on the vector maps,
  the mobile journal timeline, Collab with its fifth tab, the Review badge,
  clustered pins on the share page, the Leaflet preset list, the strict
  guard on fe80::/10, the invite link tools and their scopes, the Public
  API scope rules, the permission count in the plugin SDK.
- Features of this release that no page mentioned: videos in a journal
  entry, receipts on an expense, the Google transit backend, routing
  counters, the rating on a place, the navigation menu, car stops, the
  manual school holiday catalogue and its MCP tools, the Dawarich panel in
  the Atlas, the release notes modal, plugin frames going fullscreen, the
  corridor call into the search provider hook.
- Statements that sent an admin the wrong way: DEFAULT_LANGUAGE is not in
  the Helm ConfigMap, env.PORT cannot be changed on the chart alone, the
  rotation script does not cover the document sync credentials, event
  handlers cannot broadcast, there is no per user MFA reset in the admin
  panel, the demo user can edit, an unparsable APP_URL stops the server.
- Updating gets a section for 4.3.0: the TREK Places API as the new
  default, the new variables, the Overpass timeout, SSO sessions on an
  OIDC only instance, the migration that puts booked nights on the drive.

2026-09-20 12:11:41 +02:00

6.1 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
35 OAuth Scopes: granular permissions across 17 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, including a release notes notice every user sees once after each update (see Admin-GitHub-Releases)

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

6.1 KiB Raw Blame History