wip: only save data/ repo

.github/workflows/updater.sh

@@ -0,0 +1,106 @@
+#!/bin/bash
+
+#=================================================
+# PACKAGE UPDATING HELPER
+#=================================================
+
+# This script is meant to be run by GitHub Actions
+# The YunoHost-Apps organisation offers a template Action to run this script periodically
+# Since each app is different, maintainers can adapt its contents so as to perform
+# automatic actions when a new upstream release is detected.
+
+#=================================================
+# FETCHING LATEST RELEASE AND ITS ASSETS
+#=================================================
+
+# Fetching information
+current_version=$(cat manifest.json | jq -j '.version|split("~")[0]')
+repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]')
+# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions)
+version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1)
+declare -A assets=([app]="https://github.com/$repo/archive/refs/tags/$version.tar.gz" [dist]="https://github.com/$repo/releases/download/$version/dist.tar.gz")
+
+# Later down the script, we assume the version has only digits and dots
+# Sometimes the release name starts with a "v", so let's filter it out.
+# You may need more tweaks here if the upstream repository has different naming conventions. 
+if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then
+    version=${version:1}
+fi
+
+# Setting up the environment variables
+echo "Current version: $current_version"
+echo "Latest release from upstream: $version"
+echo "VERSION=$version" >> $GITHUB_ENV
+# For the time being, let's assume the script will fail
+echo "PROCEED=false" >> $GITHUB_ENV
+
+# Proceed only if the retrieved version is greater than the current one
+if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then
+    echo "::warning ::No new version available"
+    exit 0
+# Proceed only if a PR for this new version does not already exist
+elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then
+    echo "::warning ::A branch already exists for this update"
+    exit 0
+fi
+
+#=================================================
+# UPDATE SOURCE FILES
+#=================================================
+
+for src in app dist; do
+    # Let's download source tarball
+    asset_url="${assets[$src]}"
+    echo "Handling asset at $asset_url"
+
+    # Create the temporary directory
+    tempdir="$(mktemp -d)"
+
+    # Download sources and calculate checksum
+    filename=${asset_url##*/}
+    curl --silent -4 -L $asset_url -o "$tempdir/$filename"
+    checksum=$(sha256sum "$tempdir/$filename" | head -c 64)
+
+    # Delete temporary directory
+    rm -rf $tempdir
+
+    # Get extension
+    if [[ $filename == *.tar.gz ]]; then
+        extension=tar.gz
+    else
+        extension=${filename##*.}
+    fi
+
+    # Rewrite source file
+    cat <<EOT > conf/$src.src
+SOURCE_URL=$asset_url
+SOURCE_SUM=$checksum
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FORMAT=$extension
+SOURCE_IN_SUBDIR=true
+SOURCE_FILENAME=$filename
+SOURCE_EXTRACT=true
+EOT
+    echo "... conf/$src.src updated"
+done
+
+#
+#=================================================
+# SPECIFIC UPDATE STEPS
+#=================================================
+
+# Any action on the app's source code can be done.
+# The GitHub Action workflow takes care of committing all changes after this script ends.
+
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+
+# Replace new version in manifest
+echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json
+
+# No need to update the README, yunohost-bot takes care of it
+
+# The Action will proceed only if the PROCEED environment variable is set to true
+echo "PROCEED=true" >> $GITHUB_ENV
+exit 0

.github/workflows/updater.yml

@@ -0,0 +1,49 @@
+# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected.
+# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization.
+# This file should be enough by itself, but feel free to tune it to your needs.
+# It calls updater.sh, which is where you should put the app-specific update steps.
+name: Check for new upstream releases
+on:
+  # Allow to manually trigger the workflow
+  workflow_dispatch:
+  # Run it every day at 6:00 UTC
+  schedule:
+    - cron:  '0 6 * * *'
+jobs:
+  updater:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch the source code
+        uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Run the updater script
+        id: run_updater
+        run: |
+          # Setting up Git user
+          git config --global user.name 'yunohost-bot'
+          git config --global user.email 'yunohost-bot@users.noreply.github.com'
+          # Run the updater script
+          /bin/bash .github/workflows/updater.sh
+      - name: Commit changes
+        id: commit
+        if: ${{ env.PROCEED == 'true' }}
+        run: |
+          git commit -am "Upgrade to v$VERSION"
+      - name: Create Pull Request
+        id: cpr
+        if: ${{ env.PROCEED == 'true' }}
+        uses: peter-evans/create-pull-request@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update to version ${{ env.VERSION }}
+          committer: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
+          author: 'yunohost-bot <yunohost-bot@users.noreply.github.com>'
+          signoff: false
+          base: testing
+          branch: ci-auto-update-v${{ env.VERSION }}
+          delete-branch: true
+          title: 'Upgrade to version ${{ env.VERSION }}'
+          body: |
+            Upgrade to v${{ env.VERSION }}
+          draft: false

README.md

@@ -16,20 +16,21 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
 
 ## Overview
 
-Uptime Kuma is a self-hosted monitoring tool like "Uptime Robot".
+It is a self-hosted monitoring tool like "Uptime Robot".
 
 ### Features
 
 - Monitoring uptime for HTTP(s) / TCP / Ping / DNS Record / Push.
-- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP)...
+- Fancy, Reactive, Fast UI/UX.
-- 20 second intervals
+- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 70+ notification services, click here for the full list.
+- 20 second intervals.
 - Multi Languages
 - Simple Status Page
 - Ping Chart
 - Certificate Info
 
 
-**Shipped version:** 1.23.10~ynh1
+**Shipped version:** 1.20.1~ynh1
 
 **Demo:** https://demo.uptime.kuma.pet
 
@@ -37,12 +38,22 @@ Uptime Kuma is a self-hosted monitoring tool like "Uptime Robot".
 
 ![Screenshot of Uptime Kuma](./doc/screenshots/example.jpg)
 
+## Disclaimers / important information
+
+- Requires a full dedicated domain
+- node_modules folder is backed up and shouldn't be (600Mo...)
+- ARM architecture not supported
+- This app needs a manual post-install
+- Uses N to install specific nodejs version
+- We could pre-configure mail notifications with YunoHost mail server as an improvement. See comments in file to try to do it with Curl and WebSockets or Sqlite.
+
 ## Documentation and resources
 
 * Official app website: <https://uptime.kuma.pet/>
 * Official user documentation: <https://github.com/louislam/uptime-kuma/wiki>
+* Official admin documentation: <https://github.com/louislam/uptime-kuma/wiki>
 * Upstream app code repository: <https://github.com/louislam/uptime-kuma>
-* YunoHost Store: <https://apps.yunohost.org/app/uptime-kuma>
+* YunoHost documentation for this app: <https://yunohost.org/app_uptime-kuma>
 * Report a bug: <https://github.com/YunoHost-Apps/uptime-kuma_ynh/issues>
 
 ## Developer info

README_fr.md

@@ -16,19 +16,21 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
 
 ## Vue d’ensemble
 
-Uptime Kuma est un outil de surveillance auto-hébergé comme « Uptime Robot ».
+It is a self-hosted monitoring tool like "Uptime Robot".
 
-### Caractéristiques
+### Features
 
-- Surveillance de la disponibilité pour HTTP(s) / TCP / Ping / DNS Record / Push.
+- Monitoring uptime for HTTP(s) / TCP / Ping / DNS Record / Push.
-- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP)...
+- Fancy, Reactive, Fast UI/UX.
-- intervalles de 20 secondes
+- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 70+ notification services, click here for the full list.
-- Multi langues
+- 20 second intervals.
-- Page d'état simple
+- Multi Languages
-- Graphique Ping
+- Simple Status Page
-- Informations sur le certificat
+- Ping Chart
+- Certificate Info
 
