k1nq/TREK

mirror of https://github.com/mauriceboe/TREK.git synced 2026-06-19 13:21:46 +00:00

Files

T

jubnl c1b9d11173 docs: add full wiki with 74 pages, assets, and CI workflow

Adds the complete TREK documentation wiki covering installation,
trip planning, admin panel, MCP/AI integration, addons, and operations.

Also fixes encrypt-at-rest gaps: mapbox_access_token, Synology
credentials, per-user webhook/ntfy tokens, and photo passphrases
are now rotated by migrate-encryption.ts and stored encrypted via
settingsService.

2026-04-20 10:11:53 +02:00

3.3 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 — 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
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
Public Share Links — share a read-only view of any trip

Addons (admin-toggleable)

Vacay — personal vacation day planner with calendar view, public holidays, and carry-over tracking
Atlas — interactive world map, bucket list, travel stats, continent breakdown
Journey — travel journal linking entries to trips, with contributor roles
Memories — photo-focused trip memories
Collab — group chat, shared notes, polls, and activity sign-ups
Dashboard Widgets — currency converter and timezone clock, toggled per user

AI / MCP Integration

MCP Server — built-in Model Context Protocol server with OAuth 2.1 authentication
80+ Tools — create trips, plan itineraries, manage budgets, send messages, and more
24 OAuth Scopes — granular permissions across 13 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. The first user to register becomes the admin automatically.

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

3.3 KiB Raw Blame History