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, including when Metron search is enabled because Metron results are mapped to ComicVine before import. Manga-only libraries can use MangaDex; MyAnimeList can provide primary manga metadata when enabled with a client ID, while MangaDex still supplies chapters.
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>On Docker, retrieve it from the container logs:
docker logs comicarr 2>&1 | grep SETUPEnter 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 MangaDex, or enable MyAnimeList with a client ID alongside MangaDex for chapter data; see the Manga guide.
Configure download clients and indexers
Supported clients:
| Type | Clients |
|---|---|
| Usenet | SABnzbd, NZBGet, NZB blackhole |
| Torrent | qBittorrent, Deluge, Transmission, rTorrent, uTorrent |
| Direct | Mega, MediaFire, Pixeldrain, GetComics |
Pick your NZB client under Settings → Download clients. SABnzbd's URL, API key, category, and download directory are editable there; NZBGet, blackhole, and every torrent client are configured in config.ini.
For indexers, Newznab providers are added and edited under Settings → Search → Usenet indexers, and Torznab providers under Settings → Search → Torrent indexers (since v0.33.0). See Search Providers for the master switches Torznab needs and a worked Prowlarr/Jackett example.
Once something is configured, Settings → Acquisition tells you whether any search route is actually usable, and names what is missing when none is.
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 tab | What you can configure in the UI |
|---|---|
| General | Content sources, naming preferences (library paths are shown read-only) |
| Interface | Theme and UI options |
| API & providers | Comicarr API key, ComicVine, Metron, MangaDex, MyAnimeList |
| Search | Newznab and Torznab indexers (add / edit / enable), preferred quality, size filters |
| Acquisition | Route readiness, worker and backlog status, evidence-driven repair |
| Media | Media management / post-processing options exposed in the UI |
| Notifications | Notification providers |
| Download clients | NZB client selection; SABnzbd URL, API key, category, directory |
| AI | BYOK LLM endpoint and limits |
| Logs | Log level dial and an in-app viewer for comicarr.log |
| About | Version, diagnostics, and Support bundle |
Everything else (NZBGet/blackhole/torrent client credentials, OPDS, many advanced options) lives in config.ini.