diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 3aa0a2d..4bc8099 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,11 +1,11 @@ -###Post install +### 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 management * **Library** will be placed in `/home/yunohost.multimedia/share/eBook` folder except if both : - calibreweb is set as a private application @@ -29,12 +29,12 @@ or chmod o+rw path/to/library ``` -###OPDS +### 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 +### 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. @@ -45,7 +45,7 @@ Version number in Yunohost is different from the upstream Calibre-web app : vers * 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 +### Todo - [ ] Update mail settings with yunohost settings - [ ] enable magic link - [ ] Add cronjob to reload database (for nextcloud integration) diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index 1e7f060..adedbc9 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -1,11 +1,11 @@ -###Post installation +### 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é dans calibreweb. -###Gestion de la bibliothèque +### 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 @@ -29,12 +29,12 @@ ou chmod o+rw chemin/vers/bibliothèque ``` -###OPDS +### 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 +### 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. 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.