v2

conf/app.src

@@ -1,7 +0,0 @@
-SOURCE_URL=https://github.com/librespeed/speedtest/archive/refs/tags/5.2.5.tar.gz
-SOURCE_SUM=ed1a1d688201ed40514a68cf46738b4cd1ffee992aa838cf45ecc2fc3485c53b
-SOURCE_SUM_PRG=sha256sum
-SOURCE_FORMAT=tar.gz
-SOURCE_IN_SUBDIR=true
-SOURCE_FILENAME=
-SOURCE_EXTRACT=true

conf/nginx.conf

@@ -2,7 +2,7 @@
 location __PATH__/ {
 
   # Path to source
-  alias __FINALPATH__/ ;
+  alias __INSTALL_DIR__/ ;
 
   # Force usage of https
   if ($scheme = http) {

conf/php-fpm.conf

@@ -358,7 +358,7 @@ request_terminate_timeout = 1d
 ; Chdir to this directory at the start.
 ; Note: relative path can be used.
 ; Default Value: current directory or / when chroot
-chdir = __FINALPATH__
+chdir = __INSTALL_DIR__
 
 ; Redirect worker stdout and stderr into main error log. If not set, stdout and
 ; stderr will be redirected to /dev/null according to FastCGI specs.

manifest.toml

@@ -0,0 +1,76 @@
+packaging_format = 2
+
+id = "librespeed"
+name = "LibreSpeed"
+description.en = "Very lightweight Speedtest."
+description.fr = "Test de vitesse de connexion très léger."
+
+version = "5.2.5~ynh1"
+
+maintainers = ["Augustin Rungeard"]
+
+[upstream]
+license = "LGPL-3.0-or-later"
+website = "https://librespeed.org"
+demo = "https://librespeed.org"
+admindoc = "https://github.com/librespeed/speedtest/wiki"
+userdoc = "https://github.com/librespeed/speedtest/wiki"
+code = "https://github.com/librespeed/speedtest"
+cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number)
+fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin.
+
+[integration]
+yunohost = ">= 4.3.6"
+architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"]
+multi_instance = true
+ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials.
+sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal.
+disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ...
+ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
+ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
+
+[install]
+    [install.domain]
+    # this is a generic question - ask strings are automatically handled by Yunohost's core
+    type = "domain"
+
+    [install.path]
+    # this is a generic question - ask strings are automatically handled by Yunohost's core
+    type = "path"
+    default = "/librespeed"
+
+    [install.init_main_permission]
+    help.en = "If enabled, LibreSpeed will be accessible by people who doesn’t have an account. This can be changed later via the webadmin."
+    help.fr = "Si cette case est cochée, LibreSpeed sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin."
+    type = "group"
+    default = "visitors"
+
+    [install.password]
+    # this is a generic question - ask strings are automatically handled by Yunohost's core
+    help.en = "This password allows access to the test statistics"
+    help.fr = "Ce mot de passe permet d'accéder aux statistiques des tests"
+    type = "password"
+
+    [install.mail]
+    ask.en = "E-mail adress to contact"
+    ask.fr = "Couriel de contact"
+    help.en = "Email address to contact for stats deletion requests"
+    help.fr = "Couriel à contacter pour demander une suppression des statistiques"
+    type = "string"
+    example = "webmaster@example.com"
+
+[resources]
+        [resources.sources.main]
+        url = "https://github.com/librespeed/speedtest/archive/refs/tags/5.2.5.tar.gz"
+        sha256 = "ed1a1d688201ed40514a68cf46738b4cd1ffee992aa838cf45ecc2fc3485c53b"
+
+
+    [resources.system_user]
+
+    [resources.install_dir]
+
+    [resources.permissions]
+    main.url = "/"
+
+    [resources.database]
+    type = "mysql"

scripts/backup

@@ -14,24 +14,24 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-ynh_clean_setup () {
+#REMOVEME? ynh_clean_setup () {
 	### Remove this function if there's nothing to clean before calling the remove script.
 	true
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_print_info --message="Loading installation settings..."
+#REMOVEME? ynh_print_info --message="Loading installation settings..."
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
+#REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 #=================================================
 # DECLARE DATA AND CONF FILES TO BACKUP
@@ -47,7 +47,7 @@ ynh_print_info --message="Declaring files to be backed up..."
 # BACKUP THE APP MAIN DIR
 #=================================================
 
-ynh_backup --src_path="$final_path"
+ynh_backup --src_path="$install_dir"
 
 #=================================================
 # BACKUP THE NGINX CONFIGURATION

scripts/change_url

@@ -13,58 +13,58 @@ source /usr/share/yunohost/helpers
 # RETRIEVE ARGUMENTS
 #=================================================
 
-old_domain=$YNH_APP_OLD_DOMAIN
+#REMOVEME? old_domain=$YNH_APP_OLD_DOMAIN
-old_path=$YNH_APP_OLD_PATH
+#REMOVEME? old_path=$YNH_APP_OLD_PATH
 
-new_domain=$YNH_APP_NEW_DOMAIN
+#REMOVEME? new_domain=$YNH_APP_NEW_DOMAIN
-new_path=$YNH_APP_NEW_PATH
+#REMOVEME? new_path=$YNH_APP_NEW_PATH
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --time --weight=1
+#REMOVEME? ynh_script_progression --message="Loading installation settings..." --time --weight=1
 
-# Needed for helper "ynh_add_nginx_config"
+#REMOVEME? # Needed for helper "ynh_add_nginx_config"
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
 
 # Add settings here as needed by your application
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_user=$db_name
+#REMOVEME? db_user=$db_name
-db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
+#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
 
 #=================================================
 # BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --time --weight=1
+#REMOVEME? ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --time --weight=1
 
 # Backup the current version of the app
-ynh_backup_before_upgrade
+#REMOVEME? ynh_backup_before_upgrade
-ynh_clean_setup () {
+#REMOVEME? 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"
+#REMOVEME? 	ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 
 	# Restore it if the upgrade fails
-	ynh_restore_upgradebackup
+#REMOVEME? 	ynh_restore_upgradebackup
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # CHECK WHICH PARTS SHOULD BE CHANGED
 #=================================================
 
-change_domain=0
+#REMOVEME? change_domain=0
-if [ "$old_domain" != "$new_domain" ]
+#REMOVEME? if [ "$old_domain" != "$new_domain" ]
 then
-	change_domain=1
+	#REMOVEME? change_domain=1
 fi
 
-change_path=0
+#REMOVEME? change_path=0
-if [ "$old_path" != "$new_path" ]
+#REMOVEME? if [ "$old_path" != "$new_path" ]
 then
-	change_path=1
+	#REMOVEME? change_path=1
 fi
 
 #=================================================
@@ -76,28 +76,30 @@ fi
 #=================================================
 ynh_script_progression --message="Updating NGINX web server configuration..." --time --weight=1
 
-nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
+ynh_change_url_nginx_config
+
+#REMOVEME? nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 
 # Change the path in the NGINX config file
 if [ $change_path -eq 1 ]
 then
 	# Make a backup of the original NGINX config file if modified
-	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
+#REMOVEME? 	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
 	# Set global variables for NGINX helper
-	domain="$old_domain"
+#REMOVEME? 	domain="$old_domain"
-	path_url="$new_path"
+#REMOVEME? 	path="$new_path"
 	# Create a dedicated NGINX config
-	ynh_add_nginx_config
+#REMOVEME? 	ynh_add_nginx_config
 fi
 
 # Change the domain for NGINX
 if [ $change_domain -eq 1 ]
 then
 	# Delete file checksum for the old conf file location
-	ynh_delete_file_checksum --file="$nginx_conf_path"
+#REMOVEME? 	ynh_delete_file_checksum --file="$nginx_conf_path"
-	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
+#REMOVEME? 	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
 	# Store file checksum for the new config file location
-	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
+#REMOVEME? 	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 fi
 
 #=================================================
@@ -114,9 +116,9 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --time --weight=1
+#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --time --weight=1
 
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT

scripts/install

@@ -13,34 +13,34 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-ynh_clean_setup () {
+#REMOVEME? ynh_clean_setup () {
 	### Remove this function if there's nothing to clean before calling the remove script.
 	true
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
 
-domain=$YNH_APP_ARG_DOMAIN
+#REMOVEME? domain=$YNH_APP_ARG_DOMAIN
-path_url=$YNH_APP_ARG_PATH
+#REMOVEME? path=$YNH_APP_ARG_PATH
-is_public=$YNH_APP_ARG_IS_PUBLIC
+#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC
-password=$YNH_APP_ARG_PASSWORD
+#REMOVEME? password=$YNH_APP_ARG_PASSWORD
-mail=$YNH_APP_ARG_MAIL
+#REMOVEME? mail=$YNH_APP_ARG_MAIL
 
 ### If it's a multi-instance app, meaning it can be installed several times independently
 ### The id of the app as stated in the manifest is available as $YNH_APP_ID
 ### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2"...)
-### The app instance name is available as $YNH_APP_INSTANCE_NAME
+#REMOVEME? ### The app instance name is available as $YNH_APP_INSTANCE_NAME
-###    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
+#REMOVEME? ###    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
-###    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
+#REMOVEME? ###    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
 ###    - ynhexample__{N} for the subsequent installations, with N=3,4...
 ### The app instance name is probably what interests you most, since this is
 ### guaranteed to be unique. This is a good unique identifier to define installation path,
 ### db names...
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
@@ -53,24 +53,24 @@ app=$YNH_APP_INSTANCE_NAME
 ### Use the execution time, given by --time, to estimate the weight of a step.
 ### A common way to do it is to set a weight equal to the execution time in second +1.
 ### The execution time is given for the duration since the previous call. So the weight should be applied to this previous call.
-ynh_script_progression --message="Validating installation parameters..." --weight=1
+#REMOVEME? ynh_script_progression --message="Validating installation parameters..." --weight=1
 
 ### If the app uses NGINX as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app".
 ### If the app provides an internal web server (or uses another application server such as uWSGI), the final path should be "/opt/yunohost/$app"
-final_path=/var/www/$app
+#REMOVEME? install_dir=/var/www/$app
-test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
+#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder"
 
 # Register (book) web path
-ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
+#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
-ynh_script_progression --message="Storing installation settings..." --weight=3
+#REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=3
 
-ynh_app_setting_set --app=$app --key=domain --value=$domain
+#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain
-ynh_app_setting_set --app=$app --key=path --value=$path_url
+#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path
-ynh_app_setting_set --app=$app --key=password --value=$password
+#REMOVEME? ynh_app_setting_set --app=$app --key=password --value=$password
 ynh_app_setting_set --app=$app --key=mail --value=$mail
 
 #=================================================
@@ -80,26 +80,26 @@ ynh_app_setting_set --app=$app --key=mail --value=$mail
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Configuring system user..." --weight=1
+#REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=1
 
 # Create a system user
-ynh_system_user_create --username=$app --home_dir="$final_path"
+#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
 
 #=================================================
 # CREATE A MYSQL DATABASE
 #=================================================
-ynh_script_progression --message="Creating a MySQL database..." --weight=2
+#REMOVEME? ynh_script_progression --message="Creating a MySQL database..." --weight=2
 
 ### Use these lines if you need a database for the application.
-### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password.
+#REMOVEME? ### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password.
 ### The password will be stored as 'mysqlpwd' into the app settings,
 ### and will be available as $db_pwd
 
 
-db_name=$(ynh_sanitize_dbid --db_name=$app)
+#REMOVEME? db_name=$(ynh_sanitize_dbid --db_name=$app)
-db_user=$db_name
+#REMOVEME? db_user=$db_name
-ynh_app_setting_set --app=$app --key=db_name --value=$db_name
+#REMOVEME? ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
+#REMOVEME? ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -110,9 +110,9 @@ ynh_script_progression --message="Setting up source files..." --weight=2
 ### downloaded from an upstream source, like a git repository.
 ### `ynh_setup_source` use the file conf/app.src
 
-ynh_app_setting_set --app=$app --key=final_path --value=$final_path
+#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
 # Download, check integrity, uncompress and patch the source from app.src
-ynh_setup_source --dest_dir="$final_path"
+ynh_setup_source --dest_dir="$install_dir"
 
 # FIXME: this should be managed by the core in the future
 # Here, as a packager, you may have to tweak the ownerhsip/permissions
@@ -121,9 +121,9 @@ ynh_setup_source --dest_dir="$final_path"
 # But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
 # this will be treated as a security issue.
 
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chown -R $app:www-data $final_path
+chown -R $app:www-data $install_dir
-chmod o-rwx $final_path
+chmod o-rwx $install_dir
 
 #=================================================
 # NGINX CONFIGURATION
@@ -156,15 +156,15 @@ ynh_add_fpm_config
 ynh_script_progression --message="Initializing database..." --weight=3
 
 ynh_mysql_connect_as --user="$db_name" --password="$db_pwd" --database="$db_name" \
-    < "$final_path/results/telemetry_mysql.sql"
+    < "$install_dir/results/telemetry_mysql.sql"
 
 #=================================================
 # CONFIGURE LIBRESPEED
 #=================================================
 ynh_script_progression --message="Configuring LibreSpeed..."
 
-conf_telemetry="$final_path/results/telemetry_settings.php"
+conf_telemetry="$install_dir/results/telemetry_settings.php"
-conf_index="$final_path/example-singleServer-full.html"
+conf_index="$install_dir/example-singleServer-full.html"
 
 ynh_replace_string --match_string="stats_password = 'PASSWORD'" --replace_string="stats_password = '$password'" --target_file="$conf_telemetry"
 ynh_replace_string --match_string="MySql_username = 'USERNAME'" --replace_string="MySql_username = '$db_user'" --target_file="$conf_telemetry"
@@ -182,22 +182,22 @@ ynh_replace_string --match_string='LibreSpeed Example' --replace_string='LibreSp
 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_script_progression --message="Configuring permissions..." --weight=2
+#REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=2
 
 # Make app public if necessary
-if [ $is_public -eq 1 ]
+#REMOVEME? if [ $is_public -eq 1 ]
 then
 	# Everyone can access the app.
 	# The "main" permission is automatically created before the install script.
-	ynh_permission_update --permission="main" --add="visitors"
+#REMOVEME? 	ynh_permission_update --permission="main" --add="visitors"
 fi
 
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=2
+#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=2
 
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT

scripts/remove

@@ -12,14 +12,14 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_user=$db_name
+#REMOVEME? db_user=$db_name
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
 
 #=================================================
 # STANDARD REMOVE
@@ -28,18 +28,18 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 #=================================================
 # REMOVE THE MYSQL DATABASE
 #=================================================
-ynh_script_progression --message="Removing the MySQL database..." --weight=1
+#REMOVEME? ynh_script_progression --message="Removing the MySQL database..." --weight=1
 
 # Remove a database if it exists, along with the associated user
-ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
+#REMOVEME? ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
 
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Removing app main directory..." --weight=2
+#REMOVEME? ynh_script_progression --message="Removing app main directory..." --weight=2
 
 # Remove the app directory securely
-ynh_secure_remove --file="$final_path"
+#REMOVEME? ynh_secure_remove --file="$install_dir"
 
 #=================================================
 # REMOVE NGINX CONFIGURATION
@@ -66,10 +66,10 @@ ynh_remove_fpm_config
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Removing the dedicated system user..." --weight=3
+#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." --weight=3
 
 # Delete a system user
-ynh_system_user_delete --username=$app
+#REMOVEME? ynh_system_user_delete --username=$app
 
 #=================================================
 # END OF SCRIPT

scripts/restore

@@ -15,31 +15,31 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
+#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_user=$db_name
+#REMOVEME? db_user=$db_name
-phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
+#REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
 
 #=================================================
 # CHECK IF THE APP CAN BE RESTORED
 #=================================================
-ynh_script_progression --message="Validating restoration parameters..." --weight=2
+#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." --weight=2
 
-ynh_webpath_available --domain=$domain --path_url=$path_url \
+#REMOVEME? ynh_webpath_available --domain=$domain --path=$path \
-	|| ynh_die --message="Path not available: ${domain}${path_url}"
+	|| ynh_die --message="Path not available: ${domain}${path}"
-test ! -d $final_path \
+#REMOVEME? test ! -d $install_dir \
-	|| ynh_die --message="There is already a directory: $final_path "
+	|| ynh_die --message="There is already a directory: $install_dir "
 
 #=================================================
 # STANDARD RESTORATION STEPS
@@ -53,17 +53,17 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
+#REMOVEME? ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
 
 # Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
+#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
 
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
 ynh_script_progression --message="Restoring the app main directory..." --weight=2
 
-ynh_restore_file --origin_path="$final_path"
+ynh_restore_file --origin_path="$install_dir"
 
 # FIXME: this should be managed by the core in the future
 # Here, as a packager, you may have to tweak the ownerhsip/permissions
@@ -71,9 +71,9 @@ ynh_restore_file --origin_path="$final_path"
 # files in some cases.
 # But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
 # this will be treated as a security issue.
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$final_path"
+chown -R $app:www-data "$install_dir"
 
 #=================================================
 # RESTORE THE PHP-FPM CONFIGURATION
@@ -90,10 +90,10 @@ ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
 #=================================================
 # RESTORE THE MYSQL DATABASE
 #=================================================
-ynh_script_progression --message="Restoring the MySQL database..." --weight=1
+#REMOVEME? ynh_script_progression --message="Restoring the MySQL database..." --weight=1
 
-db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
+#REMOVEME? db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
-ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
+#REMOVEME? ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
 ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
 
 

scripts/upgrade

@@ -12,16 +12,16 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
+#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1
 
-app=$YNH_APP_INSTANCE_NAME
+#REMOVEME? app=$YNH_APP_INSTANCE_NAME
 
-domain=$(ynh_app_setting_get --app=$app --key=domain)
+#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
+#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#REMOVEME? db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-password=$(ynh_app_setting_get --app=$app --key=password)
+#REMOVEME? password=$(ynh_app_setting_get --app=$app --key=password)
-mail=$(ynh_app_setting_get --app=$app --key=mail)
+#REMOVEME? mail=$(ynh_app_setting_get --app=$app --key=mail)
 
 #=================================================
 # CHECK VERSION
@@ -50,32 +50,32 @@ ynh_script_progression --message="Ensuring downward compatibility..." --weight=2
 if [ -z "$db_name" ]; then
 	db_name=$(ynh_sanitize_dbid --db_name=$app)
 	db_user=$db_name
-	db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
+#REMOVEME? 	db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
-	ynh_app_setting_set --app=$app --key=db_name --value=$db_name
+#REMOVEME? 	ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-	ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
+#REMOVEME? 	ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
 	ynh_mysql_connect_as --user="$db_name" --password="$db_pwd" --database="$db_name" \
-            < "$final_path/results/telemetry_mysql.sql"
+            < "$install_dir/results/telemetry_mysql.sql"
 fi
 
-# If final_path doesn't exist, create it
+# If install_dir doesn't exist, create it
-if [ -z "$final_path" ]; then
+if [ -z "$install_dir" ]; then
-	final_path=/var/www/$app
+#REMOVEME? 	install_dir=/var/www/$app
-	ynh_app_setting_set --app=$app --key=final_path --value=$final_path
+#REMOVEME? 	ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
 fi
 
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1
+#REMOVEME? ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1
 
 # Backup the current version of the app
-ynh_backup_before_upgrade
+#REMOVEME? ynh_backup_before_upgrade
-ynh_clean_setup () {
+#REMOVEME? ynh_clean_setup () {
 	# Restore it if the upgrade fails
-	ynh_restore_upgradebackup
+#REMOVEME? 	ynh_restore_upgradebackup
 }
 # Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
+#REMOVEME? ynh_abort_if_errors
 
 #=================================================
 # STANDARD UPGRADE STEPS
@@ -84,10 +84,10 @@ ynh_abort_if_errors
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=4
+#REMOVEME? ynh_script_progression --message="Making sure dedicated system user exists..." --weight=4
 
 # Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
+#REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -98,7 +98,7 @@ then
 	ynh_script_progression --message="Upgrading source files..." --weight=2
 
 	# Download, check integrity, uncompress and patch the source from app.src
-	ynh_setup_source --dest_dir="$final_path"
+	ynh_setup_source --dest_dir="$install_dir"
 fi
 
 # FIXME: this should be managed by the core in the future
@@ -107,9 +107,9 @@ fi
 # files in some cases.
 # But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
 # this will be treated as a security issue.
-chmod 750 "$final_path"
+chmod 750 "$install_dir"
-chmod -R o-rwx "$final_path"
+chmod -R o-rwx "$install_dir"
-chown -R $app:www-data "$final_path"
+chown -R $app:www-data "$install_dir"
 
 #=================================================
 # NGINX CONFIGURATION
@@ -139,10 +139,10 @@ then
     
     db_name=$(ynh_sanitize_dbid --db_name=$app)
     db_user=$db_name
-    db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
+#REMOVEME?     db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
     
-    conf_telemetry="$final_path/results/telemetry_settings.php"
+    conf_telemetry="$install_dir/results/telemetry_settings.php"
-    conf_index="$final_path/example-singleServer-full.html"
+    conf_index="$install_dir/example-singleServer-full.html"
 
     ynh_replace_string --match_string="stats_password = 'PASSWORD'" --replace_string="stats_password = '$password'" --target_file="$conf_telemetry"
     ynh_replace_string --match_string="MySql_username = 'USERNAME'" --replace_string="MySql_username = '$db_user'" --target_file="$conf_telemetry"
@@ -162,9 +162,9 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=2
+#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=2
 
-ynh_systemd_action --service_name=nginx --action=reload
+#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================
 # END OF SCRIPT