Upgrade to last example_ynh

conf/systemd.service

@@ -25,4 +25,3 @@ NoNewPrivileges=true
 
 [Install]
 WantedBy=multi-user.target
-

manifest.json

@@ -14,7 +14,7 @@
         "email": "anmol@datamol.org"
     },
     "requirements": {
-        "yunohost": ">= 2.7.9"
+        "yunohost": ">= 3.4"
     },
     "multi_instance": true,
     "services": [
@@ -26,8 +26,8 @@
                 "name": "domain",
                 "type": "domain",
                 "ask": {
-                    "en": "Choose a domain name for pleroma",
+                    "en": "Choose a domain name for Pleroma",
-                    "fr": "Choisissez un nom de domaine pour pleroma"
+                    "fr": "Choisissez un nom de domaine pour Pleroma"
                 },
                 "example": "example.com"
             },

scripts/_common.sh

@@ -1,13 +1,13 @@
 #!/bin/bash
 
-# ============= FUTURE YUNOHOST HELPER =============
+#=================================================
-# Delete a file checksum from the app settings
+# PERSONNAL HELPERS
-#
+#=================================================
-# $app should be defined when calling this helper
+
-#
+#=================================================
-# usage: ynh_remove_file_checksum file
+# EXPERIMENTAL HELPERS
-# | arg: file - The file for which the checksum will be deleted
+#=================================================
-ynh_delete_file_checksum () {
+
-	local checksum_setting_name=checksum_${1//[\/ ]/_}	# Replace all '/' and ' ' by '_'
+#=================================================
-	ynh_app_setting_delete $app $checksum_setting_name
+# FUTUR OFFICIAL HELPERS
-}
+#=================================================

scripts/backup

@@ -24,6 +24,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Load settings"
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -37,12 +38,14 @@ cache=$(ynh_app_setting_get "$app" cache)
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
+ynh_print_info "Backup the app main dir"
 
 ynh_backup "$final_path"
 
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Backup nginx configuration"
 
 ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
 
@@ -54,12 +57,14 @@ fi
 #=================================================
 # BACKUP THE PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Backup php-fpm configuration"
 
 #ynh_backup "/etc/php5/fpm/pool.d/$app.conf"
 
 #=================================================
 # BACKUP THE POSTGRESQL DATABASE
 #=================================================
+ynh_print_info "Backup the postgresql database"
 
 ynh_psql_dump_db "$db_name" > db.sql
 
@@ -68,12 +73,14 @@ ynh_psql_dump_db "$db_name" > db.sql
 #=================================================
 # BACKUP LOGROTATE
 #=================================================
+ynh_print_info "Backup logrotate configuration"
 
 ynh_backup "/etc/logrotate.d/$app"
 
 #=================================================
 # BACKUP SYSTEMD
 #=================================================
+ynh_print_info "Backup systemd configuration"
 
 ynh_backup "/etc/systemd/system/$app.service"
 
@@ -82,3 +89,9 @@ ynh_backup "/etc/systemd/system/$app.service"
 #=================================================
 
 #ynh_backup "/etc/cron.d/$app"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Backup script completed. Please wait for YunoHost to create the backup."

scripts/change_url

@@ -13,6 +13,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # RETRIEVE ARGUMENTS
 #=================================================
+ynh_print_info "Retrieve arguments from the manifest"
 
 old_domain=$YNH_APP_OLD_DOMAIN
 old_path=$YNH_APP_OLD_PATH
@@ -25,6 +26,7 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Load settings"
 
 # Needed for helper "ynh_add_nginx_config"
 final_path=$(ynh_app_setting_get $app final_path)
@@ -36,6 +38,7 @@ final_path=$(ynh_app_setting_get $app final_path)
 #=================================================
 # CHECK THE SYNTAX OF THE PATHS
 #=================================================
+ynh_print_info "Check the syntax of the paths"
 
 test -n "$old_path" || old_path="/"
 test -n "$new_path" || new_path="/"
@@ -63,6 +66,7 @@ fi
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
+ynh_print_info "Modify url in nginx configuration"
 
 nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 
@@ -123,5 +127,12 @@ ynh_store_file_checksum "$final_path/$app/config/prod.secret.exs"
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_print_info "Reload nginx"
 
 systemctl reload nginx
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Change of url completed"

scripts/install

@@ -24,6 +24,7 @@ ynh_abort_if_errors
 #=================================================
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
+ynh_print_info "Retrieve arguments from the manifest ..."
 
 domain=$YNH_APP_ARG_DOMAIN
 path_url="/"
@@ -59,6 +60,7 @@ app=$YNH_APP_INSTANCE_NAME
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
+ynh_print_info "Validating arguments ..."
 
 ### 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"
@@ -74,6 +76,7 @@ ynh_webpath_register $app $domain $path_url
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
+ynh_print_info "Store settings from manifest ..."
 
 ynh_app_setting_set $app domain $domain
 ynh_app_setting_set $app path $path_url
@@ -91,6 +94,7 @@ ynh_app_setting_set "$app" random_key   "$random_key"
 #=================================================
 # FIND AND OPEN A PORT
 #=================================================
+ynh_print_info "Configuring firewall ..."
 
 ### Use these lines if you have to open a port for the application
 ### `ynh_find_port` will find the first available port starting from the given port.
@@ -100,12 +104,13 @@ ynh_app_setting_set "$app" random_key   "$random_key"
 # Find a free port
 port=$(ynh_find_port 8095)
 # Open this port
-#yunohost firewall allow --no-upnp TCP $port 2>&1
+#ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $port
 ynh_app_setting_set $app port $port
 
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
+ynh_print_info "Installing dependencies ..."
 
 ### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
 ### Those deb packages will be installed as dependencies of this package.
@@ -158,6 +163,7 @@ CREATE EXTENSION IF NOT EXISTS \"uuid-ossp\";"
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
+ynh_print_info "Setting up source files ..."
 
 ### `ynh_setup_source` is used to install an app from a zip or tar.gz file,
 ### downloaded from an upstream source, like a git repository.
@@ -171,6 +177,7 @@ git clone https://git.pleroma.social/pleroma/pleroma "$final_path/$app"
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Configuring nginx ..."
 
 ### `ynh_add_nginx_config` will use the file conf/nginx.conf
 
@@ -191,6 +198,7 @@ fi
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_print_info "Configuring system user ..."
 
 # Create a system user
 ynh_system_user_create "$app" "$final_path"
@@ -198,6 +206,7 @@ ynh_system_user_create "$app" "$final_path"
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Configuring php-fpm ..."
 
 ### `ynh_add_fpm_config` is used to set up a PHP config.
 ### You can remove it if your app doesn't use PHP.
@@ -275,6 +284,7 @@ popd
 #=================================================
 # SETUP SYSTEMD
 #=================================================
+ynh_print_info "Configuring a systemd service ..."
 
 ### `ynh_systemd_config` is used to configure a systemd script for an app.
 ### It can be used for apps that use sysvinit (with adaptation) or systemd.
@@ -303,6 +313,7 @@ ynh_add_systemd_config
 #chown -R $app: $final_path
 
 # Set the app as temporarily public for curl call
+ynh_print_info "Configuring ssowat ..."
 #ynh_app_setting_set $app skipped_uris "/"
 # Reload SSOwat config
 #yunohost app ssowatconf
@@ -311,6 +322,7 @@ ynh_add_systemd_config
 #systemctl reload nginx
 
 # Installation with curl
+ynh_print_info "Finalizing install ..."
 #ynh_local_curl "/INSTALL_PATH" "key1=value1" "key2=value2" "key3=value3"
 
 # Remove the public access
@@ -355,6 +367,7 @@ chown -R "$app":"$app" "$final_path"
 #=================================================
 # SETUP LOGROTATE
 #=================================================
+ynh_print_info "Configuring log rotation ..."
 
 ### `ynh_use_logrotate` is used to configure a logrotate configuration for the logs of this app.
 ### Use this helper only if there is effectively a log file for this app.
@@ -386,6 +399,7 @@ yunohost service add $app --description "$app daemon for Pleroma" --log "/var/lo
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_print_info "Configuring SSOwat ..."
 
 # Make app public if necessary
 if [ $is_public -eq 1 ]
@@ -397,6 +411,7 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_print_info "Reloading nginx ..."
 
 systemctl reload nginx
 
@@ -405,3 +420,9 @@ systemctl reload nginx
 #=================================================
 
 ynh_systemd_action --action=start --service_name=$app --log_path=systemd --line_match="Running Pleroma.Web.Endpoint"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Installation completed"

scripts/remove

@@ -13,6 +13,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Load settings"
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -31,7 +32,7 @@ cache=$(ynh_app_setting_get "$app" cache)
 # Remove a service from the admin panel, added by `yunohost service add`
 if yunohost service status | grep -q $app
 then
-	echo "Remove $app service"
+	ynh_print_info "Remove $app service"
 	yunohost service remove $app
 fi
 
@@ -44,6 +45,7 @@ ynh_systemd_action --action=stop --service_name=$app
 #=================================================
 # STOP AND REMOVE SERVICE
 #=================================================
+ynh_print_info "Stop and remove the service"
 
 # Remove the dedicated systemd config
 ynh_remove_systemd_config
@@ -51,6 +53,7 @@ ynh_remove_systemd_config
 #=================================================
 # REMOVE THE POSTGRESQL DATABASE
 #=================================================
+ynh_print_info "Remove the postgresql database"
 
 ynh_psql_execute_as_root "\connect $db_name 
 SELECT pg_terminate_backend (pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = '$db_name';"
@@ -61,14 +64,16 @@ ynh_psql_remove_db "$db_name" "$app"
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================
+ynh_print_info "Remove dependencies"
 
 # Remove metapackage and its dependencies
 ynh_remove_app_dependencies
-rm -f "/etc/apt/sources.list.d/erlang-solutions.list"
+ynh_secure_remove "/etc/apt/sources.list.d/erlang-solutions.list"
 
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
+ynh_print_info "Remove app main directory"
 
 # Remove the app directory securely
 ynh_secure_remove "$final_path"
@@ -76,6 +81,7 @@ ynh_secure_remove "$final_path"
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Remove nginx configuration"
 
 # Remove the dedicated nginx config
 ynh_remove_nginx_config
@@ -84,6 +90,7 @@ ynh_secure_remove "/etc/nginx/conf.d/$app-cache.conf"
 #=================================================
 # REMOVE PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Remove php-fpm configuration"
 
 # Remove the dedicated php-fpm config
 #ynh_remove_fpm_config
@@ -91,6 +98,7 @@ ynh_secure_remove "/etc/nginx/conf.d/$app-cache.conf"
 #=================================================
 # REMOVE LOGROTATE CONFIGURATION
 #=================================================
+ynh_print_info "Remove logrotate configuration"
 
 # Remove the app-specific logrotate config
 ynh_remove_logrotate
@@ -98,6 +106,7 @@ ynh_remove_logrotate
 #=================================================
 # CLOSE A PORT
 #=================================================
+ynh_print_info "Close ports"
 
 if yunohost firewall list | grep -q "\- $port$"
 then
@@ -125,6 +134,13 @@ ynh_secure_remove "/var/log/$app/"
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
+ynh_print_info "Remove the dedicated user"
 
 # Delete a system user
 ynh_system_user_delete $app
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Deletion completed"

scripts/restore

@@ -24,6 +24,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Load settings"
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -60,27 +61,14 @@ fi
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
+ynh_print_info "Restore the app main directory"
 
 ynh_restore_file "$final_path"
 
-#=================================================
-# RESTORE THE POSTGRESQL DATABASE
-#=================================================
-
-ynh_install_app_dependencies postgresql postgresql-contrib
-ynh_psql_test_if_first_run
-ynh_psql_create_user "$app" "$db_pwd"
-ynh_psql_execute_as_root \
-"CREATE DATABASE $db_name ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER $app;"
-ynh_psql_execute_as_root "\connect $db_name 
-CREATE EXTENSION IF NOT EXISTS unaccent;CREATE EXTENSION IF NOT EXISTS pg_trgm;"
-ynh_psql_execute_as_root "\connect $db_name 
-CREATE EXTENSION IF NOT EXISTS unaccent;CREATE EXTENSION IF NOT EXISTS citext;"
-ynh_psql_execute_file_as_root ./db.sql "$db_name"
-
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
+ynh_print_info "Recreate the dedicated user"
 
 # Create the dedicated user (if not existing)
 ynh_system_user_create "$app" "$final_path"
@@ -96,13 +84,14 @@ chown -R "$app":"$app" "$final_path"
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
 
-#ynh_restore_file "/etc/php5/fpm/pool.d/$app.conf"
+#ynh_restore_file "/etc/php/7.0/fpm/pool.d/$app.conf"
 
 #=================================================
 # SPECIFIC RESTORATION
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
+ynh_print_info "Reinstall dependencies"
 
 # Add erlang for Debian Jessie 
 
@@ -116,12 +105,28 @@ sudo wget https://packages.erlang-solutions.com/debian/erlang_solutions.asc
 sudo apt-key add erlang_solutions.asc
 sudo rm erlang_solutions.asc
 
-# install dependencies
+# Define and install dependencies
 ynh_install_app_dependencies git build-essential openssl ssh sudo postgresql postgresql-contrib elixir erlang-dev erlang-parsetools erlang-xmerl erlang-tools
 
+#=================================================
+# RESTORE THE POSTGRESQL DATABASE
+#=================================================
+ynh_print_info "Restore the postgresql database"
+
+ynh_psql_test_if_first_run
+ynh_psql_create_user "$app" "$db_pwd"
+ynh_psql_execute_as_root \
+"CREATE DATABASE $db_name ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER $app;"
+ynh_psql_execute_as_root "\connect $db_name 
+CREATE EXTENSION IF NOT EXISTS unaccent;CREATE EXTENSION IF NOT EXISTS pg_trgm;"
+ynh_psql_execute_as_root "\connect $db_name 
+CREATE EXTENSION IF NOT EXISTS unaccent;CREATE EXTENSION IF NOT EXISTS citext;"
+ynh_psql_execute_file_as_root ./db.sql "$db_name"
+
 #=================================================
 # RESTORE SYSTEMD
 #=================================================
+ynh_print_info "Restore the systemd configuration"
 
 ynh_restore_file "/etc/systemd/system/$app.service"
 systemctl enable $app.service
@@ -150,7 +155,9 @@ ynh_restore_file "/etc/logrotate.d/$app"
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
+ynh_print_info "Reload nginx and php-fpm"
 
+#systemctl reload php7.0-fpm
 systemctl reload nginx
 
 #=================================================
@@ -158,3 +165,9 @@ systemctl reload nginx
 #=================================================
 
 ynh_systemd_action --action=start --service_name=$app --log_path=systemd --line_match="Running Pleroma.Web.Endpoint"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Restoration completed"

scripts/upgrade

@@ -13,6 +13,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Load settings"
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -46,6 +47,7 @@ fi
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
+ynh_print_info "Ensure downward compatibility"
 
 # Fix is_public as a boolean value
 if [ "$is_public" = "Yes" ]; then
@@ -71,6 +73,7 @@ fi
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
+ynh_print_info "Backup the app before upgrading"
 
 # Backup the current version of the app
 ynh_backup_before_upgrade
@@ -100,6 +103,7 @@ path_url=$(ynh_normalize_url_path $path_url)
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
+ynh_print_info "Download, check and unpack source"
 
 # Download, check integrity, uncompress and patch the source from app.src
 #ynh_setup_source "$final_path/$app"
@@ -108,6 +112,7 @@ path_url=$(ynh_normalize_url_path $path_url)
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Reconfigure nginx"
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -128,6 +133,7 @@ fi
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
+ynh_print_info "Upgrade dependencies"
 
 # Add erlang for Debian Jessie 
 
@@ -147,6 +153,7 @@ ynh_install_app_dependencies git build-essential openssl ssh sudo postgresql pos
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_print_info "Create a dedicated user"
 
 # Create a dedicated user (if not existing)
 ynh_system_user_create "$app" "$final_path"
@@ -154,6 +161,7 @@ ynh_system_user_create "$app" "$final_path"
 #=================================================
 # PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Reconfigure php-fpm"
 
 # Create a dedicated php-fpm config
 #ynh_add_fpm_config
@@ -235,6 +243,7 @@ fi
 #=================================================
 # SETUP LOGROTATE
 #=================================================
+ynh_print_info "Reconfigure logrotate"
 
 # Use logrotate to manage app-specific logfile(s)
 ynh_use_logrotate --non-append
@@ -242,6 +251,8 @@ ynh_use_logrotate --non-append
 #=================================================
 # SETUP SYSTEMD
 #=================================================
+ynh_print_info "Reconfigure systemd"
+
 # Create a dedicated systemd config
 ynh_add_systemd_config
 
@@ -258,6 +269,7 @@ chown -R "$app":"$app" "$final_path"
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_print_info "Reconfigure SSOwat"
 
 # Make app public if necessary
 if [ $is_public -eq 1 ]
@@ -269,6 +281,7 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_print_info "Reload nginx"
 
 systemctl reload nginx
 
@@ -277,3 +290,9 @@ systemctl reload nginx
 #=================================================
 
 ynh_systemd_action --action=start --service_name=$app --log_path=systemd --line_match="Running Pleroma.Web.Endpoint"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Upgrade completed"