KomgaInstall

Summary

Update a Komga library's configuration and scanning/import options.

Inputs

• libraryId (required) — Library to update (resource locator, ID mode).
• name — The name of the library.
• root — The root path of the library.
• analyzeDimensions — Whether to analyze image dimensions.
• convertToCbz — Whether to convert files to CBZ format.
• emptyTrashAfterScan — Whether to empty trash after scanning.
• hashFiles — Whether to hash files.
• hashKoreader — Whether to hash for Koreader.
• hashPages — Whether to hash pages.
• importBarcodeIsbn — Whether to import barcode ISBN.
• importComicInfoBook — Whether to import ComicInfo.xml for books.
• importComicInfoCollection — Whether to import ComicInfo.xml for collections.
• importComicInfoReadList — Whether to import ComicInfo.xml for readlists.
• importComicInfoSeries — Whether to import ComicInfo.xml for series.
• importComicInfoSeriesAppendVolume — Whether to append volume to series when importing ComicInfo.
• importEpubBook — Whether to import EPUB metadata for books.
• importEpubSeries — Whether to import EPUB metadata for series.
• importLocalArtwork — Whether to import local artwork.
• importMylarSeries — Whether to import Mylar metadata for series.
• oneshotsDirectory — Directory for oneshot comics.
• repairExtensions — Whether to repair file extensions.
• scanCbx — Whether to scan CBX files.
• scanDirectoryExclusions — Directories to exclude from scanning.
• scanEpub — Whether to scan EPUB files.
• scanForceModifiedTime — Whether to force modified time scanning.
• scanInterval — Scan interval schedule.
• scanOnStartup — Whether to scan on startup.
• scanPdf — Whether to scan PDF files.
• seriesCover — Which cover to use for series.
• requestOptions — API request configuration including batching, proxy, timeout, and SSL validation.

Output shape

The Komga API returns the updated library object upon successful update.

All boolean parameters default to false when not provided. The requestOptions object supports batching, proxy, timeout, and SSL certificate bypass configuration.

Examples

Example 1: Update library name and scanning options.

libraryId: 'lib-123', name: 'My Library', scanPdf: true, scanEpub: true, seriesCover: 'FIRST_UNREAD_OR_FIRST'