mirror of
https://github.com/YunoHost-Apps/calibreweb_ynh.git
synced 2024-09-03 18:16:20 +02:00
Auto-update README
This commit is contained in:
yunohost-bot
parent
42ee0808da
commit
c108d59adc
2 changed files with 4 additions and 136 deletions
70
README.md
70
README.md
|
|
@ -18,78 +18,12 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
|
||||||
|
|
||||||
Browsing, reading and downloading eBooks using a Calibre database
|
Browsing, reading and downloading eBooks using a Calibre database
|
||||||
|
|
||||||
**Shipped version:** 0.6.20
|
**Shipped version:** 0.6.20~ynh1
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Disclaimers / important information
|
|
||||||
|
|
||||||
|
|
||||||
### Post install
|
|
||||||
|
|
||||||
Users having the calibreweb.main authorization group can be automatically sync from within the app, by using the "Import LDAP user" function.
|
|
||||||
Deletion of a Yunohost User will delete the according calibreweb-user.
|
|
||||||
|
|
||||||
|
|
||||||
### Library management
|
|
||||||
|
|
||||||
* **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.
|
|
||||||
|
|
||||||
* By default, Yunohost backup process **will backup** Calibreweb 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.
|
|
||||||
|
|
||||||
|
|
||||||
* 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
|
|
||||||
```
|
|
||||||
|
|
||||||
### Kobo Sync
|
|
||||||
|
|
||||||
Calibre-web comes with a [synching feature with a kobo device](https://github.com/janeczku/calibre-web/wiki/Kobo-Integration). You can activate this feature from inside the app in the administration menu. You need to set port 443 as the external server port.
|
|
||||||
A dedicated permission "Kobo sync" is created by default by the app so that you don't need to expose the whole app for synching.
|
|
||||||
|
|
||||||
[Kepubify](https://pgaskin.net/kepubify/) is also set up as the default kepub converter during installation : This means that your whole library will be converted to kepub when creating the sync token for the first time (this will not affect the existing epubs). This can take a long time : For reference, I have around 10K ebooks on my calibre library and the conversion lasted around 3-4hours on a raspberry Pi 4.
|
|
||||||
|
|
||||||
### 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)).
|
|
||||||
|
|
||||||
### Versionning
|
|
||||||
|
|
||||||
Version number in Yunohost is different from the upstream Calibre-web app : version 0.X.Y becomes 0.9.X.Y in Yunohost. This is due to the fact that Calibre-web was not versionned when first packages were built.
|
|
||||||
|
|
||||||
### Known Limitations
|
|
||||||
|
|
||||||
* 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 Calibreweb 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
|
|
||||||
- [ ] Update mail settings with yunohost settings
|
|
||||||
- [ ] enable magic link
|
|
||||||
- [ ] Add cronjob to reload database (for nextcloud integration)
|
|
||||||
- [ ] 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?
|
|
||||||
|
|
||||||
## Documentation and resources
|
## Documentation and resources
|
||||||
|
|
||||||
* Official admin documentation: <https://github.com/janeczku/calibre-web/wiki>
|
* Official admin documentation: <https://github.com/janeczku/calibre-web/wiki>
|
||||||
|
|
|
||||||
70
README_fr.md
70
README_fr.md
|
|
@ -18,78 +18,12 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
|
||||||
|
|
||||||
Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre
|
Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre
|
||||||
|
|
||||||
**Version incluse :** 0.6.20
|
**Version incluse :** 0.6.20~ynh1
|
||||||
|
|
||||||
## Captures d’écran
|
## Captures d’écran
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Avertissements / informations importantes
|
|
||||||
|
|
||||||
|
|
||||||
### Post installation
|
|
||||||
|
|
||||||
Les utilisateurs appartenant au groupe d'autorisation calibreweb.main peuvent être synchronisé automatiquement depuis l'application en utilisant la fonction "Importer les utilisateurs LDAP".
|
|
||||||
Lorsque les utilisateurs sont supprimés dans Yunohost, ils sont également supprimés dans Calibreweb.
|
|
||||||
|
|
||||||
|
|
||||||
### Gestion de la bibliothèque
|
|
||||||
|
|
||||||
* La **bibliothèque** sera placée dans `/home/yunohost.multimedia/share/eBook` sauf si simultanément :
|
|
||||||
- Calibreweb est paramétré comme une application privée
|
|
||||||
- La bibliothèque Calibreweb est paramétrée comme une bilbiothèque privée
|
|
||||||
|
|
||||||
Dans ce cas, la bibliothèque sera placée dans `/home/yunohost.multimedia/[admin]/eBook`. Le répertoire de la bibliothèque peut ensuite être déplacé directement dans l'application par l'administrateur.
|
|
||||||
|
|
||||||
* Par défaut, le processus de backup de Yunohost **archivera** la bibliothèque Calibreweb.
|
|
||||||
Vous pouvez le désactiver avec cette commande:
|
|
||||||
```
|
|
||||||
yunohost app setting calibreweb do_not_backup_data -v 1
|
|
||||||
```
|
|
||||||
|
|
||||||
* Par défaut, supprimer l'application **ne supprimera jamais** la bibliothèque.
|
|
||||||
|
|
||||||
|
|
||||||
* Si la bibliothèque existait avant l'installation de Calibreweb, les accès à celle-ci doivent être géré manuellement (sauf pour celle dans yunohost.multimedia directory). Par exemple :
|
|
||||||
```
|
|
||||||
chown -R calibreweb: chemin/vers/bibliothèque
|
|
||||||
ou
|
|
||||||
chmod o+rw chemin/vers/bibliothèque
|
|
||||||
```
|
|
||||||
|
|
||||||
### Synchronisation Kobo
|
|
||||||
|
|
||||||
Calibre-web possède [une fonction de synchronisation avec les liseuses Kobo](https://github.com/janeczku/calibre-web/wiki/Kobo-Integration). Vous pouvez activer cette fonctionnalité depuis le menu d'administration de l'application. Il faut paramétrer le port 443 comme port externe du serveur.
|
|
||||||
Une permission spécifique "Kobo sync" est créée lors de l'installation de l'application afin de ne pas avoir à exposer l'application entière.
|
|
||||||
|
|
||||||
[Kepubify](https://pgaskin.net/kepubify/) est également installé en tant que convertisseur par défaut vers le format kepub : Cela signifie que l'intégralité de votre bibliothèque sera convertie en format kepub lorsque vous créerez le jeton de synchronisation pour la première fois (ceci n'affecte pas les epubs existant). Cela peut prendre un certain temps : Par exemple, j'ai environ 10K livres dans ma bibliothèque calibre, et la conversion a durée environ 3-4h sur un Raspberry Pi 4 .
|
|
||||||
|
|
||||||
### OPDS
|
|
||||||
|
|
||||||
Pour que l'**OPDS** fonctionne, la plupart des lecteurs OPDS exigent que l'application soit en accès publique.
|
|
||||||
Egalement, il se peut que l'activation de l'accès anonyme soit nécessaire pour accéder aux bibliothèque ou télécharger les livres sur certains lecteurs : ([source](https://github.com/janeczku/calibre-web/wiki/FAQ#which-opds-readers-work-with-calibre-web)).
|
|
||||||
|
|
||||||
### Version
|
|
||||||
|
|
||||||
La numérotation est modifiée dans yunohost par rapport à Calibre-web: la version 0.X.Y devient 0.9X.Y dans yunohost. Cela provient du fait que Calibre-web n'était pas versionné lors des premiers packages.
|
|
||||||
|
|
||||||
### Problèmes connus
|
|
||||||
|
|
||||||
* Ne pas utiliser un répertoire Nextcloud pour y installer la bibliothèque: Cela fonctionnera s'il s'agit d'un stockage externe à Nextcloud, mais pas dans le cas d'un répertoire interne qui causerait des problèmes lors des synchronisations.
|
|
||||||
* La fonction "Magic link" n'est pas disponible
|
|
||||||
* Les changements fait à la bibliothèque en dehors de Calibreweb ne sont pas automatiquement vu par Calibreweb : Il est nécessaire de se déconnecter puis reconnecter ou redémarrer le service pour que les modifications soient visibles : N'utilisez donc pas simultanément Calibre et Calibreweb sur la même bibliothèque!
|
|
||||||
* La synchronisation Kobo ne fonctionne pas quand Calibreweb est installée dans un sous-domaine. Ce problème est causé par nginx. Par contre, cela fonctionne très bien quand installé dans un répertoire, par exemple `https://domain.tld/calibreweb`
|
|
||||||
|
|
||||||
## Todo
|
|
||||||
- [ ] Mise à jour des réglages mails
|
|
||||||
- [ ] Activation de magic link
|
|
||||||
- [ ] Add cronjob to reload database (for nextcloud integration)
|
|
||||||
- [ ] 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?
|
|
||||||
|
|
||||||
## Documentations et ressources
|
## Documentations et ressources
|
||||||
|
|
||||||
* Documentation officielle de l’admin : <https://github.com/janeczku/calibre-web/wiki>
|
* Documentation officielle de l’admin : <https://github.com/janeczku/calibre-web/wiki>
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue