Komga API

The Komga API allows you to access your Trove library using popular manga and comic reading applications that support the Komga server standard. This guide will walk you through setting up the Komga API and connecting your favorite reading apps to your Trove collection.

What is the Komga API?

Komga is a popular media server for comics and manga. Trove provides a Komga-compatible API layer that enables Komga clients to access your Trove library. With the Komga API enabled in Trove, you can:

Browse your library from any Komga-compatible reading app
Read comics and manga directly on your mobile device
Access your collection from multiple devices seamlessly
Use apps like Mihon (formerly Tachiyomi), Komelia, Tachidesk, and many others
Stream individual pages instead of downloading entire files

Step 1: Enable the Komga API

First, let's enable the Komga API in your Trove settings.

Navigate to Settings > OPDS in Trove
Under Komga API, toggle Komga API Enabled to activate the service

Step 2: Get Your Komga API Base URL

Trove provides the Komga API at a dedicated endpoint:

Komga Base URL

URL: http://your-server:6060/komga
API Endpoints: /komga/api/v1/*
Compatibility: Works with Komga-compatible reading apps
Authentication: Requires OPDS user credentials (see Step 3)

You can copy this URL directly from the Komga API Endpoint section in your settings.

Step 3: Create OPDS Users for Authentication

The Komga API uses OPDS user credentials for authentication. To access your Komga API, you'll need to create dedicated OPDS user credentials.

In the OPDS Users section, click Add User
Fill in the user details:

Field	Description
Username	Choose a username for API access
Password	Create a strong password for this user

Click Create to create the OPDS user

Step 4: Configure Group Unknown Series (Optional)

Trove organizes books differently than Komga:

Komga: Libraries → Series → Books
Trove: Libraries → Books (with optional series metadata)

The Komga API automatically creates virtual "series" by grouping books with the same series name in their metadata.

Group Unknown Series Feature

When enabled, books without series metadata are grouped together:

Enabled (Default): Books without a series are grouped under a single "Unknown Series" entry
Disabled: Each book without a series appears as its own individual series

To configure this setting:

Navigate to Settings > OPDS in Trove
Under Komga API, toggle Group Unknown Series to your preference

Step 5: Connect Reading Apps

Now that your Komga API is configured, you can connect various reading apps to access your Trove library.

Popular Komga-Compatible Apps:

Koma (Android) - A fork of Mihon centered around comics
Mihon (Android) - Formerly known as Tachiyomi, a popular manga reader
Komelia (Multiple platforms) - Official Komga client
Tachidesk (Desktop) - Web-based manga reader with Komga support
TachiyomiSY (Android) - Tachiyomi fork with additional features
TachiyomiJ2K (Android) - Another Tachiyomi fork

General Connection Steps:

Open your reading app
Look for Add Source, Add Server, or Browse Sources settings
Find and select the Komga source/extension
Configure the Komga source:
- Server URL: http://your-trove-domain/komga
- Username: Your OPDS username
- Password: Your OPDS password
Save and browse your library

Example: Connecting Koma

Koma is a fork of Mihon. It is centered around comics and comes with a specialized Trove extension

Installing the Trove Extension

Open Koma
Tap Browse at the bottom navigation
Tap Extensions tab
Use the top menu icon to select Extension repos
Add https://github.com/farfromrefug/extensions-source/releases/latest/download/index.min.json. Then go back.
Find Trove in the list
Tap Install next to the Trove extension
Wait for the extension to install

Configuring the Trove Source

After installation, go back to the Sources tab in Browse
Tap the Trove source
Tap the settings icon (gear icon) in the top right
Enter your connection details:
- Address: http://your-trove-domain/komga
- Username: Your OPDS username
- Password: Your OPDS password
Tap OK or Save
Go back and tap Trove again to browse your libraries

Using Koma with Trove

Browse Libraries: See all your Trove libraries
Browse Series: View books grouped by series
Read Online: Stream pages without downloading entire books
Download: Download books for offline reading

Example: Connecting Mihon (formerly Tachiyomi)

Mihon is one of the most popular manga reading apps for Android with excellent Komga support.

Installing the Komga Extension

Open Mihon
Tap Browse at the bottom navigation
Tap Extensions tab
Find Komga in the list (or search for it)
Tap Install next to the Komga extension
Wait for the extension to install

Configuring the Komga Source

After installation, go back to the Sources tab in Browse
Tap the Komga source
Tap the settings icon (gear icon) in the top right
Enter your connection details:
- Address: http://your-trove-domain/komga
- Username: Your OPDS username
- Password: Your OPDS password
Tap OK or Save
Go back and tap Komga again to browse your libraries

Using Mihon with Trove

Browse Libraries: See all your Trove libraries
Browse Series: View books grouped by series
Read Online: Stream pages without downloading entire books
Download: Download books for offline reading

Example: Connecting Komelia

Komelia is the official Komga client with cross-platform support.

Open Komelia
Click Add Server or the + button
Enter your server details:
- Server URL: http://your-trove-domain/komga
- Username: Your OPDS username
- Password: Your OPDS password
Click Connect or Add
Browse your Trove libraries and series

Komga API Features

The Trove Komga API implementation provides comprehensive endpoints for accessing your library:

Available Endpoints

Libraries

List all libraries - GET /komga/api/v1/libraries
Get library details - GET /komga/api/v1/libraries/{libraryId}

Series

List series - GET /komga/api/v1/series
- Supports pagination (page, size)
- Library filtering (library_id)
- Unpaged mode (unpaged=true)
Get series details - GET /komga/api/v1/series/{seriesId}
List books in series - GET /komga/api/v1/series/{seriesId}/books
Get series thumbnail - GET /komga/api/v1/series/{seriesId}/thumbnail

Books

List all books - GET /komga/api/v1/books
- Supports pagination (page, size)
- Library filtering (library_id)
Get book details - GET /komga/api/v1/books/{bookId}
Get book pages metadata - GET /komga/api/v1/books/{bookId}/pages
Get book page image - GET /komga/api/v1/books/{bookId}/pages/{pageNumber}
- Supports format conversion (convert=png)
Download book file - GET /komga/api/v1/books/{bookId}/file
Get book thumbnail - GET /komga/api/v1/books/{bookId}/thumbnail

Collections

List collections - GET /komga/api/v1/collections
- Maps to Trove Magic Shelves
- Supports pagination

Users

Get current user - GET /komga/api/v2/users/me

Clean Mode

All Komga API endpoints support a clean query parameter for smaller responses:

Usage: Add ?clean or ?clean=true to any endpoint
Effect: Removes null values, empty arrays, and lock fields
Benefit: Significantly smaller JSON payloads, ideal for mobile devices

Example:

GET /komga/api/v1/series?clean
GET /komga/api/v1/books/123?clean=true

Troubleshooting

Common Issues and Solutions

❌ Reading App Can't Connect

Verify the Komga API is enabled in Trove settings
Check that you're using the correct base URL: http://your-server/komga
Ensure your OPDS username and password are correct
Verify network connectivity to your Trove server
Make sure OPDS is enabled (required for authentication)

❌ Books Not Appearing

Confirm you have access to the libraries containing the books
Check that books have metadata populated, especially series information
Books without series metadata will appear under "Unknown Series" (if grouping is enabled)
Refresh or restart your reading app
Try re-syncing the source in your app

❌ Authentication Errors

The Komga API uses OPDS user accounts, not your main Trove account
Create an OPDS user in the Settings → OPDS section
Verify the OPDS user exists in Trove settings
Try creating a new OPDS user if issues persist
Ensure OPDS server is enabled

❌ Series Show as "Unknown Series"

This means the books don't have series metadata populated
Edit book metadata in Trove to add series information
Alternatively, disable "Group Unknown Series" to show each book separately

❌ Pages Not Loading

Verify the book file is accessible
Check that the book is a supported format (CBZ, CBR, CB7, PDF, EPUB)
Ensure your reading app supports streaming pages
Try downloading the entire book instead of streaming

Network Considerations

Local Network Access

Remote Access

Firewall Settings

Komga API vs OPDS

Both APIs allow external access to your Trove library, but they serve different purposes:

Feature	Komga API	OPDS
Primary Use	Manga/comic readers	E-book readers
Page Streaming	✅ Yes	❌ No
Series Organization	✅ Native support	⚠️ Limited
File Download	✅ Yes	✅ Yes
Popular Apps	Mihon, Komelia	KOReader, FBReader
Best For	Comics, manga, visual novels	Books, novels, text content

API Compatibility

The Trove Komga API aims to be compatible with Komga v1.x API. While not all endpoints are implemented, the core functionality needed for reading and browsing is fully supported.

Supported Features:

✅ Library browsing
✅ Series browsing and filtering
✅ Book metadata retrieval
✅ Page streaming
✅ Thumbnail retrieval
✅ Book file downloads
✅ Basic authentication
✅ Pagination
✅ Clean mode responses

Known Limitations:

⚠️ Read progress tracking from Komga clients is not synchronized with Trove
⚠️ Some advanced Komga features may not be implemented
⚠️ Collection support is mapped to Magic Shelves (limited functionality)

For the complete Komga API specification, see: Komga Documentation