Merge pull request #41 from YunoHost-Apps/cleaning

Cleaning

README.md

@@ -28,29 +28,12 @@ The idea of [æneria](https://aeneria.com) is to display energy consumption and
 
 ![Screenshot of æneria](./doc/screenshots/screenshot1.png)
 
-## Disclaimers / important information
-
-## Configuration
-
-* First of all, you'll need a Linky and an [Enedis account](https://mon-compte-client.enedis.fr/)
-* In your Enedis space, go to ["Gérer l'accès à mes données"](https://mon-compte-particulier.enedis.fr/donnees/) tab, and allow Enedis to collect and store your hourly consumption
-* After that, install æneria to your Yunohost instance, visit it and just follow instructions
-* That's it, now wait a bit to see data appear !
-
-## Comming from Pilea
-
-æneria is the new name of Pilea. This new name came whith a brand new version.
-
-This new version introduced some breaking changes in data structure: migration from Pilea can't be done automaticly.
-
-But don't worry, you can easilly transfer your data from Pilea to æneria following [this documentation](https://docs.aeneria.com/fr/latest/administrateur/pilea_migration.html).
-
 ## Documentation and resources
 
 * Official app website: <https://aeneria.com>
 * Official admin documentation: <https://docs.aeneria.com>
 * Upstream app code repository: <https://gitlab.com/aeneria/aeneria-app>
-* YunoHost documentation for this app: <https://yunohost.org/app_aeneria>
+* YunoHost Store: <https://apps.yunohost.org/app/aeneria>
 * Report a bug: <https://github.com/YunoHost-Apps/aeneria_ynh/issues>
 
 ## Developer info

README_fr.md

@@ -16,11 +16,10 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
 
 ## Vue d’ensemble
 
-The idea of [æneria](https://aeneria.com) is to display energy consumption and weather data on a little dashboard that allow the user to:
+L'idée de [æneria](https://aeneria.com) est d'afficher la consommation d'énergie et les données météorologiques sur un petit tableau de bord qui permet à l'utilisateur de :
-
- * Better understand our own energy consumption
- * Analyse energy consumption throw weather data
 
+  * Mieux comprendre sa propre consommation d'énergie
+  * Analyser la consommation d'énergie et les données météorologiques
 
 **Version incluse :** 1.1.6~ynh4
 
@@ -28,29 +27,12 @@ The idea of [æneria](https://aeneria.com) is to display energy consumption and
 
 ![Capture d’écran de æneria](./doc/screenshots/screenshot1.png)
 
-## Avertissements / informations importantes
-
-## Configuration
-
-* First of all, you'll need a Linky and an [Enedis account](https://mon-compte-client.enedis.fr/)
-* In your Enedis space, go to ["Gérer l'accès à mes données"](https://mon-compte-particulier.enedis.fr/donnees/) tab, and allow Enedis to collect and store your hourly consumption
-* After that, install æneria to your Yunohost instance, visit it and just follow instructions
-* That's it, now wait a bit to see data appear !
-
-## Comming from Pilea
-
-æneria is the new name of Pilea. This new name came whith a brand new version.
-
-This new version introduced some breaking changes in data structure: migration from Pilea can't be done automaticly.
-
-But don't worry, you can easilly transfer your data from Pilea to æneria following [this documentation](https://docs.aeneria.com/fr/latest/administrateur/pilea_migration.html).
-
 ## Documentations et ressources
 
 * Site officiel de l’app : <https://aeneria.com>
 * Documentation officielle de l’admin : <https://docs.aeneria.com>
 * Dépôt de code officiel de l’app : <https://gitlab.com/aeneria/aeneria-app>
-* Documentation YunoHost pour cette app : <https://yunohost.org/app_aeneria>
+* YunoHost Store: <https://apps.yunohost.org/app/aeneria>
 * Signaler un bug : <https://github.com/YunoHost-Apps/aeneria_ynh/issues>
 
 ## Informations pour les développeurs

doc/ADMIN.md

@@ -2,13 +2,5 @@
 
 * First of all, you'll need a Linky and an [Enedis account](https://mon-compte-client.enedis.fr/)
 * In your Enedis space, go to ["Gérer l'accès à mes données"](https://mon-compte-particulier.enedis.fr/donnees/) tab, and allow Enedis to collect and store your hourly consumption
-* After that, install æneria to your Yunohost instance, visit it and just follow instructions
+* After that, install æneria to your YunoHost instance, visit it and just follow instructions
 * That's it, now wait a bit to see data appear!
-
-## Comming from Pilea
-
-æneria is the new name of Pilea. This new name came whith a brand new version.
-
-This new version introduced some breaking changes in data structure: migration from Pilea can't be done automaticly.
-
-But don't worry, you can easilly transfer your data from Pilea to æneria following [this documentation](https://docs.aeneria.com/fr/latest/administrateur/pilea_migration.html).

doc/ADMIN_fr.md

@@ -0,0 +1,6 @@
+## Configuration
+
+* Tout d'abord, vous aurez besoin d'un Linky et d'un [compte Enedis](https://mon-compte-client.enedis.fr/)
+* Dans votre espace Enedis, rendez-vous dans l'onglet ["Gérer l'accès à mes données"](https://mon-compte-particulier.enedis.fr/donnees/), et permettez à Enedis de collecter et stocker votre consommation horaire
+* Après cela, installez æneria sur votre instance YunoHost, visitez-la et suivez simplement les instructions
+* Ça y est, attendez maintenant un peu pour voir les données apparaître !

doc/DESCRIPTION_fr.md

@@ -0,0 +1,4 @@
+L'idée de [æneria](https://aeneria.com) est d'afficher la consommation d'énergie et les données météorologiques sur un petit tableau de bord qui permet à l'utilisateur de :
+
+  * Mieux comprendre sa propre consommation d'énergie
+  * Analyser la consommation d'énergie et les données météorologiques

hooks/post_app_addaccess

@@ -12,7 +12,7 @@ source /etc/yunohost/apps/$app/scripts/_common.sh
 usernames=$2
 permission=$3
 groups=$4
-final_path=$(ynh_app_setting_get "$app" final_path)
+install_dir=$(ynh_app_setting_get "$app" install_dir)
 phpversion=$(ynh_app_setting_get "$app" phpversion)
 
 IFS=',' read -r -a user_list <<< "$usernames"
@@ -25,7 +25,7 @@ do
     user_list+=("${group_array[@]}")
 done
 
-pushd $final_path
+pushd $install_dir
     for user in "${user_list[@]}"
     do
         mail=$(ynh_user_get_info --username="$user" --key=mail)

hooks/post_app_removeaccess

@@ -12,7 +12,7 @@ source /etc/yunohost/apps/$app/scripts/_common.sh
 usernames=$2
 permission=$3
 groups=$4
-final_path=$(ynh_app_setting_get "$app" final_path)
+install_dir=$(ynh_app_setting_get "$app" install_dir)
 phpversion=$(ynh_app_setting_get "$app" phpversion)
 
 IFS=',' read -r -a user_list <<< "$usernames"
@@ -28,5 +28,5 @@ done
 for user in "${user_list[@]}"
 do
     mail=$(ynh_user_get_info --username="$user" --key=mail)
-    cd "$final_path" && ynh_exec_as $app php$phpversion bin/console aeneria:user:deactivate "$mail" -n
+    cd "$install_dir" && ynh_exec_as $app php$phpversion bin/console aeneria:user:deactivate "$mail" -n
 done

manifest.toml

@@ -19,8 +19,11 @@ code = "https://gitlab.com/aeneria/aeneria-app"
 yunohost = ">= 11.2"
 architectures = "all"
 multi_instance = true
+
 ldap = false
+
 sso = false
+
 disk = "50M"
 ram.build = "50M"
 ram.runtime = "50M"

scripts/install

@@ -28,9 +28,9 @@ chmod -R o-rwx "$install_dir"
 chown -R $app:www-data "$install_dir"
 
 #=================================================
-# NGINX CONFIGURATION
+# SYSTEM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Configuring NGINX web server..." --weight=1
+ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
 
 # Create a dedicated NGINX config
 ynh_add_nginx_config
@@ -43,9 +43,9 @@ ynh_add_fpm_config
 #=================================================
 # CONFIGURE AENERIA
 #=================================================
-ynh_script_progression --message="Configuring aeneria..." --weight=1
+ynh_script_progression --message="Configuring $app..." --weight=1
 
-ynh_add_config --template="../conf/.env" --destination="$install_dir/.env"
+ynh_add_config --template=".env" --destination="$install_dir/.env"
 
 # Restrict rights to aeneria user only
 chmod 600 "$install_dir/.env"

scripts/remove

@@ -10,9 +10,9 @@ source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
-# REMOVE NGINX CONFIGURATION
+# REMOVE SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
+ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
 
 # Remove the dedicated NGINX config
 ynh_remove_nginx_config

scripts/restore

@@ -27,10 +27,12 @@ ynh_script_progression --message="Restoring the PSQL database..." --weight=1
 
 ynh_psql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
 
+#=================================================
+# RESTORE SYSTEM CONFIGURATIONS
 #=================================================
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weight=1
+ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
 
 # Restore the file first, so it can have a backup if different
 ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"

scripts/upgrade

@@ -58,9 +58,9 @@ chmod -R o-rwx "$install_dir"
 chown -R $app:www-data "$install_dir"
 
 #=================================================
-# NGINX CONFIGURATION
+# REAPPLY SYSTEM CONFIGURATIONS
 #=================================================
-ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
+ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
 
 # Create a dedicated NGINX config
 ynh_add_nginx_config