diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh deleted file mode 100755 index cb2105f..0000000 --- a/.github/workflows/updater.sh +++ /dev/null @@ -1,123 +0,0 @@ -#!/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 '.[] | .tag_name' | sort -V | tail -1) -assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) - -# 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 - -# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.) -echo "${#assets[@]} available asset(s)" - -#================================================= -# UPDATE SOURCE FILES -#================================================= - -# Here we use the $assets variable to get the resources published in the upstream release. -# Here is an example for Grav, it has to be adapted in accordance with how the upstream releases look like. - -# Let's loop over the array of assets URLs -for asset_url in ${assets[@]}; do - -echo "Handling asset at $asset_url" - -# Assign the asset to a source file in conf/ directory -# Here we base the source file name upon a unique keyword in the assets url (admin vs. update) -# Leave $src empty to ignore the asset -case $asset_url in - *"node-red-"*) - src="app" - ;; - *) - src="" - ;; -esac - -# If $src is not empty, let's process the asset -if [ ! -z "$src" ]; then - -# 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 < conf/$src.src -SOURCE_URL=$asset_url -SOURCE_SUM=$checksum -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=$extension -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -EOT -echo "... conf/$src.src updated" - -else -echo "... asset ignored" -fi - -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 diff --git a/.github/workflows/updater.yml b/.github/workflows/updater.yml deleted file mode 100644 index c2ed1fd..0000000 --- a/.github/workflows/updater.yml +++ /dev/null @@ -1,48 +0,0 @@ -# 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@v3 - 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 - ./.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@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - commit-message: Update to version ${{ env.VERSION }} - committer: 'yunohost-bot ' - author: 'yunohost-bot ' - signoff: false - branch: ci-auto-update-v${{ env.VERSION }} - delete-branch: true - title: 'Upgrade to version ${{ env.VERSION }}' - body: | - Upgrade to v${{ env.VERSION }} - draft: false diff --git a/README.md b/README.md index d86184e..94b75f1 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ It provides a browser-based editor that makes it easy to wire together flows usi ### Override the default settings -From the installation directory, go edit the `/opt/yunohost/nodered/data/settings.user.js`. For example: +From the installation directory, go edit the `__INSTALL_DIR__/data/settings.user.js`. For example: ```js module.exports = (defaultSettings) => ({ @@ -44,24 +44,15 @@ logging: { // replace the default logging option ...defaultSettings.logging, // }); ``` -You can check the default settings Yunohost generates at `/opt/yunohost/nodered/data/settings.js` and find the documentation for configuring Node-RED here: https://nodered.org/docs/user-guide/runtime/configuration +You can check the default settings Yunohost generates at `__INSTALL_DIR__/data/settings.js` and find the documentation for configuring Node-RED here: -**Shipped version:** 3.0.2~ynh3 +**Shipped version:** 3.0.2~ynh4 ## Screenshots ![Screenshot of Node-RED](./doc/screenshots/screenshot.jpg) -## Disclaimers / important information - -YunoHost's permissions system allows you to select which users can have access to Node-RED: -* `main` permission protects `/admin`, the flows editor. The administrator is chosen during installation ; -* `ui` permission protects `/ui`, the dashboard allowing visual interface for the flows. Public access is chosen during installation ; -* `endpoints` permission protects `/`, for API-like endpoints. Public access is chosen during installation. - -If you have upgraded Node-RED beyond v2, check that these permissions suit you in your YunoHost admin panel. - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 6f71f71..9b47ed1 100644 --- a/README_fr.md +++ b/README_fr.md @@ -27,10 +27,9 @@ Il propose un éditeur accessible dans le navigateur, qui facilite l'ébauche de - Plus de 225 000 modules disponibles - Fonctions personnalisées en JavaScript - ### Surcharger la configuration par défaut -Depuis le répertoire d'installation, éditer le fichier `/opt/yunohost/nodered/data/settings.user.js`. Par exemple +Depuis le répertoire d'installation, éditer le fichier `__INSTALL_DIR__/data/settings.user.js`. Par exemple ```js module.exports = (defaultSettings) => ({ @@ -47,24 +46,15 @@ module.exports = (defaultSettings) => ({ }); ``` -Vous pouvez consulter les paramètres par défaut générez par Yunohost dans `/opt/yunohost/nodered/data/settings.js` et trouver la documentation pour configurer Node-RED ici: https://nodered.org/docs/user-guide/runtime/configuration +Vous pouvez consulter les paramètres par défaut générez par Yunohost dans `__INSTALL_DIR__/data/settings.js` et trouver la documentation pour configurer Node-RED ici: -**Version incluse :** 3.0.2~ynh3 +**Version incluse :** 3.0.2~ynh4 ## Captures d’écran ![Capture d’écran de Node-RED](./doc/screenshots/screenshot.jpg) -## Avertissements / informations importantes - -Le système de permissions de YunoHost permet de paramétrer les accès à Node-RED : -* la permission `main` protège `/admin`, l'éditeur de flux. L'administrateur est sélectionné pendant l'installation ; -* la permisison `ui` protège `/ui`, le tableau de bord permettant de donner une interface graphique aux flux. L'accès public est défini lors de l'installation ; -* la permission `endpoints` protège `/`, pour notamment les points d'entrée de type API. L'accès public est défini lors de l'installation. - -Si vous avez mis à jour Node-RED au-delà de la version 2, vérifiez que ces permissions vous conviennent dans votre panneau d'administration de YunoHost. - ## Documentations et ressources * Site officiel de l’app : diff --git a/check_process b/check_process deleted file mode 100644 index 71a24f4..0000000 --- a/check_process +++ /dev/null @@ -1,25 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - admin="john" - is_public=1 - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - upgrade=1 from_commit=3dae97a7ca966f2e4b8ac7b976d7b3e67a2c249f - backup_restore=1 - multi_instance=1 - change_url=1 -;;; Options -Email= -Notification=none -;;; Upgrade options - ; commit=3dae97a7ca966f2e4b8ac7b976d7b3e67a2c249f - name=3.0.2~ynh2 - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&is_public=1& diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index 66a8d12..0000000 --- a/conf/app.src +++ /dev/null @@ -1,6 +0,0 @@ -SOURCE_URL=https://github.com/node-red/node-red/releases/download/3.0.2/node-red-3.0.2.zip -SOURCE_SUM=6c452646648f9e86622148eff2208fb45d2311b5339481f86b445e9e2fa215c5 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=zip -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= diff --git a/conf/settings.js b/conf/settings.js index 0185849..7202237 100644 --- a/conf/settings.js +++ b/conf/settings.js @@ -1,4 +1,4 @@ -// CAUTION: DO NOT EDIT THIS FILE. Rather go to and edit `__FINALPATH__/settings.user.js` +// CAUTION: DO NOT EDIT THIS FILE. Rather go to and edit `__INSTALL_DIR__/settings.user.js` const getUserSettings = require('./settings.user'); @@ -61,12 +61,12 @@ const defaultSettings = Object.freeze({ * the user's home directory. To use a different location, the following * property can be used */ - userDir: '__FINALPATH__/data/', + userDir: '__INSTALL_DIR__/data/', /** Node-RED scans the `nodes` directory in the userDir to find local node files. * The following property can be used to specify an additional directory to scan. */ - nodesDir: '__FINALPATH__/data/nodes', + nodesDir: '__INSTALL_DIR__/data/nodes', /******************************************************************************* * Security diff --git a/conf/systemd.service b/conf/systemd.service index e53c8e1..c5e26ec 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -6,9 +6,9 @@ After=network.target Type=simple User=__APP__ Group=__APP__ -WorkingDirectory=__FINALPATH__/ +WorkingDirectory=__INSTALL_DIR__/ Environment="__YNH_NODE_LOAD_PATH__" -ExecStart=__YNH_NODE__ red.js -p __PORT__ -u __FINALPATH__/data +ExecStart=__YNH_NODE__ red.js -p __PORT__ -u __INSTALL_DIR__/data StandardOutput=syslog StandardError=inherit diff --git a/doc/DISCLAIMER.md b/doc/ADMIN.md similarity index 99% rename from doc/DISCLAIMER.md rename to doc/ADMIN.md index 83c5a62..933defe 100644 --- a/doc/DISCLAIMER.md +++ b/doc/ADMIN.md @@ -1,4 +1,5 @@ YunoHost's permissions system allows you to select which users can have access to Node-RED: + * `main` permission protects `/admin`, the flows editor. The administrator is chosen during installation ; * `ui` permission protects `/ui`, the dashboard allowing visual interface for the flows. Public access is chosen during installation ; * `endpoints` permission protects `/`, for API-like endpoints. Public access is chosen during installation. diff --git a/doc/DISCLAIMER_fr.md b/doc/ADMIN_fr.md similarity index 99% rename from doc/DISCLAIMER_fr.md rename to doc/ADMIN_fr.md index 93d2754..71226b2 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/ADMIN_fr.md @@ -1,4 +1,5 @@ Le système de permissions de YunoHost permet de paramétrer les accès à Node-RED : + * la permission `main` protège `/admin`, l'éditeur de flux. L'administrateur est sélectionné pendant l'installation ; * la permisison `ui` protège `/ui`, le tableau de bord permettant de donner une interface graphique aux flux. L'accès public est défini lors de l'installation ; * la permission `endpoints` protège `/`, pour notamment les points d'entrée de type API. L'accès public est défini lors de l'installation. diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 85ca980..ccd0c94 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -11,7 +11,7 @@ It provides a browser-based editor that makes it easy to wire together flows usi ### Override the default settings -From the installation directory, go edit the `/opt/yunohost/nodered/data/settings.user.js`. For example: +From the installation directory, go edit the `__INSTALL_DIR__/data/settings.user.js`. For example: ```js module.exports = (defaultSettings) => ({ @@ -26,4 +26,4 @@ logging: { // replace the default logging option ...defaultSettings.logging, // }); ``` -You can check the default settings Yunohost generates at `/opt/yunohost/nodered/data/settings.js` and find the documentation for configuring Node-RED here: https://nodered.org/docs/user-guide/runtime/configuration +You can check the default settings Yunohost generates at `__INSTALL_DIR__/data/settings.js` and find the documentation for configuring Node-RED here: diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index 2811a40..58b34c0 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -9,10 +9,9 @@ Il propose un éditeur accessible dans le navigateur, qui facilite l'ébauche de - Plus de 225 000 modules disponibles - Fonctions personnalisées en JavaScript - ### Surcharger la configuration par défaut -Depuis le répertoire d'installation, éditer le fichier `/opt/yunohost/nodered/data/settings.user.js`. Par exemple +Depuis le répertoire d'installation, éditer le fichier `__INSTALL_DIR__/data/settings.user.js`. Par exemple ```js module.exports = (defaultSettings) => ({ @@ -29,4 +28,4 @@ module.exports = (defaultSettings) => ({ }); ``` -Vous pouvez consulter les paramètres par défaut générez par Yunohost dans `/opt/yunohost/nodered/data/settings.js` et trouver la documentation pour configurer Node-RED ici: https://nodered.org/docs/user-guide/runtime/configuration +Vous pouvez consulter les paramètres par défaut générez par Yunohost dans `__INSTALL_DIR__/data/settings.js` et trouver la documentation pour configurer Node-RED ici: diff --git a/doc/PRE_UPGRADE.d/3.0.2~ynh4.md b/doc/PRE_UPGRADE.d/3.0.2~ynh4.md new file mode 100644 index 0000000..45ef300 --- /dev/null +++ b/doc/PRE_UPGRADE.d/3.0.2~ynh4.md @@ -0,0 +1,3 @@ +Permissions might be broken after this upgrade. + +You should review permissions in your users dashboard afterwards! diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 89ed2fc..0000000 --- a/manifest.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "name": "Node-RED", - "id": "nodered", - "packaging_format": 1, - "description": { - "en": "Flow-based programming for the Internet of Things", - "fr": "Programmation par flux de données pour l'Internet des objets" - }, - "version": "3.0.2~ynh3", - "url": "https://nodered.org", - "upstream": { - "license": "Apache-2.0", - "website": "https://nodered.org", - "userdoc": "https://nodered.org/docs/", - "code": "https://github.com/node-red/node-red", - "cpe": "cpe:2.3:a:nodered:node-red-dashboard" - }, - "license": "Apache-2.0", - "maintainer": { - "name": "tituspijean", - "email": "tituspijean@outlook.com" - }, - "requirements": { - "yunohost": ">= 11.1.15" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/nodered", - "default": "/nodered" - }, - { - "name": "admin", - "type": "user" - }, - { - "name": "is_public", - "type": "boolean", - "default": false, - "help": { - "en": "Should the dashboard and HTTP endpoints be publicly accessible?", - "fr": "Le tableau de bord et les points d'accès HTTP doivent-ils être publiquement accessibles ?" - } - } - ] - } -} \ No newline at end of file diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..78cdc82 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,66 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "nodered" +name = "Node-RED" +description.en = "Flow-based programming for the Internet of Things" +description.fr = "Programmation par flux de données pour l'Internet des objets" + +version = "3.0.2~ynh4" + +maintainers = ["tituspijean"] + +[upstream] +license = "Apache-2.0" +website = "https://nodered.org" +userdoc = "https://nodered.org/docs/" +code = "https://github.com/node-red/node-red" +cpe = "cpe:2.3:a:nodered:node-red" +fund = "https://openjsf.org" + +[integration] +yunohost = ">= 11.1.15" +architectures = "all" +multi_instance = true +ldap = false +sso = false +disk = "50M" +ram.build = "300M" +ram.runtime = "70M" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/nodered" + + [install.admin] + type = "user" + + [install.init_main_permission] + help.en = "Should the dashboard and HTTP endpoints be publicly accessible?" + help.fr = "Le tableau de bord et les points d'accès HTTP doivent-ils être publiquement accessibles ?" + type = "group" + default = false + +[resources] + [resources.sources.main] + url = "https://github.com/node-red/node-red/releases/download/3.0.2/node-red-3.0.2.zip" + sha256 = "6c452646648f9e86622148eff2208fb45d2311b5339481f86b445e9e2fa215c5" + + autoupdate.strategy = "latest_github_release" + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + main.additional_urls = ["/ui"] + admin.url = "/admin" + + [resources.ports] + main.default = 1880 diff --git a/scripts/backup b/scripts/backup index e6d0aa0..7189d8c 100755 --- a/scripts/backup +++ b/scripts/backup @@ -10,23 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# 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 #================================================= @@ -36,7 +19,7 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index 673347a..45029e7 100755 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,68 +9,6 @@ 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 - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -port=$(ynh_app_setting_get --app=$app --key=port) - -if [[ $path_url = "/" ]] -then - nodes_url="/" - admin_url="/admin" -else - nodes_url="$path_url" - admin_url="$path_url/admin" -fi - -#================================================= -# 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 #================================================= @@ -85,29 +23,7 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2 -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 +ynh_change_url_nginx_config #================================================= # SPECIFIC MODIFICATIONS @@ -115,10 +31,11 @@ fi # ALTERED NODERED SETTINGS FILE #================================================= -ynh_add_config --template="../conf/settings.js" --destination="$final_path/data/settings.js" +chmod 660 "$install_dir/data/settings.js" +ynh_add_config --template="settings.js" --destination="$install_dir/data/settings.js" -chmod o-rwx "$final_path/data/settings.js" -chown -R $app: "$final_path/data/settings.js" +chown "$app:" "$install_dir/data/settings.js" +chmod 400 "$install_dir/data/settings.js" #================================================= # GENERIC FINALISATION @@ -128,14 +45,7 @@ chown -R $app: "$final_path/data/settings.js" ynh_script_progression --message="Starting a systemd service..." --weight=1 # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name="$app" --action="start" #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 61707ed..9c53102 100755 --- a/scripts/install +++ b/scripts/install @@ -10,84 +10,23 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# INSTALL NODEJS #================================================= +ynh_script_progression --message="Installing NodeJS..." -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -admin=$YNH_APP_ARG_ADMIN -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=/opt/yunohost/$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 - -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url - -#================================================= -# 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=1880) -ynh_app_setting_set --app=$app --key=port --value=$port - -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." - -ynh_install_nodejs --nodejs_version=$nodejs_version - -#================================================= -# 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 +ynh_install_nodejs --nodejs_version="$nodejs_version" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=2 -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" +ynh_setup_source --dest_dir="$install_dir" -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring NGINX web server..." --weight=1 - -# Create a dedicated NGINX config -ynh_add_nginx_config +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # SPECIFIC SETUP @@ -97,11 +36,10 @@ ynh_add_nginx_config ynh_script_progression --message="Installing Node-RED..." --weight=5 ynh_use_nodejs -chown -R $app: "$final_path" -pushd $final_path - 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 install node-red-dashboard +pushd "$install_dir" + 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" install node-red-dashboard popd #================================================= @@ -110,41 +48,30 @@ popd ynh_script_progression --message="Adding a configuration file..." # Set up the settings file -mkdir -p $final_path/data -ynh_add_config --template="../conf/settings.js" --destination="$final_path/data/settings.js" -ynh_add_config --template="../conf/settings.user.js" --destination="$final_path/data/settings.user.js" +mkdir -p "$install_dir/data" +ynh_add_config --template="settings.js" --destination="$install_dir/data/settings.js" +ynh_add_config --template="settings.user.js" --destination="$install_dir/data/settings.user.js" # Small hack to have the "/" path answer with a 200 code to satisfy the CI if [[ "${PACKAGE_CHECK_EXEC:-}" = "1" ]] ; then - ynh_add_config --template="../conf/flows.json" --destination="$final_path/data/flows.json" + ynh_add_config --template="flows.json" --destination="$install_dir/data/flows.json" fi -#================================================= -# SECURE FILES AND DIRECTORIES -#================================================= - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app: "$final_path" -# make settings.js readonly -chmod a-w "$final_path/data/settings.js" +chmod 400 "$install_dir/data/settings.js" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= -# SETUP SYSTEMD +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring a systemd service..." --weight=1 +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 + +# Create a dedicated NGINX config +ynh_add_nginx_config # Create a dedicated systemd config ynh_add_systemd_config - -#================================================= -# GENERIC FINALIZATION -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add $app --description="Low-code programming for event-driven applications" +yunohost service add "$app" --description="Low-code programming for event-driven applications" #================================================= # START SYSTEMD SERVICE @@ -152,41 +79,7 @@ yunohost service add $app --description="Low-code programming for event-driven a ynh_script_progression --message="Starting a systemd service..." --weight=3 # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" - -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# The "main" permission is automatically created before the install script. -# Here we use it for the endpoints root, they should be world-accessible by default -# Since it is meant for automated actions, we hide the tile from the SSO -ynh_permission_create --permission="endpoints" --url="/" --show_tile=false - -# Create the dashboard UI permission -ynh_permission_create --permission="ui" --url="/ui" --show_tile=true - -# Reuse the main permission for the admin -ynh_permission_url --permission="main" --url="/admin" -ynh_permission_update --permission="main" --add="$admin" --remove="all_users" --show_tile=true - -# Make the dashboard public if necessary -if [ $is_public -eq 1 ] -then - ynh_permission_update --permission="ui" --add="visitors" - ynh_permission_update --permission="endpoints" --add="visitors" -else - ynh_permission_update --permission="ui" --add="$admin" - ynh_permission_update --permission="endpoints" --add="$admin" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemd_action --service_name="$app" --action="start" #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 7b4b312..3a92ca9 100755 --- a/scripts/remove +++ b/scripts/remove @@ -10,74 +10,24 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS +# REMOVE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +ynh_script_progression --message="Removing system configurations related to $app..." --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 -#================================================= # 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 - yunohost service remove $app +if ynh_exec_warn_less yunohost service status "$app" >/dev/null; 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 APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --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 -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=4 - ynh_remove_nodejs -#================================================= -# SPECIFIC REMOVE -#================================================= - -#================================================= -# 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 #================================================= diff --git a/scripts/restore b/scripts/restore index a6eebd2..93e81a7 100755 --- a/scripts/restore +++ b/scripts/restore @@ -11,100 +11,43 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# REINSTALL NODEJS #================================================= +ynh_script_progression --message="Reinstalling NodeJS..." -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading 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 web server configuration..." - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" - -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir=$final_path +ynh_install_nodejs --nodejs_version="$nodejs_version" #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=5 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app: "$final_path" - -# Create log directory and apply permissions -mkdir -p /var/log/$app -chown -R $app: /var/log/$app +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app: "$install_dir" #================================================= -# SPECIFIC RESTORATION +# RESTORE SYSTEM CONFIGURATIONS #================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 -ynh_install_nodejs --nodejs_version=$nodejs_version - -#================================================= -# RESTORE SYSTEMD -#================================================= -ynh_script_progression --message="Restoring the systemd configuration..." --weight=1 +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore_file --origin_path="/etc/systemd/system/$app.service" -systemctl enable $app.service --quiet - -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add $app --description="Low-code programming for event-driven applications" - -#================================================= -# START SYSTEMD SERVICE -#================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=3 - -ynh_systemd_action --service_name=$app --action="start" +systemctl enable "$app.service" --quiet +yunohost service add "$app" --description="Low-code programming for event-driven applications" #================================================= # GENERIC FINALIZATION #================================================= -# RELOAD NGINX +# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE #================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 +ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1 + +### Typically you only have either $app or php-fpm but not both at the same time... +ynh_systemd_action --service_name="$app" --action="start" ynh_systemd_action --service_name=nginx --action=reload diff --git a/scripts/upgrade b/scripts/upgrade index 3af0dc7..f11b86c 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,39 +9,6 @@ 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 -#================================================= -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=5 - -# 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 #================================================= @@ -56,108 +23,48 @@ ynh_systemd_action --service_name=$app --action="stop" #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -# If final_path doesn't exist, create it -if [ -z "$final_path" ]; then - final_path=/var/www/$app - ynh_app_setting_set --app=$app --key=final_path --value=$final_path -fi - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -# After 1.3.5~ynh2, permissions have been reworked -if ynh_permission_exists --permission="admin"; then - # Delete the admin permission - ynh_permission_delete --permission="admin" - # We use main as admin permission - ynh_permission_url --permission="main" --url="/admin" -fi - -if ! ynh_permission_exists --permission="ui"; then - # Create ui permission, for the dashboard - ynh_permission_create --permission="ui" --url="/ui" --show_tile=true -fi - -if ! ynh_permission_exists --permission="endpoints"; then - # Create endpoints permission - ynh_permission_create --permission="endpoints" --url="/" --show_tile=false -fi - -# Transfer the publicness of the app to ui and endpoints -if ynh_permission_has_user --permission=main --user=visitors; then - ynh_permission_update --permission="ui" --add="visitors" - ynh_permission_update --permission="endpoints" --add="visitors" - # Remove visitor access to the admin panel - ynh_permission_update --permission="main" --remove="visitors" -fi - # Flows were stored in file named after the hostname. # Not very portable. Let's fix that. -if [[ ! -f "$final_path/data/flows.json" && -f "$final_path/data/flows_$(hostname).json" ]]; then - mv "$final_path/data/flows_$(hostname)_cred.json" "$final_path/data/flows_cred.json" - mv "$final_path/data/flows_$(hostname).json" "$final_path/data/flows.json" -# Flows could be stored in a file named '>>'. -# Definitely weird, let's fix that. -elif [[ ! -f "$final_path/data/flows.json" && -f "$final_path/data/>>" ]]; then - mv "$final_path/data/>>_cred" "$final_path/data/flows_cred.json" - mv "$final_path/data/>>" "$final_path/data/flows.json" +if [[ ! -f "$install_dir/data/flows.json" ]]; then + if [[ -f "$install_dir/data/flows_$(hostname).json" ]]; then + mv "$install_dir/data/flows_$(hostname)_cred.json" "$install_dir/data/flows_cred.json" + mv "$install_dir/data/flows_$(hostname).json" "$install_dir/data/flows.json" + elif [[ -f "$install_dir/data/>>" ]]; then + mv "$install_dir/data/>>_cred" "$install_dir/data/flows_cred.json" + mv "$install_dir/data/>>" "$install_dir/data/flows.json" + fi fi # Remove logrotate and log directory, we use syslog now if [[ -d "/etc/logrotate.d/$app" ]]; then - ynh_remove_logrotate - ynh_secure_remove --file="/var/log/$app" + ynh_remove_logrotate + ynh_secure_remove --file="/var/log/$app" fi # In older versions of the package, the port serving the webui was opened to anyone, # allowing direct access to Node-RED... let's close it. -if yunohost firewall list | grep -q "\- $port$" -then - ynh_script_progression --message="Closing port $port..." --weight=1 - ynh_exec_warn_less yunohost firewall disallow TCP $port +if yunohost firewall list | grep -q "\- $port$"; then + ynh_exec_warn_less yunohost firewall disallow TCP $port fi #================================================= -# CREATE DEDICATED USER +# UPGRADE NODEJS #================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 +ynh_script_progression --message="Upgrading NodeJS..." -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir=$final_path +ynh_install_nodejs --nodejs_version="$nodejs_version" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= +ynh_script_progression --message="Upgrading source files..." --weight=2 -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." --weight=2 +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source --dest_dir="$install_dir" --full_replace=1 --keep="data" - # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" -fi - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1 - -# Create a dedicated NGINX config -ynh_add_nginx_config - -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." - -if [ $(ynh_app_setting_get --app=$app --key=nodejs_version) != $nodejs_version ]; then - ynh_remove_nodejs - ynh_install_nodejs --nodejs_version=$nodejs_version -fi +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" #================================================= # SPECIFIC UPGRADE @@ -168,11 +75,9 @@ ynh_script_progression --message="Installing Node-RED..." --weight=5 ynh_use_nodejs -chown -R $app: "$final_path" - -pushd $final_path - 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 install node-red-dashboard +pushd "$install_dir" + 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" install node-red-dashboard popd #================================================= @@ -181,43 +86,31 @@ popd ynh_script_progression --message="Updating a configuration file..." # Set up the settings file -ynh_add_config --template="../conf/settings.js" --destination="$final_path/data/settings.js" -if [[ ! -f "$final_path/data/settings.user.js" ]] ; then - ynh_add_config --template="../conf/settings.user.js" --destination="$final_path/data/settings.user.js" +ynh_add_config --template="settings.js" --destination="$install_dir/data/settings.js" +if [[ ! -f "$install_dir/data/settings.user.js" ]] ; then + ynh_add_config --template="settings.user.js" --destination="$install_dir/data/settings.user.js" fi # Small hack to have the "/" path answer with a 200 code to satisfy the CI if [[ "${PACKAGE_CHECK_EXEC:-}" = "1" ]] ; then - ynh_add_config --template="../conf/flows.json" --destination="$final_path/data/flows.json" + ynh_add_config --template="flows.json" --destination="$install_dir/data/flows.json" fi +chmod 400 "$install_dir/data/settings.js" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" + #================================================= -# SETUP SYSTEMD +# REAPPLY SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Upgrading systemd configuration..." --weight=1 +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 + +# Create a dedicated NGINX config +ynh_add_nginx_config # Create a dedicated systemd config ynh_add_systemd_config - -#================================================= -# SECURE FILES AND DIRECTORIES -#================================================= - -# Set permissions on app files -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app: "$final_path" -# make settings.js readonly -chmod a-w "$final_path/data/settings.js" - -#================================================= -# GENERIC FINALIZATION -#================================================= -# INTEGRATE SERVICE IN YUNOHOST -#================================================= -ynh_script_progression --message="Integrating service in YunoHost..." - -yunohost service add $app --description="Low-code programming for event-driven applications" +yunohost service add "$app" --description="Low-code programming for event-driven applications" #================================================= # START SYSTEMD SERVICE @@ -226,13 +119,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=3 ynh_systemd_action --service_name=$app --action="start" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..724c9b5 --- /dev/null +++ b/tests.toml @@ -0,0 +1,13 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + # ------------------------ + # ------------------------------- + # Commits to test upgrade from + # ------------------------------- + + [default.test_upgrade_from.3dae97a7] + name = "3.0.2~ynh2"