comicarr/comicarr repository overview

⁠Comicarr

Comicarr is a self-hosted comic book and manga manager. Monitor series, find new issues through your search providers, and organize downloads into your library. Import an existing collection or migrate from Mylar3.

Quick start⁠ · First-run setup⁠ · Docs⁠ · Help⁠ · Website⁠

⁠What it does

• Build your collection. Track missing issues, import files with interactive matching, and organize weekly releases and story arcs. Keep comic and manga libraries in separate folders.
• Find releases. Automate searches or review candidates and match reasons before grabbing. Multi-issue and multi-volume packs can cover several missing entries with one download.
• Follow each download. Watch searches and grabs in the activity feed. Use Needs Attention to investigate failed downloads and files that never reached the library.
• Connect your tools. Serve an optional OPDS catalog to compatible readers, use the REST API, or configure optional AI assistance with your own endpoint and credentials.

Comicarr builds on Mylar3⁠, with a React frontend, light and dark themes, and a FastAPI backend.

⁠Quick start

Docker Compose is the recommended installation method. Images support amd64 and arm64. Create a docker-compose.yml file:

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

Replace the host paths with your folders. Set PUID and PGID to the user and group that can write to them, and choose your timezone. The repository compose file⁠ includes migration and logging options.

Comicarr stores its database, settings, logs, and encryption keys under /config/comicarr inside the container (./config/comicarr with this example). Keep that directory persistent and back it up before upgrades or migration. Your download client and Comicarr must see the same completed files. Mount the same host downloads folder in both containers at /downloads and configure the client's completed-download directory accordingly.

Start Comicarr:

docker compose up -d

Open http://localhost:8090, or http://<server-address>:8090 for a remote server. For source installs, follow the local setup guide⁠. Install Python dependencies with uv sync (recommended) or pip install ..

⁠First-run setup

1. Read the setup token from the container logs:

   docker compose logs comicarr
   

   Copy

   Find [SETUP] Setup token: ... and enter it when the setup form asks. Create your admin account with a password of at least eight characters. Comicarr restarts after saving the account.

2. Configure metadata in Settings → API & providers. Comic libraries need a ComicVine API key⁠, including when using Metron search. Manga-only libraries can use MangaDex or MyAnimeList; MyAnimeList requires a client ID.

3. Set your library paths and configure a search/download route. Some clients require config.ini; follow the initial setup guide⁠. Settings → Acquisition shows which routes work and what is missing.

To migrate from Mylar3, back up the old installation, mount its entire config directory read-only at /mylar3, and use the onboarding wizard. See the migration guide⁠ before starting.

⁠Images and updates

Use ghcr.io/frankieramirez/comicarr as the canonical image; comicarr/comicarr on Docker Hub is a mirror. To pin a release, use the version from GitHub Releases⁠ as the image tag, omitting the leading v.

After backing up, update the image with docker compose pull, then recreate the container with docker compose up -d. A pull alone leaves the running container unchanged. See updating⁠ for details.

⁠Documentation

Browse the full documentation⁠ for library, manga, reading, and deployment guides.

⁠Contributing and support

For setup problems, start with troubleshooting⁠. Report a bug⁠ with your version and installation method. You can create a Support bundle in Settings → About; review its files before attaching it publicly. Feature requests⁠ have their own template.

See CONTRIBUTING.md⁠ for development setup and checks, and the Code of Conduct⁠ for community guidelines. Report vulnerabilities privately using the security policy⁠.

⁠Attribution and license

Comicarr builds on the Mylar3 team's work on comic management, downloading, and post-processing. It is licensed under the GNU General Public License v3.0⁠, like Mylar3.