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 documentation

Browse source
This commit is contained in:
Krakinou 2022-11-11 17:29:42 +01:00
parent 23d5ff9d34
commit 32359b5a9a
2 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/DISCLAIMER.md
View file

@ -29,6 +29,13 @@ 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 on a raspberry Pi 4 lasted around 3-4hours.
### OPDS
For **OPDS** to work, most OPDS-readers will require the app must be set in public mode.

7
doc/DISCLAIMER_fr.md
View file

@ -29,6 +29,13 @@ 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 sur un Raspberry Pi 4 a durée environ 3-4h.
### OPDS
Pour que l'**OPDS** fonctionne, la plupart des lecteurs OPDS exigent que l'application soit en accès publique.