Apply example_ynh

manifest.json

@@ -14,7 +14,7 @@
         "email": "anmol@datamol.org"
     },
     "requirements": {
-        "yunohost": ">= 2.7.14"
+        "yunohost": ">= 3.4"
     },
     "multi_instance": true,
     "services": [

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
 
@@ -36,24 +37,28 @@ db_name=$(ynh_app_setting_get $app db_name)
 #=================================================
 # 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"
 
 #=================================================
 # BACKUP THE PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Backup php-fpm configuration"
 
-#ynh_backup "/etc/php5/fpm/pool.d/$app.conf"
+#ynh_backup "/etc/php/7.0/fpm/pool.d/$app.conf"
 
 #=================================================
 # BACKUP THE POSTGRESQL DATABASE
 #=================================================
+ynh_print_info "Backup the postgresql database"
 
 ynh_psql_dump_db "$db_name" > db.sql
 
@@ -62,12 +67,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"
 
@@ -76,3 +83,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/.env"
 #=================================================
 # 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="/"
@@ -50,6 +51,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"
@@ -65,11 +67,13 @@ 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
 ynh_app_setting_set $app admin $admin
 ynh_app_setting_set $app is_public $is_public
+#ynh_app_setting_set $app language $language
 ynh_app_setting_set $app instance $instance_name
 ynh_app_setting_set $app registration $registration
 ynh_app_setting_set $app admin_email $admin_email
@@ -80,6 +84,7 @@ ynh_app_setting_set $app secret_key $secret_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.
@@ -88,13 +93,14 @@ ynh_app_setting_set $app secret_key $secret_key
 
 # Find a free port
 port=$(ynh_find_port 8095)
-# Open this port > not needed for Plume, will be proxied by Nginx
+# 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.
@@ -108,6 +114,7 @@ ynh_install_app_dependencies gettext postgresql postgresql-contrib libpq-dev git
 #=================================================
 # CREATE A POSTGRESQL DATABASE
 #=================================================
+ynh_print_info "Creating a postgresl database ..."
 
 ### Use these lines if you need a database for the application.
 ### `ynh_psql_test_if_first_run` will create a master password and set up global settings.
@@ -128,6 +135,7 @@ ynh_psql_execute_as_root \
 #=================================================
 # 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.
@@ -144,21 +152,25 @@ mkdir $final_path/media
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Configuring nginx ..."
 
 ### `ynh_add_nginx_config` will use the file conf/nginx.conf
+
 # Create a dedicated nginx config
 ynh_add_nginx_config
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_print_info "Configuring system user ..."
 
 # Create a system user
-ynh_system_user_create "$app" "$final_path"
+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.
@@ -233,6 +245,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.
@@ -261,6 +274,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
@@ -269,6 +283,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
@@ -313,6 +328,7 @@ ynh_store_file_checksum "$final_path/$app/.env"
 #=================================================
 # 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.
@@ -344,6 +360,7 @@ yunohost service add $app --description "$app daemon for XXX" --log "/var/log/$a
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_print_info "Configuring SSOwat ..."
 
 # Make app public if necessary
 if [ $is_public -eq 1 ]
@@ -355,6 +372,7 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_print_info "Reloading nginx ..."
 
 systemctl reload nginx
 
@@ -363,3 +381,9 @@ systemctl reload nginx
 #=================================================
 
 ynh_systemd_action --action=start --service_name=$app
+
+#=================================================
+# 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
 
@@ -30,13 +31,14 @@ final_path=$(ynh_app_setting_get $app final_path)
 # 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
 
 #=================================================
 # STOP AND REMOVE SERVICE
 #=================================================
+ynh_print_info "Stop and remove the service"
 
 # Remove the dedicated systemd config
 ynh_remove_systemd_config
@@ -44,14 +46,15 @@ ynh_remove_systemd_config
 #=================================================
 # REMOVE THE POSTGRESQL DATABASE
 #=================================================
+ynh_print_info "Remove the mysql database"
 
 # Remove a database if it exists, along with the associated user
 ynh_psql_remove_db "$db_name" "$db_name"
 
 #=================================================
-
 # REMOVE DEPENDENCIES
 #=================================================
+ynh_print_info "Remove dependencies"
 
 # Remove metapackage and its dependencies
 ynh_remove_app_dependencies
@@ -69,6 +72,7 @@ fi
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
+ynh_print_info "Remove app main directory"
 
 # Remove the app directory securely
 ynh_secure_remove "$final_path"
@@ -76,6 +80,7 @@ ynh_secure_remove "$final_path"
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Remove nginx configuration"
 
 # Remove the dedicated nginx config
 ynh_remove_nginx_config
@@ -83,6 +88,7 @@ ynh_remove_nginx_config
 #=================================================
 # REMOVE PHP-FPM CONFIGURATION
 #=================================================
+ynh_print_info "Remove php-fpm configuration"
 
 # Remove the dedicated php-fpm config
 #ynh_remove_fpm_config
@@ -90,6 +96,7 @@ ynh_remove_nginx_config
 #=================================================
 # REMOVE LOGROTATE CONFIGURATION
 #=================================================
+ynh_print_info "Remove logrotate configuration"
 
 # Remove the app-specific logrotate config
 ynh_remove_logrotate
@@ -97,11 +104,12 @@ ynh_remove_logrotate
 #=================================================
 # CLOSE A PORT
 #=================================================
+ynh_print_info "Close ports"
 
 if yunohost firewall list | grep -q "\- $port$"
 then
-	echo "Close port $port" >&2
+	ynh_print_info "Close port $port"
-	yunohost firewall disallow TCP $port 2>&1
+	ynh_exec_warn_less yunohost firewall disallow TCP $port
 fi
 
 #=================================================
@@ -124,6 +132,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,14 +24,14 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info "Load settings"
 
 app=$YNH_APP_INSTANCE_NAME
 
 domain=$(ynh_app_setting_get $app domain)
 path_url=$(ynh_app_setting_get $app path)
 final_path=$(ynh_app_setting_get $app final_path)
-port=$(ynh_app_setting_get "$app" port)
+db_name=$(ynh_app_setting_get $app db_name)
-db_name=$(ynh_app_setting_get "$app" db_name)
 db_pwd=$(ynh_app_setting_get "$app" db_pwd)
 
 #=================================================
@@ -54,23 +54,14 @@ ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================
 # 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 "$db_name" "$db_pwd"
-ynh_psql_execute_as_root \
-"CREATE DATABASE $db_name ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER $db_name;"
-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"
@@ -86,21 +77,34 @@ 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"
 
 # Define and install dependencies
 ynh_install_app_dependencies gettext postgresql postgresql-contrib libpq-dev git curl gcc make openssl libssl-dev pkg-config
 
 
+#=================================================
+# RESTORE THE POSTGRESQL DATABASE
+#=================================================
+ynh_print_info "Restore the postgresql database"
+
+ynh_psql_test_if_first_run
+ynh_psql_create_user "$db_name" "$db_pwd"
+ynh_psql_execute_as_root \
+"CREATE DATABASE $db_name ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER $db_name;"
+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
@@ -143,8 +147,9 @@ ynh_restore_file "/etc/logrotate.d/$app"
 #=================================================
 # RELOAD NGINX AND PHP-FPM
 #=================================================
+ynh_print_info "Reload nginx and php-fpm"
 
-#systemctl reload php5-fpm
+#systemctl reload php7.0-fpm
 systemctl reload nginx
 
 #=================================================
@@ -152,3 +157,9 @@ systemctl reload nginx
 #=================================================
 
 ynh_systemd_action --action=start --service_name=$app
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Restoration completed"

scripts/upgrade

@@ -43,6 +43,7 @@ fi
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
+ynh_print_info "Ensure downward compatibility"
 
 # Fix is_public as a boolean value
 if [ "$is_public" = "Yes" ]; then
@@ -68,6 +69,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
@@ -97,6 +99,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"
@@ -108,6 +111,7 @@ popd
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
+ynh_print_info "Reconfigure nginx"
 
 # Create a dedicated nginx config
 ynh_add_nginx_config
@@ -115,12 +119,14 @@ ynh_add_nginx_config
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
+ynh_print_info "Upgrade dependencies"
 
 ynh_install_app_dependencies gettext postgresql postgresql-contrib libpq-dev git curl gcc make openssl libssl-dev pkg-config
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
+ynh_print_info "Create a dedicated user"
 
 # Create a dedicated user (if not existing)
 ynh_system_user_create "$app" "$final_path"
@@ -128,6 +134,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
@@ -180,6 +187,7 @@ ynh_store_file_checksum "$final_path/$app/.env"
 #=================================================
 # SETUP LOGROTATE
 #=================================================
+ynh_print_info "Reconfigure logrotate"
 
 # Use logrotate to manage app-specific logfile(s)
 ynh_use_logrotate --non-append
@@ -187,6 +195,7 @@ ynh_use_logrotate --non-append
 #=================================================
 # SETUP SYSTEMD
 #=================================================
+ynh_print_info "Reconfigure systemd"
 
 # Create a dedicated systemd config
 ynh_add_systemd_config
@@ -203,6 +212,7 @@ chown -R "$app":"$app" "$final_path"
 #=================================================
 # SETUP SSOWAT
 #=================================================
+ynh_print_info "Reconfigure SSOwat"
 
 # Make app public if necessary
 if [ $is_public -eq 1 ]
@@ -214,6 +224,7 @@ fi
 #=================================================
 # RELOAD NGINX
 #=================================================
+ynh_print_info "Reload nginx"
 
 systemctl reload nginx
 
@@ -222,3 +233,9 @@ systemctl reload nginx
 #=================================================
 
 ynh_systemd_action --action=start --service_name=$app
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_print_info "Upgrade completed"