Apply last example_ynh

check_process

@@ -1,13 +1,9 @@
 ;; Test complet
 	; Manifest
 		domain="domain.tld"
-		path="/path"
-		admin="john"
-		language="fr"
 		is_public=1
-		password="1Strong-Password"
 		ssb_admin_id="@5Pt3dKy2HTJ0mWuS78oIiklIX0gBz6BTfEnXsbvke9c=.ed25519"
-		port="666"
+		password="1Strong-Password"
 	; Checks
 		pkg_linter=1
 		setup_sub_dir=0
@@ -16,6 +12,12 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
+		# 2.0.6~ynh3
+		upgrade=1	from_commit=c759c5f400660031676a0f92d5c5ffcc68bd6da9
 		backup_restore=1
 		multi_instance=1
+		port_already_use=0
 		change_url=1
+;;; Options
+Email=
+Notification=none

conf/nginx.conf

@@ -1,10 +1,6 @@
+#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
 location __PATH__/ {
 
-  # Force usage of https
-  if ($scheme = http) {
-     rewrite ^ https://$server_name$request_uri? permanent;
-  }
-
   proxy_set_header Accept-Encoding "";
   try_files $uri @proxy;
 

conf/systemd.service

@@ -6,7 +6,7 @@ After=network.target
 Type=simple
 User=__APP__
 Group=__APP__
-WorkingDirectory=__DATADIR__
+WorkingDirectory=__FINALPATH__/
 ExecStart=__FINALPATH__/server -repo __DATADIR__/ -lishttp localhost:__PORT__ -https-domain __DOMAIN__ -lismux :__SSBPORT__ -aliases-as-subdomains false
 StandardOutput=append:/var/log/__APP__/__APP__.log
 StandardError=inherit

manifest.json

@@ -5,7 +5,7 @@
     "description": {
         "en": "Secure Scuttlebutt room server implemented in Go"
     },
-    "version": "2.0.6~ynh3",
+    "version": "2.0.6~ynh4",
     "url": "https://github.com/ssb-ngi-pointer/go-ssb-room",
     "upstream": {
         "license": "free",
@@ -21,18 +21,25 @@
         "email": "max@mfowler.info"
     },
     "requirements": {
-        "yunohost": ">= 4.1.7"
+        "yunohost": ">= 4.3.0"
     },
     "multi_instance": true,
     "services": [
         "nginx"
     ],
     "arguments": {
-        "install" : [
+        "install": [
             {
                 "name": "domain",
-                "type": "domain",
+                "type": "domain"
-                "example": "example.com"
+            },
+            {
+                "name": "is_public",
+                "type": "boolean",
+                "default": true,
+                "help": {
+                    "en": "If false, ssbroom will only be usable by yunohost users."
+                }
             },
             {
                 "name": "ssb_admin_id",
@@ -45,14 +52,6 @@
                 },
                 "example": "@5Pt3dKy2HTJ0mWuS78oIiklIX0gBz6BTfEnXsbvke9c=.ed25519"
             },
-            {
-                "name": "is_public",
-                "type": "boolean",
-                "default": true,
-                "help": {
-                    "en": "If false, ssbroom will only be usable by yunohost users."
-                }
-            },
             {
                 "name": "password",
                 "type": "password",

scripts/_common.sh

@@ -20,22 +20,3 @@ description="Secure Scuttlebutt room server implemented in Go"
 #=================================================
 # FUTURE OFFICIAL HELPERS
 #=================================================
-
-
-ynh_detect_arch(){
-        local architecture
-        if [ -n "$(uname -m | grep arm64)" ] || [ -n "$(uname -m | grep aarch64)" ]; then
-                architecture="arm64"
-        elif [ -n "$(uname -m | grep 64)" ]; then
-                architecture="amd64"
-        elif [ -n "$(uname -m | grep 86)" ]; then
-                architecture="386"
-        elif [ -n "$(uname -m | grep armv7)" ]; then
-                architecture="arm7"
-        elif [ -n "$(uname -m | grep armv6)" ]; then
-                architecture="arm6"
-        else
-                architecture="unknown"
-        fi
-        echo $architecture
-}

scripts/backup

@@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 ynh_clean_setup () {
-	### Remove this function if there's nothing to clean before calling the remove script.
 	true
 }
 # Exit if an error occurs during the execution of the script
@@ -37,11 +36,6 @@ datadir=$(ynh_app_setting_get --app=$app --key=datadir)
 #=================================================
 ynh_print_info --message="Declaring files to be backed up..."
 
-### N.B. : the following 'ynh_backup' calls are only a *declaration* of what needs
-### to be backuped and not an actual copy of any file. The actual backup that
-### creates and fill the archive with the files happens in the core after this
-### script is called. Hence ynh_backups calls takes basically 0 seconds to run.
-
 #=================================================
 # BACKUP THE APP MAIN DIR
 #=================================================

scripts/change_url

@@ -37,6 +37,7 @@ ynh_script_progression --message="Backing up the app before changing its URL (ma
 # Backup the current version of the app
 ynh_backup_before_upgrade
 ynh_clean_setup () {
+	ynh_clean_check_starting
 	# Remove the new domain config file, the remove script won't do it as it doesn't know yet its location.
 	ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
 
@@ -110,7 +111,7 @@ fi
 #=================================================
 ynh_script_progression --message="Starting a systemd service..."  --weight=1
 
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" --line_match="event=serving"
 
 #=================================================
 # RELOAD NGINX

scripts/install

@@ -14,8 +14,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 ynh_clean_setup () {
-	### Remove this function if there's nothing to clean before calling the remove script.
+	ynh_clean_check_starting
-	true
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@@ -29,7 +28,7 @@ path_url="/"
 is_public=$YNH_APP_ARG_IS_PUBLIC
 ssb_admin_id=$YNH_APP_ARG_SSB_ADMIN_ID
 password=$YNH_APP_ARG_PASSWORD
-architecture=$(ynh_detect_arch)
+
 app=$YNH_APP_INSTANCE_NAME
 
 #=================================================
@@ -93,9 +92,8 @@ ynh_script_progression --message="Setting up source files..." --weight=1
 
 ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 # Download, check integrity, uncompress and patch the source from app.src
-ynh_setup_source --dest_dir="$final_path" --source_id="$architecture"
+ynh_setup_source --dest_dir="$final_path" --source_id="$YNH_ARCH"
 
-# permissions
 chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
 chown -R $app:www-data "$final_path"
@@ -105,7 +103,7 @@ chown -R $app:www-data "$final_path"
 #=================================================
 ynh_script_progression --message="Configuring NGINX web server..."  --weight=1
 
-# add nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config
 
 #=================================================
@@ -118,7 +116,6 @@ ynh_app_setting_set --app=$app --key=datadir --value=$datadir
 
 mkdir -p $datadir
 
-# permissions
 chmod 750 "$datadir"
 chmod -R o-rwx "$datadir"
 chown -R $app:www-data "$datadir"
@@ -127,6 +124,7 @@ chown -R $app:www-data "$datadir"
 # CREATE FIRST ADMIN USER
 #=================================================
 ynh_script_progression --message="Creating first ssbroom admin user"  --weight=1
+
 ynh_exec_as $app /usr/bin/expect<<EOF
 set force_conservative 0  ;
 set timeout -1
@@ -147,15 +145,6 @@ ynh_script_progression --message="Configuring a systemd service..."  --weight=1
 # Create a dedicated systemd config
 ynh_add_systemd_config
 
-# for yunohost version < 4.2, this is a workaround to replace string variables
-ynh_script_progression --message="String replacing systemd service with $datadir"  --weight=1
-systemd_file="/etc/systemd/system/$app.service"
-ynh_replace_string --match_string=__DATADIR__ --replace_string=$datadir --target_file=$systemd_file
-ynh_replace_string --match_string=__PORT__ --replace_string=$port --target_file=$systemd_file
-ynh_replace_string --match_string=__DOMAIN__ --replace_string=$domain --target_file=$systemd_file
-ynh_replace_string --match_string=__SSBPORT__ --replace_string=$ssbport --target_file=$systemd_file
-systemctl daemon-reload
-
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
@@ -179,18 +168,13 @@ yunohost service add $app --description="$description" --log="/var/log/$app/$app
 ynh_script_progression --message="Starting a systemd service..."  --weight=1
 
 # Start a systemd service
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" --line_match="event=serving"
 
 #=================================================
 # SETUP SSOWAT
 #=================================================
 ynh_script_progression --message="Configuring permissions..."  --weight=1
 
-# for normal operation of the app, is_public should equal True,
-# and all visitors should be able to access the /admin section, with or without SSO
-# as go-ssb-room has its own authentication and user-system
-# which operates outside of yunohost SSO
-
 # Make app public if necessary
 if [ $is_public -eq 1 ]
 then

scripts/remove

@@ -51,14 +51,6 @@ ynh_script_progression --message="Removing logrotate configuration..."  --weight
 # Remove the app-specific logrotate config
 ynh_remove_logrotate
 
-#=================================================
-# REMOVE DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Removing dependencies..."  --weight=1
-
-# Remove metapackage and its dependencies
-ynh_remove_app_dependencies
-
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
@@ -70,10 +62,13 @@ ynh_secure_remove --file="$final_path"
 #=================================================
 # REMOVE DATA DIR
 #=================================================
-ynh_script_progression --message="Removing data directory..."  --weight=1
 
-# Remove the data directory securely
+# Remove the data directory if --purge option is used
-ynh_secure_remove --file="$datadir"
+if [ "${YNH_APP_PURGE:-0}" -eq 1 ]
+then
+	ynh_script_progression --message="Removing app data directory..."
+	ynh_secure_remove --file="$datadir"
+fi
 
 #=================================================
 # REMOVE NGINX CONFIGURATION
@@ -83,16 +78,18 @@ ynh_script_progression --message="Removing NGINX web server configuration..."  -
 # Remove the dedicated NGINX config
 ynh_remove_nginx_config
 
+#=================================================
+# REMOVE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Removing dependencies..."  --weight=1
+
+# Remove metapackage and its dependencies
+ynh_remove_app_dependencies
+
 #=================================================
 # CLOSE A PORT
 #=================================================
 
-if yunohost firewall list | grep -q "\- $port$"
-then
-	ynh_script_progression --message="Closing port $port..."  --weight=1
-	ynh_exec_warn_less yunohost firewall disallow TCP $port
-fi
-
 if yunohost firewall list | grep -q "\- $ssbport$"
 then
 	ynh_script_progression --message="Closing ssbport $ssbport..."  --weight=1

scripts/restore

@@ -15,8 +15,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 ynh_clean_setup () {
-	#### Remove this function if there's nothing to clean before calling the remove script.
+	ynh_clean_check_starting
-	true
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@@ -44,13 +43,6 @@ test ! -d $final_path \
 
 #=================================================
 # STANDARD RESTORATION STEPS
-#=================================================
-# RESTORE THE NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Restoring the NGINX configuration..."  --weight=1
-
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
-
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
@@ -66,7 +58,6 @@ ynh_script_progression --message="Restoring the app main directory..."  --weight
 
 ynh_restore_file --origin_path="$final_path"
 
-# permissions
 chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
 chown -R $app:www-data "$final_path"
@@ -80,7 +71,6 @@ ynh_restore_file --origin_path="$datadir" --not_mandatory
 
 mkdir -p $datadir
 
-# permissions
 chmod 750 "$datadir"
 chmod -R o-rwx "$datadir"
 chown -R $app:www-data "$datadir"
@@ -95,6 +85,13 @@ ynh_script_progression --message="Reinstalling dependencies..."  --weight=1
 # Define and install dependencies
 ynh_install_app_dependencies $pkg_dependencies
 
+#=================================================
+# RESTORE THE NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Restoring the NGINX configuration..."  --weight=1
+
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
 #=================================================
 # OPEN SSBPORT
 #=================================================
@@ -130,7 +127,7 @@ yunohost service add $app --description="$description" --log="/var/log/$app/$app
 #=================================================
 ynh_script_progression --message="Starting a systemd service..."  --weight=1
 
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" --line_match="event=serving"
 
 #=================================================
 # GENERIC FINALIZATION

scripts/upgrade

@@ -23,18 +23,12 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 datadir=$(ynh_app_setting_get --app=$app --key=datadir)
 port=$(ynh_app_setting_get --app=$app --key=port)
 ssbport=$(ynh_app_setting_get --app=$app --key=ssbport)
-architecture=$(ynh_detect_arch)
 
 #=================================================
 # CHECK VERSION
 #=================================================
+ynh_script_progression --message="Checking version..."
 
-### This helper will compare the version of the currently installed app and the version of the upstream package.
-### $upgrade_type can have 2 different values
-### - UPGRADE_APP if the upstream app version has changed
-### - UPGRADE_PACKAGE if only the YunoHost package has changed
-### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
-### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
 upgrade_type=$(ynh_check_app_version_changed)
 
 #=================================================
@@ -45,6 +39,7 @@ ynh_script_progression --message="Backing up the app before upgrading (may take
 # 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
 }
@@ -65,27 +60,6 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app
 #=================================================
 ynh_script_progression --message="Ensuring downward compatibility..."  --weight=1
 
-#
-# N.B. : the followings setting migrations snippets are provided as *EXAMPLES*
-# of what you may want to do in some cases (e.g. a setting was not defined on
-# some legacy installs and you therefore want to initiaze stuff during upgrade)
-#
-
-# If db_name doesn't exist, create it
-#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
-#	final_path=/var/www/$app
-#	ynh_app_setting_set --app=$app --key=final_path --value=$final_path
-#fi
-
-### If nobody installed your app before 4.1,
-### then you may safely remove these lines
-
 # Cleaning legacy permissions
 if ynh_legacy_permissions_exists; then
 	ynh_legacy_permissions_delete_all
@@ -110,27 +84,13 @@ then
 	ynh_script_progression --message="Upgrading source files..."  --weight=1
 
 	# Download, check integrity, uncompress and patch the source from app.src
-    ynh_setup_source --dest_dir="$final_path" --source_id="$architecture"
+	ynh_setup_source --dest_dir="$final_path" --source_id="$YNH_ARCH"
 fi
 
-# FIXME: this should be managed by the core in the future
-# Here, as a packager, you may have to tweak the ownerhsip/permissions
-# such that the appropriate users (e.g. maybe www-data) can access
-# files in some cases.
-# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
-# this will be treated as a security issue.
 chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
 chown -R $app:www-data "$final_path"
 
-#=================================================
-# NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Upgrading NGINX web server configuration..."  --weight=1
-
-# Create a dedicated NGINX config
-ynh_add_nginx_config
-
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
@@ -140,11 +100,15 @@ ynh_install_app_dependencies $pkg_dependencies
 
 
 #=================================================
-# SPECIFIC UPGRADE
+# NGINX CONFIGURATION
-#=================================================
-# ...
 #=================================================
+ynh_script_progression --message="Upgrading NGINX web server configuration..."  --weight=1
 
+# Create a dedicated NGINX config
+ynh_add_nginx_config
+
+#=================================================
+# SPECIFIC UPGRADE
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@@ -175,7 +139,7 @@ yunohost service add $app --description="$description" --log="/var/log/$app/$app
 #=================================================
 ynh_script_progression --message="Starting a systemd service..."  --weight=1
 
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log" --line_match="event=serving"
 
 
 #=================================================

sources/extra_files/app/.gitignore

@@ -1,2 +0,0 @@
-*~
-*.sw[op]

sources/patches/.gitignore

@@ -1,2 +0,0 @@
-*~
-*.sw[op]