Merge pull request #78 from YunoHost-Apps/testing

Apply last example_ynh

README.md

@@ -5,7 +5,7 @@ It shall NOT be edited by hand.
 
 # Navidrome for YunoHost
 
-[![Integration level](https://dash.yunohost.org/integration/navidrome.svg)](https://dash.yunohost.org/appci/app/navidrome) ![](https://ci-apps.yunohost.org/ci/badges/navidrome.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/navidrome.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/navidrome.svg)](https://dash.yunohost.org/appci/app/navidrome) ![Working status](https://ci-apps.yunohost.org/ci/badges/navidrome.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/navidrome.maintain.svg)  
 [![Install Navidrome with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=navidrome)
 
 *[Lire ce readme en français.](./README_fr.md)*
@@ -32,13 +32,13 @@ Navidrome indexes all digital music stored in your hard drive and makes it avail
 - Transcoding on the fly. Can be set per user/player. Opus encoding is supported
 
 
-**Shipped version:** 0.47.5~ynh2
+**Shipped version:** 0.47.5~ynh3
 
 **Demo:** https://demo.navidrome.org/app/#/login
 
 ## Screenshots
 
-![](./doc/screenshots/ss-desktop-player.png)
+![Screenshot of Navidrome](./doc/screenshots/ss-desktop-player.png)
 
 ## Disclaimers / important information
 
@@ -56,21 +56,22 @@ You must activate *public site* if you want to connect a client player to Navidr
 
 ## Documentation and resources
 
-* Official app website: https://www.navidrome.org
+* Official app website: <https://www.navidrome.org>
-* Official admin documentation: https://www.navidrome.org/docs
+* Official admin documentation: <https://www.navidrome.org/docs>
-* Upstream app code repository: https://github.com/deluan/navidrome
+* Upstream app code repository: <https://github.com/deluan/navidrome>
-* YunoHost documentation for this app: https://yunohost.org/app_navidrome
+* YunoHost documentation for this app: <https://yunohost.org/app_navidrome>
-* Report a bug: https://github.com/YunoHost-Apps/navidrome_ynh/issues
+* Report a bug: <https://github.com/YunoHost-Apps/navidrome_ynh/issues>
 
 ## Developer info
 
 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing).
 
 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade navidrome -u https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
 ```
 
-**More info regarding app packaging:** https://yunohost.org/packaging_apps
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>

README_fr.md

@@ -1,10 +1,14 @@
+<!--
+N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
+It shall NOT be edited by hand.
+-->
+
 # Navidrome pour YunoHost
 
-[![Niveau d'intégration](https://dash.yunohost.org/integration/navidrome.svg)](https://dash.yunohost.org/appci/app/navidrome) ![](https://ci-apps.yunohost.org/ci/badges/navidrome.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/navidrome.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/navidrome.svg)](https://dash.yunohost.org/appci/app/navidrome) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/navidrome.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/navidrome.maintain.svg)  
 [![Installer Navidrome avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=navidrome)
 
 *[Read this readme in english.](./README.md)*
-*[Lire ce readme en français.](./README_fr.md)*
 
 > *Ce package vous permet d'installer Navidrome rapidement et simplement sur un serveur YunoHost.
 Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
@@ -27,13 +31,13 @@ Navidrome indexe toute la musique numérique stockée sur votre disque dur et la
 - Compatible avec tous les clients subsonique/madsononique/aironique
 - Encodage à la volée. Peut être défini par utilisateur/lecteur. Le codage opus est pris en charge 
 
-**Version incluse :** 0.47.5~ynh2
+**Version incluse :** 0.47.5~ynh3
 
 **Démo :** https://demo.navidrome.org/app/#/login
 
 ## Captures d'écran
 
-![](./doc/screenshots/ss-desktop-player.png)
+![Capture d'écran de Navidrome](./doc/screenshots/ss-desktop-player.png)
 
 ## Avertissements / informations importantes
 
@@ -51,21 +55,22 @@ Vous devez activer *site public* si vous souhaitez connecter un lecteur client
 
 ## Documentations et ressources
 
-* Site officiel de l'app : https://www.navidrome.org
+* Site officiel de l'app : <https://www.navidrome.org>
-* Documentation officielle de l'admin : https://www.navidrome.org/docs
+* Documentation officielle de l'admin : <https://www.navidrome.org/docs>
-* Dépôt de code officiel de l'app : https://github.com/deluan/navidrome
+* Dépôt de code officiel de l'app : <https://github.com/deluan/navidrome>
-* Documentation YunoHost pour cette app : https://yunohost.org/app_navidrome
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_navidrome>
-* Signaler un bug : https://github.com/YunoHost-Apps/navidrome_ynh/issues
+* Signaler un bug : <https://github.com/YunoHost-Apps/navidrome_ynh/issues>
 
 ## Informations pour les développeurs
 
 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing).
 
 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade navidrome -u https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
 ```
 
-**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
+**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps>

check_process

@@ -12,10 +12,13 @@
 		setup_private=1
 		setup_public=1
 		upgrade=1
+		# 0.40.0~ynh1
 		upgrade=1	from_commit=e41c919ddb65673ea6b452e138d36c240be3b6b7
+		# 0.47.0~ynh1
 		upgrade=1	from_commit=d7eb59fdd7a47ef4365af59db857e763f70564a4
 		backup_restore=1
 		multi_instance=0
+		port_already_use=0
 		change_url=1
 ;;; Options
 Email=

conf/nginx.conf

@@ -1,14 +1,14 @@
 #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
 location __PATH__/ {
 
-  proxy_pass        http://127.0.0.1:__PORT__;
+  proxy_pass http://127.0.0.1:__PORT__;
-  proxy_redirect    off;
+  proxy_redirect off;
-  proxy_set_header  Host $host;
+  proxy_set_header Host $host;
-  proxy_set_header  X-Real-IP $remote_addr;
+  proxy_set_header X-Real-IP $remote_addr;
-  proxy_set_header  X-Forwarded-Proto $scheme;
+  proxy_set_header X-Forwarded-Proto $scheme;
-  proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
+  proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-  proxy_set_header  X-Forwarded-Host $server_name;
+  proxy_set_header X-Forwarded-Host $server_name;
-  
+
   proxy_http_version 1.1;
   proxy_set_header Upgrade $http_upgrade;
   proxy_set_header Connection "upgrade";

conf/systemd.service

@@ -3,42 +3,34 @@ Description=Navidrome Music Server and Streamer compatible with Subsonic/Airsoni
 After=remote-fs.target network.target
 AssertPathExists=__CONFIG_PATH__
 
-[Install]
-WantedBy=multi-user.target
-
 [Service]
+Type=simple
 User=__APP__
 Group=__APP__
-Type=simple
+WorkingDirectory=__CONFIG_PATH__/
 ExecStart=__FINALPATH__/__APP__ --configfile "__CONFIG_PATH__/navidrome.toml"
-WorkingDirectory=__CONFIG_PATH__
 TimeoutStopSec=20
 KillMode=process
 Restart=on-failure
+ReadWritePaths=__CONFIG_PATH__
 
 # See https://www.freedesktop.org/software/systemd/man/systemd.exec.html
-DevicePolicy=closed
 NoNewPrivileges=yes
 PrivateTmp=yes
 PrivateUsers=yes
-ProtectControlGroups=yes
-ProtectKernelModules=yes
-ProtectKernelTunables=yes
 RestrictAddressFamilies=AF_UNIX AF_INET AF_INET6
 RestrictNamespaces=yes
 RestrictRealtime=yes
-SystemCallFilter=~@clock @debug @module @mount @obsolete @privileged @reboot @setuid @swap
+DevicePolicy=closed
-ReadWritePaths=__CONFIG_PATH__
-
-# You can uncomment the following line if you're not using the jukebox This
-# will prevent navidrome from accessing any real (physical) devices
-#PrivateDevices=yes
-
-# You can change the following line to `strict` instead of `full` if you don't
-# want navidrome to be able to write anything on your filesystem outside of
-# /var/lib/navidrome.
 ProtectSystem=full
+ProtectControlGroups=yes
+ProtectKernelModules=yes
+ProtectKernelTunables=yes
+SystemCallFilter=~@clock @debug @module @mount @obsolete @privileged @reboot @setuid @swap
 
 # You can comment the following line if you don't have any media in /home/*.
 # This will prevent navidrome from ever reading/writing anything there.
-#ProtectHome=true
+#ProtectHome=true
+
+[Install]
+WantedBy=multi-user.target

manifest.json

@@ -6,7 +6,7 @@
         "en": "Modern Music Server and Streamer compatible with Subsonic/Airsonic",
         "fr": "Serveur de musique moderne et Streamer compatibles avec Subsonic/Airsonic"
     },
-    "version": "0.47.5~ynh2",
+    "version": "0.47.5~ynh3",
     "url": "https://www.navidrome.org",
     "upstream": {
         "license": "GPL-3.0-only",
@@ -27,7 +27,7 @@
         "nginx"
     ],
     "arguments": {
-        "install" : [
+        "install": [
             {
                 "name": "domain",
                 "type": "domain"

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
 
@@ -23,7 +26,6 @@ ynh_abort_if_errors
 domain=$YNH_APP_ARG_DOMAIN
 path_url=$YNH_APP_ARG_PATH
 is_public=$YNH_APP_ARG_IS_PUBLIC
-architecture=$YNH_ARCH
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -81,7 +83,7 @@ ynh_install_app_dependencies $pkg_dependencies
 ynh_script_progression --message="Configuring system user..." --weight=1
 
 # Create a system user
-ynh_system_user_create --username=$app --home_dir=$final_path
+ynh_system_user_create --username=$app --home_dir="$final_path"
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -90,7 +92,7 @@ ynh_script_progression --message="Setting up source files..." --weight=4
 
 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
 
 chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
@@ -160,6 +162,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
+
 #=================================================
 # SPECIFIC REMOVE
 #=================================================

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,24 +36,18 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 #=================================================
 ynh_script_progression --message="Validating restoration parameters..." --weight=2
 
-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
-#=================================================
-ynh_script_progression --message="Restoring the NGINX web server configuration..."
-
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
-
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
 ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
 
 # Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir=$final_path
+ynh_system_user_create --username=$app --home_dir="$final_path"
 
 #=================================================
 # RESTORE THE APP MAIN DIR
@@ -73,6 +70,13 @@ ynh_script_progression --message="Reinstalling dependencies..." --weight=7
 # 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 VARIOUS FILES
 #=================================================

scripts/upgrade

@@ -20,7 +20,6 @@ domain=$(ynh_app_setting_get --app=$app --key=domain)
 path_url=$(ynh_app_setting_get --app=$app --key=path)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 port=$(ynh_app_setting_get --app=$app --key=port)
-architecture=$YNH_ARCH
 
 enable_downloads=$(ynh_app_setting_get --app=$app --key=enable_downloads)
 scanner_extractor=$(ynh_app_setting_get --app=$app --key=scanner_extractor)
@@ -31,6 +30,7 @@ welcome_message=$(ynh_app_setting_get --app=$app --key=welcome_message)
 #=================================================
 # 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
 }
@@ -62,6 +63,13 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path=systemd
 #=================================================
 ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
 
+# Cleaning legacy permissions
+if ynh_legacy_permissions_exists; then
+	ynh_legacy_permissions_delete_all
+
+	ynh_app_setting_delete --app=$app --key=is_public
+fi
+
 if [ -z "$enable_animation" ]; then
 	enable_animation="true"
 	ynh_app_setting_set --app=$app --key=enable_animation --value=$enable_animation
@@ -87,20 +95,13 @@ if [ -z "$welcome_message" ]; then
 	ynh_app_setting_set --app=$app --key=welcome_message --value=$welcome_message
 fi
 
-# Cleaning legacy permissions
-if ynh_legacy_permissions_exists; then
-	ynh_legacy_permissions_delete_all
-
-	ynh_app_setting_delete --app=$app --key=is_public
-fi
-
 #=================================================
 # 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
+ynh_system_user_create --username=$app --home_dir="$final_path"
 
 #=================================================
 # DOWNLOAD, CHECK AND UNPACK SOURCE
@@ -114,13 +115,20 @@ then
 	ynh_secure_remove --file=$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
 fi
 
 chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
 chown -R $app:$app "$final_path"
 
+#=================================================
+# UPGRADE DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Upgrading dependencies..." --weight=8
+
+ynh_install_app_dependencies $pkg_dependencies
+
 #=================================================
 # NGINX CONFIGURATION
 #=================================================
@@ -129,13 +137,6 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." -
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
-#=================================================
-# UPGRADE DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Upgrading dependencies..." --weight=8
-
-ynh_install_app_dependencies $pkg_dependencies
-
 #=================================================
 # UPDATE A CONFIG FILE
 #=================================================