Misc

Api Documentation

v0.6.1.7+ no longer supports enabling swagger on Kavita installations. It can be used on dev builds or you can use our API documentation.

Pre-v0.6.1.6

To view the documentation you have to enable swagger in settings and head to http://localhost:5000/swagger or use https://www.kavitareader.com/docs/api/#/

Alternatively you can build Kavita on your local machine and then browse to the Swagger UI at http://localhost:5000/swagger/. Kavita uses JWT for authentication, and thus you must attach your JWT key to Swagger to test against your local instance.

You can get your JWT by opening dev tools on a browser you have authenticated against and getting this key "kavita-user" from local storage. This will have a token key within it. Use "Bearer TOKEN_KEY" to authenticate. This must be on all APIs for Kavita to respond.

External tools

Both MangaManager and ComicTagger work with comic files and manga files. They have different UI with different features

✯ Kavita recommends

Manga Manager

  • Actively developed.
  • Currently, only supports .cbz
  • Extremely fast editings
  • Bulk updates via GUI and CLI
  • Allows for metadata scraping (currently limited to AniList and MangaUpdates, but more coming soon)
  • Change covers and backcover (changes the first and last image of the file)
  • Metadata editor with clear UI (allows bulk selection)
  • Support for CLI usage
  • Webp Converter
  • Docker support for headless systems

Go to MangaManager repo

Comic Tagger

  • Import metadata from online metadata sources for comics (ComicVine only)
  • Edit ComicInfo.xml for both cbz and cbr
  • Option to bulk edit using CLI

Go to comic tagger repo

Calibre

  • EPUB metadata editor
  • Can scrape from online and write Calibre-specific tags (which Kavita reads for grouping)
  • Powerful but steep learning curve. Need to export books so opf file is written within the EPUB for Kavita to read properly.
  • Site

Calibre Metadata

Edit your metadata making sure to set the Series and Number correctly so that Kavita groups the volumes of a Series together. Calibre%20Metadata Kavita%20Calibre%20Bobiverse

Then under Preferences change the Save to Disk settings to: Screenshot%202022-02-03%20162818

Next, use the Save to Disk option and import those files into your Kavita library location.

Sigil

  • EPUB metadata editor which has tools to ensure the epub matches the spec (fixes corrupt epub metadata).
  • Supports a number of plugins to enhance experience
  • Site

Komf

  • Separate server that listens to Series Add events from Kavita and can scrape a number of configurable sources
  • Actively developed with support from the developer in Kavita discord
  • Supports writing directly to Kavita's DB via the API or saving to ComicInfo.xml inside files.
  • Site

External readers

These are only the guides for some of them.

OPDS

Access the list of external readers here

Go to opds wiki page

Tachiyomi

Access the guide for Tachiyomi here

CDisplayEx

Access the guide for CDisplayEx here

Paperback

Access the guide for Paperback here

Aidoku

Access the guide for Aidoku here