diff --git a/README.md b/README.md index f8734794..3e90a0e8 100644 --- a/README.md +++ b/README.md @@ -127,11 +127,15 @@ A self-hosted, real-time collaborative travel planner — with maps, budgets, pa #### 🧩 Addons (admin-toggleable) +- **Lists** — packing lists + to-dos with templates, member assignments, optional bag tracking +- **Budget** — expense tracker with splits, pie chart, multi-currency +- **Documents** — file attachments on trips, places, and reservations +- **Collab** — chat, notes, polls, day-by-day attendance - **Vacay** — personal vacation planner with calendar, 100+ country holidays, carry-over tracking - **Atlas** — world map of visited countries, bucket list, travel stats, streak tracking, liquid-glass UI -- **Collab** — chat, notes, polls, day-by-day attendance -- **Journey** — magazine-style travel journal with entries, photos, maps, moods -- **Dashboard widgets** — currency converter and timezone clocks +- **Journey** — magazine-style travel journal with entries, photos (Immich/Synology), maps, moods +- **Naver List Import** — one-click import from shared Naver Maps lists +- **MCP** — expose TREK to AI assistants via OAuth 2.1 diff --git a/wiki/Admin-Addons.md b/wiki/Admin-Addons.md index 01a418c3..81553305 100644 --- a/wiki/Admin-Addons.md +++ b/wiki/Admin-Addons.md @@ -59,7 +59,7 @@ If a toggle fails (e.g., network error), it rolls back to its previous state. Some addons require credentials or environment variables before they are functional: -- **Journey** — requires photo provider credentials (Immich or Synology Photos) configured per-user in their personal Settings. See [Photo-Providers](Photo-Providers). +- **Journey** — works without any external integration. To embed photos from Immich or Synology Photos, enable the corresponding photo-provider toggle listed under Journey, then configure credentials per-user in **Settings → Integrations**. See [Photo-Providers](Photo-Providers). - **MCP** — requires `APP_URL` to be set so OAuth redirect URIs resolve correctly. ## Related pages diff --git a/wiki/Home.md b/wiki/Home.md index 102ca21e..81f8ff68 100644 --- a/wiki/Home.md +++ b/wiki/Home.md @@ -30,17 +30,23 @@ TREK is a self-hosted, real-time collaborative travel planner licensed under AGP - **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 +- **Budget Planner** — 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 -- **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 +- **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) + +> Dashboard widgets (currency converter and timezone clock) are per-user preferences, not an admin-toggleable addon — see [Dashboard-Widgets](Dashboard-Widgets). ### 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 +- **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 +- **27 OAuth Scopes** — granular permissions across 13 permission groups - **Pre-built Prompts** — `trip-summary`, `packing-list`, and `budget-overview` context loaders ### Admin @@ -48,7 +54,7 @@ TREK is a self-hosted, real-time collaborative travel planner licensed under AGP - 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. +> **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 diff --git a/wiki/Photo-Providers.md b/wiki/Photo-Providers.md index 05f37f5c..dca7acd2 100644 --- a/wiki/Photo-Providers.md +++ b/wiki/Photo-Providers.md @@ -2,7 +2,7 @@ TREK can browse your personal photo library on Immich or Synology Photos and attach selected photos to trips. TREK never copies the original files — it stores only a reference (provider name + asset ID) and proxies all image streams through its own server, so your provider credentials are never sent to the browser. -> **Admin:** Two things must be enabled for photo providers to appear in Settings: the **Memories addon** and the **individual photo provider** (Immich or Synology Photos). Both are toggled separately in **Admin → Addons**. See [Admin-Addons](Admin-Addons). If your provider is on a local or private network, the server must be configured to allow internal network access. See [Internal-Network-Access](Internal-Network-Access). +> **Admin:** Enable at least one photo provider (Immich or Synology Photos) in **Admin → Addons** — photo provider toggles appear as sub-items under the **Journey** addon. Once a provider is on, a Photo Providers section appears in each user's **Settings → Integrations**. If your provider runs on a local or private network, the server must be configured to allow internal network access. See [Admin-Addons](Admin-Addons) and [Internal-Network-Access](Internal-Network-Access). --- diff --git a/wiki/Tags-and-Categories.md b/wiki/Tags-and-Categories.md index d334f645..cdb8274d 100644 --- a/wiki/Tags-and-Categories.md +++ b/wiki/Tags-and-Categories.md @@ -1,7 +1,9 @@ # Tags and Categories -TREK has a labeling system: **Global Place Categories** (admin-managed, shared across all users). +TREK has two independent labelling systems for places: +- **Global Place Categories** — admin-managed, shared across every user on the instance (e.g. `Restaurant`, `Museum`). +- **Personal Tags** — user-scoped, private labels (e.g. `hidden gem`, `kid-friendly`). @@ -24,6 +26,23 @@ Categories appear in: > **Admin:** Create and manage categories in [Admin-Categories](Admin-Categories). Only admins can create, edit, or delete categories. All users can read them. +## Personal Tags + +Tags are private labels owned by each user. They attach to individual places via a many-to-many relationship (`place_tags` table), so the same tag can be applied to as many places as you like, and a single place can carry multiple tags. + +**Fields per tag:** + +- **Name** — free-form text. +- **Color** — hex value displayed alongside the tag name. Default: `#10b981` (emerald). + +Tags are scoped to their creator — other trip members do not see your tags, and different users can create tags with identical names without conflict. Deleting a tag automatically removes it from every place it was attached to. + +### Where to manage them + +At the moment tags are exposed primarily through the MCP API — AI assistants connected to your instance can list, create, update, and delete tags (`list_tags`, `create_tag`, `update_tag`, `delete_tag`) and attach them to places through the place endpoints. A dedicated web UI for tag management is not yet available; the filter `tag` parameter on the places API / MCP resource does support filtering places by a tag ID once one exists. + +> **AI / MCP:** See [MCP-Tools-and-Resources](MCP-Tools-and-Resources) for the full tag tool list. + ## When to use which | Use case | Use |