-**Version incluse :** 1.23.10~ynh1
+
+**Version incluse :** 1.20.1~ynh1
 
 **Démo :** https://demo.uptime.kuma.pet
 
@@ -36,12 +38,22 @@ Uptime Kuma est un outil de surveillance auto-hébergé comme « Uptime Robot »
 
 ![Capture d’écran de Uptime Kuma](./doc/screenshots/example.jpg)
 
+## Avertissements / informations importantes
+
+- Requires a full dedicated domain
+- node_modules folder is backed up and shouldn't be (600Mo...)
+- ARM architecture not supported
+- This app needs a manual post-install
+- Uses N to install specific nodejs version
+- We could pre-configure mail notifications with YunoHost mail server as an improvement. See comments in file to try to do it with Curl and WebSockets or Sqlite.
+
 ## Documentations et ressources
 
 * Site officiel de l’app : <https://uptime.kuma.pet/>
 * Documentation officielle utilisateur : <https://github.com/louislam/uptime-kuma/wiki>
+* Documentation officielle de l’admin : <https://github.com/louislam/uptime-kuma/wiki>
 * Dépôt de code officiel de l’app : <https://github.com/louislam/uptime-kuma>
-* YunoHost Store: <https://apps.yunohost.org/app/uptime-kuma>
+* Documentation YunoHost pour cette app : <https://yunohost.org/app_uptime-kuma>
 * Signaler un bug : <https://github.com/YunoHost-Apps/uptime-kuma_ynh/issues>
 
 ## Informations pour les développeurs

check_process

@@ -0,0 +1,29 @@
+# See here for more information
+# https://github.com/YunoHost/package_check#syntax-check_process-file
+
+# Move this file from check_process.default to check_process when you have filled it.
+
+;; Test complet
+	; Manifest
+		domain="domain.tld"
+		path="/"
+		is_public=1
+	; Checks
+		pkg_linter=1
+		setup_sub_dir=0
+		setup_root=1
+		setup_nourl=0
+		setup_private=1
+		setup_public=1
+		upgrade=1
+		upgrade=1	from_commit=2e870313227801603a41fd3bfcaafa912dce6d0a
+		backup_restore=1
+		multi_instance=1
+		change_url=1
+;;; Options
+Email=
+Notification=none
+;;; Upgrade options
+	; commit=2e870313227801603a41fd3bfcaafa912dce6d0a
+		name="fix restore.."
+		manifest_arg=domain=domain.td&path=/&is_public=1&port=666&

conf/app.src

@@ -0,0 +1,7 @@
+SOURCE_URL=https://github.com/louislam/uptime-kuma/archive/refs/tags/1.20.1.tar.gz
+SOURCE_SUM=c1125217d17538899842f640e9b00db6979854552858d79a5e05a64e5cda3b26
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FORMAT=tar.gz
+SOURCE_IN_SUBDIR=true
+SOURCE_FILENAME=1.20.1.tar.gz
+SOURCE_EXTRACT=true

conf/dist.src

@@ -0,0 +1,7 @@
+SOURCE_URL=https://github.com/louislam/uptime-kuma/releases/download/1.20.1/dist.tar.gz
+SOURCE_SUM=1683a8e86c05cab905cd7efa41089d072dd60dc1d695c3f0761f9c8de86f4fb8
+SOURCE_SUM_PRG=sha256sum
+SOURCE_FORMAT=tar.gz
+SOURCE_IN_SUBDIR=true
+SOURCE_FILENAME=dist.tar.gz
+SOURCE_EXTRACT=true

conf/nginx.conf

@@ -1,7 +1,14 @@
-#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
 location __PATH__/ {
 
-    proxy_pass http://127.0.0.1:__PORT__;
+  # Path to source
+ # alias __FINALPATH__/ ;
+
+  # Force usage of https
+  if ($scheme = http) {
+    rewrite ^ https://$server_name$request_uri? permanent;
+  }
+
+    proxy_pass http://localhost:__PORT__;
     # https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy#nginx
     # proxy_set_header   X-Real-IP $remote_addr;
     # proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -9,9 +16,10 @@ location __PATH__/ {
     proxy_set_header   Upgrade $http_upgrade;
     proxy_set_header   Connection "upgrade";
     
-    # Common parameter to increase upload size limit
+  # Common parameter to increase upload size limit
-    #client_max_body_size 50M;
+  #client_max_body_size 50M;
 
-    # Include SSOWAT user panel.
+
-    include conf.d/yunohost_panel.conf.inc;
+  # Include SSOWAT user panel.
+  include conf.d/yunohost_panel.conf.inc;
 }

conf/systemd.service

@@ -1,5 +1,5 @@
 [Unit]
-Description=Uptime Kuma: monitoring tool
+Description=Uptime Kuma, a fancy monitoring tool
 After=network.target
 
 [Service]
@@ -7,8 +7,7 @@ Type=simple
 Restart=always
 User=__APP__
 Group=__APP__
-WorkingDirectory=__INSTALL_DIR__/
+WorkingDirectory=__FINALPATH__/
-Environment="NODE_ENV=production"
 ExecStart=__YNH_NODE__ server/server.js --port=__PORT__
 StandardOutput=append:/var/log/__APP__/__APP__.log
 StandardError=inherit

doc/DESCRIPTION.md

@@ -1,10 +1,11 @@
-Uptime Kuma is a self-hosted monitoring tool like "Uptime Robot".
+It is a self-hosted monitoring tool like "Uptime Robot".
 
 ### Features
 
 - Monitoring uptime for HTTP(s) / TCP / Ping / DNS Record / Push.
-- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP)...
+- Fancy, Reactive, Fast UI/UX.
-- 20 second intervals
+- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and 70+ notification services, click here for the full list.
+- 20 second intervals.
 - Multi Languages
 - Simple Status Page
 - Ping Chart

doc/DESCRIPTION_fr.md

@@ -1,11 +0,0 @@
-Uptime Kuma est un outil de surveillance auto-hébergé comme « Uptime Robot ».
-
-### Caractéristiques
-
-- Surveillance de la disponibilité pour HTTP(s) / TCP / Ping / DNS Record / Push.
-- Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP)...
-- intervalles de 20 secondes
-- Multi langues
-- Page d'état simple
-- Graphique Ping
-- Informations sur le certificat

doc/DISCLAIMER.md

@@ -1,3 +1,6 @@
+- Requires a full dedicated domain
 - node_modules folder is backed up and shouldn't be (600Mo...)
+- ARM architecture not supported
 - This app needs a manual post-install
+- Uses N to install specific nodejs version
 - We could pre-configure mail notifications with YunoHost mail server as an improvement. See comments in file to try to do it with Curl and WebSockets or Sqlite.

manifest.json

@@ -0,0 +1,52 @@
+{
+    "name": "Uptime Kuma",
+    "id": "uptime-kuma",
+    "packaging_format": 1,
+    "description": {
+        "en": "Self-hosted monitoring tool like Uptime-Robot",
+        "fr": "Outil de surveillance auto-hébergé similaire à Uptime-Robot"
+    },
+    "version": "1.20.1~ynh1",
+    "url": "https://github.com/louislam/uptime-kuma/",
+    "upstream": {
+        "license": "MIT",
+        "website": "https://uptime.kuma.pet/",
+        "demo": "https://demo.uptime.kuma.pet",
+        "admindoc": "https://github.com/louislam/uptime-kuma/wiki",
+        "userdoc": "https://github.com/louislam/uptime-kuma/wiki",
+        "code": "https://github.com/louislam/uptime-kuma"
+    },
+    "license": "MIT",
+    "maintainer": {
+        "name": "Hadrien",
+        "email": "ketsapiwiq@protonmail.com"
+    },
+    "requirements": {
+        "yunohost": ">= 4.2.3"
+    },
+    "multi_instance": true,
+    "services": [
+        "nginx"
+    ],
+    "arguments": {
+        "install": [
+            {
+                "name": "domain",
+                "type": "domain",
+                "help": {
+                    "en": "This app requires a whole subdomain",
+                    "fr": "Cette app a besoin de tout un sous-domaine à elle toute seule."
+                }
+            },
+            {
+                "name": "is_public",
+                "type": "boolean",
+                "default": true,
+                "help": {
+                    "en": "This app has a status page meant to be public and a login-protected admin interface. It should be safe to expose publicly.",
+                    "fr": "Cette app a une page destinée à être publique et une interface d'admin protégée par mot de passe. Elle peut être exposée publiquement sans problème."
+                }
+            }
+        ]
+    }
+}

manifest.toml

@@ -1,64 +0,0 @@
-packaging_format = 2
-
-id = "uptime-kuma"
-name = "Uptime Kuma"
-description.en = "Monitoring tool like Uptime-Robot"
-description.fr = "Outil de surveillance similaire à Uptime-Robot"
-
-version = "1.23.10~ynh1"
-
-maintainers = ["ketsapiwiq", "eric_G"]
-
-[upstream]
-license = "MIT"
-website = "https://uptime.kuma.pet/"
-demo = "https://demo.uptime.kuma.pet"
-userdoc = "https://github.com/louislam/uptime-kuma/wiki"
-code = "https://github.com/louislam/uptime-kuma"
-
-[integration]
-yunohost = ">= 11.2"
-architectures = "all"
-multi_instance = true
-ldap = false
-sso = false
-disk = "50M"
-ram.build = "900M"
-ram.runtime = "50M"
-
-[install]
-    [install.domain]
-    type = "domain"
-
-    [install.init_main_permission]
-    help.en = "This app has a status page meant to be public and a login-protected admin interface. It should be safe to expose publicly."
-    help.fr = "Cette app a une page destinée à être publique et une interface d'admin protégée par mot de passe. Elle peut être exposée publiquement sans problème."
-    type = "group"
-    default = "visitors"
-
-[resources]
-    [resources.sources]
-        [resources.sources.dist]
-        url = "https://github.com/louislam/uptime-kuma/releases/download/1.23.10/dist.tar.gz"
-        sha256 = "fbb1442b9ef86293e8ebe2586545f5b7677c579222e65a9a740723e3dac47745"
-        autoupdate.strategy = "latest_github_release"
-        autoupdate.asset = "dist.tar.gz"
-
-        [resources.sources.main]
-        url = "https://github.com/louislam/uptime-kuma/archive/refs/tags/1.23.10.tar.gz"
-        sha256 = "77c2b2d0dc7f9ca956514c2ba5ccb67bee00dcae3e3c2f1ac1058a2ab17d585e"
-        autoupdate.strategy = "latest_github_release"
-        autoupdate.asset = "tarball"
-
-    [resources.ports]
-
-    [resources.system_user]
-
-    [resources.install_dir]
-
-    [resources.permissions]
-    main.url = "/"
-    api.url = "/api"
-    api.allowed = "visitors"
-    api.show_tile = false
-    api.protected = true

scripts/_common.sh

@@ -4,7 +4,7 @@
 # COMMON VARIABLES
 #=================================================
 
-nodejs_version=18
+nodejs_version=14
 
 #=================================================
 # PERSONAL HELPERS

scripts/backup

@@ -10,16 +10,37 @@
 source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+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
+ynh_abort_if_errors
+
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_print_info --message="Loading installation settings..."
+
+app=$YNH_APP_INSTANCE_NAME
+
+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
 #=================================================
 ynh_print_info --message="Declaring files to be backed up..."
 
 #=================================================
-# BACKUP THE APP MAIN DIR
+# BACKUP THE APP DATA DIRS
 #=================================================
 
-ynh_backup --src_path="$install_dir" --is_big
+ynh_backup --src_path="$final_path/data" --is_big
 
 #=================================================
 # BACKUP THE NGINX CONFIGURATION
@@ -45,6 +66,8 @@ ynh_backup --src_path="/etc/systemd/system/$app.service"
 # BACKUP VARIOUS FILES
 #=================================================
 
+# ynh_backup --src_path="/etc/cron.d/$app"
+
 ynh_backup --src_path="/var/log/$app/"
 
 #=================================================

scripts/change_url

@@ -9,6 +9,59 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
+#=================================================
+# RETRIEVE ARGUMENTS
+#=================================================
+
+old_domain=$YNH_APP_OLD_DOMAIN
+old_path=$YNH_APP_OLD_PATH
+
+new_domain=$YNH_APP_NEW_DOMAIN
+new_path=$YNH_APP_NEW_PATH
+
+app=$YNH_APP_INSTANCE_NAME
+
+#=================================================
+# LOAD SETTINGS
+#=================================================
+ynh_script_progression --message="Loading installation settings..." --weight=1
+
+# Needed for helper "ynh_add_nginx_config"
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+
+#=================================================
+# 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 () {
+	# 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
+	ynh_restore_upgradebackup
+}
+# Exit if an error occurs during the execution of the script
+ynh_abort_if_errors
+
+#=================================================
+# CHECK WHICH PARTS SHOULD BE CHANGED
+#=================================================
+
+change_domain=0
+if [ "$old_domain" != "$new_domain" ]
+then
+	change_domain=1
+fi
+
+change_path=0
+if [ "$old_path" != "$new_path" ]
+then
+	change_path=1
+fi
+
 #=================================================
 # STANDARD MODIFICATIONS
 #=================================================
@@ -23,7 +76,29 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app
 #=================================================
 ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1
 
-ynh_change_url_nginx_config
+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
+	# Delete file checksum for the old conf file location
+	ynh_delete_file_checksum --file="$nginx_conf_path"
+	mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
+	# Store file checksum for the new config file location
+	ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
+fi
 
 #=================================================
 # GENERIC FINALISATION
