Apply example_ynh

check_process

@@ -0,0 +1,21 @@
+;; Test complet
+	; Manifest
+		domain="domain.tld"
+		path="/path"
+		is_public=1
+	; Checks
+		pkg_linter=1
+		setup_sub_dir=1
+		setup_root=1
+		setup_nourl=0
+		setup_private=1
+		setup_public=1
+		upgrade=1
+		# upgrade=1	from_commit=CommitHash
+		backup_restore=1
+		multi_instance=1
+		port_already_use=0
+		change_url=1
+;;; Options
+Email=
+Notification=none

conf/nginx.conf

@@ -1,9 +1,7 @@
-location PATHTOCHANGE/ {
+#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
-  if ($scheme = http) {
+location __PATH__/ {
-    rewrite ^ https://$server_name$request_uri? permanent;
-  }
 
   proxy_pass       http://localhost:11334/;
   proxy_set_header Host      $host;
-  proxy_set_header X-Real-IP $remote_addr;
+  proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
 }

manifest.json

@@ -1,15 +1,26 @@
 {
     "name": "Rspamd UI",
     "id": "rspamdui",
+    "packaging_format": 1,
     "description": {
         "en": "Simple control interface for rspamd spam filtering system",
         "fr": "Simple control interface for rspamd spam filtering system"
     },
+    "version": "1.0~ynh1",
     "url": "https://rspamd.com/webui",
+    "upstream": {
+        "license": "Apache-2.0",
+        "website": "https://rspamd.com/webui",
+        "code": "https://github.com/rspamd/rspamd"
+    },
+    "license": "Apache-2.0",
     "maintainer": {
         "name": "ju",
         "email": "ju@paraiso.me"
     },
+    "requirements": {
+        "yunohost": ">= 4.3.0"
+    },
     "multi_instance": "false",
     "services": [
         "nginx"
@@ -18,20 +29,22 @@
         "install": [
             {
                 "name": "domain",
-        "type": "domain",
+                "type": "domain"
-        "ask": {
-          "en": "Choose a domain for Rspamd UI"
-        },
-        "example": "domain.org"
             },
             {
                 "name": "path",
                 "type": "path",
-        "ask": {
-          "en": "Choose a path for Rspamd UI"
-        },
                 "example": "/rspamd",
                 "default": "/rspamd"
+            },
+            {
+                "name": "is_public",
+                "type": "boolean",
+                "default": true
+            },
+            {
+                "name": "password",
+                "type": "password"
             }
         ]
     }

scripts/_common.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+#=================================================
+# COMMON VARIABLES
+#=================================================
+
+# dependencies used by the app
+#pkg_dependencies="deb1 deb2 php$YNH_DEFAULT_PHP_VERSION-deb1 php$YNH_DEFAULT_PHP_VERSION-deb2"
+
+#=================================================
+# PERSONAL HELPERS
+#=================================================
+
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
+#=================================================
+# FUTURE OFFICIAL HELPERS
+#=================================================

scripts/backup

@@ -0,0 +1,47 @@
+#!/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
+
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+ynh_clean_setup () {
+	true
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_print_info --message="Loading installation settings..."
+
+app=$YNH_APP_INSTANCE_NAME
+
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+
+#=================================================
+# DECLARE DATA AND CONF FILES TO BACKUP
+#=================================================
+ynh_print_info --message="Declaring files to be backed up..."
+
+#=================================================
+# BACKUP THE NGINX CONFIGURATION
+#=================================================
+
+ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

scripts/change_url

@@ -0,0 +1,112 @@
+#!/bin/bash
+
+#=================================================
+# GENERIC STARTING
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
+
+source _common.sh
+source /usr/share/yunohost/helpers
+
+#=================================================
+# RETRIEVE ARGUMENTS
+#=================================================
+
+old_domain=$YNH_APP_OLD_DOMAIN
+old_path=$YNH_APP_OLD_PATH
+
+new_domain=$YNH_APP_NEW_DOMAIN
+new_path=$YNH_APP_NEW_PATH
+
+app=$YNH_APP_INSTANCE_NAME
+
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_script_progression --message="Loading installation settings..."
+
+# Add settings here as needed by your application
+#db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#db_user=$db_name
+#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)..."
+
+# Backup the current version of the app
+ynh_backup_before_upgrade
+ynh_clean_setup () {
+	ynh_clean_check_starting
+	# 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
+fi
+
+change_path=0
+if [ "$old_path" != "$new_path" ]
+then
+	change_path=1
+fi
+
+#=================================================
+# STANDARD MODIFICATIONS
+#=================================================
+# MODIFY URL IN NGINX CONF
+#=================================================
+ynh_script_progression --message="Updating NGINX web server configuration..."
+
+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"
+	# Set global variables for NGINX helper
+	domain="$old_domain"
+	path_url="$new_path"
+	# Create a dedicated NGINX config
+	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"
+	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"
+fi
+
+#=================================================
+# GENERIC FINALISATION
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading NGINX web server..."
+
+ynh_systemd_action --service_name=nginx --action=reload
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Change of URL completed for $app"

scripts/install

@@ -1,22 +1,99 @@
 #!/bin/bash
 
-# Retrieve arguments
+#=================================================
-domain=$1
+# GENERIC START
-path=$2
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-sudo yunohost app checkurl $domain$path -a rspamdui
+source _common.sh
-if [[ ! $? -eq 0 ]]; then
+source /usr/share/yunohost/helpers
-  exit 1
+
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+ynh_clean_setup () {
+	ynh_clean_check_starting
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
+#=================================================
+# RETRIEVE ARGUMENTS FROM THE MANIFEST
+#=================================================
+
+domain=$YNH_APP_ARG_DOMAIN
+path_url=$YNH_APP_ARG_PATH
+is_public=$YNH_APP_ARG_IS_PUBLIC
+password=$YNH_APP_ARG_PASSWORD
+
+app=$YNH_APP_INSTANCE_NAME
+
+#=================================================
+# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
+#=================================================
+ynh_script_progression --message="Validating installation parameters..."
+
+# Register (book) web path
+ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
+
+#=================================================
+# STORE SETTINGS FROM MANIFEST
+#=================================================
+ynh_script_progression --message="Storing installation settings..."
+
+ynh_app_setting_set --app=$app --key=domain --value=$domain
+ynh_app_setting_set --app=$app --key=path --value=$path_url
+ynh_app_setting_set --app=$app --key=password --value=$password
+
+#=================================================
+# STANDARD MODIFICATIONS
+#=================================================
+# NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Configuring NGINX web server..."
+
+# Create a dedicated NGINX config
+ynh_add_nginx_config
+
+#=================================================
+# SPECIFIC SETUP
+#=================================================
+# CONFIGURE RSPAMD
+#=================================================
+ynh_script_progression --message="Configuring RSPAMD..."
+
+encrypted_password=$(rspamadm pw -p $password)
+
+ynh_replace_special_string --match_string="^password = .*" --replace_string="password = \"$encrypted_password\";" --target_file=/etc/rspamd/worker-controller.inc
+
+ynh_systemd_action --service_name=rspamd --action="restart"
+
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+# SETUP SSOWAT
+#=================================================
+ynh_script_progression --message="Configuring permissions..."
+
+# Make app public if necessary
+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"
 fi
 
-# Check port availability
+#=================================================
-sudo yunohost app checkport 11334
+# RELOAD NGINX
-if [[ ! $? -eq 0 ]]; then
+#=================================================
-  exit 1
+ynh_script_progression --message="Reloading NGINX web server..."
-fi
 
-# Configure Nginx and reload
+ynh_systemd_action --service_name=nginx --action=reload
-# Removing trailing '/' in path to handle both subdir and subdomain installs.
+
-sed -i "s@PATHTOCHANGE@${path%/}@g" ../conf/nginx.conf
+#=================================================
-sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/rspamdui.conf
+# END OF SCRIPT
-sudo service nginx reload
+#=================================================
+
+ynh_script_progression --message="Installation of $app completed"

scripts/remove

@@ -1,7 +1,46 @@
 #!/bin/bash
 
-domain=$(sudo yunohost app setting rspamdui domain)
+#=================================================
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-sudo rm /etc/nginx/conf.d/$domain.d/rspamdui.conf
+source _common.sh
-sudo service nginx reload
+source /usr/share/yunohost/helpers
-sudo yunohost app ssowatconf                                                                                                                                                                     
+
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_script_progression --message="Loading installation settings..."
+
+app=$YNH_APP_INSTANCE_NAME
+
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+
+#=================================================
+# STANDARD REMOVE
+#=================================================
+# REMOVE NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Removing NGINX web server configuration..."
+
+# Remove the dedicated NGINX config
+ynh_remove_nginx_config
+
+#=================================================
+# SPECIFIC REMOVE
+#=================================================
+# CONFIGURE RSPAMD
+#=================================================
+ynh_script_progression --message="Configuring RSPAMD..."
+
+ynh_replace_special_string --match_string="^password = .*" --replace_string="password = \"q1\";" --target_file=/etc/rspamd/worker-controller.inc
+
+ynh_systemd_action --service_name=rspamd --action="restart"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Removal of $app completed"

scripts/restore

@@ -0,0 +1,69 @@
+#!/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
+
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+ynh_clean_setup () {
+	ynh_clean_check_starting
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_script_progression --message="Loading installation settings..."
+
+app=$YNH_APP_INSTANCE_NAME
+
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+path_url=$(ynh_app_setting_get --app=$app --key=path)
+password=$(ynh_app_setting_get --app=$app --key=password)
+
+#=================================================
+# STANDARD RESTORATION STEPS
+#=================================================
+# RESTORE THE NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Restoring the NGINX web server configuration..."
+
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
+#=================================================
+# SPECIFIC RESTORATION
+#=================================================
+# CONFIGURE RSPAMD
+#=================================================
+ynh_script_progression --message="Configuring RSPAMD..."
+
+encrypted_password=$(rspamadm pw -p $password)
+
+ynh_replace_special_string --match_string="^password = .*" --replace_string="password = \"$encrypted_password\";" --target_file=/etc/rspamd/worker-controller.inc
+
+ynh_systemd_action --service_name=rspamd --action="restart"
+
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading NGINX web server..."
+
+ynh_systemd_action --service_name=nginx --action=reload
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Restoration completed for $app"

scripts/upgrade

@@ -1,16 +1,79 @@
 #!/bin/bash
 
-# Retrieve arguments
+#=================================================
-domain=$(sudo yunohost app setting rspamdui domain)
+# GENERIC START
-path=$(sudo yunohost app setting rspamdui path)
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# Check port availability
+source _common.sh
-sudo yunohost app checkport 11334
+source /usr/share/yunohost/helpers
-if [[ ! $? -eq 0 ]]; then
+
-  exit 1
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_script_progression --message="Loading installation settings..."
+
+app=$YNH_APP_INSTANCE_NAME
+
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+path_url=$(ynh_app_setting_get --app=$app --key=path)
+
+#=================================================
+# CHECK VERSION
+#=================================================
+ynh_script_progression --message="Checking version..."
+
+upgrade_type=$(ynh_check_app_version_changed)
+
+#=================================================
+# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+#=================================================
+ynh_script_progression --message="Backing up the app before upgrading (may take a while)..."
+
+# Backup the current version of the app
+ynh_backup_before_upgrade
+ynh_clean_setup () {
+	ynh_clean_check_starting
+	# Restore it if the upgrade fails
+	ynh_restore_upgradebackup
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
+#=================================================
+# STANDARD UPGRADE STEPS
+#=================================================
+# ENSURE DOWNWARD COMPATIBILITY
+#=================================================
+ynh_script_progression --message="Ensuring downward compatibility..."
+
+# Cleaning legacy permissions
+if ynh_legacy_permissions_exists; then
+	ynh_legacy_permissions_delete_all
+
+	ynh_app_setting_delete --app=$app --key=is_public
 fi
 
-# Configure Nginx and reload
+#=================================================
-sed -i "s@PATHTOCHANGE@${path%/}@g" ../conf/nginx.conf
+# NGINX CONFIGURATION
-sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/rspamdui.conf
+#=================================================
-sudo service nginx reload
+ynh_script_progression --message="Upgrading NGINX web server configuration..."
+
+# Create a dedicated NGINX config
+ynh_add_nginx_config
+
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading NGINX web server..."
+
+ynh_systemd_action --service_name=nginx --action=reload
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Upgrade of $app completed"