diff --git a/README.md b/README.md index d4c6a25..029eedc 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,71 @@ # Garradin -## Garradin est un logiciel libre de gestion associative. il permet de gérer des membres. - - -### State : Testing/Production ### - -report issue/rapport de bogues: https://github.com/Yunohost-Apps/garradin_ynh/issues -site de garradin : http://garradin.eu - -[![Integration level](https://dash.yunohost.org/integration/garradin.svg)](https://ci-apps.yunohost.org/jenkins/job/garradin%20%28Community%29/lastBuild/consoleFull)
+[![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) [![Install Garradin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=garradin) -## Installation : -- CLI -`sudo yunohost app install https://github.com/Yunohost-Apps/garradin_ynh` +*[Lire ce readme en français.](./README_fr.md)* -- À travers l'interface d'administration +> *This package allows you to install Garradin 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.* -### TODO list : -- Permissions de certains fichiers sensibles ? +## Overview +Garradin is a free association managing software. -#### Problèmes / Avertissements : -- le système SSO n'est pas implémenté, ni l'installation directe. L'utilisateur admin devra créer son compte avec le formulaire de création de compte qu'il trouvera à la fin de l'installation. Plusieurs raisons m'ont poussé à ne pas implémenter le SSO : - - Le SSO n'est pas implémenté dans l'app originale. - - Avoir 150+ utilisateurs dans Yunohost n'est pas très pratique, ni très sécurisé, et revient en fin de compte à centraliser les services. - - Ce formulaire laisse le choix à l'administrateur de choisir les modalités de création de son compte. On pourrait peut-être me reprocher de ne pas avoir intégré ce formulaire dans le formulaire d'installation que l'utilisateur remplit avant l'installation de ce paquet. Il est vrai que j'aurais pu mettre les ~dix champs qui compose le formulaire de Garradin, mais je ne trouvais pas cela très pratique. -- Cette application n'est disponible qu'en Français (la loi 1901 sur les asso n'étant appliquée qu'en France). +**Shipped version:** 0.9.5 + +## Screenshots + +![](images/membre.png) +![](images/compta.png) +![](images/emails.png) +![](images/wiki.png) +![](images/site.jpg) + +## Demo + +* [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%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/garradin/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/garradin%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/garradin/) + +## Limitations + +* The application is ONLY translated into french. + +**More info on the documentation page:** +https://yunohost.org/packaging_apps + +## 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/ + +--- + +Developer info +---------------- + +**Only if you want to use a testing branch for coding, instead of merging directly into master.** +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/garradin_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/garradin_ynh/tree/testing --debug +or +sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/garradin_ynh/tree/testing --debug +``` diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..21dd344 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,70 @@ +# Garradin + +[![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.png)](https://install-app.yunohost.org/?app=garradin) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d'installer REPLACEBYYOURAPP 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.* + +## Vue d'ensemble +Garradin est un logiciel libre de gestion associative. il permet de gérer des membres. + +**Version incluse :** 0.9.5 + +## Captures d'écran + +![](images/membre.png) +![](images/compta.png) +![](images/emails.png) +![](images/wiki.png) +![](images/site.jpg) + +## Démo + +* [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%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/garradin/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/garradin%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/garradin/) + +## Limitations + +* Garradin n'est disponible qu'en français. + +**Plus d'informations sur la page de documentation :** +https://yunohost.org/packaging_apps + +## 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/ + +--- + +Informations pour les développeurs +---------------- + +**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.** +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/garradin_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/garradin_ynh/tree/testing --debug +ou +sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/garradin_ynh/tree/testing --debug +``` diff --git a/conf/nginx.conf b/conf/nginx.conf index 8328b41..bb48715 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,27 +1,26 @@ +#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__ { -# Path to source -alias __FINALPATH__/www/ ; + # Path to source + alias __FINALPATH__/www/ ; -if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; + if ($scheme = http) { + rewrite ^ https://$server_name$request_uri? permanent; + } + + index index.php /_route.php; + try_files $uri $uri/ index.php /_route.php; + + location ~ [^/]\.php(/|$) { + fastcgi_split_path_info ^(.+?\.php)(/.*)$; + fastcgi_pass unix:/var/run/php/php7.0-fpm-__NAME__.sock; + fastcgi_index index.php; + include fastcgi_params; + fastcgi_param REMOTE_USER $remote_user; + fastcgi_param PATH_INFO $fastcgi_path_info; + fastcgi_param SCRIPT_FILENAME $request_filename; + } + + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; } - - # Example PHP configuration (remove if not used) - index index.php /_route.php; - try_files $uri $uri/ index.php /_route.php; - -location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php/php7.0-fpm-__NAME__.sock; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - fastcgi_param SCRIPT_FILENAME $request_filename; -} - # PHP configuration end - - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; -} \ No newline at end of file diff --git a/images/compta.png b/images/compta.png new file mode 100644 index 0000000..4b4b1fb Binary files /dev/null and b/images/compta.png differ diff --git a/images/emails.png b/images/emails.png new file mode 100644 index 0000000..6e28824 Binary files /dev/null and b/images/emails.png differ diff --git a/images/membre.png b/images/membre.png new file mode 100644 index 0000000..e4f0c8d Binary files /dev/null and b/images/membre.png differ diff --git a/images/site.jpg b/images/site.jpg new file mode 100644 index 0000000..a864faa Binary files /dev/null and b/images/site.jpg differ diff --git a/images/wiki.png b/images/wiki.png new file mode 100644 index 0000000..de1159b Binary files /dev/null and b/images/wiki.png differ diff --git a/scripts/change_url b/scripts/change_url index 7244972..dfd11fe 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -29,27 +29,37 @@ ynh_script_progression --message="Loading installation settings..." --time --wei # Needed for helper "ynh_add_nginx_config" final_path=$(ynh_app_setting_get --app=$app --key=final_path) -# #================================================= -# # CHECK THE SYNTAX OF THE PATHS -# #================================================= +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up the app before changing its url (may take a while)..." --time --weight=1 -# test -n "$old_path" || old_path="/" -# test -n "$new_path" || new_path="/" -# new_path=$(ynh_normalize_url_path $new_path) -# old_path=$(ynh_normalize_url_path $old_path) +# 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 #================================================= change_domain=0 -if [ "$old_domain" != "$new_domain" ]; then - change_domain=1 +if [ "$old_domain" != "$new_domain" ] +then + change_domain=1 fi change_path=0 -if [ "$old_path" != "$new_path" ]; then - change_path=1 +if [ "$old_path" != "$new_path" ] +then + change_path=1 fi #================================================= @@ -107,4 +117,4 @@ ynh_systemd_action --service_name=nginx --action=reload # END OF SCRIPT #================================================= -ynh_script_progression --message="Change of URL completed for $app" --time --last \ No newline at end of file +ynh_script_progression --message="Change of URL completed for $app" --time --last