@@ -34,6 +109,13 @@ 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"
 
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading NGINX web server..." --weight=1
+
+ynh_systemd_action --service_name=nginx --action=reload
+
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/install

@@ -9,6 +9,58 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
+#=================================================
+# MANAGE SCRIPT FAILURE
+#=================================================
+
+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
+ynh_abort_if_errors
+
+#=================================================
+# RETRIEVE ARGUMENTS FROM THE MANIFEST
+#=================================================
+
+path_url=/
+domain=$YNH_APP_ARG_DOMAIN
+is_public=$YNH_APP_ARG_IS_PUBLIC
+
+app=$YNH_APP_INSTANCE_NAME
+
+#=================================================
+# 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 --message="This path already contains a folder"
+
+# Register (book) web path
+ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
+
+#=================================================
+# STORE SETTINGS FROM MANIFEST
+#=================================================
+ynh_script_progression --message="Storing installation settings..." --weight=1
+
+# Subpath not supported
+ynh_app_setting_set --app=$app --key=path --value=$path_url
+ynh_app_setting_set --app=$app --key=domain --value=$domain
+
+#=================================================
+# STANDARD MODIFICATIONS
+#=================================================
+# FIND AND OPEN A PORT
+#=================================================
+ynh_script_progression --message="Finding an available port..." --weight=1
+
+# Find an available port
+port=$(ynh_find_port --port=3001)
+ynh_app_setting_set --app=$app --key=port --value=$port
+
 #=================================================
 # INSTALL NODEJS
 #=================================================
@@ -16,55 +68,101 @@ ynh_script_progression --message="Installing nodejs..." --weight=2
 
 ynh_install_nodejs --nodejs_version=$nodejs_version
 
+ynh_use_nodejs
+
+#=================================================
+# 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
 #=================================================
 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="$install_dir"
+ynh_setup_source --dest_dir="$final_path"
-
 # Download, check integrity, uncompress and patch the source from dist.src
-ynh_setup_source --dest_dir="$install_dir/dist" --source_id="dist"
+ynh_setup_source --source_id="dist" --dest_dir="$final_path/dist"
 
-chmod -R o-rwx "$install_dir"
+chmod 750 "$final_path"
-chown -R $app:www-data "$install_dir"
+chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$final_path"
 
 #=================================================
-# SYSTEM CONFIGURATION
+# NGINX CONFIGURATION
 #=================================================
-ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
+ynh_script_progression --message="Configuring NGINX web server..." --weight=1
 
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
-# Create a dedicated systemd config
-ynh_add_systemd_config
-
-# Use logrotate to manage application logfile(s)
-ynh_use_logrotate
-
-yunohost service add $app --description="Monitoring tool" --log="/var/log/$app/$app.log"
-
 #=================================================
 # SPECIFIC SETUP
 #=================================================
-ynh_script_progression --message="Installing $app dependencies..." --weight=7
+ynh_script_progression --message="Installing Uptime Kuma dependencies..." --weight=7
 
-pushd "$install_dir"
+pushd "$final_path"
-	ynh_use_nodejs
+	ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH $ynh_npm install
-	ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH $ynh_npm install --production
-	ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH $ynh_npm run download-dist
 popd
 
+#=================================================
+# 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
+#=================================================
+ynh_script_progression --message="Configuring log rotation..." --weight=1
+
+# Use logrotate to manage application logfile(s)
+ynh_use_logrotate
+
 #=================================================
 # INTEGRATE SERVICE IN YUNOHOST
 #=================================================
 ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
 
+yunohost service add $app --description="Uptime Kuma, a fancy monitoring tool" --log="/var/log/$app/$app.log"
+
+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+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"
 
+#=================================================
+# SETUP SSOWAT
+#=================================================
+ynh_script_progression --message="Configuring permissions..." --weight=1
+
+# Make app public if necessary
+if [ $is_public -eq 1 ]
+then
+	ynh_permission_update --permission="main" --add="visitors"
+fi
+
+ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --show_tile="false" --protected="true"
+
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading NGINX web server..." --weight=1
+
+ynh_systemd_action --service_name=nginx --action=reload
+
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/remove

@@ -10,11 +10,21 @@ source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
-# REMOVE SYSTEM CONFIGURATIONS
+# LOAD SETTINGS
 #=================================================
