k1nq/TREK
1
0
Fork 0
mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-18 21:16:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(server): keep the managed-hosting switches out of the env reference

Browse Source 
The env reference parity test forced TREK_MANAGED, MAPBOX_ACCESS_TOKEN,
CARTO_API_KEY and PLACES_API_BASE into server/.env.example with how-to text.
They are managed hosting only and stay out of the public docs, the same way
TREK_DB_FILE and APP_VERSION do, so they move to NOT_OPERATOR_SETTINGS with
that reason and their lines leave the self-hoster reference again. The
variables themselves and their behaviour are unchanged.
This commit is contained in:
Maurice
2026-10-08 17:02:03 +02:00
parent 558203213c
commit a6f635f3e0
3 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/.env.example
-6
View File
@@ -71,7 +71,6 @@ DEMO_MODE=false # Demo mode: resets data hourly
# TREK_PLACES_ENABLED=false # Whether place search asks the TREK Places API at https://places.liketrek.com: suggestions, the full search, the category buttons on the map, the Road trip search along the route, import geocoding and offline downloads. It is on by default and has no switch in the admin panel, because whether searches leave the instance is a deployment decision. Set false to search the way it did before 4.3.0 (OpenStreetMap, or your Google/Amap key) and send nothing to that host. (default: true)
# TREK_PLACES_URL=https://places.liketrek.com # Base URL of a copy of the Places API you run yourself; it has to answer the same /v1 API. Read from configuration rather than typed by a user, so an address on your LAN or Docker network works without ALLOW_INTERNAL_NETWORK. (default: https://places.liketrek.com)
# PLACES_API_BASE= # Send the Google Places calls through an egress proxy, a cache or a gateway that speaks the same API instead of places.googleapis.com directly. Unset: Google's own endpoints.
# PLACES_API_KEY= # Google Maps API key (Places API (New) enabled) for place search, photos, details and Google transit. Overrides the key set in Admin > Settings > API Keys, whose field then shows this variable read-only. The value never reaches the browser.
# AMAP_API_KEY= # Amap (高德地图) Web 服务 key for place search and geocoding inside mainland China. Overrides the key set in Admin > Settings > API Keys. A Web 端 (JS API) key is a different credential and is rejected with INVALID_USER_KEY.
@@ -80,9 +79,6 @@ DEMO_MODE=false # Demo mode: resets data hourly
# TRANSIT_API_URL=https://api.transitous.org # Base URL of the transit routing API the server proxies to. Point it at your own MOTIS instance to keep transit searches off third-party servers. A trailing slash is stripped. (default: https://api.transitous.org)
# MAPBOX_ACCESS_TOKEN= # Only read with TREK_MANAGED: the public Mapbox token (pk.*) a managed instance ships with, in place of the one in Admin > Settings. It reaches the browser by design, so never a secret token.
# CARTO_API_KEY= # Only read with TREK_MANAGED: the CARTO basemap key a managed instance ships with. Without a key the CARTO tiles carry a watermark. Public like the Mapbox token.
# TREK_PLACE_PHOTO_DIR= # Directory for cached Google place photos, e.g. a dedicated volume. Unset, they live in uploads/photos/google. Read once at startup. (default: uploads/photos/google)
# KITINERARY_EXTRACTOR_PATH= # Full path to the kitinerary-extractor binary. Unset, TREK searches /usr/lib/*/libexec/kf6/ and then PATH; the official image pins it. Set it to run a newer extractor than your distribution packages — the version in use is in the startup log and in GET /api/admin/system-info. (default: auto-detected)
@@ -120,8 +116,6 @@ DEMO_MODE=false # Demo mode: resets data hourly
# TREK_PLUGIN_LOG_BURST=50 # Log lines a plugin may write back to back before the per-second limit applies. (default: 50)
# TREK_PLUGIN_LOG_PER_SEC=10 # Sustained log lines per second per plugin. (default: 10)
# TREK_MANAGED=false # Set by hosting providers that administer an instance for its owner. It withholds the settings the provider controls from the instance admin and requires ENCRYPTION_KEY. Leave it unset on a self-hosted install. (default: false)
# UNSPLASH_ACCESS_KEY= # Optional Unsplash Access Key for trip-cover and place-image search. Without one, TREK uses Unsplash's unauthenticated endpoint, which some datacenter/VPS IPs get blocked from (#1449). Get a free key at unsplash.com/developers. Overrides any key set per-admin in Admin > Settings. Can also be configured there instead of here.
# Initial admin account — ONLY applied on the first boot, when the database has no