mirror of
https://github.com/YunoHost-Apps/calibreweb_ynh.git
synced 2024-09-03 18:16:20 +02:00
Merge pull request #81 from YunoHost-Apps/Readme_generator
Readme generator
This commit is contained in:
Krakinou
GitHub
commit
3750e61bfc
14 changed files with 298 additions and 85 deletions
119
README.md
119
README.md
|
|
@ -1,53 +1,55 @@
|
|||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Calibre-web for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/calibreweb)  
|
||||
[](https://install-app.yunohost.org/?app=calibreweb)
|
||||
[](https://install-app.yunohost.org/?app=calibreweb)
|
||||
|
||||
> *This package allow you to install calibreweb quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *This package allows you to install Calibre-web quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
## Overview
|
||||
This is an implementation of [Calibre-web](https://github.com/janeczku/calibre-web) for Yunohost.
|
||||
|
||||
Calibre-Web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing [Calibre](https://calibre-ebook.com) database.
|
||||
Browsing, reading and downloading eBooks using a Calibre database
|
||||
|
||||
*This software is a fork of [library](https://github.com/mutschler/calibreserver) and licensed under the GPL v3 License.*
|
||||
**Shipped version:** 0.96.12~ynh2
|
||||
|
||||
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 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
|
||||
|
||||
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.
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
## 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 :)
|
||||
## Disclaimers / important information
|
||||
|
||||
## 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
|
||||
### Post install
|
||||
|
||||
By default, Yunohost backup process **will backup** Calibre library.
|
||||
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.
|
||||
* 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 :
|
||||
```
|
||||
|
|
@ -55,41 +57,27 @@ 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!
|
||||
* 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`
|
||||
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/calibreweb_ynh/issues
|
||||
* App website: https://github.com/janeczku/calibre-web
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
## Developers info
|
||||
|
||||
Please do your pull request to the [testing branch](https://github.com/Yunohost-Apps/calibreweb_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
sudo yunohost app install https://github.com/Yunohost-Apps/calibreweb_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade calibreweb -u https://github.com/Yunohost-Apps/calibreweb_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
|
||||
## 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
|
||||
### Todo
|
||||
- [ ] 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
|
||||
|
|
@ -97,7 +85,22 @@ sudo yunohost app upgrade calibreweb -u https://github.com/Yunohost-Apps/calibre
|
|||
- [ ] Add action to deactivate LDAP et retrieve admin password
|
||||
- [ ] Use internal updater to update version?
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
* Official admin documentation: https://github.com/janeczku/calibre-web/wiki
|
||||
* Upstream app code repository: https://github.com/janeczku/calibre-web
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_calibreweb
|
||||
* Report a bug: https://github.com/YunoHost-Apps/calibreweb_ynh/issues
|
||||
|
||||
## LICENSE
|
||||
Package and software are GPL 3.0
|
||||
## Developer info
|
||||
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade calibreweb -u https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
102
README_fr.md
Normal file
102
README_fr.md
Normal file
|
|
@ -0,0 +1,102 @@
|
|||
# Calibre-web pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/calibreweb)  
|
||||
[](https://install-app.yunohost.org/?app=calibreweb)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Calibre-web rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre
|
||||
|
||||
**Version incluse :** 0.96.12~ynh2
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
```
|
||||
|
||||
### 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
|
||||
|
||||
* Documentation officielle de l'admin : https://github.com/janeczku/calibre-web/wiki
|
||||
* Dépôt de code officiel de l'app : https://github.com/janeczku/calibre-web
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_calibreweb
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/calibreweb_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade calibreweb -u https://github.com/YunoHost-Apps/calibreweb_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
|
|
@ -17,7 +17,7 @@
|
|||
setup_public=1
|
||||
upgrade=1
|
||||
#Last version
|
||||
upgrade=1 from_commit=daf9f864b4f4adde4130c9d000ecc87f5d44ca42
|
||||
upgrade=1 from_commit=df304aadd7767a3e38bfc6d4da45ce8a94ebc749
|
||||
#v0.6.6
|
||||
# upgrade=1 from_commit=11f5b96df7d8850beff47f9904745fa53a6f7ed9
|
||||
backup_restore=1
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
#To be deleted in future release
|
||||
config_login_type=1,
|
||||
config_ldap_provider_url=\'localhost\',
|
||||
config_ldap_port=389,
|
||||
|
|
@ -5,6 +6,6 @@ config_ldap_authentication=0,
|
|||
config_ldap_dn=\'dc=yunohost,dc=org\',
|
||||
config_ldap_user_object=\'\(\&\(objectClass=posixAccount\)\(permission=cn=calibreweb.main,ou=permission,dc=yunohost,dc=org\)\(uid=%s\)\)\',
|
||||
config_ldap_openldap=1,
|
||||
config_ldap_group_object_filter=\'\(\&\(objectClass=posixGroup\)\(permission=cn=%s.main,ou=permission,dc=yunohost,dc=org\)\)\',
|
||||
config_ldap_group_object_filter=\'\(\&\(objectClass=posixGroup\)\(cn=%s.main\)\)\',
|
||||
config_ldap_group_members_field=\'memberUid\',
|
||||
config_ldap_group_name=\'calibreweb\'
|
||||
|
|
@ -1,3 +1,4 @@
|
|||
#to be deleted in future release
|
||||
config_calibre_dir=\'$calibre_dir\',
|
||||
config_port=$port,
|
||||
config_logfile=\'$LOG_FILE\',
|
||||
57
doc/DISCLAIMER.md
Normal file
57
doc/DISCLAIMER.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
|
||||
### 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
|
||||
```
|
||||
|
||||
### 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?
|
||||
57
doc/DISCLAIMER_fr.md
Normal file
57
doc/DISCLAIMER_fr.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
|
||||
### 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
|
||||
```
|
||||
|
||||
### 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?
|
||||
BIN
doc/screenshots/screenshot.png
Normal file
BIN
doc/screenshots/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 171 KiB |
|
|
@ -6,8 +6,13 @@
|
|||
"en": "Browsing, reading and downloading eBooks using a Calibre database",
|
||||
"fr": "Explorer, lire et télécharger des eBooks à partir d'une base de données Calibre"
|
||||
},
|
||||
"version": "0.96.12~ynh1",
|
||||
"version": "0.96.12~ynh2",
|
||||
"url": "https://github.com/janeczku/calibre-web",
|
||||
"upstream": {
|
||||
"license": "GPL-3.0-only",
|
||||
"admindoc": "https://github.com/janeczku/calibre-web/wiki",
|
||||
"code": "https://github.com/janeczku/calibre-web"
|
||||
},
|
||||
"license": "GPL-3.0-only",
|
||||
"maintainer": {
|
||||
"name": "Krakinou",
|
||||
|
|
|
|||
|
|
@ -1,9 +1,10 @@
|
|||
#!/bin/bash
|
||||
|
||||
PKG_DEPENDENCIES="sqlite3 libldap2-dev libsasl2-dev python3-dev imagemagick python3-lxml libjpeg-dev"
|
||||
PKG_DEPENDENCIES="sqlite3 libldap2-dev libsasl2-dev python3-dev imagemagick python3-lxml libjpeg-dev zlib1g-dev"
|
||||
#PKG_DEPENDENCIES="sqlite3 python3-pip imagemagick"
|
||||
|
||||
DOSSIER_MEDIA=/home/yunohost.multimedia
|
||||
|
||||
#These var are used in init_calibre_db_settings conf file
|
||||
log_file=/var/log/$app/$app.log
|
||||
access_log_file=/var/log/$app/$app-access.log
|
||||
|
||||
|
|
|
|||
|
|
@ -177,26 +177,6 @@ chown -R $app:$app /var/log/$app
|
|||
#=================================================
|
||||
# SPECIFIC SETUP
|
||||
#=================================================
|
||||
# SET SQLITE DATABASE SETTINGS
|
||||
#=================================================
|
||||
ynh_script_progression --message="Setting up database and settings..." --weight=5
|
||||
#we need to start and stop the service so that initial app.db file is created and that we can set default data
|
||||
#If port 8083 is already in use (ex for second instance), then service start will fail, which is expected : so we do not want
|
||||
#to set $port on the line match. "server on" will be displayed in case the port is already in use and should be ok to spot the fact that the database is initialized.
|
||||
#ynh_systemd_action --service_name=$app --action="start" --line_match="Starting Gevent server on" --log_path="$final_path/calibre-web.log" -t 30
|
||||
#sleep required on low spec like raspberryPi
|
||||
#sleep 2s
|
||||
#remove unwanted calibre-web.log
|
||||
#ynh_secure_remove --file="$final_path/calibre-web.log"
|
||||
#ynh_systemd_action --service_name=$app --action="stop"
|
||||
|
||||
|
||||
#set database settings as per conf file
|
||||
#conf="\"UPDATE settings SET $(. <(echo -E echo $(<../conf/init_calibre_db_settings))), $(. <(echo -E echo $(<../conf/init_calibre_db_ldap_settings))) WHERE ID=1\""
|
||||
#eval sqlite3 $final_path/app.db "$conf"
|
||||
|
||||
#conf="\"UPDATE user SET $(. <(echo -E echo $(<../conf/init_calibre_db_user))) WHERE ID=1\""
|
||||
#eval sqlite3 $final_path/app.db "$conf"
|
||||
|
||||
#Update Imagick policy as per https://github.com/janeczku/calibre-web/wiki/FAQ#what-to-do-if-cover-pictures-are-not-extracted-from-pdf-files
|
||||
ynh_replace_string --match_string="<policy domain="coder" rights="none" pattern="PDF" />" \
|
||||
|
|
|
|||
|
|
@ -111,4 +111,4 @@ ynh_system_user_delete --username=$app
|
|||
# MESSAGE TO USER
|
||||
#=================================================
|
||||
ynh_script_progression --message="Removal of $app completed" --last
|
||||
ynh_print_warn "!!!The library folder $calibre_dir was not deleted. Delete it manually if required!!!"
|
||||
ynh_print_info "The library folder $calibre_dir was not deleted. Delete it manually if required"
|
||||
|
|
|
|||
|
|
@ -114,6 +114,12 @@ if version_gt "0.6.6" "$current_upstream_app_version" && [ "$current_upstream_pa
|
|||
current_upstream_app_version="0.6.6"
|
||||
fi
|
||||
|
||||
#LDAP settings were wrongly set in version prior to 0.6.13 and we could not retrieve LDAP users. This will change the settings to correct values
|
||||
if sqlite3 $final_path/app.db "SELECT config_ldap_group_object_filter FROM settings" \
|
||||
| grep -xq "(&(objectClass=posixGroup)(permission=cn=%s.main,ou=permission,dc=yunohost,dc=org))" ; then
|
||||
eval sqlite3 $final_path/app.db "\"UPDATE settings SET config_ldap_group_object_filter='(&(objectClass=posixGroup)(cn=%s.main))' WHERE ID=1\""
|
||||
fi
|
||||
|
||||
#=================================================
|
||||
# STANDARD UPGRADE STEPS
|
||||
#=================================================
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@
|
|||
config_ldap_member_user_object = Column(String, default='') #
|
||||
config_ldap_openldap = Column(Boolean, default=True)
|
||||
- config_ldap_group_object_filter = Column(String, default='(&(objectclass=posixGroup)(cn=%s))')
|
||||
+ config_ldap_group_object_filter = Column(String, default='(&(objectClass=posixGroup)(permission=cn=%s.main,ou=permission,dc=yunohost,dc=org))')
|
||||
+ config_ldap_group_object_filter = Column(String, default='(&(objectClass=posixGroup)(cn=%s.main))')
|
||||
config_ldap_group_members_field = Column(String, default='memberUid')
|
||||
config_ldap_group_name = Column(String, default='calibreweb')
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue