Major update of all scripts to use the new yunohost helpers

conf/php-fpm.conf

@@ -1,239 +1,71 @@
-; Start a new pool named 'www'.
+[#POOLNAME#]
-; the variable $pool can we used in any directive and will be replaced by the
-; pool name ('www' here)
-[NAMETOCHANGE]
-
-; Per pool prefix
-; It only applies on the following directives:
-; - 'slowlog'
-; - 'listen' (unixsocket)
-; - 'chroot'
-; - 'chdir'
-; - 'php_values'
-; - 'php_admin_values'
-; When not set, the global prefix (or /usr) applies instead.
-; Note: This directive can also be relative to the global prefix.
-; Default Value: none
-;prefix = /path/to/pools/$pool
-
 ; The address on which to accept FastCGI requests.
-; Valid syntaxes are:
+listen = /var/run/php5-fpm-#POOLNAME#.sock
-;   'ip.add.re.ss:port'    - to listen on a TCP socket to a specific address on
-;                            a specific port;
-;   'port'                 - to listen on a TCP socket to all addresses on a
-;                            specific port;
-;   '/path/to/unix/socket' - to listen on a unix socket.
-; Note: This value is mandatory.
-listen = /var/run/php5-fpm-NAMETOCHANGE.sock
 
-; Set listen(2) backlog. A value of '-1' means unlimited.
+; Set permissions for unix socket, if one is used.
-; Default Value: 128 (-1 on FreeBSD and OpenBSD)
-;listen.backlog = -1
-
-; List of ipv4 addresses of FastCGI clients which are allowed to connect.
-; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original
-; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address
-; must be separated by a comma. If this value is left blank, connections will be
-; accepted from any ip address.
-; Default Value: any
-;listen.allowed_clients = 127.0.0.1
-
-; Set permissions for unix socket, if one is used. In Linux, read/write
-; permissions must be set in order to allow connections from a web server. Many
-; BSD-derived systems allow connections regardless of permissions.
-; Default Values: user and group are set as the running user
-;                 mode is set to 0666
 listen.owner = www-data
 listen.group = www-data
 listen.mode = 0600
 
-; Unix user/group of processes
+; Unix user/group of processes.
-; Note: The user is mandatory. If the group is not set, the default user's group
+user = #USER#
-;       will be used.
+group = #GROUP#
-user = www-data
-group = www-data
 
 ; Choose how the process manager will control the number of child processes.
-; Possible Values:
-;   static  - a fixed number (pm.max_children) of child processes;
-;   dynamic - the number of child processes are set dynamically based on the
-;             following directives:
-;             pm.max_children      - the maximum number of children that can
-;                                    be alive at the same time.
-;             pm.start_servers     - the number of children created on startup.
-;             pm.min_spare_servers - the minimum number of children in 'idle'
-;                                    state (waiting to process). If the number
-;                                    of 'idle' processes is less than this
-;                                    number then some children will be created.
-;             pm.max_spare_servers - the maximum number of children in 'idle'
-;                                    state (waiting to process). If the number
-;                                    of 'idle' processes is greater than this
-;                                    number then some children will be killed.
-; Note: This value is mandatory.
 pm = dynamic
 
 ; The number of child processes to be created when pm is set to 'static' and the
 ; maximum number of child processes to be created when pm is set to 'dynamic'.
-; This value sets the limit on the number of simultaneous requests that will be
-; served. Equivalent to the ApacheMaxClients directive with mpm_prefork.
-; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP
-; CGI.
-; Note: Used when pm is set to either 'static' or 'dynamic'
-; Note: This value is mandatory.
 pm.max_children = 6
 
 ; The number of child processes created on startup.
-; Note: Used only when pm is set to 'dynamic'
-; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2
 pm.start_servers = 3
 
 ; The desired minimum number of idle server processes.
-; Note: Used only when pm is set to 'dynamic'
-; Note: Mandatory when pm is set to 'dynamic'
 pm.min_spare_servers = 3
 
 ; The desired maximum number of idle server processes.
-; Note: Used only when pm is set to 'dynamic'
-; Note: Mandatory when pm is set to 'dynamic'
 pm.max_spare_servers = 5
 
 ; The number of requests each child process should execute before respawning.
-; This can be useful to work around memory leaks in 3rd party libraries. For
-; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS.
-; Default Value: 0
 pm.max_requests = 500
 
 ; The URI to view the FPM status page. If this value is not set, no URI will be
-; recognized as a status page. By default, the status page shows the following
+; recognized as a status page.
-; information:
-;   accepted conn        - the number of request accepted by the pool;
-;   pool                 - the name of the pool;
-;   process manager      - static or dynamic;
-;   idle processes       - the number of idle processes;
-;   active processes     - the number of active processes;
-;   total processes      - the number of idle + active processes.
-;   max children reached - number of times, the process limit has been reached,
-;                          when pm tries to start more children (works only for
-;                          pm 'dynamic')
-; The values of 'idle processes', 'active processes' and 'total processes' are
-; updated each second. The value of 'accepted conn' is updated in real time.
-; Example output:
-;   accepted conn:        12073
-;   pool:                 www
-;   process manager:      static
-;   idle processes:       35
-;   active processes:     65
-;   total processes:      100
-;   max children reached: 1
-; By default the status page output is formatted as text/plain. Passing either
-; 'html' or 'json' as a query string will return the corresponding output
-; syntax. Example:
-;   http://www.foo.bar/status
-;   http://www.foo.bar/status?json
-;   http://www.foo.bar/status?html
-; Note: The value must start with a leading slash (/). The value can be
-;       anything, but it may not be a good idea to use the .php extension or it
-;       may conflict with a real PHP file.
-; Default Value: not set
 pm.status_path = /fpm-status
 
 ; The ping URI to call the monitoring page of FPM. If this value is not set, no
-; URI will be recognized as a ping page. This could be used to test from outside
+; URI will be recognized as a ping page.
-; that FPM is alive and responding, or to
-; - create a graph of FPM availability (rrd or such);
-; - remove a server from a group if it is not responding (load balancing);
-; - trigger alerts for the operating team (24/7).
-; Note: The value must start with a leading slash (/). The value can be
-;       anything, but it may not be a good idea to use the .php extension or it
-;       may conflict with a real PHP file.
-; Default Value: not set
 ping.path = /ping
 
-; This directive may be used to customize the response of a ping request. The
-; response is formatted as text/plain with a 200 response code.
-; Default Value: pong
-;ping.response = pong
-
 ; The timeout for serving a single request after which the worker process will
-; be killed. This option should be used when the 'max_execution_time' ini option
+; be killed.
-; does not stop script execution for some reason. A value of '0' means 'off'.
+request_terminate_timeout = 1d
-; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
-; Default Value: 0
-request_terminate_timeout = 120s
 
 ; The timeout for serving a single request after which a PHP backtrace will be
 ; dumped to the 'slowlog' file. A value of '0s' means 'off'.
-; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
-; Default Value: 0
 request_slowlog_timeout = 5s
 
-; The log file for slow requests
+; The log file for slow requests.
-; Default Value: not set
+slowlog = /var/log/nginx/#POOLNAME#.slow.log
-; Note: slowlog is mandatory if request_slowlog_timeout is set
-slowlog = /var/log/nginx/NAMETOCHANGE.slow.log
 
 ; Set open file descriptor rlimit.
-; Default Value: system defined value
 rlimit_files = 4096
 
 ; Set max core size rlimit.
-; Possible Values: 'unlimited' or an integer greater or equal to 0
-; Default Value: system defined value
 rlimit_core = 0
 
-; Chroot to this directory at the start. This value must be defined as an
-; absolute path. When this value is not set, chroot is not used.
-; Note: you can prefix with '$prefix' to chroot to the pool prefix or one
-; of its subdirectories. If the pool prefix is not set, the global prefix
-; will be used instead.
-; Note: chrooting is a great security feature and should be used whenever
-;       possible. However, all PHP paths will be relative to the chroot
-;       (error_log, sessions.save_path, ...).
-; Default Value: not set
-;chroot =
-
 ; Chdir to this directory at the start.
-; Note: relative path can be used.
+chdir = #DESTDIR#
-; Default Value: current directory or / when chroot
-chdir = /var/www/NAMETOCHANGE
 
-; Redirect worker stdout and stderr into main error log. If not set, stdout and
+; Redirect worker stdout and stderr into main error log.
-; stderr will be redirected to /dev/null according to FastCGI specs.
-; Note: on highloaded environement, this can cause some delay in the page
-; process time (several ms).
-; Default Value: no
 catch_workers_output = yes
 
-; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from
+; Do not clear environment in FPM workers.
-; the current environment.
+clear_env = no
-; Default Value: clean env
-;env[HOSTNAME] = $HOSTNAME
-;env[PATH] = /usr/local/bin:/usr/bin:/bin
-;env[TMP] = /tmp
-;env[TMPDIR] = /tmp
-;env[TEMP] = /tmp
 
-; Additional php.ini defines, specific to this pool of workers. These settings
+; Additional php.ini defines, specific to this pool of workers.
-; overwrite the values previously defined in the php.ini. The directives are the
+php_value[upload_max_filesize] = 10G
-; same as the PHP SAPI:
+php_value[post_max_size] = 10G
-;   php_value/php_flag             - you can set classic ini defines which can
+php_value[default_charset] = UTF-8
-;                                    be overwritten from PHP call 'ini_set'.
+php_value[always_populate_raw_post_data] = -1
-;   php_admin_value/php_admin_flag - these directives won't be overwritten by
-;                                     PHP call 'ini_set'
-; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no.
-
-; Defining 'extension' will load the corresponding shared extension from
-; extension_dir. Defining 'disable_functions' or 'disable_classes' will not
-; overwrite previously defined php.ini values, but will append the new value
-; instead.
-
-; Note: path INI options can be relative and will be expanded with the prefix
-; (pool, global or /usr)
-
-; Default Value: nothing is defined by default except the values in php.ini and
-;                specified at startup with the -d argument
-;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com
-;php_flag[display_errors] = off
-;php_admin_value[error_log] = /var/log/fpm-php.www.log
-;php_admin_flag[log_errors] = on
-;php_admin_value[memory_limit] = 32M

manifest.json

@@ -9,7 +9,7 @@
     "url": "http://kanboard.net/",
     "maintainer": {
         "name": "mbugeia",
-        "email": "kanboard@mbugeia.eu"
+        "email": "maxime@max.privy.place"
     },
     "multi_instance": "false",
     "services": [

scripts/backup

@@ -1,27 +1,32 @@
 #!/bin/bash
 
-set -e
+set -eu
 
-# The parameter $1 is the backup directory location dedicated to the app
+app="kanboard"
-BACKUP_DIR=$1
 
-# The parameter $2 is the id of the app instance ex: strut__2
+# Set app specific variables
-APP=$2
+dbname=$app
+dbuser=$app
 
-# retrieve useful param
+# Source app helpers
-domain=$(sudo yunohost app setting ${APP} domain)
+source /usr/share/yunohost/helpers
-db_pwd=$(sudo yunohost app setting ${APP} mysqlpwd)
 
-# Backup app files
+# Retrieve app settings
-sudo mkdir -p "${BACKUP_DIR}/www"
+domain=$(ynh_app_setting_get "$app" domain)
-sudo cp -a /var/www/${APP}/. "${BACKUP_DIR}/www"
+dbpass=$(ynh_app_setting_get "$app" mysqlpwd)
 
-# Backup conf files
+# Copy the app source files
-sudo mkdir -p "${BACKUP_DIR}/conf"
+DESTDIR="/var/www/$app"
-sudo cp -a /etc/nginx/conf.d/$domain.d/${APP}.conf "${BACKUP_DIR}/conf/${APP}.conf"
+ynh_backup "$DESTDIR" "www"
-sudo cp -a /etc/php5/fpm/pool.d/${APP}.conf "${BACKUP_DIR}/conf/php-fpm.conf"
 
-# Backup mysql
+# Copy the data directory
-mysqldump -u ${APP} -p$db_pwd ${APP} | sudo dd of=${BACKUP_DIR}/${APP}.dmp
+DATADIR="/home/yunohost.app/${app}/data"
+ynh_backup "$DATADIR" "data" 1
 
-exit 0
+# Copy the conf files
+mkdir ./conf
+ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "conf/nginx.conf"
+ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" "conf/php-fpm.conf"
+
+# Dump the database
+mysqldump -u "$dbuser" -p"$dbpass" --no-create-db "$dbname" > ./db.sql

scripts/install

@@ -1,7 +1,11 @@
 #!/bin/bash
 
-set -e
+set -eu
-app=kanboard
+
+app="kanboard"
+
+# Source app helpers
+source /usr/share/yunohost/helpers
 
 # Retrieve arguments
 domain=$1
@@ -9,63 +13,77 @@ path=$2
 admin=$3
 is_public=$4
 
+# TODO: Check domain/path availability with app helper
+sudo yunohost app checkurl "${domain}${path}" -a "$app" \
+  || ynh_die "The path ${domain}${path} is not available for app installation."
+
+# Check user parameter
+ynh_user_exists "$admin" \
+  || ynh_die "The chosen admin user does not exist."
+ynh_app_setting_set $app admin_user $admin
+
 # Retrieve admin email
 email=$(sudo yunohost user info $admin | grep mail: | sed "s/mail: //g")
 
-# Check domain/path availability
+# Check destination directory
-sudo yunohost app checkurl $domain$path -a $app  \
+DESTDIR="/var/www/$app"
-    || (echo "Path not available: $domain$path" && exit 1)
+[[ -d $DESTDIR ]] && ynh_die \
+"The destination directory '$DESTDIR' already exists.\
+ You should safely delete it before installing this app."
 
 # Generate random password
-db_pwd=$(openssl rand -hex 15)
+dbpass=$(ynh_string_random)
+dbname=$app
+dbuser=$app
 
 # Initialize database and store mysql password for upgrade
-sudo yunohost app initdb $app -p $db_pwd
+ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass"
-sudo yunohost app setting $app mysqlpwd -v $db_pwd
+ynh_app_setting_set $app mysqlpwd $db_pwd
-sudo yunohost app setting $app adminusername -v $admin
+ynh_app_setting_set $app adminusername $admin
-sudo yunohost app setting $app is_public -v $is_public
+ynh_app_setting_set $app is_public $is_public
 
 # Copy sources
-final_path=/var/www/$app
+sudo mkdir -p $DESTDIR
-sudo mkdir -p $final_path
+sudo cp -a ../sources/. $DESTDIR
-sudo cp -a ../sources/. $final_path
 
 # Copy and edit config.php
-sudo cp ../conf/config.php $final_path
+sudo cp ../conf/config.php ${DESTDIR}
-sudo sed -i "s/yuno_dbpdw/$db_pwd/g" $final_path/config.php
+sudo sed -i "s/yuno_dbpdw/${dbpass}/g" ${DESTDIR}/config.php
-sudo sed -i "s/yuno_dbuser/$app/g" $final_path/config.php
+sudo sed -i "s/yuno_dbuser/${dbuser}/g" ${DESTDIR}/config.php
-sudo sed -i "s/yuno_admin/$admin/g" $final_path/config.php
+sudo sed -i "s/yuno_admin/${admin}/g" ${DESTDIR}/config.php
-sudo sed -i "s/yuno_email/$email/g" $final_path/config.php
+sudo sed -i "s/yuno_email/${email}/g" ${DESTDIR}/config.php
-sudo sed -i "s/yuno_domain/$domain/g" $final_path/config.php
+sudo sed -i "s/yuno_domain/${domain}/g" ${DESTDIR}/config.php
 
 # Set permissions to kanboard and data directory
-sudo chown -R root:root $final_path
+sudo chown -R root:root ${DESTDIR}
-sudo chown -R www-data:www-data $final_path/data
+sudo chown -R www-data:www-data ${DESTDIR}/data
 
-# Use dedicated php pool
+# Copy and set php-fpm configuration
-sed -i "s@NAMETOCHANGE@$app@g" ../conf/php-fpm.conf
+phpfpm_conf="/etc/php5/fpm/pool.d/${app}.conf"
-finalphpconf=/etc/php5/fpm/pool.d/$app.conf
+sed -i "s@#USER#@${app}@g"         ../conf/php-fpm.conf
-sudo cp ../conf/php-fpm.conf $finalphpconf
+sed -i "s@#GROUP#@${app}@g"        ../conf/php-fpm.conf
-sudo chown root: $finalphpconf
+sed -i "s@#POOLNAME#@${app}@g"     ../conf/php-fpm.conf
-sudo chmod 644 $finalphpconf
+sed -i "s@#DESTDIR#@${DESTDIR}/@g" ../conf/php-fpm.conf
+sudo cp ../conf/php-fpm.conf "$phpfpm_conf"
+sudo chown root: $phpfpm_conf
+sudo chmod 644 $phpfpm_conf
 
 # Modify Nginx configuration file and copy it to Nginx conf directory
-sed -i "s@NAMETOCHANGE@$app@g" ../conf/nginx.conf*
+sed -i "s@NAMETOCHANGE@${app}@g" ../conf/nginx.conf*
-sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf*
+sed -i "s@PATHTOCHANGE@${path}@g" ../conf/nginx.conf*
-sed -i "s@ALIASTOCHANGE@$final_path/@g" ../conf/nginx.conf*
+sed -i "s@ALIASTOCHANGE@${DESTDIR}/@g" ../conf/nginx.conf*
-sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
+sudo cp ../conf/nginx.conf /etc/nginx/conf.d/${domain}.d/${app}.conf
 
 # Make app public or private
 if [ "$is_public" = "Yes" ];
 then
-	sudo yunohost app setting $app unprotected_uris -v "/"
+	sudo yunohost app setting ${app} unprotected_uris -v "/"
-	sudo sed -i "s/define('LDAP_AUTH'.*$/define('LDAP_AUTH', true);/g" $final_path/config.php
+	sudo sed -i "s/define('LDAP_AUTH'.*$/define('LDAP_AUTH', true);/g" ${DESTDIR}/config.php
-	sudo sed -i "s/define('HIDE_LOGIN_FORM'.*$/define('HIDE_LOGIN_FORM', false);/g" $final_path/config.php
+	sudo sed -i "s/define('HIDE_LOGIN_FORM'.*$/define('HIDE_LOGIN_FORM', false);/g" ${DESTDIR}/config.php
-	sudo sed -i "s/define('REMEMBER_ME_AUTH'.*$/define('REMEMBER_ME_AUTH', true);/g" $final_path/config.php
+	sudo sed -i "s/define('REMEMBER_ME_AUTH'.*$/define('REMEMBER_ME_AUTH', true);/g" ${DESTDIR}/config.php
-	sudo sed -i "s/define('DISABLE_LOGOUT'.*$/define('DISABLE_LOGOUT', false);/g" $final_path/config.php
+	sudo sed -i "s/define('DISABLE_LOGOUT'.*$/define('DISABLE_LOGOUT', false);/g" ${DESTDIR}/config.php
 fi
 
-# Reload Nginx, PHP5-FPM and regenerate SSOwat conf
+# Reload services
-sudo service php5-fpm restart
+sudo service php5-fpm restart || true
-sudo service nginx reload
+sudo service nginx reload || true
-sudo yunohost app ssowatconf

scripts/remove

@@ -1,21 +1,26 @@
 #!/bin/bash
-app=kanboard
 
-# Retrieve arguments
+app="kanboard"
-domain=$(sudo yunohost app setting $app domain)
-root_pwd=$(sudo cat /etc/yunohost/mysql)
 
-# Remove sources
+dbname=$app
-sudo rm -rf /var/www/$app
+dbuser=$app
 
-# Remove database
+# Source app helpers
+source /usr/share/yunohost/helpers
+
+# Drop MySQL database and user
+ynh_mysql_drop_db "$dbname" 2>/dev/null || true
+ynh_mysql_drop_user "$dbuser" 2>/dev/null || true
 mysql -u root -p$root_pwd -e "DROP DATABASE $app ; DROP USER $app@localhost ;"
 
-# Remove configuration files
+# Retrieve domain from app settings
-sudo rm -f /etc/nginx/conf.d/$domain.d/$app.conf
+domain=$(ynh_app_setting_get "$app" domain)
-sudo rm -f /etc/php5/fpm/pool.d/$app.conf
 
-# Restart services
+# Delete app directory and configurations
-sudo service php5-fpm restart
+sudo rm -rf "/var/www/${app}"
-sudo service nginx reload
+sudo rm -f "/etc/php5/fpm/pool.d/${app}.conf"
-sudo yunohost app ssowatconf
+[[ -n $domain ]] && sudo rm -f "/etc/nginx/conf.d/${domain}.d/${app}.conf"
+
+# Reload services
+sudo service php5-fpm restart || true
+sudo service nginx reload || true

scripts/restore

@@ -1,41 +1,56 @@
 #!/bin/bash
 
-set -e
+set -eu
 
-# The parameter $1 is the backup directory location dedicated to the app
+app="kanboard"
-BACKUP_DIR=$1
 
-# The parameter $2 is the id of the app instance ex: strut__2
+# Set app specific variables
-APP=$2
+dbname=$app
+dbuser=$app
 
-# retrieve useful param
+# Source app helpers
-domain=$(sudo yunohost app setting ${APP} domain)
+source /usr/share/yunohost/helpers
-db_pwd=$(sudo yunohost app setting ${APP} mysqlpwd)
-path=$(sudo yunohost app setting ${APP} path)
 
-# Check domain/path availability
+# Retrieve old app settings
-sudo yunohost app checkurl $domain$path -a ${APP}  \
+domain=$(ynh_app_setting_get "$app" domain)
-    || (echo "Path not available: $domain$path" && exit 1)
+path=$(ynh_app_setting_get "$app" path)
+dbpass=$(ynh_app_setting_get "$app" mysqlpwd)
 
-# Restore sources & data
+# TODO: Check domain/path availability with app helper
-final_path=/var/www/${APP}
+sudo yunohost app checkurl "${domain}${path}" -a "$app" \
-sudo mkdir $final_path
+  || ynh_die "The path ${domain}${path} is not available for app installation."
-sudo cp -a ${BACKUP_DIR}/www/. $final_path
+
+# Check destination directory
+DESTDIR="/var/www/$app"
+[[ -d $DESTDIR ]] && ynh_die \
+"The destination directory '$DESTDIR' already exists.\
+ You should safely delete it before restoring this app."
+
+# Check configuration files
+nginx_conf="/etc/nginx/conf.d/${domain}.d/${app}.conf"
+[[ -f $nginx_conf ]] && ynh_die \
+"The NGINX configuration already exists at '${nginx_conf}'.
+You should safely delete it before restoring this app."
+phpfpm_conf="/etc/php5/fpm/pool.d/${app}.conf"
+[[ -f $phpfpm_conf ]] && ynh_die \
+"The PHP FPM configuration already exists at '${phpfpm_conf}'.
+You should safely delete it before restoring this app."
+
+# Restore the app files
+sudo cp -a ./www "$DESTDIR"
+
+# Create and restore the database
+ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass"
+ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ./db.sql
 
 # Restore permissions
-sudo chown -R root:root $final_path
+sudo chown -R root:root "$DESTDIR"
-sudo chown -R www-data:www-data $final_path/data
+sudo chown -R www-data:www-data "$DESTDIR"/data
 
-# Restore conf files
+# Restore configuration files
-sudo cp -a "${BACKUP_DIR}/conf/${APP}.conf" /etc/nginx/conf.d/$domain.d/${APP}.conf
+sudo cp -a ./conf/nginx.conf   "$nginx_conf"
-sudo cp -a "${BACKUP_DIR}/conf/php-fpm.conf" /etc/php5/fpm/pool.d/${APP}.conf
+sudo cp -a ./conf/php-fpm.conf "$phpfpm_conf"
 
-# Restore mysql dump
+# Reload services
-sudo su -c "mysql -u ${APP} -p$db_pwd ${APP} < ${BACKUP_DIR}/${APP}.dmp"
+sudo service php5-fpm restart || true
-
+sudo service nginx reload || true
-# Reload Nginx, PHP5-FPM and regenerate SSOwat conf
-sudo service php5-fpm restart
-sudo service nginx reload
-sudo yunohost app ssowatconf
-
-exit 0

scripts/upgrade

@@ -1,75 +1,87 @@
 #!/bin/bash
 
-set -e
+set -eu
-app=kanboard
+
+app="kanboard"
+
+# Source app helpers
+source /usr/share/yunohost/helpers
 
 # Retrieve settings
-domain=$(sudo yunohost app setting $app domain)
+domain=$(ynh_app_setting_get "$app" domain)
-path=$(sudo yunohost app setting $app path)
+path=$(ynh_app_setting_get "$app" path)
-admin=$(sudo yunohost app setting $app adminusername)
+admin=$(ynh_app_setting_get "$app" adminusername)
 email=$(sudo yunohost user info $admin | grep mail: | sed "s/mail: //g")
-db_pwd=$(sudo yunohost app setting $app mysqlpwd)
+db_pwd=$(ynh_app_setting_get "$app"  mysqlpwd)
-is_public=$(sudo yunohost app setting $app is_public)
+is_public=$(ynh_app_setting_get "$app"  is_public)
 if [ -z $is_public ]
 then	# Old version doesnt have is_public settings
 	is_public=No
-	sudo yunohost app setting $app is_public -v $is_public
+	ynh_app_setting_set $app is_public $is_public
 fi
 
+# Check destination directory
+DESTDIR="/var/www/$app"
+[[ ! -d $DESTDIR ]] && ynh_die \
+"The destination directory '$DESTDIR' does not exist.\
+ The app is not correctly installed, you should remove it first."
+
 # flush php sessions before upgrade
 sudo rm -rf /var/lib/php5/session/*
 
-final_path=/var/www/$app
+# Move old app dir
-sudo mv $final_path $final_path.old
+sudo mv ${DESTDIR} ${DESTDIR}.old
 
-sudo mkdir -p $final_path
+sudo mkdir -p ${DESTDIR}
-sudo cp -a ../sources/. $final_path
+sudo cp -a ../sources/. ${DESTDIR}
 # restore data
-sudo cp -a $final_path.old/data $final_path
+sudo cp -a ${DESTDIR}.old/data ${DESTDIR}
 # restore plugins
-if [ -e $final_path.old/plugins ]
+if [ -e ${DESTDIR}.old/plugins ]
 then
-	sudo cp -a $final_path.old/plugins $final_path
+	sudo cp -a ${DESTDIR}.old/plugins ${DESTDIR}
 fi
 # delete temp directory
-sudo rm -Rf $final_path.old
+sudo rm -Rf ${DESTDIR}.old
 
 # Copy and edit config.php
-sudo cp ../conf/config.php $final_path
+sudo cp ../conf/config.php ${DESTDIR}
-sudo sed -i "s/yuno_dbpdw/$db_pwd/g" $final_path/config.php
+sudo sed -i "s/yuno_dbpdw/${dbpass}/g" ${DESTDIR}/config.php
-sudo sed -i "s/yuno_dbuser/$app/g" $final_path/config.php
+sudo sed -i "s/yuno_dbuser/${dbuser}/g" ${DESTDIR}/config.php
-sudo sed -i "s/yuno_admin/$admin/g" $final_path/config.php
+sudo sed -i "s/yuno_admin/${admin}/g" ${DESTDIR}/config.php
-sudo sed -i "s/yuno_email/$email/g" $final_path/config.php
+sudo sed -i "s/yuno_email/${email}/g" ${DESTDIR}/config.php
-sudo sed -i "s/yuno_domain/$domain/g" $final_path/config.php
+sudo sed -i "s/yuno_domain/${domain}/g" ${DESTDIR}/config.php
 
 # Set permissions to kanboard and data directory
-sudo chown -R root:root $final_path
+sudo chown -R root:root ${DESTDIR}
-sudo chown -R www-data:www-data $final_path/data
+sudo chown -R www-data:www-data ${DESTDIR}/data
 
-# Use dedicated php pool
+# Copy and set php-fpm configuration
-sed -i "s@NAMETOCHANGE@$app@g" ../conf/php-fpm.conf
+phpfpm_conf="/etc/php5/fpm/pool.d/${app}.conf"
-finalphpconf=/etc/php5/fpm/pool.d/$app.conf
+sed -i "s@#USER#@${app}@g"         ../conf/php-fpm.conf
-sudo cp ../conf/php-fpm.conf $finalphpconf
+sed -i "s@#GROUP#@${app}@g"        ../conf/php-fpm.conf
-sudo chown root: $finalphpconf
+sed -i "s@#POOLNAME#@${app}@g"     ../conf/php-fpm.conf
-sudo chmod 644 $finalphpconf
+sed -i "s@#DESTDIR#@${DESTDIR}/@g" ../conf/php-fpm.conf
+sudo cp ../conf/php-fpm.conf "$phpfpm_conf"
+sudo chown root: $phpfpm_conf
+sudo chmod 644 $phpfpm_conf
 
 # Modify Nginx configuration file and copy it to Nginx conf directory
-sed -i "s@NAMETOCHANGE@$app@g" ../conf/nginx.conf*
+sed -i "s@NAMETOCHANGE@${app}@g" ../conf/nginx.conf*
-sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf*
+sed -i "s@PATHTOCHANGE@${path}@g" ../conf/nginx.conf*
-sed -i "s@ALIASTOCHANGE@$final_path/@g" ../conf/nginx.conf*
+sed -i "s@ALIASTOCHANGE@${DESTDIR}/@g" ../conf/nginx.conf*
-sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
+sudo cp ../conf/nginx.conf /etc/nginx/conf.d/${domain}.d/${app}.conf
 
 # Make app public or private
 if [ "$is_public" = "Yes" ];
 then
-	sudo yunohost app setting $app unprotected_uris -v "/"
+	sudo yunohost app setting ${app} unprotected_uris -v "/"
-	sudo sed -i "s/define('LDAP_AUTH'.*$/define('LDAP_AUTH', true);/g" $final_path/config.php
+	sudo sed -i "s/define('LDAP_AUTH'.*$/define('LDAP_AUTH', true);/g" ${DESTDIR}/config.php
-	sudo sed -i "s/define('HIDE_LOGIN_FORM'.*$/define('HIDE_LOGIN_FORM', false);/g" $final_path/config.php
+	sudo sed -i "s/define('HIDE_LOGIN_FORM'.*$/define('HIDE_LOGIN_FORM', false);/g" ${DESTDIR}/config.php
-	sudo sed -i "s/define('REMEMBER_ME_AUTH'.*$/define('REMEMBER_ME_AUTH', true);/g" $final_path/config.php
+	sudo sed -i "s/define('REMEMBER_ME_AUTH'.*$/define('REMEMBER_ME_AUTH', true);/g" ${DESTDIR}/config.php
-	sudo sed -i "s/define('DISABLE_LOGOUT'.*$/define('DISABLE_LOGOUT', false);/g" $final_path/config.php
+	sudo sed -i "s/define('DISABLE_LOGOUT'.*$/define('DISABLE_LOGOUT', false);/g" ${DESTDIR}/config.php
 fi
 
-# Reload Nginx, PHP5-FPM and regenerate SSOwat conf
+# Reload services
-sudo service php5-fpm restart
+sudo service php5-fpm restart || true
-sudo service nginx reload
+sudo service nginx reload || true
-sudo yunohost app ssowatconf