Skip to content

Komga

Jump to bottom
errorfg edited this page Nov 3, 2026 · 3 revisions

English | 中文

Komga

Connect your own Komga server to browse, read and download its comics, with reading progress synced both ways. One server at a time.

Connecting the server

  1. Choose Komga in the source picker at the top of the navigation drawer; the Komga page opens.
  2. If nothing is set up yet, tap Configure Komga; later, use Komga settings in the More menu at the top right.
  3. Fill in:
    • Server URL, e.g. https://komga.example.com; it must start with http or https. A trailing / is removed, a sub-path is kept.
    • Username and Password, or an API key. When both are given the API key is used. Komga before 1.20 does not accept API keys.
  4. Tap Test Connection; after "Connected to Komga", tap Save.

With cloud sync's auto sync on, the server address and credentials reach your other devices (sync type "Komga server"), so they need no setup.

Browsing

  • Home: Continue reading, On deck, Recently added series, Recently updated series, Libraries, Downloads.
  • Libraries: view by Series or All books with the switch at the bottom of the list; filter by read status (Unread, In progress, Read, Newly added); sort by date added, last read, title, volume or relevance; filter by authors, publishers, languages, genres and tags (any value within a category, every category at once). Layouts: cards, list, details.
  • Top bar: the buttons float over the content. At the top left are the sidebar and back; at the top right Search, Sort and filter and More. Sorting, reading status, display and filters are in Sort and filter: choosing the current sort again reverses it, and the button icon turns solid while a filter applies. Series actions and Komga settings are in More.
  • Search: the magnifier at the top right searches series and book titles in all libraries.
  • Series page: counts, status and metadata; tap a metadata chip to see other series with the same author, tag and so on.
  • Long-press a book or series (right-click on desktop) for its menu.

Back and reopening

Since 8.2.0, Komga and PDF are on a par with the sites:

  • Back on the first level does not return to a site; on Android, press it twice to leave the app, and on iOS swipe right to close the page.
  • They count as the source used last and reopen over the home page at the next start (after unlocking); switching to a site clears that.

Reading progress sync

  • Before a book opens, its progress is fetched from the server and merged with this device's; the book opens at the result. When the server cannot be reached, the local progress is used.
  • While reading, progress is reported every 5 seconds and when you leave. Reaching the last page counts as finished, so Komga marks the book read.
  • When both sides changed: if only one side changed since they last agreed, that side wins; only when both changed are the times compared, and the newer wins. So a device clock that differs from the server's does not make the two overwrite each other.
  • Reports that failed are kept and retried when the Komga page opens, when the app returns to the foreground, and at startup.
  • The cloud icon at the top runs a full sync by hand; the menus of books and series mark them read or unread.

Offline downloads

  • Download in a book's menu, Download series in a series' menu (queued in volume order). One book downloads at a time.
  • Downloads need the Komga account's FILE_DOWNLOAD permission.
  • Downloaded books are under Downloads on the home page and read without the server; progress made offline is reported once the server can be reached.
  • ZIP-based books (CBZ and the like) are downloaded as the whole file; CBR, 7z, PDF and other formats are downloaded page by page and read offline just the same.

Reader

  • The top menu moves to the previous or next book; in scrolling layouts the next book follows on, and scrolling back past the first page puts the previous book before it. Offline, it moves among the downloaded books of the series.
  • The reading direction always follows the reader's own settings, not Komga's series direction.
  • Image formats Flutter cannot decode are converted to PNG by the server. Text-only EPUBs cannot be read.

Common errors

Message What to do
Enter a valid HTTP or HTTPS server URL The address must start with http:// or https://.
Enter an API key or username Fill in at least one of them.
Komga rejected the username or password Check the username and password.
The API key was rejected. … Check the key; with Komga before 1.20, use username and password.
Komga denied this action (HTTP 403). … The account lacks download or page streaming permission; add it in Komga's user settings.
Cannot connect to the Komga server. … Wrong address, server not running, or no network.
Cannot establish a secure connection to the Komga server. … The server's HTTPS certificate is not trusted, e.g. a self-signed one.

中文

English

上游 wiki / Upstream wiki

Clone this wiki locally