# ![app icon](./.github/readme-images/app-icon.png) Komga

Komga is a free an open source comics/mangas server.

## Features

Komga just started, and for now it can:

- scan and index a folder containing comic book archives in `cbz` and `cbr` format. Rescan periodically.
- serve the individual pages of those books via an API
- serve the complete file via an API

## Status & vision

The first version is a simple server with only an API and no UI.
It's aimed to work with [Tachiyomi](https://github.com/inorichi/tachiyomi) through an extension.

Future versions may bring:

- support for PDF files
- support for multiple libraries (multiple folders)
- a web UI to administrate the server
- matching with online metadata sources (like ComicVine) to enrich information like description or genre

The long term vision is to offer something similar to Plex, but for comics!

## Installation

The easiest way to install Komga is to use Docker. You can have a look at the sample [docker-compose.yml](./doc/docker-compose.yml).

## Credits

The Komga icon is based on an icon made by [Freepik](https://www.freepik.com/home) from www.flaticon.com