Merge branch 'master' into db_user

6 years ago · 1a780c389b
parent 8cd1f74d2f 831c25206c
commit 1a780c389b
8 changed files with 96 additions and 25 deletions
--- a/README.md
+++ b/README.md
@ -47,9 +47,9 @@ Can the app be used by multiple users?

 #### Supported architectures

-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
-* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/)
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
+* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/)

 ## Limitations

@ -66,6 +66,7 @@ https://yunohost.org/packaging_apps

 * Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
 * App website: Link to the official website of this app
+ * Upstream app repository: Link to the official repository of the upstream app
 * YunoHost website: https://yunohost.org/

 ---
--- a/README_fr.md
+++ b/README_fr.md
@ -39,9 +39,9 @@ L'application peut-elle être utilisée par plusieurs utilisateurs?

 #### Supported architectures

-* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
-* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
-* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/)
+* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
+* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
+* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/)

 ## Limitations

@ -54,10 +54,11 @@ L'application peut-elle être utilisée par plusieurs utilisateurs?
 **Plus d'informations sur la page de documentation:**  
 https://yunohost.org/packaging_apps

-## Links
+## Liens

 * Signaler un bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
 * Site de l'application: Lien vers le site officiel de cette application
+ * Dépôt de l'application principale: Lien vers le dépôt officiel de l'application principale
 * Site web YunoHost: https://yunohost.org/

 ---
--- a/scripts/backup
+++ b/scripts/backup
@ -34,6 +34,13 @@ db_name=$(ynh_app_setting_get --app=$app --key=db_name)

 #=================================================
 # STANDARD BACKUP STEPS
+#=================================================
+# STOP SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Stopping a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
+
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
@ -65,10 +72,10 @@ ynh_mysql_dump_db --database="$db_name" > db.sql
 #=================================================
 # BACKUP FAIL2BAN CONFIGURATION
 #=================================================
-ynh_script_progression --message="Backing up fail2ban configuration" --time --weight=1
+ynh_script_progression --message="Backing up fail2ban configuration..." --time --weight=1

-ynh_backup "/etc/fail2ban/jail.d/$app.conf"
-ynh_backup "/etc/fail2ban/filter.d/$app.conf"
+ynh_backup --src_path="/etc/fail2ban/jail.d/$app.conf"
+ynh_backup --src_path="/etc/fail2ban/filter.d/$app.conf"

 #=================================================
 # SPECIFIC BACKUP
@ -92,6 +99,13 @@ ynh_backup --src_path="/etc/systemd/system/$app.service"

 ynh_backup --src_path="/etc/cron.d/$app"

+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+
 #=================================================
 # END OF SCRIPT
 #=================================================
--- a/scripts/change_url
+++ b/scripts/change_url
@ -52,6 +52,13 @@ fi

 #=================================================
 # STANDARD MODIFICATIONS
+#=================================================
+# STOP SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Stopping a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
+
 #=================================================
 # MODIFY URL IN NGINX CONF
 #=================================================
@ -89,6 +96,13 @@ fi

 #=================================================
 # GENERIC FINALISATION
+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+
 #=================================================
 # RELOAD NGINX
 #=================================================
--- a/scripts/install
+++ b/scripts/install
@ -59,7 +59,7 @@ ynh_script_progression --message="Validating installation parameters..." --time
 ### 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"
 final_path=/var/www/$app
-test ! -e "$final_path" || ynh_die "This path already contains a folder"
+test ! -e "$final_path" || ynh_die --message="This path already contains a folder"

 # Register (book) web path
 ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
@ -88,7 +88,7 @@ ynh_script_progression --message="Configuring firewall..." --time --weight=1
 ###		- Remove the section "CLOSE A PORT" in the remove script

 # Find a free port
-port=$(ynh_find_port 8095)
+port=$(ynh_find_port --port=8095)
 # Open this port
 ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $port
 ynh_app_setting_set --app=$app --key=port --value=$port
@ -122,7 +122,7 @@ ynh_script_progression --message="Creating a MySQL database..." --time --weight=
 ###		- Remove also the section "REMOVE THE MYSQL DATABASE" in the remove script
 ###		- As well as the section "RESTORE THE MYSQL DATABASE" in the restore script

-db_name=$(ynh_sanitize_dbid $app)
+db_name=$(ynh_sanitize_dbid --db_name=$app)
 db_user=$db_name
 ynh_app_setting_set --app=$app --key=db_name --value=$db_name
 ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
@ -298,6 +298,22 @@ yunohost service add $app --log "/var/log/$app/$app.log"
 # if using yunohost version 3.2 or more in the 'manifest.json', a description can be added
 #yunohost service add $app --description "$app daemon for XXX" --log "/var/log/$app/$app.log"

+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+
+### `ynh_systemd_action` is used to start a systemd service for an app.
+### Only needed if you have configure a systemd service
+### If you're not using these lines:
+###		- Remove the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the backup script
+###		- As well as the section "START SYSTEMD SERVICE" in the restore script
+###		- As well as the section"STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the upgrade script
+###		- And the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the change_url script
+
+# Start a systemd service
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+
 #=================================================
 # SETUP FAIL2BAN
 #=================================================
