Merge pull request #130 from YunoHost-Apps/example

Apply example_ynh
2024-09-03 18:26:14 +02:00 · 2022-05-30 14:12:07 +02:00 · 2022-05-30 14:12:07 +02:00 · 05c379bb89
commit 05c379bb89
parent b8a73b88a7 bf61be6611
12 changed files with 128 additions and 115 deletions
--- a/README.md
+++ b/README.md
@ -5,7 +5,7 @@ It shall NOT be edited by hand.

 # CryptPad for YunoHost

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

 *[Lire ce readme en français.](./README_fr.md)*
@ -23,7 +23,7 @@ CryptPad is a collaboration suite that is end-to-end-encrypted and open-source.

 ## Screenshots

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

 ## Disclaimers / important information

@ -43,21 +43,22 @@ adminKeys: [

 ## Documentation and resources

-* Official app website: https://cryptpad.fr/
-* Official admin documentation: https://docs.cryptpad.fr/en/
-* Upstream app code repository: https://github.com/xwiki-labs/cryptpad
-* YunoHost documentation for this app: https://yunohost.org/app_cryptpad
-* Report a bug: https://github.com/YunoHost-Apps/cryptpad_ynh/issues
+* Official app website: <https://cryptpad.fr/>
+* Official admin documentation: <https://docs.cryptpad.fr/en/>
+* Upstream app code repository: <https://github.com/xwiki-labs/cryptpad>
+* YunoHost documentation for this app: <https://yunohost.org/app_cryptpad>
+* Report a bug: <https://github.com/YunoHost-Apps/cryptpad_ynh/issues>

 ## Developer info

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

 To try the testing branch, please proceed like that.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug
 or
 sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_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,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.
+-->
+
 # CryptPad pour YunoHost

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

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

 > *Ce package vous permet d'installer CryptPad 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.*
@ -19,7 +23,7 @@ CryptPad est une suite de collaboration chiffrée de bout en bout et open source

 ## Captures d'écran

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

 ## Avertissements / informations importantes

@ -39,21 +43,22 @@ adminKeys: [

 ## Documentations et ressources

-* Site officiel de l'app : https://cryptpad.fr/
-* Documentation officielle de l'admin : https://docs.cryptpad.fr/en/
-* Dépôt de code officiel de l'app : https://github.com/xwiki-labs/cryptpad
-* Documentation YunoHost pour cette app : https://yunohost.org/app_cryptpad
-* Signaler un bug : https://github.com/YunoHost-Apps/cryptpad_ynh/issues
+* Site officiel de l'app : <https://cryptpad.fr/>
+* Documentation officielle de l'admin : <https://docs.cryptpad.fr/en/>
+* Dépôt de code officiel de l'app : <https://github.com/xwiki-labs/cryptpad>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_cryptpad>
+* Signaler un bug : <https://github.com/YunoHost-Apps/cryptpad_ynh/issues>

 ## Informations pour les développeurs

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

 Pour essayer la branche testing, procédez comme suit.
-```
+
+``` bash
 sudo yunohost app install https://github.com/YunoHost-Apps/cryptpad_ynh/tree/testing --debug
 ou
 sudo yunohost app upgrade cryptpad -u https://github.com/YunoHost-Apps/cryptpad_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/6
+++ b/6
@ -1,9 +1,8 @@
-;; Nom du test
-	auto_remove=1
+;; Test complet
 	; Manifest
 		domain="domain.tld"
+		is_public=1
 		admin="john"
-		is_public="1"
 	; Checks
 		pkg_linter=1
 		setup_sub_dir=0
@ -16,6 +15,7 @@
 		upgrade=1	from_commit=2a54cd03f90c93b07150a64644ffc7f208110a18
 		backup_restore=1
 		multi_instance=0
+		port_already_use=0
 		change_url=1
 ;;; Options
 Email=
--- a/conf/app.src
+++ b/conf/app.src
@ -4,3 +4,4 @@ SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=tar.gz
 SOURCE_IN_SUBDIR=true
 SOURCE_FILENAME=cryptpad.tar.gz
+SOURCE_EXTRACT=true
--- 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_redirect    off;
--- a/manifest.json
+++ b/manifest.json
@ -38,10 +38,6 @@
                    "fr": "CryptPad doit être installé dans un domaine ou sous-domaine dédié."
                }
            },
-            {
-                "name": "admin",
-                "type": "user"
-            },
            {
                "name": "is_public",
                "type": "boolean",
@ -50,6 +46,10 @@
                    "fr": "Si cette case est cochée, CryptPad sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin."
                },
                "default": true
+            },
+            {
+                "name": "admin",
+                "type": "user"
            }
        ]
    }
--- 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

@ -14,7 +15,7 @@ source /usr/share/yunohost/helpers
 #=================================================

 ynh_clean_setup () {
-	ynh_clean_check_starting
+	true
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@ -22,11 +23,12 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
+ynh_print_info --message="Loading installation settings..."

 app=$YNH_APP_INSTANCE_NAME

-domain=$(ynh_app_setting_get --app=$app --key=domain)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+domain=$(ynh_app_setting_get --app=$app --key=domain)

 #=================================================
 # DECLARE DATA AND CONF FILES TO BACKUP
--- a/scripts/change_url
+++ b/scripts/change_url
@ -30,17 +30,18 @@ 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=2

 # 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
@ -69,7 +70,7 @@ fi
 #=================================================
 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"
+ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"

 #=================================================
 # MODIFY URL IN NGINX CONF
@ -107,7 +108,7 @@ fi
 #=================================================
 ynh_script_progression --message="Starting a systemd service..." --weight=1

-ynh_systemd_action --service_name=$app --action=start --log_path=systemd --line_match="server available"
+ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="server available"

 #=================================================
 # RELOAD NGINX
--- a/scripts/install
+++ b/scripts/install
@ -1,7 +1,7 @@
 #!/bin/bash

 #=================================================
-# GENERIC STARTING
+# GENERIC START
 #=================================================
 # IMPORT GENERIC HELPERS
 #=================================================
@ -10,7 +10,7 @@ source _common.sh
 source /usr/share/yunohost/helpers

 #=================================================
-# MANAGE FAILURE OF THE SCRIPT
+# MANAGE SCRIPT FAILURE
 #=================================================

 ynh_clean_setup () {
@ -24,20 +24,20 @@ ynh_abort_if_errors
 #=================================================

 domain=$YNH_APP_ARG_DOMAIN
-is_public=$YNH_APP_ARG_IS_PUBLIC
 path_url="/"
+is_public=$YNH_APP_ARG_IS_PUBLIC
 admin=$YNH_APP_ARG_ADMIN
 email=$(ynh_user_get_info --username=$admin --key=mail)

 app=$YNH_APP_INSTANCE_NAME

 #=================================================
-# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS
+# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
 #=================================================
 ynh_script_progression --message="Validating installation parameters..." --weight=1

 final_path=/var/www/$app
-test ! -e "$final_path" || ynh_die "This path already contains a folder"
+test ! -e "$final_path" || ynh_die --message="This path already contains a folder"

 # Register (book) web path
 ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
@ -45,9 +45,10 @@ ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
+ynh_script_progression --message="Storing installation settings..."

 ynh_app_setting_set --app=$app --key=domain --value=$domain
-ynh_app_setting_set --app=$app --key=path_url --value=$path_url
+ynh_app_setting_set --app=$app --key=path --value=$path_url
 ynh_app_setting_set --app=$app --key=admin --value=$admin

 #=================================================
@ -66,11 +67,10 @@ porti=$(ynh_find_port --port=$(($port + 1)))
 ynh_app_setting_set --app=$app --key=porti --value=$porti

 #=================================================
-# INSTALL NODEJS & YARN
+# INSTALL DEPENDENCIES
 #=================================================
 ynh_script_progression --message="Installing dependencies..." --weight=20

-# Install Nodejs
 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version

 #=================================================
@ -102,22 +102,25 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=1
 # Create a dedicated NGINX config
 ynh_add_nginx_config

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

 env_path="$PATH"
+# Create a dedicated systemd config
 ynh_add_systemd_config

-#=================================================
-# CONFIGURE CONFIG.JS	
-#=================================================
-
-ynh_add_config --template="../conf/config.js" --destination="$final_path/config/config.js"
-chmod 600 "$final_path/config/config.js"
-chown $app "$final_path/config/config.js"
-
 #=================================================
 # INSTALL CRYPTPAD
 #=================================================
@ -130,6 +133,8 @@ pushd "$final_path"
 	ynh_exec_warn_less bower install --allow-root
 popd

+#=================================================
+# GENERIC FINALIZATION
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
 #=================================================
@ -143,7 +148,7 @@ yunohost service add $app --description="Zero Knowledge realtime collaborative e
 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="server available"
+ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --line_match="server available"

 #=================================================
 # SETUP SSOWAT
--- a/scripts/remove
+++ b/scripts/remove
@ -1,7 +1,7 @@
 #!/bin/bash

 #=================================================
-# GENERIC STARTING
+# GENERIC START
 #=================================================
 # IMPORT GENERIC HELPERS
 #=================================================
@ -16,8 +16,8 @@ ynh_script_progression --message="Loading installation settings..." --weight=1

 app=$YNH_APP_INSTANCE_NAME

-port=$(ynh_app_setting_get --app=$app --key=port)
 domain=$(ynh_app_setting_get --app=$app --key=domain)
+port=$(ynh_app_setting_get --app=$app --key=port)
 final_path=$(ynh_app_setting_get --app=$app --key=final_path)

 #=================================================
@ -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=3
+	ynh_script_progression --message="Removing $app service integration..." --weight=3
 	yunohost service remove $app
 fi

@ -41,17 +41,10 @@ ynh_script_progression --message="Stopping and removing the systemd service..."
 # Remove the dedicated systemd config
 ynh_remove_systemd_config

-#=================================================
-# REMOVE NODEJS
-#=================================================
-ynh_script_progression --message="Removing dependencies..." --weight=3
-
-ynh_remove_nodejs
-
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Removing $app main directory..." --weight=3
+ynh_script_progression --message="Removing app main directory..." --weight=3

 # Remove the app directory securely
 ynh_secure_remove --file="$final_path"
@ -64,6 +57,13 @@ 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=3
+
+ynh_remove_nodejs
+
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
--- a/scripts/restore
+++ b/scripts/restore
@ -6,7 +6,7 @@
 # IMPORT GENERIC HELPERS
 #=================================================

-#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
+# 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

@ -44,6 +44,7 @@ test ! -d $final_path \
 #=================================================
 # 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"

@ -58,11 +59,10 @@ ynh_system_user_create --username=$app --home_dir="$final_path"
 #=================================================
 # RESTORE THE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Restoring CryptPad main directory..." --weight=6
+ynh_script_progression --message="Restoring the app main directory..." --weight=6

 ynh_restore_file --origin_path="$final_path"

-# Restore permissions on app files
 chmod 750 "$final_path"
 chmod -R o-rwx "$final_path"
 chown -R $app:$app "$final_path"
@ -73,7 +73,7 @@ chmod 600 "$final_path/config/config.js"
 #=================================================
 ynh_script_progression --message="Reinstalling dependencies..." --weight=7

-# Install Nodejs
+# Define and install dependencies
 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version

 #=================================================
@ -96,7 +96,7 @@ yunohost service add $app --description="Zero Knowledge realtime collaborative e
 #=================================================
 ynh_script_progression --message="Starting a systemd service..." --weight=1

-ynh_systemd_action --service_name=$app --action=start --log_path=systemd --line_match="server available"
+ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="server available"

 #=================================================
 # GENERIC FINALIZATION
--- a/scripts/upgrade
+++ b/scripts/upgrade
@ -1,7 +1,7 @@
 #!/bin/bash

 #=================================================
-# GENERIC STARTING
+# GENERIC START
 #=================================================
 # IMPORT GENERIC HELPERS
 #=================================================
@ -17,9 +17,9 @@ ynh_script_progression --message="Loading installation settings..." --weight=1
 app=$YNH_APP_INSTANCE_NAME

 domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path_url)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+path_url=$(ynh_app_setting_get --app=$app --key=path)
 admin=$(ynh_app_setting_get --app=$app --key=admin)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
 email=$(ynh_user_get_info --username=$admin --key=mail)
 port=$(ynh_app_setting_get --app=$app --key=port)
 porti=$(ynh_app_setting_get --app=$app --key=porti)
@ -27,9 +27,34 @@ porti=$(ynh_app_setting_get --app=$app --key=porti)
 #=================================================
 # CHECK VERSION
 #=================================================
+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=1
+
+# 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="/var/log/$app/$app.log"
+
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
@ -48,29 +73,6 @@ 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 the app before upgrading (may take a while)..." --weight=1
-
-# 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="/var/log/$app/$app.log"
-
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
@ -104,19 +106,12 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." -
 ynh_add_nginx_config

 #=================================================
-# INSTALL NODEJS
+# UPGRADE DEPENDENCIES
 #=================================================
 ynh_script_progression --message="Upgrading dependencies..." --weight=6

-# Install Nodejs
 ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version

-#=================================================
-# CONFIGURE CONFIG.JS	
-#=================================================
-
-#ynh_add_config --template="../conf/config.js" --destination="$final_path/config/config.js"
-
 #=================================================
 # INSTALL CRYPTPAD
 #=================================================
@ -138,6 +133,8 @@ env_path="$PATH"
 # Create a dedicated systemd config
 ynh_add_systemd_config

+#=================================================
+# GENERIC FINALIZATION
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
 #=================================================
@ -150,7 +147,7 @@ yunohost service add $app --description="Zero Knowledge realtime collaborative e
 #=================================================
 ynh_script_progression --message="Starting a systemd service..." --weight=1

-ynh_systemd_action --service_name=$app --action=start --log_path=systemd --line_match="server available"
+ynh_systemd_action --service_name=$app --action="start" --log_path=systemd --line_match="server available"

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