Docker Compose Template

Before deploying this template, ensure you have the following infrastructure ready:

• A VPS with Docker installed: Follow the official instructions at https://get.docker.com.
• Open Ports: Ports 80 and 443 must be open on your VPS firewall.
• Domain & DNS:
  • You need a domain with DNS records pointing to your VPS IP for every subdomain you intend to use.
  • Free options like DuckDNS or Afraid.org are supported.
  • Recommended: Use Cloudflare for your nameservers. This allows you to use the included cloudflare-ddns profile to automatically maintain DNS records, which is not possible with DuckDNS or Afraid.org.

Follow these steps to clone the repository and perform the initial configuration:

1. Clone the repository: Navigate to /opt and clone the repo into a docker directory.

   cd /opt
   git clone https://github.com/Viren070/docker-compose-vps-template.git docker
   cd docker

2. Configure Environment Variables: Open the .env file located in the apps folder. You can use nano or a remote editor like VS Code with the Remote - SSH extension.

   nano .env

3. Start Core Services: After filling in the initial values in the root .env, start only the essential services (Authelia and Traefik) using the required profile:

   docker compose --profile required up -d

Radarr services are organized into Docker Compose profiles. This allows you to selectively start specific instances rather than all of them at once.

• radarr profile: Includes the standard radarr, radarr4k, and radarranime services.
• all profile: Includes all services in the template.

To start only the Radarr-related services, use the --profile flag with Docker Compose.

docker compose --profile radarr up -d

Sonarr services are organized into Docker Compose profiles:

• all: Includes all Sonarr services (sonarr, sonarr4k, and sonarranime).
• sonarr: Includes only the sonarr4k service.

Dependencies: All Sonarr services depend on the decypharr service. The Sonarr containers will only start once decypharr reaches a healthy state.

The autosync service depends on the following services being in a healthy state before it starts:

• sonarr
• sonarr4k
• sonarranime
• radarr
• radarr4k
• radarranime

AioStremio is deployed as a service named aiostremio which depends on a Redis instance (aiostremio_redis) for caching. The service uses the viren070/aiostremio:latest image. To run this service, you must include the aiostremio or all profile in your docker-compose command. The service is configured to be accessible via Traefik with automatic TLS via Let's Encrypt and authentication via Authelia.

docker compose --profile aiostremio up -d

To enable hardware-accelerated machine learning inference in the immich_machine-learning service, follow two steps:

1. Update the Image Tag: Append the appropriate hardware suffix to the image tag. Supported suffixes are armnn, cuda, rocm, openvino, or rknn. Example: ${IMMICH_VERSION:-release}-cuda.

2. Uncomment the Extends Block: Uncomment the extends section in compose.yaml and select the corresponding service from hwaccel.ml.yml.

Available services for inference:

• armnn
• cuda
• rocm
• openvino
• openvino-wsl (use for WSL2 where applicable)
• rknn

immich_machine-learning:
    image: ghcr.io/immich-app/immich-machine-learning:${IMMICH_VERSION:-release}-cuda
    # ...
    extends:
      file: hwaccel.ml.yml
      service: cuda # set to one of [armnn, cuda, rocm, openvino, openvino-wsl, rknn]

The compose.yaml file defines three distinct service variants. You can control which ones are deployed using Docker Compose profiles.

Available Services

1. blackhole: The standard service.
2. blackhole4k: Optimized for 4K media, requiring sonarr4k and radarr4k to be healthy.
3. blackholeanime: Optimized for anime media, requiring sonarranime and radarranime to be healthy.

Deployment Commands

To start all services (including those in the all profile):

docker compose --profile all up -d

To start only the Blackhole-related services:

docker compose --profile blackhole up -d

The xrdb service is associated with the xrdb and all profiles. To start this specific service, you must include the profile in your docker compose command.

# To start only the xrdb service
docker compose --profile xrdb up -d

# To start all services including xrdb
docker compose --profile all up -d

The aiomanager service runs the AI Manager application. It is configured to use an .env file for environment variables and requires a ${DOCKER_DATA_DIR} variable to be defined for persistent storage. By default, it exposes port ${PORT:-1610}.

To run this service specifically, use the aiomanager profile. It is also included in the all profile.

services:
  aiomanager:
    image: ghcr.io/sonicx161/aiomanager:latest
    container_name: aiomanager
    restart: unless-stopped
    expose:
      - ${PORT:-1610}
    env_file:
      - .env
    volumes:
      - ${DOCKER_DATA_DIR}/aiomanager/data:/app/data
    profiles:
      - aiomanager
      - all