Merge pull request #67 from YunoHost-Apps/example_ynh

Example ynh
2024-09-03 20:36:02 +02:00 · 2019-11-21 19:53:22 +01:00 · 2019-11-21 19:53:22 +01:00 · a0cfb3d375
commit a0cfb3d375
parent 75c61fb565 7664361efc
8 changed files with 34 additions and 22 deletions
--- a/conf/config.ini
+++ b/conf/config.ini
@ -1,7 +1,7 @@
 [server]
 hidden_host          = 
 port                 = __PORT__
-bind                 = localhost
+bind                 = 127.0.0.1
 tls_cert_path        = 
 tls_key_path         = 
 templates_parent_dir = 
--- a/conf/systemd.service
+++ b/conf/systemd.service
@ -1,5 +1,5 @@
 [Unit]
-Description=Write Freely Service
+Description=Write Freely __APP__ Service
 After=network.target

 [Service]
--- a/scripts/backup
+++ b/scripts/backup
@ -6,6 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================

+#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers

@ -37,14 +38,14 @@ db_name=$(ynh_app_setting_get --app=$app --key=db_name)
 #=================================================
 ynh_print_info --message="Stopping a systemd service..."

-ynh_systemd_action --service_name=$app --action="stop"
+ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --line_match="Stopped Write Freely"

 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================
 ynh_print_info --message="Backing up the main app directory..."

-ynh_backup "$final_path"
+ynh_backup --src_path="$final_path"

 #=================================================
 # BACKUP THE NGINX CONFIGURATION
@ -74,7 +75,7 @@ ynh_backup --src_path="/etc/systemd/system/$app.service"
 #=================================================
 ynh_print_info --message="Starting a systemd service..."

-ynh_systemd_action --service_name=$app --action="start"
+ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Serving on"

 #=================================================
 # END OF SCRIPT
--- a/scripts/change_url
+++ b/scripts/change_url
@ -58,7 +58,7 @@ fi
 #=================================================
 ynh_print_info --message="Stopping a systemd service..."

-ynh_systemd_action --service_name=$app --action="stop"
+ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --line_match="Stopped Write Freely"

 #=================================================
 # MODIFY URL IN NGINX CONF
@ -112,7 +112,7 @@ ynh_store_file_checksum --file="$final_path/config.ini"
 #=================================================
 ynh_print_info --message="Starting a systemd service..."

-ynh_systemd_action --service_name=$app --action="start"
+ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Serving on"

 #=================================================
 # RELOAD NGINX
--- a/scripts/install
+++ b/scripts/install
@ -57,7 +57,7 @@ final_path=/var/www/$app
 test ! -e "$final_path" || ynh_die --message="This path already contains a folder"

 # Register (book) web path
-ynh_webpath_register $app $domain $path_url
+ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url

 #=================================================
 # STORE SETTINGS FROM MANIFEST
@ -76,7 +76,7 @@ ynh_app_setting_set --app=$app --key=single_user --value=$single_user
 #=================================================
 # FIND AND OPEN A PORT
 #=================================================
-ynh_print_info --message="Configuring firewall ..."
+ynh_print_info --message="Configuring firewall..."

 # Find a free port
 port=$(ynh_find_port --port=8095)
@ -123,7 +123,7 @@ ynh_system_user_create --username=$app --home_dir="$final_path"
 #=================================================
 # SETUP SYSTEMD
 #=================================================
-ynh_print_info --message="Configuring a systemd service ..."
+ynh_print_info --message="Configuring a systemd service..."

 # Create a dedicated systemd config
 ynh_add_systemd_config
@ -175,18 +175,19 @@ chown -R "$app":"$app" "$final_path"
 #=================================================

 # 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 WriteFreely" --log_type systemd
+yunohost service add $app --description "$app daemon for WriteFreely" --log "/var/log/$app/$app.log"

 #=================================================
 # START SYSTEMD SERVICE
 #=================================================

-ynh_systemd_action --service_name=$app --action=start
+# Start a systemd service
+ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Serving on"

 #=================================================
 # SETUP SSOWAT
 #=================================================
-ynh_print_info --message="Configuring SSOwat ..."
+ynh_print_info --message="Configuring SSOwat..."

 # Make app public if necessary
 if [ $is_public -eq 1 ]
--- a/scripts/remove
+++ b/scripts/remove
@ -29,7 +29,7 @@ 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
+if ynh_exec_warn_less yunohost service status $app >/dev/null
 then
 	ynh_print_info --message="Removing $app service..."
 	yunohost service remove $app
@ -46,7 +46,7 @@ ynh_remove_systemd_config
 #=================================================
 # REMOVE THE MYSQL DATABASE
 #=================================================
-ynh_print_info --message="Removing the MySQL database"
+ynh_print_info --message="Removing the MySQL database..."

 # 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 APP MAIN DIR
 #=================================================
-ynh_print_info --message="Removing app main directory"
+ynh_print_info --message="Removing app main directory..."

 # Remove the app directory securely
 ynh_secure_remove --file="$final_path"
@ -62,11 +62,19 @@ ynh_secure_remove --file="$final_path"
 #=================================================
 # REMOVE NGINX CONFIGURATION
 #=================================================
-ynh_print_info --message="Removing nginx web server configuration"
+ynh_print_info --message="Removing nginx web server configuration..."

 # Remove the dedicated nginx config
 ynh_remove_nginx_config

+#=================================================
+# REMOVE LOGROTATE CONFIGURATION
+#=================================================
+ynh_script_progression --message="Removing logrotate configuration..." --time --weight=1
+
+# Remove the app-specific logrotate config
+ynh_remove_logrotate
+
 #=================================================
 # CLOSE A PORT
 #=================================================
--- a/scripts/restore
+++ b/scripts/restore
@ -102,7 +102,7 @@ yunohost service add $app --description "$app daemon for WriteFreely" --log_type
 #=================================================
 ynh_print_info --message="Starting a systemd service..."

-ynh_systemd_action --service_name=$app --action="start"
+ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Serving on"

 #=================================================
 # GENERIC FINALIZATION
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -87,9 +87,9 @@ ynh_print_info --message="Backing up the app before upgrading (may take a while)
 # Backup the current version of the app
 ynh_backup_before_upgrade
 ynh_clean_setup () {
+	ynh_clean_check_starting
 	# restore it if the upgrade fails
 	ynh_restore_upgradebackup
-	ynh_clean_check_starting
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@ -99,8 +99,9 @@ ynh_abort_if_errors
 #=================================================
 # STOP SYSTEMD SERVICE
 #=================================================
+ynh_print_info --message="Stopping a systemd service..."

-ynh_systemd_action --service_name=$app --action=stop
+ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --line_match="Stopped Write Freely"

 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@ -135,6 +136,7 @@ ynh_system_user_create --username=$app --home_dir="$final_path"
 #=================================================
 # MAKE UPGRADE
 #=================================================
+ynh_print_info --message="Making the upgrade..."

 chown -R "$app":"$app" "$final_path"

@ -182,9 +184,9 @@ fi
 #=================================================
 # START SERVICE
 #=================================================
-ynh_print_info --message="Starting a systemd service.."
+ynh_print_info --message="Starting a systemd service..."

-ynh_systemd_action --service_name=$app --action=start
+ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Serving on"

 #=================================================
 # RELOAD NGINX