Docker Compose Documentation

This README describes how to use the Starr Docker Compose configuration.

Overview

This Docker Compose configuration defines a Starr app stack for media management and dashboard access. It includes services for requests and automation (seerr, radarr, sonarr, prowlarr), torrent downloading (transmission), and a service dashboard (heimdall), with optional Plex support.

Services

seerr

• Overseerr-compatible request management for media libraries.
• Provides a web UI for users to request movies and TV shows and for admins to approve or deny requests.

radarr

• Movie collection automation for searching, downloading, and organizing films.
• Integrates with download clients to automatically acquire and manage movie files.

sonarr

• TV series automation for searching, downloading, and managing shows.
• Tracks episodes and seasons, then works with download clients to keep your library updated.

prowlarr

• Indexer manager for Sonarr, Radarr, and other Starr services.
• Aggregates torrent and Usenet indexers, making them available to the automation apps.

transmission

• BitTorrent client for downloading and seeding torrent files.
• Handles torrent downloads, uploads, watch folders, and web-based remote management.

heimdall

• Application dashboard for organizing links to your services.
• Provides a centralized portal to quickly access each containerized service.

plex (commented out)

• Media server for streaming movies, TV shows, and music to clients.
• Can be enabled to serve local media libraries over the network.

Setup Directories

• movies
• tv (or series, whether you prefer)
• downloads
  • complete
  • incomplete
• watch (required by Transmission to monitor directory for external torrent files).

Common Sections

• services - defines each container and its configuration.
• image / build - specify a prebuilt image or build context.
• ports - map service ports to the host machine.
• volumes - mount project files or persistent storage.
• environment - define environment variables for each service.
• depends_on - specify service startup order.

Example Workflow

1. Ensure Docker is installed and running.
2. Place the docker-compose.yml file in the project root.
3. Run docker compose up --build to build and start the containers.
4. Open the application at the configured host port.
5. Run docker compose down when finished.

Basic Commands

• docker compose up - start all services defined in docker-compose.yml.
• docker compose up -d - start services in detached mode.
• docker compose down - stop and remove containers, networks, and volumes created by Compose.
• docker compose logs -f - follow logs from all services.
• docker compose ps - list running Compose services.

Notes

• Check the Docker Compose file for service names and ports before connecting.
• Replace config mount volumes with external volumes.
• Remove Plex Claim env variable.
• Create directories to mount and keep your media/config after each restart.
• Use docker compose restart <service> to restart an individual service.
• Avoid removing your volume contents by keeping -v out when stopping services.
• If you change service configuration, rerun docker compose up --build.