-# REMOVE SYSTEMD SERVICE 
+ynh_script_progression --message="Loading installation settings..." --weight=1
+
+app=$YNH_APP_INSTANCE_NAME
+
+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)
+
+#=================================================
+# STANDARD REMOVE
+#=================================================
+# REMOVE SERVICE INTEGRATION IN YUNOHOST
 #=================================================
-ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
 
 # 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
@@ -23,20 +33,65 @@ then
 	yunohost service remove $app
 fi
 
+#=================================================
+# STOP AND REMOVE SERVICE
+#=================================================
+ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1
+
 # Remove the dedicated systemd config
 ynh_remove_systemd_config
 
+#=================================================
+# REMOVE LOGROTATE CONFIGURATION
+#=================================================
+ynh_script_progression --message="Removing logrotate configuration..." --weight=1
+
 # Remove the app-specific logrotate config
 ynh_remove_logrotate
 
+#=================================================
+# REMOVE NODEJS
+#=================================================
+ynh_script_progression --message="Removing nodejs version..." --weight=1
+
 ynh_remove_nodejs
 
+#=================================================
+# REMOVE APP MAIN DIR
+#=================================================
+ynh_script_progression --message="Removing app main directory and dependencies..." --weight=2
+
+# Remove the app directory securely
+ynh_secure_remove --file="$final_path"
+
+#=================================================
+# REMOVE NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
+
 # Remove the dedicated NGINX config
 ynh_remove_nginx_config
 
+#=================================================
+# SPECIFIC REMOVE
+#=================================================
+# REMOVE VARIOUS FILES
+#=================================================
+ynh_script_progression --message="Removing various files..." --weight=1
+
 # Remove the log files
 ynh_secure_remove --file="/var/log/$app"
 
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+# REMOVE DEDICATED USER
+#=================================================
+ynh_script_progression --message="Removing the dedicated system user..." --weight=1
+
+# Delete a system user
+ynh_system_user_delete --username=$app
+
 #=================================================
 # END OF SCRIPT
 #=================================================

scripts/restore

@@ -11,49 +11,121 @@ source ../settings/scripts/_common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
-# RESTORE THE APP MAIN DIR
+# MANAGE SCRIPT FAILURE
 #=================================================
-ynh_script_progression --message="Restoring the app main directory..." --weight=1
 
-ynh_restore_file --origin_path="$install_dir"
+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
+ynh_abort_if_errors
 
-chmod -R o-rwx "$install_dir"
+#=================================================
-chown -R $app:www-data "$install_dir"
+# LOAD SETTINGS
+#=================================================
+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)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+
+#=================================================
+# CHECK IF THE APP CAN BE RESTORED
+#=================================================
+ynh_script_progression --message="Validating restoration parameters..." --weight=1
+
+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"
+
+#=================================================
+# INSTALL NODEJS
+#=================================================
+ynh_script_progression --message="Reinstalling nodejs version..." --weight=2
+
+ynh_install_nodejs --nodejs_version=$nodejs_version
+
+ynh_use_nodejs
 
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Reinstalling dependencies..." --weight=1
+ynh_script_progression --message="Reinstalling dependencies..." --weight=7
 
-# Define and install dependencies
+cd $final_path && ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH $ynh_npm install
-ynh_install_nodejs --nodejs_version=$nodejs_version
 
 #=================================================
-# RESTORE SYSTEM CONFIGURATIONS
+# RESTORE THE APP DATA DIR
 #=================================================
-# RESTORE THE PHP-FPM CONFIGURATION
+ynh_script_progression --message="Restoring the app data directory..." --weight=1
-#=================================================
-ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
 
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_restore_file --origin_path="$final_path/data"
+
+chmod 750 "$final_path/data"
+chmod -R o-rwx "$final_path/data"
+chown -R $app:www-data "$final_path/data"
+
+#=================================================
+# RESTORE VARIOUS FILES
+#=================================================
+ynh_script_progression --message="Restoring various files..." --weight=1
 
 ynh_restore_file --origin_path="/var/log/$app/"
 
+#=================================================
+# RESTORE SYSTEMD
+#=================================================
+ynh_script_progression --message="Restoring the systemd configuration..." --weight=1
+
 ynh_restore_file --origin_path="/etc/systemd/system/$app.service"
 systemctl enable $app.service --quiet
 
