Skip to Content
Getting StartedInstallation

Installation

The recommended way to run Tracearr is with Docker Compose.

Docker Compose

We maintain ready-to-use Docker Compose files in the Tracearr repository :

FileDescription
docker-compose.pg18.yml Recommended — PostgreSQL 18 with TimescaleDB HA
docker-compose.example.yml Standard setup with PostgreSQL 16

Quick Start

# Download the recommended compose file curl -O https://raw.githubusercontent.com/connorgallopo/Tracearr/main/docker/examples/docker-compose.pg18.yml # Generate required secrets echo "JWT_SECRET=$(openssl rand -hex 32)" > .env echo "COOKIE_SECRET=$(openssl rand -hex 32)" >> .env # Start Tracearr docker compose -f docker-compose.pg18.yml up -d

Tracearr will be available at http://localhost:3000.

See the comments in the compose file for optional environment variables like TZ, PORT, LOG_LEVEL, and DB_PASSWORD.

Other Platforms

Tracearr is also available on these platforms:

The supervised image tag (ghcr.io/connorgallopo/tracearr:supervised) bundles TimescaleDB and Redis into a single container. This was developed specifically for Unraid and is only recommended for bare-metal installations where running separate database containers isn’t practical.

For all other environments (Docker Compose, Kubernetes, TrueNAS, Proxmox, etc.), use the standard latest tag with external TimescaleDB and Redis.

Next Steps

Once Tracearr is running, connect your first media server.

Last updated on