Installation

Install Comicarr using Docker Compose.

Docker is the primary and recommended way to run Comicarr.

Quick Start

Create a docker-compose.yml file:

docker-compose.yml
services:
  comicarr:
    image: ghcr.io/frankieramirez/comicarr:latest
    container_name: comicarr
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/New_York
    volumes:
      - ./config:/config
      - /path/to/comics:/comics
      - /path/to/manga:/manga
      - /path/to/downloads:/downloads
    ports:
      - 8090:8090
    restart: unless-stopped
    stop_grace_period: 30s

Start the container:

docker compose up -d

Comicarr is now running at http://localhost:8090.

Environment Variables

VariableDescriptionDefault
PUIDUser ID for file permissions1000
PGIDGroup ID for file permissions1000
TZTimezone (list)America/New_York

Synology NAS

On Synology, use PUID=1026 and PGID=100 to match the default admin user.

Volumes

MountDescription
/configDatabase, logs, and application settings. Back this up.
/comicsYour comic book library. Comicarr organizes files here.
/mangaYour manga library. Used for MangaDex downloads.
/downloadsStaging area for downloads before post-processing. Point your download client here.

Next Steps

On this page