Self-host Trek with Docker Compose

Plan trips that actually happen.

This is still a work in progress.

The generated compose file and instructions may not be complete or correct for every app yet. Please report any issues you encounter to contact@bitflake.com.

The steps below take a few minutes end to end.

Docker compose setup and file
save the generated compose and env files.
Secret generation
create the random passwords Trek needs.
Start Trek with Docker Compose
bring the stack up and check it's healthy.

Requirements

You'll need these installed on the machine you're deploying to:

Docker

Packages Trek and everything it depends on into an isolated container, so it runs the same way on your machine as it does everywhere else.

Install guide

Docker Compose

Reads docker-compose.ymland starts everything in it together. Ships with Docker Desktop. On Linux servers it's usually a separate install.

Install guide

1. Docker compose setup and file

Create a folder for Trek and save the file below into it as docker-compose.yml. It describes every container the stack needs — Trekitself and any supporting services, such as its database — along with the ports, volumes and environment variables each one uses. You'll also need an empty .env file in the same folder; Docker Compose reads it automatically and uses it to fill in the ${VARIABLE}references you'll see in the file below.

docker-compose.yml

version: "3.9"
services:
  trek:
    image: mauriceboe/trek:latest
    restart: unless-stopped
    ports:
      - 3000:3000
    environment:
      DEMO_MODE: "true"
      ENCRYPTION_KEY: ${RANDOM_ENCRYPTION_KEY}
    volumes:
      - data:/app/data
      - uploads:/app/uploads
    command:
      - sh
      - -c
      - cd /app/server && exec node --require tsconfig-paths/register dist/index.js
    healthcheck:
      test:
        - CMD
        - curl
        - -f
        - http://localhost:3000/api/health
      interval: 10s
      timeout: 5s
      retries: 5
volumes:
  data: null
  uploads: null

Volumes

Trek stores its data in named Docker volumes, so it survives container restarts and updates:

data mounted at /app/data
uploads mounted at /app/uploads

2. Secret generation

Trek needs a few randomly generated secrets — for example, database passwords or an internal session key — before it can start. These are referenced from docker-compose.ymlabove but don't live in it, so they need to end up in your .env file. Pick one of the two options below.

Generating secrets…

3. Start Trek with Docker Compose

From the folder with docker-compose.yml and .env, run:

Terminal

Start Trek and all its supporting services in the background.

docker compose up -d

The -d flag runs the stack in the background so it keeps running after you close the terminal. Docker will pull the images the first time, which can take a minute or two.

To check on it afterwards: docker compose ps shows whether containers are healthy, and docker compose logs -f follows their logs if something looks wrong. Once it's running, open http://localhost:3000 in your browser.