Skip to main content

Examples

Full Example​

A complete example demonstrating all Configarr features is available in our GitHub repository. This example includes:

  • Docker Compose configuration
  • Complete Sonarr and Radarr setup
  • Custom format configurations
  • Quality profile settings
  • Template usage

You can find the full example at: configarr/examples/full

Quick Start with the Full Example​

  1. Start the Arr containers:

    docker-compose up -d

    This will:

    • Create required networks
    • Launch Sonarr instance
    • Launch Radarr instance
    • Configure API keys using provided XML configs

  2. Run Configarr:

    docker-compose -f docker-compose.jobs.yml run --rm configarr

Access Points​

Once running, you can access the services at:

Cleanup​

To remove all containers and volumes:

docker-compose down -v