+#=================================================
+# RESTORE THE LOGROTATE CONFIGURATION
+#=================================================
+ynh_script_progression --message="Restoring the logrotate configuration..." --weight=1
+
 ynh_restore_file --origin_path="/etc/logrotate.d/$app"
 
-yunohost service add $app --description="Monitoring tool" --log="/var/log/$app/$app.log"
+#=================================================
+# INTEGRATE SERVICE IN YUNOHOST
+#=================================================
+ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
+
+yunohost service add $app --description="Uptime Kuma, a fancy monitoring tool" --log="/var/log/$app/$app.log"
+
+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+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"
 
 #=================================================
 # GENERIC FINALIZATION
 #=================================================
-# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE
+# RELOAD NGINX
 #=================================================
-ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server..." --weight=1
-
-ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
 
 ynh_systemd_action --service_name=nginx --action=reload
 

scripts/upgrade

@@ -9,12 +9,38 @@
 source _common.sh
 source /usr/share/yunohost/helpers
 
+#=================================================
+# LOAD SETTINGS
+#=================================================
+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)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+port=$(ynh_app_setting_get --app=$app --key=port)
+
 #=================================================
 # CHECK 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 () {
+	# 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
 #=================================================
@@ -24,6 +50,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
 #=================================================
@@ -32,42 +66,66 @@ if [ "$upgrade_type" == "UPGRADE_APP" ]
 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="$install_dir"
+    ynh_setup_source --source_id="app" --dest_dir="$final_path"
-
     # Download, check integrity, uncompress and patch the source from dist.src
-    ynh_setup_source --dest_dir="$install_dir/dist" --source_id="dist"
+    ynh_setup_source --source_id="dist" --dest_dir="$final_path/dist"
+
 fi
 
-chmod -R o-rwx "$install_dir"
+chmod 750 "$final_path"
-chown -R $app:www-data "$install_dir"
+chmod -R o-rwx "$final_path"
+chown -R $app:www-data "$final_path"
 
 #=================================================
-# REAPPLY SYSTEM CONFIGURATIONS
+# INSTALL NODEJS
 #=================================================
-ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
+ynh_script_progression --message="Upgrading nodejs..." --weight=2
 
 ynh_install_nodejs --nodejs_version=$nodejs_version
 
+ynh_use_nodejs
+
+#=================================================
+# NGINX CONFIGURATION
+#=================================================
+ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
+
 # Create a dedicated NGINX config
 ynh_add_nginx_config
 
+#=================================================
+# SPECIFIC UPGRADE
+#=================================================
+ynh_script_progression --message="Upgrading Uptime Kuma dependencies..." --weight=7
+
+pushd "$final_path"
+	ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH $ynh_npm install
+popd
+
+#=================================================
+# SETUP SYSTEMD
+#=================================================
+ynh_script_progression --message="Upgrading systemd configuration..." --weight=1
+
 # Create a dedicated systemd config
 ynh_add_systemd_config
 
+#=================================================
+# GENERIC FINALIZATION
+#=================================================
+# SETUP LOGROTATE
+#=================================================
+ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1
+
 # Use logrotate to manage app-specific logfile(s)
 ynh_use_logrotate --non-append
 
-yunohost service add $app --description="Monitoring tool" --log="/var/log/$app/$app.log"
-
 #=================================================
-# SPECIFIC UPGRADE
+# INTEGRATE SERVICE IN YUNOHOST
 #=================================================
-ynh_script_progression --message="Upgrading $app dependencies..." --weight=7
+ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
 
-pushd "$install_dir"
+yunohost service add $app --description="Uptime Kuma, a fancy monitoring tool" --log="/var/log/$app/$app.log"
-	ynh_use_nodejs
-	ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH $ynh_npm install --production
-popd
 
 #=================================================
 # START SYSTEMD SERVICE
@@ -76,6 +134,13 @@ 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"
 
+#=================================================
+# RELOAD NGINX
+#=================================================
+ynh_script_progression --message="Reloading NGINX web server..." --weight=1
+
+ynh_systemd_action --service_name=nginx --action=reload
+
 #=================================================
 # END OF SCRIPT
 #=================================================

tests.toml

@@ -1,9 +0,0 @@
-test_format = 1.0
-
-[default]
-
-    # -------------------------------
-    # Commits to test upgrade from
-    # -------------------------------
-
-    test_upgrade_from.484a6b12681415f6cc031ed3279795ce1a8b29cc.name = "Upgrade from 1.20.2"