2021-02-28 18:06:43 +01:00
|
|
|
# Komga for YunoHost
|
2021-02-28 08:43:32 +01:00
|
|
|
|
2021-03-04 15:13:34 +01:00
|
|
|
[![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)
|
2021-02-28 11:31:18 +01:00
|
|
|
[![Install Komga with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=komga)
|
2021-02-28 08:43:32 +01:00
|
|
|
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
|
2021-02-28 11:31:18 +01:00
|
|
|
> *This package allows you to install Komga quickly and simply on a YunoHost server.
|
2021-02-28 08:43:32 +01:00
|
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
2021-02-28 11:31:18 +01:00
|
|
|
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
|
|
|
|
|
2021-02-28 11:36:31 +01:00
|
|
|
**Shipped version:** 0.75.1
|
2021-02-28 08:43:32 +01:00
|
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
2021-02-28 11:31:18 +01:00
|
|
|
![](./screenshots/home.png)
|
2021-02-28 08:43:32 +01:00
|
|
|
|
|
|
|
## Demo
|
|
|
|
|
2021-02-28 11:31:18 +01:00
|
|
|
* [Official demo](https://demo.komga.org)
|
2021-02-28 08:43:32 +01:00
|
|
|
|
2021-02-28 18:06:43 +01:00
|
|
|
- Login: `demo@komga.org`
|
|
|
|
- Password: `komga-demo`
|
|
|
|
|
2021-02-28 08:43:32 +01:00
|
|
|
## Configuration
|
|
|
|
|
2021-02-28 11:31:18 +01:00
|
|
|
For most configurations, you can use the Admin panel in Komga.
|
2021-02-28 08:43:32 +01:00
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
|
|
* Official documentation: Link to the official documentation of this app
|
|
|
|
|
|
|
|
## YunoHost specific features
|
|
|
|
|
|
|
|
#### Multi-user support
|
|
|
|
|
2021-02-28 11:31:18 +01:00
|
|
|
Are LDAP and HTTP auth supported? **No**
|
|
|
|
Can the app be used by multiple users? **Yes**
|
2021-02-28 08:43:32 +01:00
|
|
|
|
|
|
|
#### Supported architectures
|
|
|
|
|
2021-02-28 11:38:39 +01:00
|
|
|
* 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/)
|
2021-02-28 08:43:32 +01:00
|
|
|
|
|
|
|
## Limitations
|
|
|
|
|
2021-02-28 11:31:18 +01:00
|
|
|
* None discovered yet.
|
2021-02-28 08:43:32 +01:00
|
|
|
|
|
|
|
## Links
|
|
|
|
|
2021-02-28 11:31:18 +01:00
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/komga_ynh/issues
|
2021-02-28 11:38:39 +01:00
|
|
|
* App website: https://komga.org
|
|
|
|
* Upstream app repository: https://github.com/gotson/komga
|
2021-02-28 08:43:32 +01:00
|
|
|
* YunoHost website: https://yunohost.org/
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## Developer info
|
|
|
|
|
2021-02-28 11:31:18 +01:00
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/komga_ynh/tree/testing).
|
2021-02-28 08:43:32 +01:00
|
|
|
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
```
|
2021-02-28 11:38:39 +01:00
|
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/komga_ynh/tree/testing --debug
|
2021-02-28 08:43:32 +01:00
|
|
|
or
|
2021-02-28 11:38:39 +01:00
|
|
|
sudo yunohost app upgrade komga -u https://github.com/YunoHost-Apps/komga_ynh/tree/testing --debug
|
2021-02-28 08:43:32 +01:00
|
|
|
```
|