--- a/scripts/remove
+++ b/scripts/remove
@ -31,14 +31,14 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 # Remove a service from the admin panel, added by `yunohost service add`
 if yunohost service status $app >/dev/null 2>&1
 then
-	ynh_script_progression --message="Removing $app service" --time --weight=1
+	ynh_script_progression --message="Removing $app service..." --time --weight=1
 	yunohost service remove $app
 fi

 #=================================================
 # STOP AND REMOVE SERVICE
 #=================================================
-ynh_script_progression --message="Stopping and removing the systemd service" --time --weight=1
+ynh_script_progression --message="Stopping and removing the systemd service..." --time --weight=1

 # Remove the dedicated systemd config
 ynh_remove_systemd_config
@ -46,7 +46,7 @@ ynh_remove_systemd_config
 #=================================================
 # REMOVE THE MYSQL DATABASE
 #=================================================
-ynh_script_progression --message="Removing the MySQL database" --time --weight=1
+ynh_script_progression --message="Removing the MySQL database..." --time --weight=1

 # Remove a database if it exists, along with the associated user
 ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
@ -54,7 +54,7 @@ ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Removing dependencies" --time --weight=1
+ynh_script_progression --message="Removing dependencies..." --time --weight=1

 # Remove metapackage and its dependencies
 ynh_remove_app_dependencies
@ -62,7 +62,7 @@ ynh_remove_app_dependencies
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Removing app main directory" --time --weight=1
+ynh_script_progression --message="Removing app main directory..." --time --weight=1

 # Remove the app directory securely
 ynh_secure_remove --file="$final_path"
@ -70,7 +70,7 @@ ynh_secure_remove --file="$final_path"
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing nginx web server configuration" --time --weight=1
+ynh_script_progression --message="Removing nginx web server configuration..." --time --weight=1

 # Remove the dedicated nginx config
 ynh_remove_nginx_config
@ -78,7 +78,7 @@ ynh_remove_nginx_config
 #=================================================
 # REMOVE PHP-FPM CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing php-fpm configuration" --time --weight=1
+ynh_script_progression --message="Removing php-fpm configuration..." --time --weight=1

 # Remove the dedicated php-fpm config
 ynh_remove_fpm_config
@ -86,7 +86,7 @@ ynh_remove_fpm_config
 #=================================================
 # REMOVE LOGROTATE CONFIGURATION
 #=================================================
-ynh_script_progression --message="Removing logrotate configuration" --time --weight=1
+ynh_script_progression --message="Removing logrotate configuration..." --time --weight=1

 # Remove the app-specific logrotate config
 ynh_remove_logrotate
@ -97,7 +97,7 @@ ynh_remove_logrotate

 if yunohost firewall list | grep -q "\- $port$"
 then
-	ynh_script_progression --message="Closing port $port"
+	ynh_script_progression --message="Closing port $port..."
 	ynh_exec_warn_less yunohost firewall disallow TCP $port
 fi

@ -129,7 +129,7 @@ ynh_secure_remove --file="/var/log/$app/"
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Removing the dedicated system user" --time --weight=1
+ynh_script_progression --message="Removing the dedicated system user..." --time --weight=1

 # Delete a system user
 ynh_system_user_delete --username=$app
--- a/scripts/restore
+++ b/scripts/restore
@ -122,6 +122,13 @@ systemctl enable $app.service

 yunohost service add $app --log "/var/log/$app/$app.log"

+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+
 #=================================================
 # RESTORE THE CRON FILE
 #=================================================
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -51,13 +51,13 @@ elif [ "$is_public" = "No" ]; then
 fi

 # If db_name doesn't exist, create it
-if [ -z $db_name ]; then
+if [ -z "$db_name" ]; then
 	db_name=$(ynh_sanitize_dbid --db_name=$app)
 	ynh_app_setting_set --app=$app --key=db_name --value=$db_name
 fi

 # If final_path doesn't exist, create it
-if [ -z $final_path ]; then
+if [ -z "$final_path" ]; then
 	final_path=/var/www/$app
 	ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 fi
@ -90,6 +90,13 @@ path_url=$(ynh_normalize_url_path --path_url=$path_url)

 #=================================================
 # STANDARD UPGRADE STEPS
+#=================================================
+# STOP SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Stopping a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
+
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@ -139,6 +146,10 @@ ynh_add_fpm_config
 # ...
 #=================================================

+#=================================================
+# STORE THE CONFIG FILE CHECKSUM
+#=================================================
+
 ### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script.
 ### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it.
 ynh_backup_if_checksum_is_different --file="$final_path/CONFIG_FILE"
@ -190,6 +201,13 @@ then
 	ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
 fi

+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+
 #=================================================
 # RELOAD NGINX
 #=================================================