mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-18 21:16:47 +00:00
Maurice
b401da2264
CARTO started stamping "API KEY REQUIRED" across every keyless basemap tile on 26.08.2026. #2060 added a key field as the immediate answer, but it leaves a self-hosted instance needing an email exchange with CARTO before its maps look right, and every default in the client still pointed at CARTO. Default to OpenFreeMap Positron instead: no key, no account, no request limit, commercial use allowed, attribution required. OpenFreeMap serves vector tiles only, so the Leaflet basemap is a MapLibre style document rather than an XYZ template. maplibre-gl-leaflet hangs a GL canvas into Leaflet's own tile pane, which leaves everything above it alone - markers, GeoJSON, clusters, plugin layers, the custom panes, and the click handling, since Leaflet's CSS already puts pointer-events:none on that layer. maplibre-gl still arrives only through a dynamic import, so no chunk that draws a map grows by a megabyte. Switched: the trip planner, the MapView fallback every preview goes through, the journey map, collections, the atlas, the shared trip page and the offline tile prefetch. OpenFreeMap Positron and Bright join the tile presets in settings, the admin defaults and both mobile screens. A CARTO template that is already saved keeps working when a key backs it - that stays a supported choice. Without a key it is not drawn at all: resolveTileUrl falls back to the default rather than to a watermark, so an instance that upgrades with one in its settings sees the new basemap immediately and needs no migration. The stored value is left as it is, so the Map settings tab still shows what was chosen and the warning underneath it explains why - one sentence appended, in all 23 locales. OpenFreeMap asks for a credit of its own; OpenStreetMap alone under its tiles is wrong and a licence problem. attributionForTile() derives it from the URL rather than from a flag at each call site, and the shared trip map, which carried no attribution at all, now gets one. Offline maps keep working and get cheaper. A vector style is four things instead of one, so sync/glPrefetcher.ts walks the style document, its sprite, the Latin glyph ranges of each font stack it uses, the TileJSON - the planet path is versioned, so guessing it answers 200 with an empty body - and then the .pbf tiles. Over the Berlin bounding box TREK computes, raster z10-16 is 2237 requests and 34.6 MB and gives up above z16; vector z10-14 is 177 requests and 32.1 MB and stays sharp above that, because MapLibre scales the z14 tile rather than asking for another. The Workbox rule for tiles.openfreemap.org moves to CacheFirst and shares the prefetcher's cache, so browsing tops a downloaded region up instead of filling a second copy beside it - a versioned tile path can never be stale. Clearing offline maps clears it too. The atlas loses its second raster layer. It existed to warm the HTTP cache of neighbouring zoom levels, which a vector basemap does not need; a second one would only cost a second WebGL context. OpenFreeMap has no label-free style, so its labels are switched off on the live map instead - they are all symbol layers, while borders and coastlines are line and fill - re-armed on style.load so a theme switch keeps them off. Theme changes call setStyle in place rather than rebuilding the layer: a swap per toggle would leak a WebGL context, and browsers cap those in the low teens.
113 lines
8.5 KiB
Markdown
113 lines
8.5 KiB
Markdown
# 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](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](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](Appearance-Settings) for the detail.
|
|
|
|
## Map tab
|
|
|
|
The Map tab requires an explicit **Save** action after making changes.
|
|
|
|
**Provider** — choose between:
|
|
|
|
- **Leaflet** — The default. Pick from built-in presets (OpenStreetMap, OpenStreetMap DE, OpenFreeMap Positron/Bright, CartoDB Light/Dark, Stadia Smooth) or enter a custom tile URL template. OpenFreeMap Positron is what an unconfigured map draws; the CartoDB presets need an API key.
|
|
- **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 custom `mapbox://styles/USER/ID` URL. 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](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](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](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](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](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.
|
|
|
|
## See also
|
|
|
|
- [Display-Settings](Display-Settings)
|
|
- [Appearance-Settings](Appearance-Settings)
|
|
- [Map-Settings](Map-Settings)
|
|
- [Notifications](Notifications)
|
|
- [Offline-Mode-and-PWA](Offline-Mode-and-PWA)
|
|
- [Two-Factor-Authentication](Two-Factor-Authentication)
|
|
- [Languages](Languages)
|