mirror of
https://github.com/mauriceboe/TREK.git
synced 2026-10-18 21:16:47 +00:00
docs(wiki): bring the wiki in line with 4.0.0 (#2034)
* 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.
This commit is contained in:
+14
-8
@@ -29,8 +29,9 @@ An `integration` plugin can add a whole new **notification channel** — Gotify,
|
||||
Telegram, anything that takes a message — alongside TREK's built-in email, webhook and
|
||||
ntfy.
|
||||
|
||||
Once you install and enable such a plugin, switch its channel on in
|
||||
**Admin → Notifications**. It then appears as a new column in every user's
|
||||
Once you install and activate such a plugin, its channel is live — there is no separate
|
||||
switch for it in **Admin → Notifications**, which only turns the built-in email, webhook
|
||||
and ntfy channels on. It appears right away as a new column in every user's
|
||||
**Settings → Notifications** matrix, and each user supplies their own credentials on the
|
||||
plugin's own settings page and picks per-event what they want pushed — exactly like a
|
||||
built-in channel.
|
||||
@@ -95,9 +96,10 @@ code:
|
||||
|
||||
- It has **no** access to `JWT_SECRET`, the database connection, or any TREK
|
||||
secret — those are simply not reachable by its process.
|
||||
- It **cannot** open `trek.db`, write files, spawn child processes, use worker
|
||||
threads, or load native addons. Its own data lives in a separate SQLite file it
|
||||
reaches only through TREK.
|
||||
- It **cannot** open TREK's own database (`server/data/travel.db`, or
|
||||
`/app/data/travel.db` in the container), write files, spawn child processes, use
|
||||
worker threads, or load native addons. Its own data lives in a separate SQLite file
|
||||
it reaches only through TREK.
|
||||
- It talks to TREK exclusively over an internal RPC channel, and TREK only
|
||||
answers the capabilities the plugin's manifest **declares and you approve**.
|
||||
An ungranted call is refused, not merely ignored.
|
||||
@@ -123,9 +125,11 @@ A single panel with a segmented **Installed / Discover** switch at the top left,
|
||||
plus a toolbar:
|
||||
|
||||
- **Search** — filters the current list by name/description (and author, in Discover).
|
||||
- **Type** filter — All / Widget / Integration / Page.
|
||||
- **Type** filter — All types / Widget / Integration / Page / Trip page.
|
||||
- **Status** filter (Installed view only) — All / Active / Off / Update available / Error.
|
||||
- **Sort** — Name / Recently updated / Updates first.
|
||||
- **Sort** — Name / Recently updated, plus **Updates first** in Installed and **Most
|
||||
downloads** in Discover. The view-specific option falls back to Name when you switch
|
||||
views.
|
||||
- **Upload** — sideload a plugin from a `.zip`/`.tar.gz` (see [Installing](#installing-a-plugin)).
|
||||
- **Rescan** — rediscovers the on-disk plugins directory **and** force-pulls the
|
||||
remote registry, bypassing the 30-minute server cache and GitHub's CDN so a
|
||||
@@ -222,7 +226,9 @@ The **⋯** menu on each row:
|
||||
- **Allowed hosts** — add the hosts a plugin may reach, for a plugin that talks to a
|
||||
service only *you* can name. See [Allowed hosts](#allowed-hosts) below.
|
||||
- **Source repository** — opens the plugin's GitHub repo (registry installs only).
|
||||
- **Delete** — uninstalls: removes the code and lets you keep or delete its data.
|
||||
- **Report an issue** — opens that repo's issue tracker (registry installs only).
|
||||
- **Delete** — uninstalls, after a confirmation: it stops the plugin, removes its code,
|
||||
**and deletes all of its data**. This cannot be undone.
|
||||
|
||||
## Allowed hosts
|
||||
|
||||
|
||||
Reference in New Issue
Block a user