mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-19 05:26:47 +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.
8.4 KiB
8.4 KiB
User Settings
The Settings page lets you personalise every aspect of TREK — appearance, maps, notifications, offline behaviour, and your account.
Navigating to Settings
Open the user menu in the top navigation bar and select Settings. The page opens on the General tab by default.
If your account requires MFA setup, TREK redirects you directly to the Account tab (via ?mfa=required).
Tabs
| Tab | Purpose | Shown when |
|---|---|---|
| General | Start page and start tab, currency, language, temperature unit, distance unit, time format, booking route labels, always show booking routes, map POI pills, blur booking codes, and optimize route from accommodation | Always |
| Appearance | Color mode, color scheme / accent, readability (transparency, reduce motion, density, text size), and which widgets appear on your dashboard | Always |
| Map | Map provider (Leaflet, Mapbox GL, or MapLibre GL), tile presets, map style and Mapbox token, 3D buildings, high-quality mode | Always |
| Notifications | Email, webhook, ntfy, and in-app notification preferences | Always |
| Integrations | Photo providers (Immich, Synology, etc.), the AirTrail connection, your own AI parsing model, and MCP OAuth clients / API tokens | Only when a photo provider (Immich or Synology Photos), MCP, AirTrail or AI Parsing is enabled |
| Plugins | Per-user settings for installed plugins | Only when at least one plugin is installed |
| Offline | Cached trips, pending changes, re-sync and clear cache | Always |
| Account | Username, email, password, MFA (TOTP + backup codes), passkeys, avatar, delete account | Always |
| About | App version, links to Ko-fi / Buy Me a Coffee / Discord / GitHub (bug reports, feature requests) / Wiki | Only when version metadata is available |
General tab
The General tab controls the following preferences, all saved immediately on change. See Display-Settings for the detail.
Startup
- Start page — open TREK on the dashboard (the default) or straight in your active trip.
- Start tab — which planner tab that trip opens on, e.g. Costs for entering expenses on the road.
Language & region
- Currency — your display currency; Trip currency (the default) shows each trip in its own. See Currencies.
- Language — displayed as a button grid on desktop and a dropdown on mobile.
- Temperature unit — Celsius (°C) or Fahrenheit (°F).
- Distance unit — Metric (km) or Imperial (mi).
- Time format — 24h (14:30) or 12h (2:30 PM).
Travel & map
- Booking route labels — show or hide station / airport names on booking route endpoint markers.
- Always show booking routes — draw the route for every flight, train and other booking on the map automatically, instead of switching it on per item.
- Explore places on the map — show a POI category pill on the trip map for finding nearby places from OpenStreetMap.
- Blur booking codes — blur confirmation codes and reference numbers (useful when screen-sharing).
- Optimize route from accommodation — when optimizing a day, start the route at the hotel you wake up in and end it at the one you check into that evening.
Appearance tab
- Color mode — Light, Dark, or Auto (follows your operating system / browser preference).
- Color scheme — a preset accent, or Custom with your own light and dark accent colors.
- Readability (Experimental) — transparency, reduce motion, density, and text size.
- Dashboard widgets — which widgets appear on the dashboard, independently for desktop and mobile.
See Appearance-Settings for the detail.
Map tab
The Map tab requires an explicit Save action after making changes.
Provider — choose between:
- Leaflet — Classic 2D raster tiles. You can pick from built-in presets (OpenStreetMap, OpenStreetMap DE, CartoDB Light/Dark, Stadia Smooth) or enter a custom tile URL template.
- Mapbox GL (Experimental) — Vector tiles with 3D buildings and terrain. Requires a public Mapbox access token (
pk.*). Supports built-in style presets (Mapbox Standard, Standard Satellite, Streets, Outdoors, Light, Dark, Satellite, Satellite Streets, Navigation Day, Navigation Night) or a custommapbox://styles/USER/IDURL. Additional options:- 3D Buildings & Terrain — Pitch and real 3D building extrusions (works on every style including satellite).
- High Quality Mode (Experimental) — Antialiasing + globe projection for sharper edges. May impact performance on lower-end devices.
- MapLibre GL — Vector tiles from OpenFreeMap, and the reason to pick it over Mapbox GL: it needs no access token. Styles are OpenFreeMap Liberty, Bright, and Positron, or any
https://tiles.openfreemap.org/…style URL. The 3D and high-quality toggles are Mapbox-only and are not shown here.
Each GL provider keeps its own saved style, so switching between Mapbox GL and MapLibre GL never overwrites the other one's choice.
Atlas always uses Leaflet regardless of the provider setting.
Opening view — there is no default map center or zoom setting. Every map frames itself on the places it is showing. See Map-Settings.
Account tab summary
The Account tab lets you:
- Edit your username and email address.
- Change your password (hidden when the server runs in OIDC-only mode — see OIDC-SSO).
- Set up or disable two-factor authentication (TOTP). After enabling MFA, backup codes are shown once and can be copied, downloaded, or printed. See Two-Factor-Authentication.
- Manage your passkeys — add one (confirm your password, then follow your device prompt), rename it, or remove it. Add a passkey only appears when the instance has passkeys switched on and a WebAuthn domain resolves; an existing passkey stays listed either way so you can always clean it up. See Passkeys.
- Upload or remove your profile avatar.
- Delete your account (irreversible; blocked if you are the only admin).
If your account was linked via SSO, an SSO badge appears next to your role and the OIDC issuer domain is shown below it.
Integrations tab
The Integrations tab is only visible when a photo provider (Immich or Synology Photos), MCP, AirTrail or AI Parsing is enabled. Each section then appears with its own addon, so the tab holds only what your instance actually runs:
- Photo Providers (only when a photo provider is enabled) — Configure Immich, Synology Photos, and other photo integrations. One card appears per enabled provider.
- AirTrail (only when the AirTrail addon is enabled) — Instance URL and API key for your self-hosted AirTrail, plus a self-signed-certificate switch and a Write changes back to AirTrail toggle (off by default: AirTrail is the source of truth and TREK only reads from it). Test connection reports how many flights it can see. The key is stored encrypted and never prefilled — leaving the field blank keeps the stored one.
- AI parsing (only when the AI Parsing addon is enabled) — The provider (OpenAI or Anthropic), model and API key used to extract bookings from your uploaded files, plus Send documents as images for vision-capable models. This is the per-user fallback: it only takes effect when your administrator has not configured a model for the whole instance. A local Ollama endpoint is not offered here — that is set up once, instance-wide, in the admin settings (#1772). See AI-Booking-Import.
- MCP section (only when MCP addon is enabled):
- Shows the MCP server endpoint URL.
- OAuth Clients sub-tab — Create and manage OAuth 2.1 clients (with redirect URIs and scopes). Quick-fill presets are provided for Claude.ai, Claude Desktop, Cursor, VS Code, Windsurf, and Zed. Active OAuth sessions can be viewed and revoked here.
- API Tokens sub-tab (Deprecated) — Create and manage personal bearer tokens for direct MCP access.