1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/komga_ynh.git synced 2024-09-03 19:36:07 +02:00
komga_ynh/README.md
2021-02-28 18:06:43 +01:00

78 lines
2.3 KiB
Markdown

# Komga for YunoHost
[![Integration level](https://dash.yunohost.org/integration/Komga.svg)](https://dash.yunohost.org/appci/app/Komga) ![](https://ci-apps.yunohost.org/ci/badges/Komga.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/Komga.maintain.svg)
[![Install Komga with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=komga)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Komga quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
Komga is a free and open source comics/mangas server.
Features include:
* Browse libraries, series and books
* Search bar
* Download book files
* Manage multiple users, with per-library accesss control
* Webreader
**Shipped version:** 0.75.1
## Screenshots
![](./screenshots/home.png)
## Demo
* [Official demo](https://demo.komga.org)
- Login: `demo@komga.org`
- Password: `komga-demo`
## Configuration
For most configurations, you can use the Admin panel in Komga.
## Documentation
* Official documentation: Link to the official documentation of this app
## YunoHost specific features
#### Multi-user support
Are LDAP and HTTP auth supported? **No**
Can the app be used by multiple users? **Yes**
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/komga%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/komga/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/komga%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/komga/)
## Limitations
* None discovered yet.
## Links
* Report a bug: https://github.com/YunoHost-Apps/komga_ynh/issues
* App website: https://komga.org
* Upstream app repository: https://github.com/gotson/komga
* YunoHost website: https://yunohost.org/
---
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/komga_ynh/tree/testing).
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
```