From b0bfb018b2cdb77067fa00363907af2e55414b49 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Sun, 25 Jul 2021 10:17:44 +0200 Subject: [PATCH] Update README --- README.md | 52 +++++++++++++++---------------- README_fr.md | 73 +++++++++++++++++++++----------------------- doc/DISCLAIMER.md | 52 +++++++++++++++---------------- doc/DISCLAIMER_fr.md | 58 +++++++++++++++++++++++++++++++++++ 4 files changed, 141 insertions(+), 94 deletions(-) create mode 100644 doc/DISCLAIMER_fr.md diff --git a/README.md b/README.md index 91a11ba..36728fc 100644 --- a/README.md +++ b/README.md @@ -27,67 +27,63 @@ Browsing, reading and downloading eBooks using a Calibre database ## 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. -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 : +###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. -## 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. +* 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. +* 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 ``` + +###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 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 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 -- [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 ? ## Documentation and resources diff --git a/README_fr.md b/README_fr.md index 4e86002..91baf38 100644 --- a/README_fr.md +++ b/README_fr.md @@ -23,67 +23,64 @@ Explorer, lire et télécharger des eBooks à partir d'une base de données Cali ## 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 +###Post installation -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)). +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 -## Backup library +* 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 -By default, Yunohost backup process **will backup** Calibre library. -You may deactivate backup of the library with +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ée 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 ``` -By default, removing the app will **never** delete the library. +* Par défaut, supprimer l'application **ne supprimera jamais** la bibliothèque. -## 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 : +* 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: path/to/library -or -chmod o+rw path/to/library +chown -R calibreweb: chemin/vers/bibliothèque +ou +chmod o+rw chemin/vers/bibliothèque ``` -* 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` + +###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. +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. + +### 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 -- [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 +- [ ] Mise à jour des réglages mails +- [ ] Activation de 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 diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index c8bc359..3aa0a2d 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -1,61 +1,57 @@ -* 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 : +###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. -## 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. +* 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. +* 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 ``` + +###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 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 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 -- [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 ? diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..1e7f060 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,58 @@ + +###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 + +* 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ée 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 +``` + +###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. +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. + +### 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?