k1nq/TREK

mirror of https://github.com/mauriceboe/TREK.git synced 2026-10-18 21:16:47 +00:00

Files

T

Maurice 7da0080557 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.

2026-08-25 12:36:52 +02:00

5.4 KiB

Raw Blame History

Updating

How to update TREK to a newer version without losing data.

Before You Update

Back up your data first. Go to Admin Panel → Backups and create a manual backup, or copy your ./data and ./uploads directories to a safe location. See Backups for details.

Image Tags

Tag	Example	Behavior
`latest`	`mauriceboe/trek:latest`	Always the newest release across all major versions
Major version	`mauriceboe/trek:4`	Latest release pinned to that major version
Full version	`mauriceboe/trek:4.0.0`	Exact release; never changes

Use latest or a major-version tag if you want updates on each redeploy. Use a full version tag for explicit control — update by changing the tag, not by re-pulling.

Docker Compose (Recommended)

latest or major-version tag:

docker compose pull && docker compose up -d

This pulls the newest matching image and recreates the container with your existing volumes. Your data is untouched.

Pinned full-version tag:

Edit docker-compose.yml, update the tag in the image: line (e.g. 4.0.0 → 4.0.1), then redeploy:

docker compose up -d

Docker Run

If you started TREK with docker run, pull the new image and replace the container:

docker pull mauriceboe/trek
docker rm -f trek
docker run -d --name trek -p 3000:3000 \
  -v ./data:/app/data \
  -v ./uploads:/app/uploads \
  -e ENCRYPTION_KEY=<your-key> \
  --restart unless-stopped \
  mauriceboe/trek

Tip: Not sure which volume paths you used? Check before removing:
docker inspect trek --format '{{json .Mounts}}'

Helm (Kubernetes)

⚠️ Chart repository moved: The Helm chart is no longer served at https://mauriceboe.github.io/TREK (the project moved from a personal repo to the liketrek organization). The canonical chart URL is now https://chart.liketrek.com — a custom domain (CNAME) for the GitHub Pages site at https://liketrek.github.io/TREK, so it stays stable even if the repository moves again. If your trek repo still points to an old URL, switch it before updating:
helm repo remove trek
helm repo add trek https://chart.liketrek.com
You can check which URL you have configured with helm repo list. Existing releases are unaffected — only the repo URL changes.

To update to the newest chart release:

helm repo update
helm upgrade trek trek/trek

Your existing values and PVCs (data, uploads) are preserved. To pin an exact chart version instead, pass --version <x.y.z>.

See Install-Helm for the full installation walkthrough and values reference.

Database Migrations

TREK runs any pending database migrations automatically at startup. No manual migration steps are required after pulling a new image.

Encryption Key Note

If you are upgrading from a version that predates the dedicated ENCRYPTION_KEY (i.e. you have no ENCRYPTION_KEY environment variable set), TREK automatically falls back to ./data/.jwt_secret on startup and immediately promotes it to ./data/.encryption_key. No manual steps are required — the transition is handled at first boot after the upgrade.

If you want to rotate to a new key at any point (not required for a normal update), see Encryption-Key-Rotation for the full procedure.

Proxmox VE (LXC)

If you installed TREK via the Proxmox VE Community Scripts, run the following command inside the LXC container and select Update when prompted:

bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/trek.sh)"

Tip: Always check the community-scripts TREK page to confirm the latest command before running.

The script stops the service, backs up your data and uploads, applies the new release, restores the backup, and restarts. No manual steps required.

To verify the update completed and check for errors:

# Inside the container (pct enter <id> from the Proxmox shell)
journalctl -u trek -n 50

Portainer

Open the Stacks list, click the TREK stack, then click Redeploy.

latest or major-version tag — enable the Re-pull image and redeploy switch before confirming. Portainer pulls the newest matching image and recreates the container.

Pinned full-version tag (e.g. 4.0.0) — edit the stack, update the tag in the image: line, then click Update the stack. No re-pull switch needed; the tag change forces a fresh pull.

See Install-Portainer for the full installation walkthrough.

Unraid

In the Unraid Docker tab, click the TREK container and select Update. Unraid will pull the latest image and restart with the same volumes.

Next Steps

Backups — schedule automatic backups so you always have a restore point before updates
Encryption-Key-Rotation — if you need to rotate or migrate the encryption key
Install-Docker-Compose — switch to Compose for easier future updates

5.4 KiB Raw Blame History