Once a library has been created, it is processed by Kavita so that all the files are matched to series and metadata is gathered. As time goes on, you’ll add and remove files to the libraries or make other changes that mean the library is no longer up-to-date. You can invoke the Scan libraries task from the actions menu to bring them up-to-date. Scan Library, and Refresh Metadata for a library do different things.
Scanning a library makes Kavita check its folders and sub-folders for new or removed items (books, archive files, etc). If new media is found, it then pulls it into the library. You can think of scanning as “check for new or changed content”. The Kavita Homepage and Library info, will not be updated until the scan is complete.
All files that have changed after a scan will have their metadata refreshed if applicable.
You should Scan Library Files if you have:
Scanning a Library is an automated task that by default runs once a day at midnight. You can invoke it at any given time from the Library actions menu from the UI.
Kavita will generate a library representation of your files on disk. A Kavita library does not represent exactly your folder structure. Kavita uses filenames and some limited folder names to parse out the series, volume, chapter, etc from the file and group them. Books like epub, will use the metadata within the epub to perform grouping.
Analysis is automatically performed when content is added to your Library. In rare cases, new versions of Kavita may update the media analysis capabilities to correct something or add the ability to detect new things. In those cases, content may be re-analyzed when you access it after the new server version is installed.
Whenever an item is added to one of your Libraries, Kavita performs some analysis on it to gather information. In addition, files analyzed will also be refreshed for metadata in the following conditions:
During analysis, artwork will automatically be grabbed from the media file. The first page will be used for poster/thumbnail type purposes unless a file named cover is within the archive. Epubs have cover images specified within the metadata.
You can analyze content in multiple ways: for a book, for a series, or even for an entire Library.
Look for the Action Menu icon of three vertical dots.
Note: Depending on the size of your Library, analysis may take a while.
Kavita is set by default to Scan all Libraries Daily (this can be changed under the General Tab in Admin Settings), and to perform a Database Backup Weekly.
Refreshing Metadata for a library, series, or individual book causes the metadata for the item to be refreshed, even if it already has metadata. You can think of refreshing as “update metadata for the requested item even if it already has some”.
You should refresh a library or individual item if:
Metadata is gathered from the following sources:
The metadata refresh is dependent of the type of Library created.
This will import the following fields from the filename into Kavita:
Numberas their Kavita equivalent
This will import the following fields from the .opf file for the Series info into Kavita.
Volumetags will be used to overwrite the title of the Series, in the form
<Series> (<Volume>), or just
Volumetag is not present or if the
1. If multiple values are present, the most frequent value from all books will be used.
Folders and File Structures FAQ starts here.