diff --git a/sources/patches/.gitignore b/.gitignore
similarity index 54%
rename from sources/patches/.gitignore
rename to .gitignore
index 783a4ae..8f144f3 100644
--- a/sources/patches/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
*~
*.sw[op]
+.DS_Store
diff --git a/conf/extra_php-fpm.conf b/conf/extra_php-fpm.conf
deleted file mode 100644
index 700c37c..0000000
--- a/conf/extra_php-fpm.conf
+++ /dev/null
@@ -1,4 +0,0 @@
-; Additional php.ini defines, specific to this pool of workers.
-
-php_admin_value[upload_max_filesize] = 50M
-php_admin_value[post_max_size] = 50M
diff --git a/conf/nginx.conf b/conf/nginx.conf
index 2dad80d..3bd06b4 100644
--- a/conf/nginx.conf
+++ b/conf/nginx.conf
@@ -12,7 +12,7 @@ location __PATH__/ {
try_files $uri $uri/ index.php;
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
- fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
+ fastcgi_pass unix:/var/run/php/php__PHP_VERSION__-fpm-__APP__.sock;
fastcgi_index index.php;
include fastcgi_params;
diff --git a/config_panel.toml.example b/config_panel.toml.example
deleted file mode 100644
index c41389b..0000000
--- a/config_panel.toml.example
+++ /dev/null
@@ -1,30 +0,0 @@
-version = "1.0"
-
-[main]
-name = "Snappymail configuration"
-
- [main.php_fpm_config]
- name = "PHP-FPM configuration"
-
- [main.php_fpm_config.fpm_footprint]
- ask = "Memory footprint"
- type = "select"
- choices.low = "Low, <= 20Mb per pool"
- choices.medium = "Medium, between 20Mb and 40Mb per pool"
- choices.high = "High, > 40Mb per pool"
- choices.specific = "Use specific value"
- default = "low"
-
- [main.php_fpm_config.fpm_free_footprint]
- visible = "fpm_footprint == 'specific'"
- ask = "Memory footprint of the service?"
- type = "number"
- default = "0"
- help = "Free field to specify exactly the footprint in Mb if you don't want to use one of the three previous values."
-
- [main.php_fpm_config.fpm_usage]
- ask = "Expected usage"
- type = "select"
- choices = ["low", "medium", "high"]
- default = "low"
- help = "low: Personal usage, behind the SSO. No RAM footprint when not used, but the impact on the processor can be high if many users are using the service.
medium: Low usage, few people or/and publicly accessible. Low RAM footprint, medium processor footprint when used.
high: High usage, frequently visited website. High RAM footprint, but lower on processor usage and quickly responding."
diff --git a/manifest.toml b/manifest.toml
index fe38967..42e6fc1 100644
--- a/manifest.toml
+++ b/manifest.toml
@@ -17,7 +17,8 @@ admindoc = "https://github.com/the-djmaze/snappymail/wiki"
code = "https://github.com/the-djmaze/snappymail"
[integration]
-yunohost = ">= 11.2"
+yunohost = ">= 11.2.16"
+helpers_version = "2.1"
architectures = "all"
multi_instance = true
diff --git a/scripts/_common.sh b/scripts/_common.sh
index 7e974aa..d6a3c54 100644
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -1,20 +1,8 @@
#!/bin/bash
#=================================================
-# COMMON VARIABLES
+# COMMON VARIABLES AND CUSTOM HELPERS
#=================================================
main_domain=$(cat /etc/yunohost/current_host)
timezone=$(cat /etc/timezone)
-
-#=================================================
-# PERSONAL HELPERS
-#=================================================
-
-#=================================================
-# EXPERIMENTAL HELPERS
-#=================================================
-
-#=================================================
-# FUTURE OFFICIAL HELPERS
-#=================================================
diff --git a/scripts/backup b/scripts/backup
index b3c4ac3..2223bdd 100755
--- a/scripts/backup
+++ b/scripts/backup
@@ -1,38 +1,29 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers
-#=================================================
-# DECLARE DATA AND CONF FILES TO BACKUP
-#=================================================
-ynh_print_info --message="Declaring files to be backed up..."
+ynh_print_info "Declaring files to be backed up..."
#=================================================
# BACKUP THE APP MAIN DIR
#=================================================
-ynh_backup --src_path="$install_dir"
+ynh_backup "$install_dir"
#=================================================
# SYSTEM CONFIGURATION
#=================================================
-ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
-ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
+ynh_backup "/etc/php/$php_version/fpm/pool.d/$app.conf"
-ynh_backup --src_path="/etc/logrotate.d/$app"
+ynh_backup "/etc/logrotate.d/$app"
#=================================================
# END OF SCRIPT
#=================================================
-ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
+ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
diff --git a/scripts/change_url b/scripts/change_url
index 4a846db..b3c02ba 100644
--- a/scripts/change_url
+++ b/scripts/change_url
@@ -1,37 +1,31 @@
#!/bin/bash
-#=================================================
-# GENERIC STARTING
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# MODIFY URL IN NGINX CONF
#=================================================
-ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
+ynh_script_progression "Updating NGINX web server configuration..."
-ynh_change_url_nginx_config
+ynh_config_change_url_nginx
#=================================================
# UPDATE A CONFIG FILE
#=================================================
-ynh_script_progression --message="Updating a configuration file..." --weight=1
+ynh_script_progression "Updating configuration..."
-ynh_replace_string --match_string='default_domain = "$domain"' --replace_string='default_domain = "$new_domain"' --target_file="$install_dir/app/data/_data_/_default_/configs/application.ini"
+ynh_replace --match='default_domain = "$domain"' --replace='default_domain = "$new_domain"' --file="$install_dir/app/data/_data_/_default_/configs/application.ini"
#=================================================
# SETUP SSO
#=================================================
-ynh_script_progression --message="Applying SSO patch..." --weight=1
+ynh_script_progression "Applying SSO patch..."
-ynh_add_config --template="sso.php" --destination="$install_dir/index.php"
+ynh_config_add --template="sso.php" --destination="$install_dir/index.php"
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Change of URL completed for $app" --last
+ynh_script_progression "Change of URL completed for $app"
diff --git a/scripts/config b/scripts/config
deleted file mode 100644
index 91c2de7..0000000
--- a/scripts/config
+++ /dev/null
@@ -1,95 +0,0 @@
-#!/bin/bash
-
-#=================================================
-# GENERIC STARTING
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
-source _common.sh
-source /usr/share/yunohost/helpers
-
-ynh_abort_if_errors
-
-#=================================================
-# RETRIEVE ARGUMENTS
-#=================================================
-
-phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
-current_fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint)
-
-#=================================================
-# SPECIFIC GETTERS FOR TOML SHORT KEY
-#=================================================
-
-get__fpm_footprint() {
- # Free footprint value for php-fpm
- # Check if current_fpm_footprint is an integer
- if [ "$current_fpm_footprint" -eq "$current_fpm_footprint" ] 2> /dev/null
- then
- echo "specific"
- else
- echo "$current_fpm_footprint"
- fi
-}
-
-get__free_footprint() {
- # Free footprint value for php-fpm
- # Check if current_fpm_footprint is an integer
- if [ "$current_fpm_footprint" -eq "$current_fpm_footprint" ] 2> /dev/null
- then
- # If current_fpm_footprint is an integer, that's a numeric value for the footprint
- echo "$current_fpm_footprint"
- else
- echo "0"
- fi
-}
-
-#=================================================
-# SPECIFIC SETTERS FOR TOML SHORT KEYS
-#=================================================
-
-set__fpm_footprint() {
- if [ "$fpm_footprint" != "specific" ]
- then
- ynh_app_setting_set --app=$app --key=fpm_footprint --value="$fpm_footprint"
- fi
-}
-
-set__fpm_free_footprint() {
- if [ "$fpm_footprint" = "specific" ]
- then
- ynh_app_setting_set --app=$app --key=fpm_footprint --value="$fpm_free_footprint"
- fi
-}
-
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-
-ynh_app_config_validate() {
- _ynh_app_config_validate
-
- if [ "${changed[fpm_usage]}" == "true" ] || [ "${changed[fpm_footprint]}" == "true" ] || [ "${changed[fpm_free_footprint]}" == "true" ]; then
- # If fpm_footprint is set to 'specific', use $fpm_free_footprint value.
- if [ "$fpm_footprint" = "specific" ]
- then
- fpm_footprint=$fpm_free_footprint
- fi
-
- if [ "$fpm_footprint" == "0" ]
- then
- ynh_print_err --message="When selecting 'specific', you have to set a footprint value into the field below."
-
- exit 0
- fi
- fi
-}
-
-ynh_app_config_apply() {
- _ynh_app_config_apply
-
- ynh_add_fpm_config --phpversion=$phpversion --usage=$fpm_usage --footprint=$fpm_footprint
-}
-
-ynh_app_config_run $1
diff --git a/scripts/install b/scripts/install
index 4a266a7..60eae60 100755
--- a/scripts/install
+++ b/scripts/install
@@ -1,18 +1,12 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-ynh_script_progression --message="Setting up source files..." --weight=3
+ynh_script_progression "Setting up source files..."
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$install_dir/app"
@@ -23,28 +17,28 @@ chown -R $app:www-data "$install_dir"
#=================================================
# SYSTEM CONFIGURATION
#=================================================
-ynh_script_progression --message="Adding system configurations related to $app..." --weight=3
+ynh_script_progression "Adding system configurations related to $app..."
# Create a dedicated PHP-FPM config
-ynh_add_fpm_config
+ynh_config_add_phpfpm
# Create a dedicated NGINX config
-ynh_add_nginx_config
+ynh_config_add_nginx
# Use logrotate to manage application logfile(s)
-ynh_use_logrotate
+ynh_config_add_logrotate
#=================================================
# APP INITIAL CONFIGURATION
#=================================================
# ADD A CONFIGURATION
#=================================================
-ynh_script_progression --message="Adding a configuration file..." --weight=1
+ynh_script_progression "Adding $app's configuration..."
mkdir -p "$install_dir/app/data/_data_/_default_/configs"
chown $app:$app -R "$install_dir/app/data/_data_"
-ynh_add_config --template="application.ini" --destination="$install_dir/app/data/_data_/_default_/configs/application.ini"
+ynh_config_add --template="application.ini" --destination="$install_dir/app/data/_data_/_default_/configs/application.ini"
chmod 600 "$install_dir/app/data/_data_/_default_/configs/application.ini"
chown $app:$app "$install_dir/app/data/_data_/_default_/configs/application.ini"
@@ -52,12 +46,12 @@ chown $app:$app "$install_dir/app/data/_data_/_default_/configs/application.ini"
#=================================================
# SETUP SSO
#=================================================
-ynh_script_progression --message="Applying SSO patch..." --weight=1
+ynh_script_progression "Applying SSO patch..."
-ynh_add_config --template="sso.php" --destination="$install_dir/index.php"
+ynh_config_add --template="sso.php" --destination="$install_dir/index.php"
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Installation of $app completed" --last
+ynh_script_progression "Installation of $app completed"
diff --git a/scripts/remove b/scripts/remove
index 430db72..b323d18 100755
--- a/scripts/remove
+++ b/scripts/remove
@@ -1,30 +1,24 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# REMOVE SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
+ynh_script_progression "Removing system configurations related to $app..."
# Remove the dedicated NGINX config
-ynh_remove_nginx_config
+ynh_config_remove_nginx
# Remove the app-specific logrotate config
-ynh_remove_logrotate
+ynh_config_remove_logrotate
# Remove the dedicated PHP-FPM config
-ynh_remove_fpm_config
+ynh_config_remove_phpfpm
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Removal of $app completed" --last
+ynh_script_progression "Removal of $app completed"
diff --git a/scripts/restore b/scripts/restore
index acd1ca8..8602989 100755
--- a/scripts/restore
+++ b/scripts/restore
@@ -1,11 +1,5 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers
@@ -13,9 +7,9 @@ source /usr/share/yunohost/helpers
#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
-ynh_script_progression --message="Restoring the app main directory..." --weight=5
+ynh_script_progression "Restoring the app main directory..."
-ynh_restore_file --origin_path="$install_dir"
+ynh_restore "$install_dir"
chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$install_dir"
@@ -23,26 +17,24 @@ chown -R $app:www-data "$install_dir"
#=================================================
# RESTORE SYSTEM CONFIGURATIONS
#=================================================
-ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
+ynh_script_progression "Restoring system configurations related to $app..."
-ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
+ynh_restore "/etc/php/$php_version/fpm/pool.d/$app.conf"
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_restore "/etc/nginx/conf.d/$domain.d/$app.conf"
-ynh_restore_file --origin_path="/etc/logrotate.d/$app"
+ynh_restore "/etc/logrotate.d/$app"
-#=================================================
-# GENERIC FINALIZATION
#=================================================
# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE
#=================================================
-ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
+ynh_script_progression "Reloading NGINX web server and $app's service..."
-ynh_systemd_action --service_name=php$phpversion-fpm --action=reload
-ynh_systemd_action --service_name=nginx --action=reload
+ynh_systemctl --service=php$php_version-fpm --action=reload
+ynh_systemctl --service=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Restoration completed for $app" --last
+ynh_script_progression "Restoration completed for $app"
diff --git a/scripts/upgrade b/scripts/upgrade
index dd25d13..ebf243b 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -1,21 +1,15 @@
#!/bin/bash
-#=================================================
-# GENERIC START
-#=================================================
-# IMPORT GENERIC HELPERS
-#=================================================
-
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
-ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
+ynh_script_progression "Ensuring downward compatibility..."
# Do something when upgrading from 2.3.2~ynh1 or lower
-if ynh_compare_current_package_version --comparison le --version 2.28.4~ynh1
+if ynh_app_upgrading_from_version_before_or_equal_to 2.28.4~ynh1
then
# Move everything inside a $install_dir/app/ subfolder
# This allows to have a $install_dir/index.php handling the SSO
@@ -28,7 +22,7 @@ fi
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-ynh_script_progression --message="Upgrading source files..." --weight=5
+ynh_script_progression "Upgrading source files..."
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$install_dir/app" --keep="data/_data_/_default_/configs/application.ini"
@@ -39,25 +33,25 @@ chown -R $app:www-data "$install_dir"
#=================================================
# REAPPLY SYSTEM CONFIGURATIONS
#=================================================
-ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=5
+ynh_script_progression "Upgrading system configurations related to $app..."
# Create a dedicated PHP-FPM config
-ynh_add_fpm_config
+ynh_config_add_phpfpm
# Create a dedicated NGINX config
-ynh_add_nginx_config
+ynh_config_add_nginx
# Use logrotate to manage app-specific logfile(s)
-ynh_use_logrotate --non-append
+ynh_config_add_logrotate
#=================================================
# RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS...)
#=================================================
# UPDATE A CONFIG FILE
#=================================================
-#ynh_script_progression --message="Updating a configuration file..." --weight=1
+#ynh_script_progression "Updating configuration..."
-#ynh_add_config --template="application.ini" --destination="$install_dir/app/data/_data_/_default_/configs/application.ini"
+#ynh_config_add --template="application.ini" --destination="$install_dir/app/data/_data_/_default_/configs/application.ini"
#chmod 600 "$install_dir/app/data/_data_/_default_/configs/application.ini"
#chown $app:$app "$install_dir/app/data/_data_/_default_/configs/application.ini"
@@ -65,12 +59,12 @@ ynh_use_logrotate --non-append
#=================================================
# SETUP SSO
#=================================================
-ynh_script_progression --message="Applying SSO patch..." --weight=1
+ynh_script_progression "Applying SSO patch..."
-ynh_add_config --template="sso.php" --destination="$install_dir/index.php"
+ynh_config_add --template="sso.php" --destination="$install_dir/index.php"
#=================================================
# END OF SCRIPT
#=================================================
-ynh_script_progression --message="Upgrade of $app completed" --last
+ynh_script_progression "Upgrade of $app completed"
diff --git a/sources/extra_files/app/.gitignore b/sources/extra_files/app/.gitignore
deleted file mode 100644
index 783a4ae..0000000
--- a/sources/extra_files/app/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-*~
-*.sw[op]