Initial Setup

First-run configuration for Comicarr.

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

ComicVine API key required

Comicarr uses ComicVine for all comic metadata — series info, issue details, cover art, and story arcs. You cannot add series without an API key.

Access the UI

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

Create your credentials

Set a username and password. Passwords must be at least 8 characters and are stored as a bcrypt hash.

An API key is automatically generated during first-run setup. You can find it later in Settings → Interface if you need it for external tools or scripts.

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. Comicarr uses this for all comic metadata lookups, so comic features won't work without it. (Manga users can skip this and configure MyAnimeList or MangaDex instead — see the Manga guide.)

Configure a download client

Connect at least one download client so Comicarr can send grabs. Supported clients:

TypeClients
UsenetSABnzbd, NZBGet
TorrentqBittorrent, Deluge, Transmission, rTorrent

Configure under Settings → Download clients. See the Configuration reference for full details on each client.

Add search providers

Add one or more Newznab (Usenet) or Torznab (torrent) indexers under Settings → Search. These are the sources Comicarr searches for downloads.

See Search Providers configuration for setup details.

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.

Next Steps

On this page