diff --git a/README.md b/README.md index a1abc22..39f59f7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Garradin for YunoHost [![Integration level](https://dash.yunohost.org/integration/garradin.svg)](https://dash.yunohost.org/appci/app/garradin) ![](https://ci-apps.yunohost.org/ci/badges/garradin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/garradin.maintain.svg) @@ -9,50 +14,24 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -Garradin is a free association managing software. -**Shipped version:** 1.1.10 +Garradin (word meaning money in an aboriginal dialect of northern Australia, pronounced "gar-a-dine" em) is software for associative management. It is the tool of choice for managing an association, a sports club, an NGO, etc. It is designed to meet the needs of a small to medium-sized structure: management of members, accounting, website, note-taking in meetings, archiving and sharing of the association's operating documents, discussion between members, etc. etc. . + +**Shipped version:** 1.1.10~ynh1 + +**Demo:** https://garradin.eu/essai/ ## Screenshots -![](images/membre-v1.1.png) -![](images/compta.png) -![](images/emails.png) -![](images/edition-site-v1.1.png) -![](images/site.jpg) +![](./doc/screenshots/screenshot.png) -## Demo +## Documentation and resources -* [Official demo](https://garradin.eu/essai/) - -## Documentation - - * Official documentation: https://fossil.kd2.org/garradin/wiki?name=Documentation - -## YunoHost specific features - -#### Multi-user support - -LDAP is not supported yet. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/garradin.svg)](https://ci-apps.yunohost.org/ci/apps/garradin/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/garradin.svg)](https://ci-apps-arm.yunohost.org/ci/apps/garradin/) - -## Limitations - -* The application is ONLY translated into french. -* Do not install this application on the default root path's domain name without adding a subpath, otherwise the sso conection page will be substitute by home's garradin page. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/garradin_ynh/issues - * App website: https://garradin.eu - * Upstream app repository: https://fossil.kd2.org/garradin/wiki?name=Garradin - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: http://garradin.eu +* Official admin documentation: https://fossil.kd2.org/garradin/wiki?name=Documentation +* Upstream app code repository: https://fossil.kd2.org/garradin/wiki?name=Garradin +* YunoHost documentation for this app: https://yunohost.org/app_garradin +* Report a bug: https://github.com/YunoHost-Apps/garradin_ynh/issues ## Developer info @@ -64,3 +43,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/garradin_ynh/tree/tes or sudo yunohost app upgrade garradin -u https://github.com/YunoHost-Apps/garradin_ynh/tree/testing --debug ``` + +**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 a1437e6..e76169a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,58 +1,33 @@ # Garradin pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/garradin.svg)](https://dash.yunohost.org/appci/app/garradin) ![](https://ci-apps.yunohost.org/ci/badges/garradin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/garradin.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/garradin.svg)](https://dash.yunohost.org/appci/app/garradin) ![](https://ci-apps.yunohost.org/ci/badges/garradin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/garradin.maintain.svg) [![Installer Garradin avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=garradin) *[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Garradin rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/install) pour apprendre comment l'installer.* +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## Vue d'ensemble -Garradin est un logiciel libre de gestion associative. il permet de gérer des membres. -**Version incluse :** 1.1.10 +Garradin (mot signifiant argent dans un dialecte aborigène du nord de l'Australie, prononcé « gar-a-dine »em) est un logiciel de gestion associative. Il est l'outil de prédilection pour gérer une association, un club sportif, une ONG, etc. Il est conçu pour répondre aux besoins d'une structure de petite à moyenne taille : gestion des adhérents, comptabilité, site web, prise de notes en réunion, archivage et partage des documents de fonctionnement de l'association, discussion entre adhérents, etc etc. + +**Version incluse :** 1.1.10~ynh1 + +**Démo :** https://garradin.eu/essai/ ## Captures d'écran -![](images/membre-v1.1.png) -![](images/compta.png) -![](images/emails.png) -![](images/edition-site-v1.1.png) -![](images/site.jpg) +![](./doc/screenshots/screenshot.png) -## Démo +## Documentations et ressources -* [Démo officielle](https://garradin.eu/essai/) - -## Documentation - - * Documentation officielle : https://fossil.kd2.org/garradin/wiki?name=Documentation - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP n'est pas disponible. - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/garradin.svg)](https://ci-apps.yunohost.org/ci/apps/garradin/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/garradin.svg)](https://ci-apps-arm.yunohost.org/ci/apps/garradin/) - -## Limitations - -* Garradin n'est disponible qu'en français. -* N'installez pas cette apllication à la racine du domaine par défaut sans ajouter un sous-domaine. Sinon la page de connexion SSO sera remplacée par la page d'accueil de Garradin. - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/garradin_ynh/issues - * Site de l'application : http://garradin.eu - * Dépôt de l'application principale : https://fossil.kd2.org/garradin/wiki?name=Garradin - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : http://garradin.eu +* Documentation officielle de l'admin : https://fossil.kd2.org/garradin/wiki?name=Documentation +* Dépôt de code officiel de l'app : https://fossil.kd2.org/garradin/wiki?name=Garradin +* Documentation YunoHost pour cette app : https://yunohost.org/app_garradin +* Signaler un bug : https://github.com/YunoHost-Apps/garradin_ynh/issues ## Informations pour les développeurs @@ -64,3 +39,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/garradin_ynh/tree/tes ou sudo yunohost app upgrade garradin -u https://github.com/YunoHost-Apps/garradin_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/check_process b/check_process index cc22c57..5eda0e2 100644 --- a/check_process +++ b/check_process @@ -1,8 +1,8 @@ ; Test complet ; Manifest - domain="domain.tld" (DOMAIN) - path="/path" (PATH) - is_public=1 (PUBLIC|public=1|private=0) + domain="domain.tld" + path="/path" + is_public=1 ; Checks pkg_linter=1 setup_sub_dir=1 @@ -11,6 +11,14 @@ setup_private=1 setup_public=1 upgrade=1 + #upgrade=1 from_commit=a36dd8b13d85078ddcee0d6d3146feb107d3e042 backup_restore=1 multi_instance=1 change_url=1 +;;; Options +Email= +Notification=none +;;; Upgrade options + ; commit=a36dd8b13d85078ddcee0d6d3146feb107d3e042 + name=Merge pull request #55 from yunohost-bot/issue-and-pr-template + manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666& diff --git a/conf/app.src b/conf/app.src index ea10a5d..3e30ce9 100644 --- a/conf/app.src +++ b/conf/app.src @@ -3,4 +3,3 @@ SOURCE_SUM=56785921ce99d8424871bf340a3225016fede10345e3ce9fe51e47facc2e88cc SOURCE_SUM_PRG=sha256sum SOURCE_FORMAT=tar.bz2 SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..20fa158 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1 @@ +Garradin (word meaning money in an aboriginal dialect of northern Australia, pronounced "gar-a-dine" em) is software for associative management. It is the tool of choice for managing an association, a sports club, an NGO, etc. It is designed to meet the needs of a small to medium-sized structure: management of members, accounting, website, note-taking in meetings, archiving and sharing of the association's operating documents, discussion between members, etc. etc. . \ No newline at end of file diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..7f3f080 --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1 @@ +Garradin (mot signifiant argent dans un dialecte aborigène du nord de l'Australie, prononcé « gar-a-dine »em) est un logiciel de gestion associative. Il est l'outil de prédilection pour gérer une association, un club sportif, une ONG, etc. Il est conçu pour répondre aux besoins d'une structure de petite à moyenne taille : gestion des adhérents, comptabilité, site web, prise de notes en réunion, archivage et partage des documents de fonctionnement de l'association, discussion entre adhérents, etc etc. \ No newline at end of file diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..e69de29 diff --git a/doc/screenshots/screenshot.png b/doc/screenshots/screenshot.png new file mode 100644 index 0000000..4aceda2 Binary files /dev/null and b/doc/screenshots/screenshot.png differ diff --git a/manifest.json b/manifest.json index bb35489..cf151b2 100644 --- a/manifest.json +++ b/manifest.json @@ -7,14 +7,21 @@ "fr": "Logiciel libre de gestion d'association" }, "version": "1.1.10~ynh1", - "url": "http://garradin.eu/a-propos/", + "url": "http://garradin.eu", + "upstream": { + "license": "GPL-3.0-or-later", + "website": "http://garradin.eu", + "demo": "https://garradin.eu/essai/", + "admindoc": "https://fossil.kd2.org/garradin/wiki?name=Documentation", + "code": "https://fossil.kd2.org/garradin/wiki?name=Garradin" + }, "license": "GPL-3.0-or-later", "maintainer": { "name": "frju365", "email": "win10@tutanota.com" }, "requirements": { - "yunohost": ">=4.1.7" + "yunohost": ">=4.2.4" }, "multi_instance": true, "services": [ diff --git a/pull_request_template.md b/pull_request_template.md deleted file mode 100644 index ef70e18..0000000 --- a/pull_request_template.md +++ /dev/null @@ -1,16 +0,0 @@ -## Problem - -- *Description of why you made this PR* - -## Solution - -- *And how do you fix that problem* - -## PR Status - -- [ ] Code finished and ready to be reviewed/tested -- [ ] The fix/enhancement were manually tested (if applicable) - -## Automatic tests - -Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/scripts/install b/scripts/install index b7447b9..056bbe3 100644 --- a/scripts/install +++ b/scripts/install @@ -51,7 +51,7 @@ ynh_app_setting_set --app=$app --key=path --value=$path_url ynh_script_progression --message="Configuring system user..." --weight=3 # Create a system user -ynh_system_user_create --username=$app +ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -76,7 +76,7 @@ ynh_add_nginx_config ynh_script_progression --message="Configuring PHP-FPM..." --weight=5 # Create a dedicated PHP-FPM config -ynh_add_fpm_config --phpversion=$YNH_PHP_VERSION --package="$extra_php_dependencies" +ynh_add_fpm_config --package="$extra_php_dependencies" #================================================= # ADD A CONFIGURATION @@ -112,7 +112,7 @@ ynh_script_progression --message="Configuring permissions..." --weight=8 # Make app public if necessary if [ $is_public -eq 1 ] then - ynh_permission_update --permission "main" --add "visitors" + ynh_permission_update --permission="main" --add="visitors" fi #================================================= diff --git a/scripts/remove b/scripts/remove index 3f0c7d7..7780ced 100644 --- a/scripts/remove +++ b/scripts/remove @@ -41,7 +41,7 @@ ynh_remove_nginx_config ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=2 # Remove the dedicated PHP-FPM config -ynh_remove_fpm_config --phpversion=$YNH_PHP_VERSION --package="$extra_php_dependencies" +ynh_remove_fpm_config --package="$extra_php_dependencies" #================================================= # GENERIC FINALIZATION diff --git a/scripts/restore b/scripts/restore index 4ba8ebe..d702b05 100644 --- a/scripts/restore +++ b/scripts/restore @@ -45,20 +45,20 @@ test ! -d $final_path \ ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# RESTORE THE APP MAIN DIR -#================================================= -ynh_script_progression --message="Restoring Garradin main directory..." --weight=5 - -ynh_restore_file "$final_path" - #================================================= # RECREATE THE DEDICATED USER #================================================= ynh_script_progression --message="Recreating the dedicated system user..." --weight=3 # Create the dedicated user (if not existing) -ynh_system_user_create --username=$app +ynh_system_user_create --username=$app --home_dir="$final_path" + +#================================================= +# RESTORE THE APP MAIN DIR +#================================================= +ynh_script_progression --message="Restoring Garradin main directory..." --weight=5 + +ynh_restore_file --origin_path="$final_path" #================================================= # RESTORE USER RIGHTS @@ -80,7 +80,7 @@ ynh_script_progression --message="Reconfiguring PHP-FPM..." --weight=6 ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" -ynh_add_fpm_config --phpversion=$YNH_PHP_VERSION --package="$extra_php_dependencies" +ynh_add_fpm_config --package="$extra_php_dependencies" #================================================= # GENERIC FINALIZATION @@ -89,7 +89,7 @@ ynh_add_fpm_config --phpversion=$YNH_PHP_VERSION --package="$extra_php_dependenc #================================================= ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." --weight=1 -ynh_systemd_action --service_name=php${phpversion}-fpm --action=reload +ynh_systemd_action --service_name=php$phpversion-fpm --action=reload ynh_systemd_action --service_name=nginx --action=reload #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 8b5a911..27f5e05 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -31,6 +31,20 @@ else upgrade_type=$(ynh_check_app_version_changed) fi +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up Garradin before upgrading (may take a while)..." --weight=30 + +# Backup the current version of the app +ynh_backup_before_upgrade +ynh_clean_setup () { + # restore it if the upgrade fails + ynh_restore_upgradebackup +} +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= @@ -65,21 +79,6 @@ if [ -e "$bdd" ]; then cp -a $bdd /tmp/association.sqlite fi -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up Garradin before upgrading (may take a while)..." --weight=30 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - - #================================================= # UPGRADE TO 0.9.8 if necessary #================================================= @@ -136,26 +135,25 @@ then upgrade_type="UPGRADE_APP" fi +#================================================= +# CREATE DEDICATED USER +#================================================= +ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 + +# Create a dedicated user (if not existing) +ynh_system_user_create --username=$app --home_dir="$final_path" + #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Upgrading source files..." --weight=5 - if [ "$upgrade_type" == "UPGRADE_APP" ] then # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$final_path" fi -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app - #================================================= # NGINX CONFIGURATION #================================================= @@ -170,8 +168,7 @@ ynh_add_nginx_config ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=2 # Create a dedicated PHP-FPM config -ynh_add_fpm_config --phpversion=$YNH_PHP_VERSION --package="$extra_php_dependencies" -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) +ynh_add_fpm_config --package="$extra_php_dependencies" #======================================================= # backup bdd, squelettes directory and config.local.php