Initial Setup

First-run configuration for Comicarr.

After installing Comicarr, follow these steps to get your library up and running.

ComicVine API key required for comics

Comicarr uses ComicVine for comic metadata — series info, issue details, cover art, and story arcs. Comic features need an API key. Manga-only libraries can use MangaDex / MyAnimeList instead.

Access the UI

Open http://localhost:8090 in your browser. You'll be greeted with the first-run setup screen.

Create your admin credentials

Set a username and password (minimum 8 characters). Passwords are stored as bcrypt hashes.

On first run, Comicarr generates a setup token and prints it to the server console / container logs:

[SETUP] *** First-run setup required ***
[SETUP] Setup token: <token>

Docker installs run in quiet mode, so the token is also written to stdout. Retrieve it with:

docker logs comicarr 2>&1 | grep SETUP

Enter the token on the setup form when prompted, along with your username and password. Comicarr restarts after credentials are saved.

Optional: migrate from Mylar3

If your database is empty, the onboarding wizard can import a Mylar3 library. For Docker, mount your Mylar3 config directory read-only (see docker-compose.yml comments, typically at /mylar3). Full details: Migration.

Add your ComicVine API key

Get a free API key from comicvine.gamespot.com/api. You'll need a free Comic Vine account.

Enter the key in Settings → API & providers. Comic features won't work without it. (Manga users can configure MyAnimeList or MangaDex instead — see the Manga guide.)

Configure download clients and indexers

Most download-client and indexer settings are edited in config.ini (the Download clients Settings tab is currently read-only). Supported clients:

TypeClients
UsenetSABnzbd, NZBGet, NZB blackhole
TorrentqBittorrent, Deluge, Transmission, rTorrent, uTorrent
DirectMega, MediaFire, Pixeldrain, GetComics

Newznab / Torznab providers are also configured in config.ini. See the Configuration reference for keys and examples.

Docker config path: /config/comicarr/config.ini (host: ./config/comicarr/config.ini with the default compose volume).

API key for external tools

An API key is auto-generated on first startup. View or regenerate it under Settings → API & providers. See the API documentation for which endpoints accept it.

Add your first series

From the Library page in the sidebar, click Add (top-right, shortcut N) to open the Search page. Search by name, select a result, and choose what to monitor. Comicarr will begin searching for missing issues or chapters automatically.

See the Adding Series guide for a full walkthrough.

Settings map

Settings tabWhat you can configure in the UI
GeneralContent sources, naming preferences (library paths are shown read-only)
InterfaceTheme and UI options
API & providersComicarr API key, ComicVine, Metron, MangaDex, MyAnimeList
SearchPreferred quality and size filters
MediaMedia management / post-processing options exposed in the UI
NotificationsNotification providers
Download clientsRead-only status of configured clients
AIBYOK LLM endpoint and limits
AboutVersion and diagnostics

Everything else (download client hosts/credentials, Newznab/Torznab, OPDS, many advanced options) lives in config.ini.

Next Steps

On this page