Getting Started
This guide will help you install Tracearr and connect your first media server.
Requirements
- A running Plex, Jellyfin, or Emby media server
- API access to your media server (API key or token)
- Docker installed (for self-hosted deployments)
Choose Your Install Method
| Method | Best for |
|---|---|
| Docker Compose | Terminal users running docker compose on the command line |
| Docker UI | Portainer, Dockge, or similar web-based Docker management tools |
| Supervised | Unraid and other bare-metal hosts where separate containers aren’t practical |
| Kubernetes | Helm-based deployments on any Kubernetes cluster |
| Railway | Cloud hosting with no server to manage |
Not sure? Docker Compose is the recommended default. If you manage Docker through a browser, pick Docker UI. If you’re on Unraid, check the Community Apps tab first — Tracearr is available there as a one-click install.
Community Integrations
Tracearr is also available on these platforms through community-maintained scripts and catalogs:
- Unraid Community Apps — Search for “Tracearr” in the Apps tab
- Proxmox VE — Community helper script for LXC containers
The Tracearr listing in the TrueNAS app catalog is not maintained by the Tracearr developer. The catalog maintainers have modified dependencies and configuration without understanding Tracearr’s architecture, which has caused issues for users. We do not recommend installing Tracearr through the TrueNAS app catalog.
TrueNAS SCALE (24.10+) supports Docker Compose natively. You can deploy Tracearr using the Docker UI guide — either through TrueNAS’s built-in Custom App feature or by installing Portainer or Dockge from the TrueNAS app catalog.