Misc

Backup

If you need to restore a backup, do not fret. It is incredibly easy. There are two ways to approach a backup. First, if you are seeing errors on an update to a new version, you can get an old version of your database from config/temp/version/kavita.db. This is a quick backup that occurs when database migrations are needed on an upgrade. You can just copy and paste this over your database in config/ and retry.

If you however have some bad data and need to restore, then check config/backups for a zip of all user data. The scheduled backup (server settings) will save your database, appsettings.json, covers, themes, and bookmarks. You just need to copy and paste these over the config folder and restart.

Misc information about Metadata

Publication Status

Kavita will set the Publication Status on a series for you based on the underlying ComicInfo. If you have at least one ComicInfo with the Count property, then Kavita will at least mark the series as Ended. Kavita will also check if the number of Volumes or Chapters matches this exactly and if so, will mark the series as Completed. This logic will only run if the field is not locked. At any time you can hover over the tag badge in Series Detail to view how many issues or volumes you are missing.

Format

Kavita will take the following Format tags from ComicInfo and use them to treat the file as a special:

  • Special
  • Reference
  • Director's Cut
  • Box Set
  • Box-Set
  • Annual
  • Anthology
  • Epilogue
  • One Shot
  • One-Shot
  • Prologue
  • TPB
  • Trade Paper Back
  • Omnibus
  • Compendium
  • Absolute
  • Graphic Novel
  • GN
  • FCBD

Api Documentation

To view Kavita's API documentation, you will need to 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 readers

These are only the guides for some of them.

Access the list of external readers here

Tachiyomi

Access the guide for Tachiyomi here

External tools

Comic Tagger

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

Go to comic tagger repo

Calibre

Lets you add metadata to ebooks.

Go to Calibre's main page

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.

Manga Manager

Currently in development.

  • Change covers for individual cbz (changes the first image of the file)
  • Rename files to include volume info

Go to Manga Manager repo