Skip to content

General

Host

This section defines how Kapowarr binds to a IP/port when starting up. Any setting here requires you to restart Kapowarr after saving it for it to apply.

Bind Address

This tells Kapowarr what IP to bind to. If you specify an IP that is not on the machine running Kapowarr, you will encounter errors.
Using 0.0.0.0 will have Kapowarr bind to all interfaces it finds on the host machine.

Note: this setting is not applicable if you have Kapowarr deployed using Docker.

Port Number

This tells Kapowarr what port to listen on. The default is 5656, which would put the Kapowarr UI on http://{HOST}:5656/.

If you have Kapowarr deployed using Docker, do not change this setting but instead follow the instructions below:

Alter the command to run the container by replacing -p 5656:5656 with -p {PORT}:5656, where {PORT} is the desired port (e.g. -p 8009:5656). Run the container with the new version of the command (you will need to remove the old container if you had it running before).

Alter the file to run the container and replace - 5656:5656 with - {PORT}:5656, where {PORT} is the desired port (e.g. - 8009:5656). Then re-run the container with the new version of the file.

  1. Open Containers and locate the kapowarr container in the list.
  2. Click the stop button on the right, then the delete button.
  3. Follow the instructions for launching the container, starting from step 3. At step 6, set the value to the desired port. For example, if you set it to 8009, the web-UI will then be accessible via http://{host}:8009/. Continue following the rest of the steps.

Base URL

This is used for reverse proxy support - the default is empty. If you want to put Kapowarr behind a proxy (so you can access the web-UI via a nice URL), set a Base URL (it must start with a / character).

To get Kapowarr running on http://example.com/kapowarr, you would set your reverse proxy to forward the /kapowarr path to the IP and port of your Kapowarr instance, and set Base URL to /kapowarr.

Security

Login Password

You might want to set a password to restrict access to the web-ui (and API). This is optional, but highly recommended if you are exposing Kapowarr to the internet. If you want to disable the password, set an empty value for the setting and save.

API Key

This is where Kapowarr defines the API key for any queries made to the Kapowarr API.

Comic Vine API

Comic Vine API Key

Kapowarr uses ComicVine as its metadata source. To fetch the metadata from ComicVine, Kapowarr needs access to the API, which requires an API key.

  1. Go to the API page of ComicVine.
  2. If you don't have a free account at ComicVine already, sign up and once logged in, revisit the linked page.
  3. You'll see your ComicVine API key, which is 40 characters long and contains the letters a-f and numbers 0-9 (e.g. da39a3ee5e6b4b0d3255bfef95601890afd80709).
  4. Copy that API key and set it as the value in the web-UI. Don't forget to save.

On the documentation page about rate limiting, information can be found about the handling of the ComicVine API rate limit.

UI

Theme

The default theme is "Light". If you like dark mode, select "Dark".

Logging

Log Level

The default log level is 'Info'. This means that only things that would appear in a console (or stdout) get logged. If you are troubleshooting or want to share logs, setting this to 'Debug' will make the system log what it's doing in much more detail.

Note that this should be set to 'Info' when not debugging, as Kapowarr logs so much in 'Debug' mode that it could slow down operation.

Download Logs

By clicking the button, a text file will be downloaded containing all the latest logs. This file can be used in case a large amount of logs need to be shared (as it would be impractical to paste everything in a comment).