komga Documentation

Media server for comics/mangas/BDs/magazines/eBooks with API, OPDS, Kobo Sync and KOReader Sync support

6,777 stars Kotlin Kotlin 1 file ยท ~559 tokens #api#comics#ddd#docker#domain-driven-design#kobo#koreader-sync#kotlin
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy komga on any server, homelab, or cloud container platform.

File: README.md



Komga

Komga is a media server for your comics, mangas, BDs, magazines and eBooks.

Chat on [Discord](https://discord.gg/TdRpkDu)

Features

  • Browse libraries, series and books via a responsive web UI that works on desktop, tablets and phones
  • Organize your library with collections and read lists
  • Edit metadata for your series and books
  • Import embedded metadata automatically
  • Webreader with multiple reading modes
  • Manage multiple users, with per-library access control, age restrictions, and labels restrictions
  • Offers a REST API, many community tools and scripts can interact with Komga
  • OPDS v1 and v2 support
  • Kobo Sync with your Kobo eReader
  • KOReader Sync
  • Download book files, whole series, or read lists
  • Duplicate files detection
  • Duplicate pages detection and removal
  • Import books from outside your libraries directly into your series folder
  • Import ComicRack cbl read lists

Installation

Refer to the website for instructions.

Documentation

Head over to our website for more information.

Develop in Komga

Check the development guidelines.

Translation

Powered by

Thanks to JetBrains for providing the development environment that helps us develop Komga.

Thanks to Chromatic for providing the visual testing platform that helps us review UI changes and catch visual regressions.

Credits

The Komga icon is based on an icon made by Freepik from www.flaticon.com


File: AGENTS.md

Project Guidelines

Project Structure

  • komga: Backend
  • komga-tray: Desktop application wrapper
  • komga-webui: Legacy frontend
  • next-ui: Frontend