komga_ynh/README.md

Komga for YunoHost

Read this README in other languages.

This package allows you to install Komga quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

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

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
• Offers a REST API, many community tools and scripts can interact with Komga
• Download book files

Shipped version: 1.11.1~ynh1

Demo: https://demo.komga.org

Screenshots

Documentation and resources

• Official app website: https://komga.org
• Official admin documentation: https://komga.org/guides/
• Upstream app code repository: https://github.com/gotson/komga
• YunoHost Store: https://apps.yunohost.org/app/komga
• Report a bug: https://github.com/YunoHost-Apps/komga_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

sudo yunohost app install https://github.com/YunoHost-Apps/komga_ynh/tree/testing --debug
or
sudo yunohost app upgrade komga -u https://github.com/YunoHost-Apps/komga_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps