Admin Settings
Libraries

Libraries Tab

Library

The libraries tab is how you make your own content available to your users.

Managing Libraries

LibraryStatus

The name of the library is highlighted in green. Clicking on it will send you to the series view inside the library.

Type is one of 4 options:

Manga
Comic
Book
Image

Shared folders tell you how many source folders you have linked to this library. A single library can contain more than 1 folder on disk to merge libraries.

Last Scanned: Will give you the timestamp that the last scan occurred.

Adding Libraries

To add a library click on the "Add Library" button

LibraryAdd

General

LibraryAddScreen Fill out the name you want your library known by. This is what you will select when adding libraries to users.

Select the type of library you are trying to create from the dropdown, then press next.

️⚠️

Read up on the different types of libraries you can make and the rules that govern them here: !! ADD LINK !!

Folders

LibraryAddFolders

Pick the folders you want added to your library using the folder picker. A library can contain more than 1 folder. This is useful if you have your files spread out across multiple hard drives or network shares. It is not recommended to directly select a series folder.

🐳

Docker users: If you don't see your mounted folder at first make sure to check / for it.

Library Cover

LibraryAddCovers

This step isn't required but allows you to upload a small cover image to use to customize the icon when the library is displayed.

Using too large of a file here can slow down the server. 32x32 is recommended

Advanced Settings

LibraryAdvanced

File types

This controls what kind of files the scanner will look for when adding to the library. Use this for example if you want to turn off PDF's from showing up in a comic library. Or if you're having cover.jpg's creating a new series, you can turn off 'image'.

Exclude Patterns

LibraryAdvancedGlob

In the example above, any file within a folder named One Piece from the library root will be ignored.

More advanced customization of excludes is accomplished by glob patterns (opens in a new tab)

  • Patterns without the forward-slash ' /' character (e.g. *.cbz) match filenames
  • Patterns with the forward-slash '/' character (e.g. somedir/*) match directory and file patterns
  • **/folder/* will ignore the folder at any depth in a path

Manage Collections

Set to create Collections from SeriesGroup tags found within ComicInfo.xml or epub metadata.

Manage ReadingLists

Set to create Reading Lists from StoryArc/StoryArcNumber and AlternativeSeries/AlternativeCount tags found within ComicInfo.xml or epub metadata.

Allow Scrobbling

ℹ️

This feature requires an active Kavita+ subscription to use.

This controls if your users can scrobble series that are found in this library.

Folder Watching

⚠️

Folder watching takes 10 minutes to trigger once a change is detected.

Folder watching is enabled by default and watches each folder of a given library for modifications.

Folder watching lets Kavita know when a file has been added or modified in your library and update it in your Kavita instance. When files are added (loose images or non-supported extensions are ignored), renamed, deleted, etc, Kavita takes note and queues a Scan.

Overrides server folder watching for this library. If off, folder watching won't run on this library. If libraries share folders, then folders may still be run against.

🐳

Docker on Windows over WSL2 does not support folder watching. See Issue on Gihtub (opens in a new tab)

Include in Dashboard

Should series from the library be included on the Dashboard? This affects all cards like On Deck, Recently Updated, Recently Added, or any custom additions.

Include in Recommended

Should series from the library be included on the Recommended page?

Include in Search

Should series and any derived information (genres, people, files) from the library be included in search results?