k1nq/TREK

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

Files

T

Maurice 5d04f9c400 fix(docker): move start-up into a script so an edited container still boots

The image carried its whole start-up sequence as one inline `sh -c` string
containing four single-quoted echo messages. Container management UIs render
Config.Cmd back into a text field and re-split it on submit with a quote-aware,
escape-unaware tokenizer, so editing a container in place — the usual way to
change an environment variable — shredded the quoting and left dash half an
if-block to parse. The container then died before Node started, with only
`TREK: 1: Syntax error: end of file unexpected (expecting "fi")` in the log:
the word TREK is the stranded fragment of the first echo, reported as $0.

The logic moves to server/scripts/entrypoint.sh unchanged, and CMD becomes a
single bare token, which has nothing left to mangle. A unit test pins that
shape — both exec-form lines parse, and every argv element stays one token
free of quotes and spaces — and the Dockerfile joins the test workflow's path
filter so that guard actually runs when someone edits it.

Closes #2374

2026-09-20 12:48:44 +02:00

5.0 KiB

Raw Blame History

Install: Portainer

Install TREK on Portainer using a Stack (Docker Compose).

Prerequisite

Portainer must be installed and connected to your Docker environment. Use Stacks — it supports Docker Compose and gives you the full compose syntax including environment variables, volumes, and restart policies.

Create a Stack

In Portainer, go to Stacks → Add stack.
Give the stack a name (e.g. trek).
Select Web editor and paste the compose file from docker-compose.yml.

Fill in the environment variables at the bottom of the page.

Click Deploy the stack.

Compose Content

See https://github.com/liketrek/TREK/blob/main/docker-compose.yml

Set at minimum ENCRYPTION_KEY, TZ, and ALLOWED_ORIGINS in the Environment variables section of the stack editor. Portainer's stack variables are only substituted into ${...} placeholders in the compose file, they are not injected into the container, and the shipped compose file interpolates exactly four: ENCRYPTION_KEY, TZ, LOG_LEVEL, and ALLOWED_ORIGINS.

Every other variable ships commented out, so setting it here does nothing. To use one — APP_URL, for example, which OIDC needs and which email notification links are built from — uncomment its line in the Web editor and put the value there directly, or change it to - APP_URL=${APP_URL:-} so the stack variable is picked up.

Change a variable later by editing the stack and redeploying it — never by editing the container in place. Portainer's container editor rewrites the container's start-up command as well, which leaves it unable to boot; see Troubleshooting.

Generate an encryption key with:

openssl rand -hex 32

Image Tags

Three tag strategies are available:

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 (e.g. 4) if you want automatic updates on redeploy. Use a full version tag (e.g. 4.0.0) if you want explicit control over which release runs.

Updating

How you update depends on the tag you chose:

latest or major-version tag — In Portainer, open the stack, click Redeploy, enable the Re-pull image and redeploy switch, then confirm. Portainer will pull the newest matching image and recreate the container.

Pinned full-version tag — Edit the stack, change the tag in the image: line (e.g. 4.0.0 → 4.0.1), then click Update the stack. No need to toggle the re-pull switch — a tag change forces a fresh pull.

Back up your data before any update. Go to Admin Panel → Backup or copy your ./data and ./uploads directories. See Backups.

Volumes

Stack-relative path	Container path	Contents
`./data`	`/app/data`	SQLite database, logs, encryption key
`./uploads`	`/app/uploads`	Uploaded files (photos, documents, covers, avatars)

Portainer resolves ./ relative to the stack's working directory. Confirm the paths under Stack details after deploying.

Named Volumes

You can use Docker named volumes instead of bind mounts. Named volumes are fully managed by Docker and not tied to a host path — a good fit for Portainer where the working directory can vary. See the Docker Compose volumes reference for all options.

Replace the volumes: block in the service and add a top-level declaration:

services:
  app:
    # ... (rest of service config unchanged)
    volumes:
      - trek_data:/app/data
      - trek_uploads:/app/uploads

volumes:
  trek_data:
  trek_uploads:

Portainer lists named volumes under Volumes in the sidebar, where you can inspect or back them up.

Next Steps

Environment-Variables — full variable reference
Reverse-Proxy — HTTPS configuration
Updating — update strategies across all install methods

5.0 KiB Raw Blame History