mirror of
https://github.com/YunoHost-Apps/cops_ynh.git
synced 2024-09-03 18:25:57 +02:00
50 lines
No EOL
2 KiB
Markdown
50 lines
No EOL
2 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# COPS for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/cops)  
|
|
[](https://install-app.yunohost.org/?app=cops)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install COPS 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
|
|
|
|
Calibre OPDS (and HTML) PHP Server
|
|
|
|
**Shipped version:** 1.1.3~ynh1
|
|
|
|
**Demo:** http://cops-demo.slucas.fr/index.php
|
|
|
|
## Disclaimers / important information
|
|
|
|
You need to indicate the true path of your calibre library and make sure COPS runs under the same user as were the files are located
|
|
|
|
Designed to work best with OwnCloud or NextCloud
|
|
|
|
Creates an OPDS and HTML server based on a Calibre folder stored in NextCloud
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: https://blog.slucas.fr/projects/calibre-opds-php-server/
|
|
* Upstream app code repository: https://github.com/seblucas/cops
|
|
* YunoHost documentation for this app: https://yunohost.org/app_cops
|
|
* Report a bug: https://github.com/YunoHost-Apps/cops_ynh/issues
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/cops_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
```
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/cops_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade cops -u https://github.com/YunoHost-Apps/cops_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps |