Merge pull request #23 from YunoHost-Apps/upgrade

Apply example_ynh

.gitignore

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

.vscode/settings.json

@@ -1,8 +0,0 @@
-{
-	"markdownlint.config": {
-		"MD028": false,
-		"MD025": {
-			"front_matter_title": ""
-		}
-	}
-}

README.md

@@ -29,7 +29,7 @@ Inspired by the Invidious project.
 - Mobile support (responsive design)
 
 
-**Shipped version:** 2022.06.19~ynh1
+**Shipped version:** 2022.06.19~ynh2
 
 **Demo:** https://nitter.net/
 

README_fr.md

@@ -29,7 +29,7 @@ Nitter est une interface alternative pour Twitter qui est plus rapide que le sit
 - Support mobile (conception réactive)
 
 
-**Version incluse :** 2022.06.19~ynh1
+**Version incluse :** 2022.06.19~ynh2
 
 **Démo :** https://nitter.net/
 

check_process

@@ -10,7 +10,8 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
-		upgrade=0	from_commit=CommitHash
+		# 2022.06.09~ynh1
+		upgrade=0	from_commit=0f1e8c0d23500b4ec4aa8085c287fac1adbe0db8
 		backup_restore=1
 		multi_instance=1
 		port_already_use=0
@@ -18,8 +19,3 @@
 ;;; Options
 Email=
 Notification=none
-;;; Upgrade options
-	; commit=CommitHash
-		name=Name and date of the commit.
-		manifest_arg=domain=DOMAIN&is_public=1&
-

conf/nginx.conf

@@ -1,4 +1,6 @@
-location / {
+#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
+location __PATH__/ {
+
   # Path to source
   alias __FINALPATH__/public/ ;
 

conf/systemd.service

@@ -6,7 +6,7 @@ After=network.target redis.service
 Type=simple
 User=__APP__
 Group=__APP__
-WorkingDirectory=__FINALPATH__
+WorkingDirectory=__FINALPATH__/
 ExecStart=__FINALPATH__/nitter >> /var/log/__APP__/__APP__.log 2>&1
 Restart=always
 RestartSec=15

manifest.json

@@ -6,7 +6,7 @@
         "en": "Alternative front-end for Twitter that respects your privacy",
         "fr": "Interface alternative pour Twitter qui respecte votre vie privée"
     },
-    "version": "2022.06.19~ynh1",
+    "version": "2022.06.19~ynh2",
     "url": "https://github.com/zedeus/nitter",
     "upstream": {
         "license": "AGPL-3.0-only",

scripts/change_url

@@ -14,7 +14,10 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 old_domain=$YNH_APP_OLD_DOMAIN
+old_path=$YNH_APP_OLD_PATH
+
 new_domain=$YNH_APP_NEW_DOMAIN
+new_path="/"
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -27,13 +30,14 @@ ynh_script_progression --message="Loading installation settings..." --weight=1
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 
 #=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
 #=================================================
 ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1
 
 # 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"
 
@@ -53,6 +57,12 @@ then
 	change_domain=1
 fi
 
+change_path=0
+if [ "$old_path" != "$new_path" ]
+then
+	change_path=1
+fi
+
 #=================================================
 # STANDARD MODIFICATIONS
 #=================================================
@@ -69,6 +79,18 @@ ynh_script_progression --message="Updating NGINX web server configuration..." --
 
 nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
 
+# Change the path in the NGINX config file
+if [ $change_path -eq 1 ]
+then
+	# Make a backup of the original NGINX config file if modified
+	ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
+	# Set global variables for NGINX helper
+	domain="$old_domain"
+	path_url="$new_path"
+	# Create a dedicated NGINX config
+	ynh_add_nginx_config
+fi
+
 # Change the domain for NGINX
 if [ $change_domain -eq 1 ]
 then
@@ -82,8 +104,9 @@ fi
 #=================================================
 # SPECIFIC MODIFICATIONS
 #=================================================
-# EDIT NITTER.CONF
+# UPDATE A CONFIG FILE
 #=================================================
+ynh_script_progression --message="Updating a configuration file..."
 
 if [ $change_domain -eq 1 ]
 then
@@ -99,6 +122,7 @@ fi
 #=================================================
 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"
 
 #=================================================

scripts/install

@@ -13,6 +13,9 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
+ynh_clean_setup () {
+	ynh_clean_check_starting
+}
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 
@@ -28,10 +31,11 @@ theme=$YNH_APP_ARG_THEME
 replace_youtube=$YNH_APP_ARG_REPLACE_YOUTUBE
 replace_instagram=$YNH_APP_ARG_REPLACE_INSTAGRAM
 replace_reddit=$YNH_APP_ARG_REPLACE_REDDIT
-hmac_key=$(ynh_string_random --length=64)
 
 app=$YNH_APP_INSTANCE_NAME
 
+hmac_key=$(ynh_string_random --length=64)
+
 #=================================================
 # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
@@ -75,6 +79,14 @@ ynh_script_progression --message="Installing dependencies..." --weight=1
 
 ynh_install_app_dependencies $pkg_dependencies
 
+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Configuring system user..." --weight=1
+
+# Create a system user
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@@ -85,6 +97,10 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path
 ynh_setup_source --dest_dir="$final_path" --source_id="app"
 ynh_setup_source --dest_dir="$final_path/nim-installation" --source_id=$YNH_ARCH
 
+chmod 750 "$final_path"
+chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$final_path"
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@@ -93,15 +109,6 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=1
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..." --weight=1
-
-# Create a system user
-ynh_system_user_create --username=$app
-usermod -d $final_path $app 2>&1
-
 #=================================================
 # SPECIFIC SETUP
 #=================================================
@@ -111,6 +118,16 @@ ynh_script_progression --message="Compiling Nitter..." --weight=30
 
 build_nitter
 
+#=================================================
+# ADD A CONFIGURATION
+#=================================================
+ynh_script_progression --message="Adding a configuration file..."
+
+ynh_add_config --template="nitter.conf" --destination="$final_path/nitter.conf"
+
+chmod 400 "$final_path/nitter.conf"
+chown $app:$app "$final_path/nitter.conf"
+
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@@ -119,19 +136,14 @@ ynh_script_progression --message="Configuring a systemd service..." --weight=1
 # Create a dedicated systemd config
 ynh_add_systemd_config
 
-#=================================================
-# ADD A CONFIGURATION
-#=================================================
-ynh_add_config --template="nitter.conf" --destination="$final_path/nitter.conf"
-
-#=================================================
-# GENERIC FINALIZATION
 #=================================================
 # SECURE FILES AND DIRECTORIES
 #=================================================
 # Set permissions to app files
 set_permissions
 
+#=================================================
+# GENERIC FINALIZATION
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
 #=================================================
@@ -155,6 +167,8 @@ ynh_script_progression --message="Configuring permissions..." --weight=1
 # Make app public if necessary
 if [ $is_public -eq 1 ]
 then
+	# Everyone can access the app.
+	# The "main" permission is automatically created before the install script.
 	ynh_permission_update --permission="main" --add="visitors"
 fi
 

scripts/remove

@@ -41,14 +41,6 @@ ynh_script_progression --message="Stopping and removing the systemd service..."
 # Remove the dedicated systemd config
 ynh_remove_systemd_config
 
-#=================================================
-# REMOVE DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Removing dependencies..." --weight=1
-
-# Remove metapackage and its dependencies
-ynh_remove_app_dependencies
-
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
@@ -65,6 +57,14 @@ 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
+
 #=================================================
 # GENERIC FINALIZATION
 #=================================================

scripts/restore

@@ -14,6 +14,9 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================
 
+ynh_clean_setup () {
+	ynh_clean_check_starting
+}
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
 
@@ -33,15 +36,18 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..." --weight=1
 
-test ! -d $final_path || ynh_die --message="There is already a directory: $final_path "
+test ! -d $final_path \
+	|| ynh_die --message="There is already a directory: $final_path "
 
 #=================================================
 # STANDARD RESTORATION STEPS
 #=================================================
-# RESTORE THE NGINX CONFIGURATION
+# RECREATE THE DEDICATED USER
 #=================================================
+ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
 
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+# Create the dedicated user (if not existing)
+ynh_system_user_create --username=$app --home_dir="$final_path"
 
 #=================================================
 # RESTORE THE APP MAIN DIR
@@ -51,14 +57,7 @@ ynh_script_progression --message="Restoring the app main directory..." --weight=
 ynh_restore_file --origin_path="$final_path"
 
 #=================================================
-# RECREATE THE DEDICATED USER
+# SPECIFIC RESTORATION
-#=================================================
-ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
-
-# Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app
-usermod -d $final_path $app 2>&1
-
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
@@ -67,6 +66,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 web server configuration..."
+
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
 #=================================================
 # RESTORE USER RIGHTS
 #=================================================
@@ -74,8 +80,6 @@ ynh_install_app_dependencies $pkg_dependencies
 # Restore permissions on app files
 set_permissions
 
-#=================================================
-# SPECIFIC RESTORATION
 #=================================================
 # RESTORE SYSTEMD
 #=================================================

scripts/upgrade

@@ -9,7 +9,6 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
-
 #=================================================
 # LOAD SETTINGS
 #=================================================
@@ -31,6 +30,7 @@ hmac_key=$(ynh_app_setting_get --app=$app --key=hmac_key)
 #=================================================
 # CHECK VERSION
 #=================================================
+ynh_script_progression --message="Checking version..."
 
 upgrade_type=$(ynh_check_app_version_changed)
 
@@ -42,6 +42,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
 }
@@ -57,6 +58,14 @@ ynh_script_progression --message="Stopping a systemd service..." --weight=1
 
 ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
 
+#=================================================
+# CREATE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
+
+# Create a dedicated user (if not existing)
+ynh_system_user_create --username=$app --home_dir="$final_path"
+
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
 #=================================================
@@ -70,13 +79,9 @@ then
 	ynh_setup_source --dest_dir="$final_path/nim-installation" --source_id=$YNH_ARCH --keep="$final_path/nitter.conf"
 fi
 
-#=================================================
+chmod 750 "$final_path"
-# NGINX CONFIGURATION
+chmod -R o-rwx "$final_path"
-#=================================================
+chown -R $app:www-data "$final_path"
-ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
-
-# Create a dedicated NGINX config
-ynh_add_nginx_config
 
 #=================================================
 # UPGRADE DEPENDENCIES
@@ -86,13 +91,12 @@ ynh_script_progression --message="Upgrading dependencies..." --weight=1
 ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
-# CREATE DEDICATED USER
+# NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
+ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
 
-# Create a dedicated user (if not existing)
+# Create a dedicated NGINX config
-ynh_system_user_create --username=$app
+ynh_add_nginx_config
-usermod -d $final_path $app 2>&1
 
 #=================================================
 # SPECIFIC UPGRADE
@@ -103,6 +107,13 @@ ynh_script_progression --message="Compiling Nitter..." --weight=30
 
 build_nitter
 
+#=================================================
+# UPDATE A CONFIG FILE
+#=================================================
+ynh_script_progression --message="Updating a configuration file..."
+
+ynh_add_config --template="nitter.conf" --destination="$final_path/nitter.conf"
+
 #=================================================
 # SETUP SYSTEMD
 #=================================================
@@ -111,19 +122,15 @@ ynh_script_progression --message="Upgrading systemd configuration..." --weight=1
 # Create a dedicated systemd config
 ynh_add_systemd_config
 
-#=================================================
-# UPDATE A CONFIG FILE
-#=================================================
-ynh_add_config --template="nitter.conf" --destination="$final_path/nitter.conf"
-
-#=================================================
-# GENERIC FINALIZATION
 #=================================================
 # SECURE FILES AND DIRECTORIES
 #=================================================
 
 # Set permissions on app files
 set_permissions
+
+#=================================================
+# GENERIC FINALIZATION
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
 #=================================================

sources/extra_files/app/.gitignore

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

sources/patches/.gitignore

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