mirror of
https://github.com/YunoHost-Apps/calibreweb_ynh.git
synced 2024-09-03 18:16:20 +02:00
Automatic Readme
This commit is contained in:
Krakinou
parent
2eb31331b4
commit
5f7f465bcb
5 changed files with 218 additions and 39 deletions
83
README.md
83
README.md
|
|
@ -1,22 +1,34 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
# Calibre-web for YunoHost
|
# Calibre-web for YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/calibreweb)  
|
[](https://dash.yunohost.org/appci/app/calibreweb)  
|
||||||
[](https://install-app.yunohost.org/?app=calibreweb)
|
[](https://install-app.yunohost.org/?app=calibreweb)
|
||||||
|
|
||||||
> *This package allow you to install calibreweb quickly and simply on a YunoHost server.
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
|
||||||
|
> *This package allows you to install Calibre-web 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
|
## Overview
|
||||||
This is an implementation of [Calibre-web](https://github.com/janeczku/calibre-web) for Yunohost.
|
|
||||||
|
|
||||||
Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing [Calibre](https://calibre-ebook.com) database.
|
Browsing, reading and downloading eBooks using a Calibre database
|
||||||
|
|
||||||
*This software is a fork of [library](https://github.com/mutschler/calibreserver) and licensed under the GPL v3 License.*
|
**Shipped version:** 0.96.12~ynh2
|
||||||
|
|
||||||
Alternatively, you may use [COPS](https://github.com/YunoHost-Apps/cops_ynh) which also allows access to your Calibre Library, but in read-only mode.
|
|
||||||
|
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Disclaimers / important information
|
||||||
|
|
||||||
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||||
**Shipped version:** The shipped version is 0.6.12 - Pilar, but as the numbering changed in the calibre-web app, it is numbered as 0.96.12 in yunohost.
|
**Shipped version:** The shipped version is 0.6.12 - Pilar, but as the numbering changed in the calibre-web app, it is numbered as 0.96.12 in yunohost.
|
||||||
|
|
||||||
Users will be synchronized with authorized Yunohost users (having the calibreweb.main authorization group) automatically. In case of issue you may force the sync in the app itself.
|
Users will be synchronized with authorized Yunohost users (having the calibreweb.main authorization group) automatically. In case of issue you may force the sync in the app itself.
|
||||||
|
|
||||||
Library will be placed in `/home/yunohost.multimedia/share/eBook` folder except if both :
|
Library will be placed in `/home/yunohost.multimedia/share/eBook` folder except if both :
|
||||||
|
|
@ -25,18 +37,12 @@ Library will be placed in `/home/yunohost.multimedia/share/eBook` folder except
|
||||||
|
|
||||||
In this case the library will be set in `/home/yunohost.multimedia/[admin]/eBook` folder. Library folder can always be changed manually in the application settings by the administrator.
|
In this case the library will be set in `/home/yunohost.multimedia/[admin]/eBook` folder. Library folder can always be changed manually in the application settings by the administrator.
|
||||||
|
|
||||||
## Screenshots
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Security
|
|
||||||
The default admin password of the app (admin123) is kept during the installation process. It is used as a fallback password in case of LDAP issue.
|
|
||||||
You should change it to something more secure in the app :)
|
|
||||||
|
|
||||||
## OPDS
|
## OPDS
|
||||||
For OPDS to work, most OPDS-readers will require the app must be set in public mode.
|
For OPDS to work, most OPDS-readers will require the app must be set in public mode.
|
||||||
Also, you may have to activate the "anonym browsing" for some reader to access book covers or download books ([source](https://github.com/janeczku/calibre-web/wiki/FAQ#which-opds-readers-work-with-calibre-web)).
|
Also, you may have to activate the "anonym browsing" for some reader to access book covers or download books ([source](https://github.com/janeczku/calibre-web/wiki/FAQ#which-opds-readers-work-with-calibre-web)).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Backup library
|
## Backup library
|
||||||
|
|
||||||
By default, Yunohost backup process **will backup** Calibre library.
|
By default, Yunohost backup process **will backup** Calibre library.
|
||||||
|
|
@ -47,6 +53,7 @@ yunohost app setting calibreweb do_not_backup_data -v 1
|
||||||
|
|
||||||
By default, removing the app will **never** delete the library.
|
By default, removing the app will **never** delete the library.
|
||||||
|
|
||||||
|
|
||||||
## Known Limitations
|
## Known Limitations
|
||||||
|
|
||||||
* Authorization access to library to be done manually after install if Calibre library was already existing (except in yunohost.multimedia directory), for example :
|
* Authorization access to library to be done manually after install if Calibre library was already existing (except in yunohost.multimedia directory), for example :
|
||||||
|
|
@ -60,26 +67,6 @@ chmod o+rw path/to/library
|
||||||
* Change to library made outside calibreweb are not automatically updated in calibreweb. It is required to disconnect and reconnect to see the changes : Do not open a database both in calibre & calibreweb!
|
* Change to library made outside calibreweb are not automatically updated in calibreweb. It is required to disconnect and reconnect to see the changes : Do not open a database both in calibre & calibreweb!
|
||||||
* Kobo Sync doesn’t work when Calibre is installed on a subdomain. This issue is caused by nginx. However, it works great when installed on a path e.g. `https://domain.tld/calibreweb`
|
* Kobo Sync doesn’t work when Calibre is installed on a subdomain. This issue is caused by nginx. However, it works great when installed on a path e.g. `https://domain.tld/calibreweb`
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/calibreweb_ynh/issues
|
|
||||||
* App website: https://github.com/janeczku/calibre-web
|
|
||||||
* YunoHost website: https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Developers info
|
|
||||||
|
|
||||||
Please do your pull request to the [testing branch](https://github.com/Yunohost-Apps/calibreweb_ynh/tree/testing).
|
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
|
||||||
```
|
|
||||||
sudo yunohost app install https://github.com/Yunohost-Apps/calibreweb_ynh/tree/testing --debug
|
|
||||||
or
|
|
||||||
sudo yunohost app upgrade calibreweb -u https://github.com/Yunohost-Apps/calibreweb_ynh/tree/testing --debug
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## Todo
|
## Todo
|
||||||
- [X] Multiinstance
|
- [X] Multiinstance
|
||||||
- [X] Better Multimedia integration : Integrate in Yunohost.multimedia
|
- [X] Better Multimedia integration : Integrate in Yunohost.multimedia
|
||||||
|
|
@ -96,8 +83,28 @@ sudo yunohost app upgrade calibreweb -u https://github.com/Yunohost-Apps/calibre
|
||||||
- [ ] Add action to synchronize users
|
- [ ] Add action to synchronize users
|
||||||
- [ ] Add action to deactivate LDAP et retrieve admin password
|
- [ ] Add action to deactivate LDAP et retrieve admin password
|
||||||
- [ ] Use internal updater to update version?
|
- [ ] Use internal updater to update version?
|
||||||
|
* Other infos that people should be aware of, such as:
|
||||||
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||||
|
* how to configure / administrate the application if it ain't obvious
|
||||||
|
* upgrade process / specificities / things to be aware of ?
|
||||||
|
* security considerations ?
|
||||||
|
|
||||||
|
## Documentation and resources
|
||||||
|
|
||||||
|
* Official admin documentation: https://github.com/janeczku/calibre-web/wiki
|
||||||
|
* Upstream app code repository: https://github.com/janeczku/calibre-web
|
||||||
|
* YunoHost documentation for this app: https://yunohost.org/app_calibreweb
|
||||||
|
* Report a bug: https://github.com/YunoHost-Apps/calibreweb_ynh/issues
|
||||||
|
|
||||||
## LICENSE
|
## Developer info
|
||||||
Package and software are GPL 3.0
|
|
||||||
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing).
|
||||||
|
|
||||||
|
To try the testing branch, please proceed like that.
|
||||||
|
```
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing --debug
|
||||||
|
or
|
||||||
|
sudo yunohost app upgrade calibreweb -u https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||||
106
README_fr.md
Normal file
106
README_fr.md
Normal file
|
|
@ -0,0 +1,106 @@
|
||||||
|
# Calibre-web pour YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/calibreweb)  
|
||||||
|
[](https://install-app.yunohost.org/?app=calibreweb)
|
||||||
|
|
||||||
|
*[Read this readme in english.](./README.md)*
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
|
> *Ce package vous permet d'installer Calibre-web rapidement et simplement sur un serveur YunoHost.
|
||||||
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
|
## Vue d'ensemble
|
||||||
|
|
||||||
|
Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre
|
||||||
|
|
||||||
|
**Version incluse :** 0.96.12~ynh2
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Captures d'écran
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Avertissements / informations importantes
|
||||||
|
|
||||||
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||||
|
**Shipped version:** The shipped version is 0.6.12 - Pilar, but as the numbering changed in the calibre-web app, it is numbered as 0.96.12 in yunohost.
|
||||||
|
Users will be synchronized with authorized Yunohost users (having the calibreweb.main authorization group) automatically. In case of issue you may force the sync in the app itself.
|
||||||
|
|
||||||
|
Library will be placed in `/home/yunohost.multimedia/share/eBook` folder except if both :
|
||||||
|
- calibreweb is set as a private application
|
||||||
|
- calibreweb library is set as a public library
|
||||||
|
|
||||||
|
In this case the library will be set in `/home/yunohost.multimedia/[admin]/eBook` folder. Library folder can always be changed manually in the application settings by the administrator.
|
||||||
|
|
||||||
|
## OPDS
|
||||||
|
For OPDS to work, most OPDS-readers will require the app must be set in public mode.
|
||||||
|
Also, you may have to activate the "anonym browsing" for some reader to access book covers or download books ([source](https://github.com/janeczku/calibre-web/wiki/FAQ#which-opds-readers-work-with-calibre-web)).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Backup library
|
||||||
|
|
||||||
|
By default, Yunohost backup process **will backup** Calibre library.
|
||||||
|
You may deactivate backup of the library with
|
||||||
|
```
|
||||||
|
yunohost app setting calibreweb do_not_backup_data -v 1
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, removing the app will **never** delete the library.
|
||||||
|
|
||||||
|
|
||||||
|
## Known Limitations
|
||||||
|
|
||||||
|
* Authorization access to library to be done manually after install if Calibre library was already existing (except in yunohost.multimedia directory), for example :
|
||||||
|
```
|
||||||
|
chown -R calibreweb: path/to/library
|
||||||
|
or
|
||||||
|
chmod o+rw path/to/library
|
||||||
|
```
|
||||||
|
* Do not use a Nextcloud folder. It's all right if the folder is an external storage in Nextcloud but not if it's an internal one : Changing the data in the library will cause trouble with the sync
|
||||||
|
* "Magic link feature is not yet available
|
||||||
|
* Change to library made outside calibreweb are not automatically updated in calibreweb. It is required to disconnect and reconnect to see the changes : Do not open a database both in calibre & calibreweb!
|
||||||
|
* Kobo Sync doesn’t work when Calibre is installed on a subdomain. This issue is caused by nginx. However, it works great when installed on a path e.g. `https://domain.tld/calibreweb`
|
||||||
|
|
||||||
|
## Todo
|
||||||
|
- [X] Multiinstance
|
||||||
|
- [X] Better Multimedia integration : Integrate in Yunohost.multimedia
|
||||||
|
- [X] rework LDAP integration to create user automatically
|
||||||
|
- [X] Package_check integration
|
||||||
|
- [X] On backup/remove/upgrade : check for database location to update settings
|
||||||
|
- [ ] Update mail settings with yunohost settings
|
||||||
|
- [ ] enable magic link
|
||||||
|
- [ ] Add cronjob to reload database (for nextcloud integration)
|
||||||
|
- [X] OPDS activation
|
||||||
|
- [ ] Add config-panel option to trigger do_not_backup_data
|
||||||
|
- [ ] Add config-panel to manage max upload size
|
||||||
|
- [ ] Add action to restart the server
|
||||||
|
- [ ] Add action to synchronize users
|
||||||
|
- [ ] Add action to deactivate LDAP et retrieve admin password
|
||||||
|
- [ ] Use internal updater to update version?
|
||||||
|
* Other infos that people should be aware of, such as:
|
||||||
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||||
|
* how to configure / administrate the application if it ain't obvious
|
||||||
|
* upgrade process / specificities / things to be aware of ?
|
||||||
|
* security considerations ?
|
||||||
|
|
||||||
|
## Documentations et ressources
|
||||||
|
|
||||||
|
* Documentation officielle de l'admin : https://github.com/janeczku/calibre-web/wiki
|
||||||
|
* Dépôt de code officiel de l'app : https://github.com/janeczku/calibre-web
|
||||||
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_calibreweb
|
||||||
|
* Signaler un bug : https://github.com/YunoHost-Apps/calibreweb_ynh/issues
|
||||||
|
|
||||||
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing).
|
||||||
|
|
||||||
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
|
```
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing --debug
|
||||||
|
ou
|
||||||
|
sudo yunohost app upgrade calibreweb -u https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||||
61
doc/DISCLAIMER.md
Normal file
61
doc/DISCLAIMER.md
Normal file
|
|
@ -0,0 +1,61 @@
|
||||||
|
* Any known limitations, constrains or stuff not working, such as (but not limited to):
|
||||||
|
**Shipped version:** The shipped version is 0.6.12 - Pilar, but as the numbering changed in the calibre-web app, it is numbered as 0.96.12 in yunohost.
|
||||||
|
Users will be synchronized with authorized Yunohost users (having the calibreweb.main authorization group) automatically. In case of issue you may force the sync in the app itself.
|
||||||
|
|
||||||
|
Library will be placed in `/home/yunohost.multimedia/share/eBook` folder except if both :
|
||||||
|
- calibreweb is set as a private application
|
||||||
|
- calibreweb library is set as a public library
|
||||||
|
|
||||||
|
In this case the library will be set in `/home/yunohost.multimedia/[admin]/eBook` folder. Library folder can always be changed manually in the application settings by the administrator.
|
||||||
|
|
||||||
|
## OPDS
|
||||||
|
For OPDS to work, most OPDS-readers will require the app must be set in public mode.
|
||||||
|
Also, you may have to activate the "anonym browsing" for some reader to access book covers or download books ([source](https://github.com/janeczku/calibre-web/wiki/FAQ#which-opds-readers-work-with-calibre-web)).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Backup library
|
||||||
|
|
||||||
|
By default, Yunohost backup process **will backup** Calibre library.
|
||||||
|
You may deactivate backup of the library with
|
||||||
|
```
|
||||||
|
yunohost app setting calibreweb do_not_backup_data -v 1
|
||||||
|
```
|
||||||
|
|
||||||
|
By default, removing the app will **never** delete the library.
|
||||||
|
|
||||||
|
|
||||||
|
## Known Limitations
|
||||||
|
|
||||||
|
* Authorization access to library to be done manually after install if Calibre library was already existing (except in yunohost.multimedia directory), for example :
|
||||||
|
```
|
||||||
|
chown -R calibreweb: path/to/library
|
||||||
|
or
|
||||||
|
chmod o+rw path/to/library
|
||||||
|
```
|
||||||
|
* Do not use a Nextcloud folder. It's all right if the folder is an external storage in Nextcloud but not if it's an internal one : Changing the data in the library will cause trouble with the sync
|
||||||
|
* "Magic link feature is not yet available
|
||||||
|
* Change to library made outside calibreweb are not automatically updated in calibreweb. It is required to disconnect and reconnect to see the changes : Do not open a database both in calibre & calibreweb!
|
||||||
|
* Kobo Sync doesn’t work when Calibre is installed on a subdomain. This issue is caused by nginx. However, it works great when installed on a path e.g. `https://domain.tld/calibreweb`
|
||||||
|
|
||||||
|
## Todo
|
||||||
|
- [X] Multiinstance
|
||||||
|
- [X] Better Multimedia integration : Integrate in Yunohost.multimedia
|
||||||
|
- [X] rework LDAP integration to create user automatically
|
||||||
|
- [X] Package_check integration
|
||||||
|
- [X] On backup/remove/upgrade : check for database location to update settings
|
||||||
|
- [ ] Update mail settings with yunohost settings
|
||||||
|
- [ ] enable magic link
|
||||||
|
- [ ] Add cronjob to reload database (for nextcloud integration)
|
||||||
|
- [X] OPDS activation
|
||||||
|
- [ ] Add config-panel option to trigger do_not_backup_data
|
||||||
|
- [ ] Add config-panel to manage max upload size
|
||||||
|
- [ ] Add action to restart the server
|
||||||
|
- [ ] Add action to synchronize users
|
||||||
|
- [ ] Add action to deactivate LDAP et retrieve admin password
|
||||||
|
- [ ] Use internal updater to update version?
|
||||||
|
* Other infos that people should be aware of, such as:
|
||||||
|
* any specific step to perform after installing (such as manually finishing the install, specific admin credentials, ...)
|
||||||
|
* how to configure / administrate the application if it ain't obvious
|
||||||
|
* upgrade process / specificities / things to be aware of ?
|
||||||
|
* security considerations ?
|
||||||
BIN
doc/screenshots/screenshot.png
Normal file
BIN
doc/screenshots/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 171 KiB |
|
|
@ -6,8 +6,13 @@
|
||||||
"en": "Browsing, reading and downloading eBooks using a Calibre database",
|
"en": "Browsing, reading and downloading eBooks using a Calibre database",
|
||||||
"fr": "Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre"
|
"fr": "Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre"
|
||||||
},
|
},
|
||||||
"version": "0.96.12~ynh1",
|
"version": "0.96.12~ynh2",
|
||||||
"url": "https://github.com/janeczku/calibre-web",
|
"url": "https://github.com/janeczku/calibre-web",
|
||||||
|
"upstream": {
|
||||||
|
"license": "GPL-3.0-only",
|
||||||
|
"admindoc": "https://github.com/janeczku/calibre-web/wiki",
|
||||||
|
"code": "https://github.com/janeczku/calibre-web"
|
||||||
|
},
|
||||||
"license": "GPL-3.0-only",
|
"license": "GPL-3.0-only",
|
||||||
"maintainer": {
|
"maintainer": {
|
||||||
"name": "Krakinou",
|
"name": "Krakinou",
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue