diff --git a/README.md b/README.md index a7cd47e..758bdef 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,31 @@ + + # Wallabag for YunoHost [![Integration level](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.maintain.svg) -[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) +[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wallabag2) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Wallabag 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.* +> *This package allows you to install Wallabag 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 -[Wallabag](https://www.wallabag.org/) is a self hostable Read-It-Later application allowing you to not miss any content anymore. Click, save, read it when you can. -It extracts content so that you can read it when you have time. +A self hostable read-it-later app -It provides a web interface, browser (Firefox / Chrome / Opera) add-ons, mobile apps (Android / iOS / Windows Phone) and even on e-reader (PocketBook / Kobo). +**Shipped version:** 2.4.2~ynh1 -**Shipped version:** 2.4.2 +**Demo:** https://demo.yunohost.org/wallabag/ ## Screenshots -![](https://www.linuxbabe.com/wp-content/uploads/2016/10/wallabag-quick-start-page.png) +![](./doc/screenshots/wallabag-quick-start-page.png) -## Demo - -* [YunoHost demo](https://demo.yunohost.org/wallabag/) -* [Video demo](https://player.vimeo.com/video/167435064) - -## Configuration - -## Documentation - - * Official documentation: https://doc.wallabag.org/en/ - * YunoHost documentation: https://yunohost.org/#/app_wallabag2 +## Disclaimers / important information ## YunoHost specific features @@ -41,46 +35,28 @@ In addition to Wallabag core features, the following are made available with thi * Allow one user to be the administrator (set at the installation) * Asynchronous import using Redis (need to be enabled in the *Internal Settings*). RabbitMQ import not supported (yet ?) -#### Multi-users support - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wallabag2/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wallabag2/) - ## Limitations * Removing a Yunohost's user won't delete the related wallabag user, but only desactivate it. You need to manualy remove it from wallabag before. See: https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39 -## Additional information +## Documentation and resources -**NB: Since @jeromelebleu is no longer maintaining this package, I (@lapineige) take over this repository. But I have limited time and experience, so feel free to help !** +* Official app website: https://www.wallabag.org +* Official user documentation: https://yunohost.org/#/app_wallabag2 +* Official admin documentation: https://doc.wallabag.org/en/ +* Upstream app code repository: https://github.com/wallabag/wallabag +* YunoHost documentation for this app: https://yunohost.org/app_wallabag2 +* Report a bug: https://github.com/YunoHost-Apps/wallabag2_ynh/issues -#### Upgrade from v1 +## Developer info -The upgrade from the YunoHost [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) -app requires a manual operation, that's why it's provided as a new package. -For the migration process, please refer to the -[Wallabag official documentation](https://doc.wallabag.org/en/user/import/wallabagv1.html). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing). -## Links - - * Report a bug: https://github.com/YunoHost-Apps/wallabag2_ynh/issues - * App website: https://www.wallabag.org/ - * Upstream app repository: https://github.com/wallabag/wallabag - * YunoHost website: https://yunohost.org/ - ---- - -## Developers and testers info - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing). - -To try the testing branch, please proceed like that: +To try the testing branch, please proceed like that. ``` sudo yunohost app install https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug or sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug ``` -Please be aware that the testing branch *might* contains some bugs and is not recommended if you need a stable app. -Doing a normal upgrade of the package avec `sudo yunohost app upgrade wallabag2` (without any URL specified) will revert you app to the master branch. + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 00b0cb0..9bbcc06 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,36 +1,27 @@ # Wallabag pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.maintain.svg) -[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) +[![Niveau d'intégration](https://dash.yunohost.org/integration/wallabag2.svg)](https://dash.yunohost.org/appci/app/wallabag2) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/wallabag2.maintain.svg) +[![Installer Wallabag avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wallabag2) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Wallabag rapidement et simplement sur un serveur YunoHost. +> *Ce package vous permet d'installer Wallabag 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 -[Wallabag](https://www.wallabag.org/) est une application de lecture différée : elle permet simplement d’archiver une page web en ne conservant que le contenu. Les éléments superflus (menus, publicités, etc.) sont supprimés. +Une application de lecture-plus-tard auto-hébergeable -Sont disponibles une interface web, des add-ons pour navigateurs (Firefox / Chrome / Opera), des applications pour mobile (Android / iOS / Windows Phone) et même sur liseuse (PocketBook / Kobo). +**Version incluse :** 2.4.2~ynh1 -**Version incluse:** 2.4.2 +**Démo :** https://demo.yunohost.org/wallabag/ ## Captures d'écran -![](https://www.linuxbabe.com/wp-content/uploads/2016/10/wallabag-quick-start-page.png) +![](./doc/screenshots/wallabag-quick-start-page.png) -## Démo - -* [Démo YunoHost](https://demo.yunohost.org/wallabag/) -* [Démo video](https://player.vimeo.com/video/167435064) - -## Configuration - -## Documentation - - * Documentation officielle : https://doc.wallabag.org/fr/ - * Documentation YunoHost : https://yunohost.org/#/app_wallabag2 +## Avertissements / informations importantes ## Caractéristiques spécifiques YunoHost @@ -40,45 +31,28 @@ En plus des fonctionnalités principales de Wallabag, ce paquet propose égaleme * De permettre à un utilisateur d'être administrateur (réglage lors de l'installation) * Un import asynchrone utilisant Redis (à activer dans les *Paramètres Internes*). L'import via RabbitMQ n'est pas (encore ?) supporté. -#### Support multi-utilisateurs - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wallabag2/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wallabag2%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wallabag2/) - ## Limitations * Supprimer un utilisateur YunoHost ne supprimera pas l'utilisateur Wallabag lié, il sera seulement désactivé. Vous devez le supprimer manuellement avant. Voir : https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39 -## Informations additionnelles +## Documentations et ressources -**NB: Depuis que @jeromelebleu ne maintient plus ce paquet, je (@lapineige) reprends la charge de ce dépôt. Mais j'ai un temps et une expérience limitées, donc n'hésitez pas à donner un coup de main :) !** - - -#### Mettre à niveau depuis la v1 - -La mise à niveau depuis le paquet YunoHost de [Wallabag v1](https://github.com/YunoHost-Apps/wallabag_ynh) demande une opération manuelle, c'est pourquoi un nouveau paquet est fournit. -Pour le processus de migration, merci de vous référer à [la documentation officiel de Wallabag](https://doc.wallabag.org/fr/user/import/wallabagv1.html). - -## Links - - * Signaler un bug : https://github.com/YunoHost-Apps/wallabag2_ynh/issues - * Site de l'application : https://www.wallabag.org/ - * Dépôt de l'application principale : https://github.com/wallabag/wallabag - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://www.wallabag.org +* Documentation officielle utilisateur : https://yunohost.org/#/app_wallabag2 +* Documentation officielle de l'admin : https://doc.wallabag.org/en/ +* Dépôt de code officiel de l'app : https://github.com/wallabag/wallabag +* Documentation YunoHost pour cette app : https://yunohost.org/app_wallabag2 +* Signaler un bug : https://github.com/YunoHost-Apps/wallabag2_ynh/issues ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing). -Pour essayer la branche testing, procédez comme ceci : +Pour essayer la branche testing, procédez comme suit. ``` sudo yunohost app install https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug ou sudo yunohost app upgrade wallabag2 -u https://github.com/YunoHost-Apps/wallabag2_ynh/tree/testing --debug ``` -Soyez concient que la branche testing *pourrait* contenir des bugs et n'est pas recommandée si vous recherchez la stabilité de votre application. -Une mise à jour classique avec `sudo yunohost app upgrade wallabag2` (sans préciser l'URL) fera retourner votre application au niveau de la branche master. + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/conf/app.src b/conf/app.src index 41bda61..ceaa0db 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,4 +1,4 @@ -SOURCE_URL=https://static.wallabag.org/releases/wallabag-release-2.4.2.tar.gz +SOURCE_URL=https://github.com/wallabag/wallabag/releases/download/2.4.2/wallabag-2.4.2.tar.gz SOURCE_SUM=da56ec37ed3d78a4b4132e8a248ac4997442eefaad6f831805304a8c317569d8 SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.gz diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..65bd66e --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,11 @@ +## YunoHost specific features + +In addition to Wallabag core features, the following are made available with this package: + + * Integrate with YunoHost users and SSO - i.e. logout button + * Allow one user to be the administrator (set at the installation) + * Asynchronous import using Redis (need to be enabled in the *Internal Settings*). RabbitMQ import not supported (yet ?) + +## Limitations + +* Removing a Yunohost's user won't delete the related wallabag user, but only desactivate it. You need to manualy remove it from wallabag before. See: https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39 diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..ca8cdf9 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,11 @@ +## Caractéristiques spécifiques YunoHost + +En plus des fonctionnalités principales de Wallabag, ce paquet propose également : + + * Une intégration avec le système de gestion des utilisateurs et le SSO de YunoHost - e.g. un bouton de déconnexion + * De permettre à un utilisateur d'être administrateur (réglage lors de l'installation) + * Un import asynchrone utilisant Redis (à activer dans les *Paramètres Internes*). L'import via RabbitMQ n'est pas (encore ?) supporté. + +## Limitations + +* Supprimer un utilisateur YunoHost ne supprimera pas l'utilisateur Wallabag lié, il sera seulement désactivé. Vous devez le supprimer manuellement avant. Voir : https://github.com/YunoHost-Apps/wallabag2_ynh/issues/39 diff --git a/doc/screenshots/wallabag-quick-start-page.png b/doc/screenshots/wallabag-quick-start-page.png new file mode 100644 index 0000000..d8c25f5 Binary files /dev/null and b/doc/screenshots/wallabag-quick-start-page.png differ diff --git a/manifest.json b/manifest.json index d042a79..18315d3 100644 --- a/manifest.json +++ b/manifest.json @@ -8,6 +8,14 @@ }, "version": "2.4.2~ynh1", "url": "https://www.wallabag.org", + "upstream": { + "license": "MIT", + "website": "https://www.wallabag.org", + "demo": "https://demo.yunohost.org/wallabag/", + "admindoc": "https://doc.wallabag.org/en/", + "userdoc": "https://yunohost.org/#/app_wallabag2", + "code": "https://github.com/wallabag/wallabag" + }, "license": "MIT", "maintainer": { "name": "lapineige", diff --git a/scripts/change_url b/scripts/change_url index df33ee7..ab2a542 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -8,7 +8,6 @@ source _common.sh source /usr/share/yunohost/helpers -ynh_abort_if_errors #================================================= # RETRIEVE ARGUMENTS @@ -32,6 +31,23 @@ db_user=$db_name db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) final_path=$(ynh_app_setting_get --app=$app --key=final_path) +#================================================= +# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 + +# Backup the current version of the app +ynh_backup_before_upgrade +ynh_clean_setup () { + # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. + ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" + + # Restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + #================================================= # CHECK WHICH PARTS SHOULD BE CHANGED #================================================= diff --git a/scripts/install b/scripts/install index 79bc401..d3e035a 100644 --- a/scripts/install +++ b/scripts/install @@ -79,7 +79,7 @@ ynh_setup_source --dest_dir="$final_path" #================================================= ynh_script_progression --message="Configuring NGINX web server..." --weight=2 -# Create a dedicated nginx config +# Create a dedicated NGINX config ynh_add_nginx_config #================================================= @@ -162,14 +162,14 @@ ynh_replace_string --match_string="__APP__" --replace_string="$app" --target_fil #================================================= # SETUP SSOWAT #================================================= -ynh_script_progression --message="Configuring permissions..." +ynh_script_progression --message="Configuring permissions..." --weight=1 ynh_permission_update --permission="main" --add="visitors" #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 ynh_systemd_action --service_name=nginx --action=reload