YunoHost-Apps/calibreweb_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/calibreweb_ynh.git synced 2024-09-03 18:16:20 +02:00
Code Issues Activity Actions

Update README with new info

Browse source 
OPDS
LDAP
Version number
Backup process
This commit is contained in:
Krakinou 2020-05-06 22:51:48 +02:00
parent db18509592
commit a3a4adb17a
1 changed files with 19 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -15,8 +15,10 @@ Calibre-Web is a web app providing a clean interface for browsing, reading and d
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. 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.
**Shipped version:** The shipped version 0.6.0, but as the numbering changed in the calibre-web app, it is numbered as 0.96.0 in yunohost **Shipped version:** The shipped version is 0.6.7Beta (On going developement), but as the numbering changed in the calibre-web app, it is numbered as 0.96.7 in yunohost.
0.6.7Beta bring an integrated LDAP support. Once final 0.6.7 release will be published, update will be done only to stable version (0.6.7, 0.6.8...)
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 :
- calibreweb is set as a private application - calibreweb is set as a private application
@ -24,25 +26,30 @@ 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.
This app support http authentification.
## Screenshots ## Screenshots
![screenshot](https://raw.githubusercontent.com/janeczku/docker-calibre-web/master/screenshot.png) ![screenshot](https://raw.githubusercontent.com/janeczku/docker-calibre-web/master/screenshot.png)
## 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
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 ## Backup library
By default, backup process will not backup Calibre library ([backup_core_only logic](https://yunohost.org/#/backup_fr)). By default, Yunohost backup process **will backup** Calibre library.
You may activate backup of the library with You may deactivate backup of the library with
``` ```
yunohost app setting calibreweb backup_core_only -v 0 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
* Partial LDAP support : user existing both in Yunohost and calibreweb can use their Yunohost password to log in, but user existing previously to the application installation will not be duplicated in the database automatically
* Authorization access to library to be done manually after install if Calibre library was already existing, for example : * Authorization access to library to be done manually after install if Calibre library was already existing, for example :
``` ```
chown -R calibreweb: path/to/library chown -R calibreweb: path/to/library
@ -51,8 +58,8 @@ 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 * 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 * "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 * 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!
* OPDS is not yet working * Yunohost install use the Tornado server which limits the upload size of a single file to 200Mo.
## Links ## Links
@ -84,7 +91,8 @@ sudo yunohost app upgrade calibreweb -u https://github.com/Yunohost-Apps/calibre
- [ ] Update mail settings with yunohost settings - [ ] Update mail settings with yunohost settings
- [ ] enable magic link - [ ] enable magic link
- [ ] Add cronjob to reload database (for nextcloud integration) - [ ] Add cronjob to reload database (for nextcloud integration)
- [ ] OPDS activation - [X] OPDS activation
- [ ] Add config-panel option to trigger do_not_backup_data
- [ ] Add action to restart the server - [ ] Add action to restart the server
- [ ] 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