Merge pull request #11 from YunoHost-Apps/testing

Apply example_ynh
2024-09-03 18:25:53 +02:00 · 2022-07-20 20:47:18 +02:00 · 2022-07-20 20:47:18 +02:00 · 658cdf0dba
commit 658cdf0dba
parent 880c750eca e1386951e4
14 changed files with 152 additions and 89 deletions
--- a/README.md
+++ b/README.md
@ -5,7 +5,7 @@ It shall NOT be edited by hand.

 # Dispatch for YunoHost

-[![Integration level](https://dash.yunohost.org/integration/dispatch.svg)](https://dash.yunohost.org/appci/app/dispatch) ![](https://ci-apps.yunohost.org/ci/badges/dispatch.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/dispatch.maintain.svg)  
+[![Integration level](https://dash.yunohost.org/integration/dispatch.svg)](https://dash.yunohost.org/appci/app/dispatch) ![Working status](https://ci-apps.yunohost.org/ci/badges/dispatch.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/dispatch.maintain.svg)  
 [![Install Dispatch with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=dispatch)

 *[Lire ce readme en français.](./README_fr.md)*
@ -17,29 +17,42 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in

 Web-based IRC graphical client

-**Shipped version:** 0.7~ynh3
+### Features
+
+- Searchable history
+- Persistent connections
+- Multiple servers and users
+- Automatic HTTPS through Let's Encrypt
+- Single binary with no dependencies
+- DCC downloads
+- SASL
+- Client certificates
+
+
+**Shipped version:** 0.7~ynh4

 **Demo:** https://dispatch.khlieng.com/

 ## Screenshots

-![](./doc/screenshots/screenshot.png)
+![Screenshot of Dispatch](./doc/screenshots/screenshot.png)

 ## Documentation and resources

-* Upstream app code repository: https://github.com/khlieng/dispatch
-* YunoHost documentation for this app: https://yunohost.org/app_dispatch
-* Report a bug: https://github.com/YunoHost-Apps/dispatch_ynh/issues
+* Upstream app code repository: <https://github.com/khlieng/dispatch>
+* YunoHost documentation for this app: <https://yunohost.org/app_dispatch>
+* Report a bug: <https://github.com/YunoHost-Apps/dispatch_ynh/issues>

 ## Developer info

 Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/dispatch_ynh/tree/testing).

 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/dispatch_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade dispatch -u https://github.com/YunoHost-Apps/dispatch_ynh/tree/testing --debug
 ```

-**More info regarding app packaging:** https://yunohost.org/packaging_apps
+**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
--- a/README_fr.md
+++ b/README_fr.md
@ -1,41 +1,58 @@
+<!--
+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.
+-->
+
 # Dispatch pour YunoHost

-[![Niveau d'intégration](https://dash.yunohost.org/integration/dispatch.svg)](https://dash.yunohost.org/appci/app/dispatch) ![](https://ci-apps.yunohost.org/ci/badges/dispatch.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/dispatch.maintain.svg)  
+[![Niveau d'intégration](https://dash.yunohost.org/integration/dispatch.svg)](https://dash.yunohost.org/appci/app/dispatch) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/dispatch.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/dispatch.maintain.svg)  
 [![Installer Dispatch avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=dispatch)

 *[Read this readme in english.](./README.md)*
-*[Lire ce readme en français.](./README_fr.md)*

 > *Ce package vous permet d'installer Dispatch 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.*

 ## Vue d'ensemble

-Client graphique IRC
+Web-based IRC graphical client

-**Version incluse :** 0.7~ynh3
+### Features
+
+- Searchable history
+- Persistent connections
+- Multiple servers and users
+- Automatic HTTPS through Let's Encrypt
+- Single binary with no dependencies
+- DCC downloads
+- SASL
+- Client certificates
+
+
+**Version incluse :** 0.7~ynh4

 **Démo :** https://dispatch.khlieng.com/

 ## Captures d'écran

-![](./doc/screenshots/screenshot.png)
+![Capture d'écran de Dispatch](./doc/screenshots/screenshot.png)

 ## Documentations et ressources

-* Dépôt de code officiel de l'app : https://github.com/khlieng/dispatch
-* Documentation YunoHost pour cette app : https://yunohost.org/app_dispatch
-* Signaler un bug : https://github.com/YunoHost-Apps/dispatch_ynh/issues
+* Dépôt de code officiel de l'app : <https://github.com/khlieng/dispatch>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_dispatch>
+* Signaler un bug : <https://github.com/YunoHost-Apps/dispatch_ynh/issues>

 ## Informations pour les développeurs

 Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/dispatch_ynh/tree/testing).

 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/dispatch_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade dispatch -u https://github.com/YunoHost-Apps/dispatch_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>
--- a/9
+++ b/9
@ -1,17 +1,16 @@
 ;; Test complet
 	; Manifest
 		domain="domain.tld"
-		path="/path"
-		admin="john"
 		is_public=1
 	; Checks
 		pkg_linter=1
-		setup_sub_dir=1
+		setup_sub_dir=0
 		setup_root=1
 		setup_nourl=0
 		setup_private=1
 		setup_public=1
 		upgrade=1
+		# 0.7~ynh1
 		upgrade=1	from_commit=bb833bf6d91735f09c9f5f362f38636e86be5337
 		backup_restore=1
 		multi_instance=0
@ -19,7 +18,3 @@
 ;;; Options
 Email=
 Notification=none
-;;; Upgrade options
-	; commit=bb833bf6d91735f09c9f5f362f38636e86be5337
-		name=Merge pull request #6 from YunoHost-Apps/testing
-		manifest_arg=domain=DOMAIN&path=PATH&admin=USER&language=fr&is_public=1&password=pass&port=666&
--- a/conf/nginx.conf
+++ b/conf/nginx.conf
@ -1,4 +1,5 @@
-location / {
+#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
+location __PATH__/ {

  proxy_pass http://127.0.0.1:__PORT__/;
  proxy_http_version 1.1;
@ -8,5 +9,5 @@ location / {
  proxy_set_header Host $host;

  # Include SSOWAT user panel.
-  include conf.d/yunohost_panel.conf.inc;
+  #include conf.d/yunohost_panel.conf.inc;
 }
--- a/conf/systemd.service
+++ b/conf/systemd.service
@ -14,7 +14,7 @@ StartLimitInterval=60s
 StartLimitBurst=3

 # Sandboxing options to harden security
-# Depending on specificities of your service/app, you may need to tweak these 
+# Depending on specificities of your service/app, you may need to tweak these
 # .. but this should be a good baseline
 # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html
 NoNewPrivileges=yes
@ -41,7 +41,7 @@ CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM
 CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG
 CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE
 CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW
-CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG 
+CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG

 [Install]
 WantedBy=multi-user.target
--- a/doc/DESCRIPTION.md
+++ b/doc/DESCRIPTION.md
--- a/doc/DISCLAIMER.md
+++ b/doc/DISCLAIMER.md
--- a/manifest.json
+++ b/manifest.json
@ -6,7 +6,7 @@
        "en": "Web-based IRC graphical client",
        "fr": "Client graphique IRC"
    },
-    "version": "0.7~ynh3",
+    "version": "0.7~ynh4",
    "url": "https://github.com/khlieng/dispatch",
    "upstream": {
        "license": "AGPL-3.0-only",
@ -25,7 +25,7 @@
        "nginx"
    ],
    "arguments": {
-        "install" : [
+        "install": [
            {
                "name": "domain",
                "type": "domain"
--- 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

@ -13,6 +14,9 @@ source /usr/share/yunohost/helpers
 # MANAGE SCRIPT FAILURE
 #=================================================

+ynh_clean_setup () {
+	true
+}
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors

--- a/scripts/change_url
+++ b/scripts/change_url
@ -31,17 +31,18 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 port=$(ynh_app_setting_get --app=$app --key=port)

 #=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up $app before changing its URL (may take a while)..." --weight=1
+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"

-	# restore it if the upgrade fails
+	# Restore it if the upgrade fails
 	ynh_restore_upgradebackup
 }
 # Exit if an error occurs during the execution of the script
@ -70,7 +71,7 @@ fi
 #=================================================
 ynh_script_progression --message="Stopping a systemd service..." --weight=1

-ynh_systemd_action --service_name=$app --action=stop --log_path="systemd"
+ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"

 #=================================================
 # MODIFY URL IN NGINX CONF
@ -109,7 +110,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="systemd"
+ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="Listening on port"

 #=================================================
 # RELOAD NGINX
--- a/scripts/install
+++ b/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="/"
 is_public=$YNH_APP_ARG_IS_PUBLIC
-architecture=$YNH_ARCH

 app=$YNH_APP_INSTANCE_NAME

@ -63,7 +65,7 @@ ynh_app_setting_set --app=$app --key=port --value=$port
 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
@ -71,12 +73,9 @@ ynh_system_user_create --username=$app --home_dir=$final_path
 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"
-
-mkdir "$final_path/.dispatch"
-ynh_add_config --template="../conf/config.default.toml" --destination="$final_path/.dispatch/config.toml"
+ynh_setup_source --dest_dir="$final_path" --source_id="$YNH_ARCH"
+mkdir -p "$final_path/.dispatch"

 chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
@ -87,16 +86,31 @@ chown -R $app:www-data "$final_path"
 #=================================================
 ynh_script_progression --message="Configuring NGINX web server..." --weight=3

-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config

+#=================================================
+# SPECIFIC SETUP
+#=================================================
+# ADD A CONFIGURATION
+#=================================================
+ynh_script_progression --message="Adding a configuration file..."
+
+ynh_add_config --template="../conf/config.default.toml" --destination="$final_path/.dispatch/config.toml"
+
+chmod 400 "$final_path/.dispatch/config.toml"
+chown $app:$app "$final_path/.dispatch/config.toml"
+
 #=================================================
 # SETUP SYSTEMD
 #=================================================
 ynh_script_progression --message="Configuring a systemd service..." --weight=1

+# Create a dedicated systemd config
 ynh_add_systemd_config

+#=================================================
+# GENERIC FINALIZATION
 #=================================================
 # SETUP LOGROTATE
 #=================================================
@ -118,16 +132,18 @@ yunohost service add $app --description="Web-based IRC client" --log="/var/log/$
 ynh_script_progression --message="Starting a systemd service..." --weight=2

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

 #=================================================
 # SETUP SSOWAT
 #=================================================
 ynh_script_progression --message="Configuring permissions..." --weight=1

-# Make app public if necessary or protect it
+# 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

--- a/scripts/remove
+++ b/scripts/remove
@ -29,7 +29,7 @@ final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 # Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
 if ynh_exec_warn_less yunohost service status $app >/dev/null
 then
-	ynh_script_progression --message="Removing $app service..." --weight=1
+	ynh_script_progression --message="Removing $app service integration..." --weight=1
 	yunohost service remove $app
 fi

@ -52,7 +52,7 @@ ynh_remove_logrotate
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Removing $app main directory..." --weight=6
+ynh_script_progression --message="Removing app main directory..." --weight=6

 # Remove the app directory securely
 ynh_secure_remove --file="$final_path"
--- a/scripts/restore
+++ b/scripts/restore
@ -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

@ -22,7 +23,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading settings..." --weight=1
+ynh_script_progression --message="Loading installation settings..." --weight=1

 app=$YNH_APP_INSTANCE_NAME

@ -35,29 +36,23 @@ 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 configuration..." --weight=1
-
-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
 #=================================================
-ynh_script_progression --message="Restoring $app main directory..." --weight=4
+ynh_script_progression --message="Restoring the app main directory..." --weight=4

 ynh_restore_file --origin_path="$final_path"

@ -67,6 +62,13 @@ chown -R $app:www-data "$final_path"

 #=================================================
 # SPECIFIC RESTORATION
+#=================================================
+# RESTORE THE NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1
+
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+
 #=================================================
 # RESTORE SYSTEMD
 #=================================================
@ -94,7 +96,7 @@ yunohost service add $app --description="Web-based IRC client" --log="/var/log/$
 #=================================================
 ynh_script_progression --message="Starting a systemd service..." --weight=1

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

 #=================================================
 # GENERIC FINALIZATION
--- a/scripts/upgrade
+++ b/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

 #=================================================
 # CHECK VERSION
@ -29,6 +28,30 @@ ynh_script_progression --message="Checking version..."

 upgrade_type=$(ynh_check_app_version_changed)

+#=================================================
+# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
+#=================================================
+ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=4
+
+# 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
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
+#=================================================
+# STANDARD UPGRADE STEPS
+#=================================================
+# STOP SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Stopping a systemd service..." --weight=1
+
+ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd"
+
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
@ -41,36 +64,13 @@ if ynh_legacy_permissions_exists; then
 	ynh_app_setting_delete --app=$app --key=is_public
 fi

-#=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
-#=================================================
-ynh_script_progression --message="Backing up $app before upgrading (may take a while)..." --weight=4
-
-# Backup the current version of the app
-ynh_backup_before_upgrade
-ynh_clean_setup () {
-	# restore it if the upgrade fails
-	ynh_restore_upgradebackup
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# STANDARD UPGRADE STEPS
-#=================================================
-# STOP SYSTEMD SERVICE
-#=================================================
-ynh_script_progression --message="Stopping a systemd service..." --weight=1
-
-ynh_systemd_action --service_name=$app --action=stop --log_path=systemd
-
 #=================================================
 # 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
@ -81,7 +81,7 @@ then
 	ynh_script_progression --message="Upgrading source files..." --weight=5

 	# Download, check integrity, uncompress and patch the source from app.src
-	ynh_setup_source --dest_dir=$final_path --source_id="$architecture" --keep="$final_path/.dispatch/config.toml"
+	ynh_setup_source --dest_dir=$final_path --source_id="$YNH_ARCH" --keep=".dispatch/config.toml"
 fi

 chmod 750 "$final_path"
@ -93,17 +93,31 @@ chown -R $app:www-data "$final_path"
 #=================================================
 ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2

-# Create a dedicated nginx config
+# Create a dedicated NGINX config
 ynh_add_nginx_config

+#=================================================
+# SPECIFIC UPGRADE
+#=================================================
+# UPDATE A CONFIG FILE
+#=================================================
+ynh_script_progression --message="Updating a configuration file..."
+
+ynh_add_config --template="../conf/config.default.toml" --destination="$final_path/.dispatch/config.toml"
+
+chmod 400 "$final_path/.dispatch/config.toml"
+chown $app:$app "$final_path/.dispatch/config.toml"
+
 #=================================================
 # SETUP SYSTEMD
 #=================================================
-ynh_script_progression --message="Configuring a systemd service..." --weight=2
+ynh_script_progression --message="Upgrading systemd configuration..." --weight=2

 # Create a dedicated systemd config
 ynh_add_systemd_config

+#=================================================
+# GENERIC FINALIZATION
 #=================================================
 # SETUP LOGROTATE
 #=================================================
@ -124,7 +138,7 @@ yunohost service add $app --description="Web-based IRC client" --log="/var/log/$
 #=================================================
 ynh_script_progression --message="Starting a systemd service..." --weight=1

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

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