Fix

check_process

@@ -18,8 +18,7 @@
 		setup_public=1
 		upgrade=1
 		backup_restore=1
-		multi_instance=1
+		multi_instance=0
-		incorrect_path=1
 		port_already_use=0
 		change_url=0
 ;;; Levels

conf/nginx.conf

@@ -1,5 +1,4 @@
-location __PATH__/ {
+location ^~ __PATH__/ {
-
   # Force usage of https
   if ($scheme = http) {
     rewrite ^ https://$server_name$request_uri? permanent;
@@ -21,7 +20,7 @@ location __PATH__/ {
   # Pass ETag header from cockpit to clients.
   # See: https://github.com/cockpit-project/cockpit/issues/5239
   gzip off;
-}
 
  # Include SSOWAT user panel.
   include conf.d/yunohost_panel.conf.inc;
+}

scripts/backup

@@ -1,33 +1,62 @@
 #!/bin/bash
 
-# Exit on command errors and treat unset variables as an error
+#=================================================
-set -eu
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# See comments in install script
+source ../settings/scripts/_common.sh
-app=$YNH_APP_INSTANCE_NAME
-
-# Source YunoHost helpers
 source /usr/share/yunohost/helpers
 
-# Backup sources & data
+#=================================================
-# Note: the last argument is where to save this path, see the restore script.
+# MANAGE SCRIPT FAILURE
-ynh_backup "/var/www/${app}" "sources"
+#=================================================
 
-### MySQL (remove if not used) ###
+ynh_clean_setup () {
-# If a MySQL database is used:
+	ynh_clean_check_starting
-# # Dump the database
+}
-# dbname=$app
+# Exit if an error occurs during the execution of the script
-# dbuser=$app
+ynh_abort_if_errors
-# dbpass=$(ynh_app_setting_get "$app" mysqlpwd)
-# mysqldump -u "$dbuser" -p"$dbpass" --no-create-db "$dbname" > ./dump.sql
-### MySQL end ###
 
-# Copy NGINX configuration
+#=================================================
-domain=$(ynh_app_setting_get "$app" domain)
+# LOAD SETTINGS
-ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "nginx.conf"
+#=================================================
+ynh_print_info --message="Loading installation settings..."
 
-### PHP (remove if not used) ###
+app=$YNH_APP_INSTANCE_NAME
-# If a dedicated php-fpm process is used:
+
-# # Copy PHP-FPM pool configuration
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-# ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" "php-fpm.conf"
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-### PHP end ###
+
+#=================================================
+# 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"
+
+#=================================================
+# SPECIFIC BACKUP
+#=================================================
+# BACKUP SYSTEMD
+#=================================================
+
+ynh_backup --src_path="/etc/systemd/system/$app.service"
+
+#=================================================
+# BACKUP THE POSTGRESQL DATABASE
+#=================================================
+ynh_print_info --message="Backing up the PostgreSQL database..."
+
+ynh_psql_dump_db --database="$db_name" > db.sql
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info --message="Backup script completed for cockpit. (YunoHost will then actually copy those files to the archive)."

scripts/install

@@ -13,11 +13,6 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
-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
 
 #=================================================
@@ -34,18 +29,18 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
-ynh_script_progression --message="Validating installation parameters..." --weight=1
+# ynh_script_progression --message="Validating installation parameters..." --weight=1
 
-final_path=/var/www/$app
+# final_path=/var/www/$app
-test ! -e "$final_path" || ynh_die "This path already contains a folder"
+# test ! -e "$final_path" || ynh_die "This path already contains a folder"
 
-# Normalize the url path syntax
+# # Normalize the url path syntax
-path_url=$(ynh_normalize_url_path $path_url)
+# path_url=$(ynh_normalize_url_path $path_url)
 
-# Check web path availability
+# # Check web path availability
-ynh_webpath_available $domain $path_url
+# ynh_webpath_available $domain $path_url
-# Register (book) web path
+# # Register (book) web path
-ynh_webpath_register $app $domain $path_url
+# ynh_webpath_register $app $domain $path_url
 
 #=================================================
 # STORE SETTINGS FROM MANIFEST
@@ -83,18 +78,24 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=2
 ynh_add_nginx_config
 
 #=================================================
-# SETUP SSOWAT
+# START SYSTEMD SERVICE
 #=================================================
-
+ynh_script_progression --message="Starting a systemd service..." --weight=2
-# If app is public, add url to SSOWat conf as skipped_uris
-if [ $is_public -eq 1 ]; then
-  # unprotected_uris allows SSO credentials to be passed anyway.
-  ynh_app_setting_set "$app" unprotected_uris "/"
-fi
 
 # Reload services
-systemctl start cockpit
+ynh_systemd_action --service_name=$app --action="start"
-systemctl enable --now cockpit
+ynh_systemd_action --service_name=$app --action="enable"
+
+#=================================================
+# SETUP SSOWAT
+#=================================================
+ynh_script_progression --message="Configuring SSOwat..." --weight=1
+
+# Make app public if necessary or protect it
+if [ $is_public -eq 1 ]
+then
+	ynh_permission_update --permission "main" --add "visitors"
+fi
 
 #=================================================
 # RELOAD NGINX
@@ -107,5 +108,4 @@ ynh_systemd_action --service_name=nginx --action=reload
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Installation of HedgeDoc completed" --last
+ynh_script_progression --message="Installation of Cockpit completed" --last
-

scripts/remove

@@ -18,27 +18,25 @@ app=$YNH_APP_INSTANCE_NAME
 
 domain=$(ynh_app_setting_get $app domain)
 port=$(ynh_app_setting_get $app port)
-db_name=$(ynh_app_setting_get $app db_name)
-db_user=$db_name
 final_path=$(ynh_app_setting_get $app final_path)
 
 #=================================================
 # STANDARD REMOVE
 #=================================================
-# REMOVE SERVICE FROM ADMIN PANEL
+# REMOVE SERVICE INTEGRATION IN YUNOHOST
 #=================================================
 
-# Remove a service from the admin panel, added by `yunohost service add`
+# Remove the service from the list of services known by Yunohost (added from `yunohost service add`)
-if yunohost service status $app >/dev/null 2>&1
+if ynh_exec_warn_less yunohost service status $app >/dev/null
 then
-	ynh_print_info "Removing $app service"
+	ynh_script_progression --message="Removing $app service..." --weight=1
 	yunohost service remove $app
 fi
 
 #=================================================
 # STOP AND REMOVE SERVICE
 #=================================================
-ynh_print_info "Stopping and removing the systemd service"
+ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1
 
 # Remove the dedicated systemd config
 ynh_remove_systemd_config
@@ -46,7 +44,7 @@ ynh_remove_systemd_config
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================
-ynh_print_info "Removing dependencies"
+ynh_script_progression --message="Removing dependencies..." --weight=1
 
 # Remove metapackage and its dependencies
 ynh_remove_app_dependencies
@@ -54,72 +52,21 @@ ynh_remove_app_dependencies
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_print_info "Removing app main directory"
+# ynh_print_info "Removing app main directory"
 
-# Remove the app directory securely
+# # Remove the app directory securely
-ynh_secure_remove "$final_path"
+# ynh_secure_remove "$final_path"
 
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
-ynh_print_info "Removing nginx web server configuration"
+ynh_script_progression --message="Removing NGINX web server configuration..." --weight=5
 
-# Remove the dedicated nginx config
+# Remove the dedicated NGINX config
 ynh_remove_nginx_config
 
-#=================================================
-# REMOVE PHP-FPM CONFIGURATION
-#=================================================
-#ynh_print_info "Removing php-fpm configuration"
-
-# Remove the dedicated php-fpm config
-#ynh_remove_fpm_config
-
-#=================================================
-# REMOVE LOGROTATE CONFIGURATION
-#=================================================
-ynh_print_info "Removing logrotate configuration"
-
-# Remove the app-specific logrotate config
-ynh_remove_logrotate
-
-#=================================================
-# CLOSE A PORT
-#=================================================
-
-if yunohost firewall list | grep -q "\- $port$"
-then
-	ynh_print_info "Closing port $port"
-	ynh_exec_warn_less yunohost firewall disallow TCP $port
-fi
-
-#=================================================
-# SPECIFIC REMOVE
-#=================================================
-# REMOVE THE CRON FILE
-#=================================================
-
-# Remove a cron file
-ynh_secure_remove "/etc/cron.d/$app"
-
-# Remove a directory securely
-ynh_secure_remove "/etc/$app/"
-
-# Remove the log files
-ynh_secure_remove "/var/log/$app/"
-
-#=================================================
-# GENERIC FINALIZATION
-#=================================================
-# REMOVE DEDICATED USER
-#=================================================
-ynh_print_info "Removing the dedicated system user"
-
-# Delete a system user
-ynh_system_user_delete $app
-
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_print_info "Removal of $app completed"
+ynh_script_progression --message="Removal of HedgeDoc completed" --last

scripts/restore

@@ -1,52 +1,109 @@
 #!/bin/bash
 
-# Note: each files and directories you've saved using the ynh_backup helper
+#=================================================
-# will be located in the current directory, regarding the last argument.
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# Exit on command errors and treat unset variables as an error
+source ../settings/scripts/_common.sh
-set -eu
-
-# See comments in install script
-app=$YNH_APP_INSTANCE_NAME
-
-# Source YunoHost helpers
 source /usr/share/yunohost/helpers
 
-# Retrieve old app settings
+#=================================================
-domain=$(ynh_app_setting_get "$app" domain)
+# MANAGE SCRIPT FAILURE
-path_url=$(ynh_app_setting_get "$app" path_url)
+#=================================================
 
-# Check domain/path availability
+ynh_clean_setup () {
-sudo yunohost app checkurl "${domain}${path_url}" -a "$app" \
+	ynh_clean_check_starting
-    || ynh_die "Path not available: ${domain}${path_url}"
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
 
-# Restore sources & data
+#=================================================
-src_path="/var/www/${app}"
+# LOAD SETTINGS
-sudo cp -a ./sources "$src_path"
+#=================================================
+ynh_script_progression --message="Loading settings..." --weight=1
 
-# Restore permissions to app files
+app=$YNH_APP_INSTANCE_NAME
-# you may need to make some file and/or directory writeable by www-data (nginx user)
-sudo chown -R root: "$src_path"
 
-### MySQL (remove if not used) ###
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-# If a MySQL database is used:
+path_url=$(ynh_app_setting_get --app=$app --key=path)
-# # Create and restore the database
-# dbname=$app
-# dbuser=$app
-# dbpass=$(ynh_app_setting_get "$app" mysqlpwd)
-# ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass"
-# ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ./dump.sql
-### MySQL end ###
 
-# Restore NGINX configuration
-sudo cp -a ./nginx.conf "/etc/nginx/conf.d/${domain}.d/${app}.conf"
 
-### PHP (remove if not used) ###
+#=================================================
-# If a dedicated php-fpm process is used:
+# CHECK IF THE APP CAN BE RESTORED
-# # Copy PHP-FPM pool configuration and reload the service
+#=================================================
-# sudo cp -a ./php-fpm.conf "/etc/php5/fpm/pool.d/${app}.conf"
+ynh_script_progression --message="Validating restoration parameters..." --weight=2
-# sudo service php5-fpm reload
-### PHP end ###
 
-# Restart webserver
+ynh_webpath_available --domain=$domain --path_url=$path_url \
-sudo service nginx reload
+	|| ynh_die --message="Path not available: ${domain}${path_url}"
+test ! -d $final_path \
+	|| ynh_die --message="There is already a directory: $final_path "
+
+#=================================================
+# STANDARD RESTORATION STEPS
+#=================================================
+# RESTORE THE NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Restoring the NGINX configuration..."
+
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
+#=================================================
+# SPECIFIC RESTORATION
+#=================================================
+# REINSTALL DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Reinstalling dependencies..." --weight=7
+
+# Define and install dependencies
+ynh_install_app_dependencies $pkg_dependencies
+
+#=================================================
+# RESTORE SYSTEMD
+#=================================================
+ynh_script_progression --message="Restoring the systemd configuration..." --weight=5
+
+ynh_restore_file --origin_path="/etc/systemd/system/$app.service"
+systemctl enable $app.service
+
+#=================================================
+# NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Configuring NGINX web server..." --weight=2
+
+# Create a dedicated NGINX config
+ynh_add_nginx_config
+
+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --weight=2
+
+# Reload services
+ynh_systemd_action --service_name=$app --action="start"
+ynh_systemd_action --service_name=$app --action="enable"
+
+#=================================================
+# SETUP SSOWAT
+#=================================================
+ynh_script_progression --message="Configuring SSOwat..." --weight=1
+
+# Make app public if necessary or protect it
+if [ $is_public -eq 1 ]
+then
+	ynh_permission_update --permission "main" --add "visitors"
+fi
+
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading NGINX web server..." --weight=2
+
+ynh_systemd_action --service_name=nginx --action=reload
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Installation of Cockpit completed" --last

scripts/upgrade

@@ -1,60 +1,90 @@
 #!/bin/bash
 
-# Exit on command errors and treat unset variables as an error
+#=================================================
-set -eu
+# GENERIC START
+#=================================================
+# IMPORT GENERIC HELPERS
+#=================================================
 
-# See comments in install script
+source _common.sh
-app=$YNH_APP_INSTANCE_NAME
-final_path=/opt/yunohost/$app
-
-# Source YunoHost helpers
 source /usr/share/yunohost/helpers
 
-# Stop cockpit service
+#=================================================
-systemctl stop cockpit
+# LOAD SETTINGS
+#=================================================
+ynh_script_progression --message="Loading installation settings..." --weight=2
 
-#==============================================
+app=$YNH_APP_INSTANCE_NAME
-# INSTALL DEPS
-#==============================================
 
-## Install the backports repo for debian
+domain=$(ynh_app_setting_get --app=$app --key=domain)
-echo 'deb http://deb.debian.org/debian stretch-backports main' > \
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
- /etc/apt/sources.list.d/$app.list
+port=$(ynh_app_setting_get --app=$app --key=port)
 
-ynh_package_update
+#final_path=/opt/yunohost/$app
 
-#==============================================
+#=================================================
-# INSTALL COCKPIT
+# CHECK VERSION
-#==============================================
+#=================================================
+ynh_script_progression --message="Checking version..."
 
-ynh_package_install cockpit
+upgrade_type=$(ynh_check_app_version_changed)
+
+#=================================================
+# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+#=================================================
+ynh_script_progression --message="Backing up HedgeDoc before upgrading (may take a while)..." --weight=120
+
+# Backup the current version of the app
+ynh_backup_before_upgrade
+ynh_clean_setup () {
+	# 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
+#=================================================
+# STOP SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Stopping a systemd service..." --weight=1
+
+ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
+
+#=================================================
+# INSTALL DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Installing dependencies..." --weight=20
+
+ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_script_progression --message="Configuring NGINX web server..." --weight=2
 
-# Create a dedicated nginx config
+# Create a dedicated NGINX config
-#ynh_add_nginx_config
+ynh_add_nginx_config
-
 
 #=================================================
-# UPGRADE CONFIG
+# START SYSTEMD SERVICE
 #=================================================
-#cp -a ../conf/loolwsd.xml /etc/loolwsd
+ynh_script_progression --message="Starting a systemd service..." --weight=2
-#ynh_replace_string "__NEXTCLOUDDOMAIN__" "$nextcloud_domain" "/etc/loolwsd/loolwsd.xml"
-#ynh_replace_string "__PASSWORD__" "$password" "/etc/loolwsd/loolwsd.xml"
-#systemctl restart loolwsd
 
+# Reload services
+ynh_systemd_action --service_name=$app --action="start"
+ynh_systemd_action --service_name=$app --action="enable"
 
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading NGINX web server..." --weight=2
 
-# If app is public, add url to SSOWat conf as skipped_uris
+ynh_systemd_action --service_name=nginx --action=reload
-#if [[ $is_public -eq 1 ]]; then
-  # See install script
-#  ynh_app_setting_set "$app" unprotected_uris "/"
-#fi
 
-rm /etc/apt/sources.list.d/$app.list
+#=================================================
-
+# END OF SCRIPT
-# Start cockpit service
+#=================================================
-systemctl start cockpit
 
+ynh_script_progression --message="Installation of Cockpit completed" --last