Docker Guide

Docker Deployment Guide

Quick Start

Basic Docker Run Command

docker run -d \
  --name=addarr \
  -v /path/to/config:/config \
  --restart unless-stopped \
  cyneric/addarr

Detailed Setup

Docker Compose (Recommended)

Create a docker-compose.yml file:

version: '3'
services:
  addarr:
    image: cyneric/addarr
    container_name: addarr
    volumes:
      - /path/to/config:/config
    environment:
      - TZ=Your/Timezone
      - PUID=1000
      - PGID=1000
    restart: unless-stopped
    networks:
      - media-network

Full Docker Run Command

docker run -d \
  --name=addarr \
  -v /path/to/config:/config \
  -e TZ=Your/Timezone \
  -e PUID=1000 \
  -e PGID=1000 \
  --restart unless-stopped \
  --network media-network \
  cyneric/addarr

Volume Mappings

Required Volumes

Volume	Description
/config	Contains configuration files

Permissions

• Set correct PUID/PGID to match your user
• Ensure write permissions on config directory

Environment Variables

Available Variables

Variable	Description	Default
TZ	Timezone	UTC
PUID	User ID	1000
PGID	Group ID	1000

Network Configuration

Connecting with Sonarr/Radarr

1. Create a Docker network:

docker network create media-network

2. Add all containers to the same network:

docker network connect media-network sonarr
docker network connect media-network radarr
docker network connect media-network addarr

Example Docker Compose with Full Stack

version: '3'
services:
  addarr:
    image: cyneric/addarr
    container_name: addarr
    volumes:
      - /path/to/config:/config
    environment:
      - TZ=Your/Timezone
      - PUID=1000
      - PGID=1000
    restart: unless-stopped
    networks:
      - media-network

  sonarr:
    image: linuxserver/sonarr
    container_name: sonarr
    volumes:
      - /path/to/sonarr/config:/config
      - /path/to/tv:/tv
    environment:
      - TZ=Your/Timezone
      - PUID=1000
      - PGID=1000
    networks:
      - media-network

  radarr:
    image: linuxserver/radarr
    container_name: radarr
    volumes:
      - /path/to/radarr/config:/config
      - /path/to/movies:/movies
    environment:
      - TZ=Your/Timezone
      - PUID=1000
      - PGID=1000
    networks:
      - media-network

networks:
  media-network:
    driver: bridge

Configuration

Path Mapping

When using Docker, ensure paths in config.ini match container paths:

[sonarr]
root_folder = /tv  # Path inside Sonarr container

[radarr]
root_folder = /movies  # Path inside Radarr container

Network Access

Use container names as hostnames:

[sonarr]
host = http://sonarr:8989

[radarr]
host = http://radarr:7878

Maintenance

Updating

# Pull new image
docker pull cyneric/addarr

# Stop and remove old container
docker stop addarr
docker rm addarr

# Run new container with same parameters
docker run ... # (your run command)

Backup

1. Stop container:

docker stop addarr

2. Backup config directory:

tar -czf addarr-backup.tar.gz /path/to/config

Logs

# View logs
docker logs addarr

# Follow logs
docker logs -f addarr

# Last 100 lines
docker logs --tail 100 addarr

Troubleshooting

Common Issues

1. Permission Problems

# Fix ownership
chown -R 1000:1000 /path/to/config

2. Network Issues

# Test network connectivity
docker network inspect media-network

# Check container DNS
docker exec addarr ping sonarr

3. Volume Mounting

# Verify mounts
docker inspect addarr | grep Mounts -A 20

Health Checks

# Check container status
docker ps -a | grep addarr

# View container details
docker inspect addarr

# Check resource usage
docker stats addarr