From 0bd4ca51fb6bfb42b6a1cb74985664731ba28e07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Sun, 15 Oct 2023 09:39:51 +0200 Subject: [PATCH] v2 --- conf/app.src | 6 --- conf/settings.js | 6 +-- conf/systemd.service | 4 +- manifest.toml | 61 ++++++++++++++++++++++++++++ scripts/backup | 12 +++--- scripts/change_url | 74 +++++++++++++++++----------------- scripts/install | 84 +++++++++++++++++++------------------- scripts/remove | 20 ++++----- scripts/restore | 30 +++++++------- scripts/upgrade | 96 ++++++++++++++++++++++---------------------- 10 files changed, 225 insertions(+), 168 deletions(-) delete mode 100644 conf/app.src create mode 100644 manifest.toml 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/manifest.toml b/manifest.toml new file mode 100644 index 0000000..30e7397 --- /dev/null +++ b/manifest.toml @@ -0,0 +1,61 @@ +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~ynh3" + +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 = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number) +fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin. + +[integration] +yunohost = ">= 11.1.15" +architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"] +multi_instance = true +ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials. +sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal. +disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... +ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... +ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... + +[install] + [install.domain] + # this is a generic question - ask strings are automatically handled by Yunohost's core + type = "domain" + + [install.path] + # this is a generic question - ask strings are automatically handled by Yunohost's core + type = "path" + default = "/nodered" + + [install.admin] + # this is a generic question - ask strings are automatically handled by Yunohost's core + 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" + + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" diff --git a/scripts/backup b/scripts/backup index e6d0aa0..078d66a 100755 --- a/scripts/backup +++ b/scripts/backup @@ -15,17 +15,17 @@ source /usr/share/yunohost/helpers #================================================= # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_print_info --message="Loading installation settings..." +#REMOVEME? ynh_print_info --message="Loading installation settings..." -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) #================================================= # DECLARE DATA AND CONF FILES TO BACKUP @@ -36,7 +36,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..fec4375 100755 --- a/scripts/change_url +++ b/scripts/change_url @@ -13,62 +13,62 @@ source /usr/share/yunohost/helpers # RETRIEVE ARGUMENTS #================================================= -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH +#REMOVEME? old_domain=$YNH_APP_OLD_DOMAIN +#REMOVEME? old_path=$YNH_APP_OLD_PATH -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH +#REMOVEME? new_domain=$YNH_APP_NEW_DOMAIN +#REMOVEME? new_path=$YNH_APP_NEW_PATH -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? app=$YNH_APP_INSTANCE_NAME #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +#REMOVEME? 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) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) -if [[ $path_url = "/" ]] +if [[ $path = "/" ]] then nodes_url="/" admin_url="/admin" else - nodes_url="$path_url" - admin_url="$path_url/admin" + nodes_url="$path" + admin_url="$path/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 +#REMOVEME? 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 () { +#REMOVEME? ynh_backup_before_upgrade +#REMOVEME? 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" +#REMOVEME? ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" # Restore it if the upgrade fails - ynh_restore_upgradebackup +#REMOVEME? ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # CHECK WHICH PARTS SHOULD BE CHANGED #================================================= -change_domain=0 -if [ "$old_domain" != "$new_domain" ] +#REMOVEME? change_domain=0 +#REMOVEME? if [ "$old_domain" != "$new_domain" ] then - change_domain=1 + #REMOVEME? change_domain=1 fi -change_path=0 -if [ "$old_path" != "$new_path" ] +#REMOVEME? change_path=0 +#REMOVEME? if [ "$old_path" != "$new_path" ] then - change_path=1 + #REMOVEME? change_path=1 fi #================================================= @@ -85,28 +85,30 @@ 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 +ynh_change_url_nginx_config + +#REMOVEME? 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" +#REMOVEME? ynh_backup_if_checksum_is_different --file="$nginx_conf_path" # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" +#REMOVEME? domain="$old_domain" +#REMOVEME? path="$new_path" # Create a dedicated NGINX config - ynh_add_nginx_config +#REMOVEME? 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 +#REMOVEME? ynh_delete_file_checksum --file="$nginx_conf_path" +#REMOVEME? 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" +#REMOVEME? ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" fi #================================================= @@ -115,10 +117,10 @@ fi # ALTERED NODERED SETTINGS FILE #================================================= -ynh_add_config --template="../conf/settings.js" --destination="$final_path/data/settings.js" +ynh_add_config --template="../conf/settings.js" --destination="$install_dir/data/settings.js" -chmod o-rwx "$final_path/data/settings.js" -chown -R $app: "$final_path/data/settings.js" +chmod o-rwx "$install_dir/data/settings.js" +chown -R $app: "$install_dir/data/settings.js" #================================================= # GENERIC FINALISATION @@ -133,9 +135,9 @@ ynh_systemd_action --service_name=$app --action="start" #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 61707ed..4dec89c 100755 --- a/scripts/install +++ b/scripts/install @@ -14,72 +14,72 @@ source /usr/share/yunohost/helpers #================================================= # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? 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 +#REMOVEME? domain=$YNH_APP_ARG_DOMAIN +#REMOVEME? path=$YNH_APP_ARG_PATH +#REMOVEME? admin=$YNH_APP_ARG_ADMIN +#REMOVEME? is_public=$YNH_APP_ARG_IS_PUBLIC -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? app=$YNH_APP_INSTANCE_NAME #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 +#REMOVEME? 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" +#REMOVEME? install_dir=/opt/yunohost/$app +#REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder" # Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url +#REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path #================================================= # STORE SETTINGS FROM MANIFEST #================================================= -ynh_script_progression --message="Storing installation settings..." --weight=1 +#REMOVEME? 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 +#REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain +#REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path #================================================= # STANDARD MODIFICATIONS #================================================= # FIND AND OPEN A PORT #================================================= -ynh_script_progression --message="Finding an available port..." --weight=1 +#REMOVEME? 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 +#REMOVEME? port=$(ynh_find_port --port=1880) +#REMOVEME? ynh_app_setting_set --app=$app --key=port --value=$port #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Installing dependencies..." +#REMOVEME? 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 +#REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=1 # Create a system user -ynh_system_user_create --username=$app --home_dir=$final_path +#REMOVEME? ynh_system_user_create --username=$app --home_dir=$install_dir #================================================= # 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 +#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir # 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 @@ -97,9 +97,9 @@ ynh_add_nginx_config ynh_script_progression --message="Installing Node-RED..." --weight=5 ynh_use_nodejs -chown -R $app: "$final_path" +chown -R $app: "$install_dir" -pushd $final_path +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,24 +110,24 @@ 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="../conf/settings.js" --destination="$install_dir/data/settings.js" +ynh_add_config --template="../conf/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="../conf/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" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app: "$install_dir" # make settings.js readonly -chmod a-w "$final_path/data/settings.js" +chmod a-w "$install_dir/data/settings.js" #================================================= # SETUP SYSTEMD @@ -157,36 +157,36 @@ ynh_systemd_action --service_name=$app --action="start" #================================================= # SETUP SSOWAT #================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 +#REMOVEME? 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 +#REMOVEME? ynh_permission_create --permission="endpoints" --url="/" --show_tile=false # Create the dashboard UI permission -ynh_permission_create --permission="ui" --url="/ui" --show_tile=true +#REMOVEME? 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 +#REMOVEME? ynh_permission_update --permission="main" --add="$admin" --remove="all_users" --show_tile=true # Make the dashboard public if necessary -if [ $is_public -eq 1 ] +#REMOVEME? if [ $is_public -eq 1 ] then - ynh_permission_update --permission="ui" --add="visitors" - ynh_permission_update --permission="endpoints" --add="visitors" +#REMOVEME? ynh_permission_update --permission="ui" --add="visitors" +#REMOVEME? ynh_permission_update --permission="endpoints" --add="visitors" else - ynh_permission_update --permission="ui" --add="$admin" - ynh_permission_update --permission="endpoints" --add="$admin" +#REMOVEME? ynh_permission_update --permission="ui" --add="$admin" +#REMOVEME? ynh_permission_update --permission="endpoints" --add="$admin" fi #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 7b4b312..e5e0e84 100755 --- a/scripts/remove +++ b/scripts/remove @@ -12,13 +12,13 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) #================================================= # STANDARD REMOVE @@ -44,10 +44,10 @@ ynh_remove_systemd_config #================================================= # REMOVE APP MAIN DIR #================================================= -ynh_script_progression --message="Removing app main directory..." --weight=2 +#REMOVEME? ynh_script_progression --message="Removing app main directory..." --weight=2 # Remove the app directory securely -ynh_secure_remove --file="$final_path" +#REMOVEME? ynh_secure_remove --file="$install_dir" #================================================= # REMOVE NGINX CONFIGURATION @@ -60,7 +60,7 @@ ynh_remove_nginx_config #================================================= # REMOVE DEPENDENCIES #================================================= -ynh_script_progression --message="Removing dependencies..." --weight=4 +#REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=4 ynh_remove_nodejs @@ -73,10 +73,10 @@ ynh_remove_nodejs #================================================= # REMOVE DEDICATED USER #================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 +#REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." --weight=1 # Delete a system user -ynh_system_user_delete --username=$app +#REMOVEME? ynh_system_user_delete --username=$app #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index a6eebd2..8d5a93e 100755 --- a/scripts/restore +++ b/scripts/restore @@ -15,26 +15,26 @@ source /usr/share/yunohost/helpers #================================================= # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= ynh_script_progression --message="Loading settings..." --weight=1 -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) #================================================= # CHECK IF THE APP CAN BE RESTORED #================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=1 +#REMOVEME? ynh_script_progression --message="Validating restoration parameters..." --weight=1 -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " +#REMOVEME? test ! -d $install_dir \ + || ynh_die --message="There is already a directory: $install_dir " #================================================= # STANDARD RESTORATION STEPS @@ -48,21 +48,21 @@ 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 +#REMOVEME? 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 +#REMOVEME? ynh_system_user_create --username=$app --home_dir=$install_dir #================================================= # 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" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app: "$install_dir" # Create log directory and apply permissions mkdir -p /var/log/$app @@ -73,7 +73,7 @@ chown -R $app: /var/log/$app #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling dependencies..." +#REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." ynh_install_nodejs --nodejs_version=$nodejs_version diff --git a/scripts/upgrade b/scripts/upgrade index 3af0dc7..357b8b5 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,14 +12,14 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 +#REMOVEME? ynh_script_progression --message="Loading installation settings..." --weight=1 -app=$YNH_APP_INSTANCE_NAME +#REMOVEME? 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) +#REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain) +#REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path) +#REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir) +#REMOVEME? port=$(ynh_app_setting_get --app=$app --key=port) #================================================= # CHECK VERSION @@ -31,16 +31,16 @@ 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 +#REMOVEME? 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 () { +#REMOVEME? ynh_backup_before_upgrade +#REMOVEME? ynh_clean_setup () { # Restore it if the upgrade fails - ynh_restore_upgradebackup +#REMOVEME? ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script -ynh_abort_if_errors +#REMOVEME? ynh_abort_if_errors #================================================= # STANDARD UPGRADE STEPS @@ -56,55 +56,55 @@ 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 +# If install_dir doesn't exist, create it +if [ -z "$install_dir" ]; then +#REMOVEME? install_dir=/var/www/$app +#REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir fi # Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all +#REMOVEME? if ynh_legacy_permissions_exists; then +#REMOVEME? 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 +#REMOVEME? 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 +#REMOVEME? if ! ynh_permission_exists --permission="ui"; then # Create ui permission, for the dashboard - ynh_permission_create --permission="ui" --url="/ui" --show_tile=true +#REMOVEME? ynh_permission_create --permission="ui" --url="/ui" --show_tile=true fi -if ! ynh_permission_exists --permission="endpoints"; then +#REMOVEME? if ! ynh_permission_exists --permission="endpoints"; then # Create endpoints permission - ynh_permission_create --permission="endpoints" --url="/" --show_tile=false +#REMOVEME? 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" +#REMOVEME? ynh_permission_update --permission="ui" --add="visitors" +#REMOVEME? ynh_permission_update --permission="endpoints" --add="visitors" # Remove visitor access to the admin panel - ynh_permission_update --permission="main" --remove="visitors" +#REMOVEME? 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" +if [[ ! -f "$install_dir/data/flows.json" && -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" # 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" +elif [[ ! -f "$install_dir/data/flows.json" && -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 # Remove logrotate and log directory, we use syslog now @@ -124,10 +124,10 @@ fi #================================================= # CREATE DEDICATED USER #================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 +#REMOVEME? 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 +#REMOVEME? ynh_system_user_create --username=$app --home_dir=$install_dir #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE @@ -138,7 +138,7 @@ 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="$final_path" + ynh_setup_source --dest_dir="$install_dir" fi #================================================= @@ -152,9 +152,9 @@ ynh_add_nginx_config #================================================= # UPGRADE DEPENDENCIES #================================================= -ynh_script_progression --message="Upgrading dependencies..." +#REMOVEME? ynh_script_progression --message="Upgrading dependencies..." -if [ $(ynh_app_setting_get --app=$app --key=nodejs_version) != $nodejs_version ]; then +#REMOVEME? if [ $(ynh_app_setting_get --app=$app --key=nodejs_version) != $nodejs_version ]; then ynh_remove_nodejs ynh_install_nodejs --nodejs_version=$nodejs_version fi @@ -168,9 +168,9 @@ ynh_script_progression --message="Installing Node-RED..." --weight=5 ynh_use_nodejs -chown -R $app: "$final_path" +chown -R $app: "$install_dir" -pushd $final_path +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,14 +181,14 @@ 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="../conf/settings.js" --destination="$install_dir/data/settings.js" +if [[ ! -f "$install_dir/data/settings.user.js" ]] ; then + ynh_add_config --template="../conf/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="../conf/flows.json" --destination="$install_dir/data/flows.json" fi #================================================= @@ -204,11 +204,11 @@ ynh_add_systemd_config #================================================= # Set permissions on app files -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app: "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app: "$install_dir" # make settings.js readonly -chmod a-w "$final_path/data/settings.js" +chmod a-w "$install_dir/data/settings.js" #================================================= # GENERIC FINALIZATION @@ -229,9 +229,9 @@ ynh_systemd_action --service_name=$app --action="start" #================================================= # RELOAD NGINX #================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 +#REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1 -ynh_systemd_action --service_name=nginx --action=reload +#REMOVEME? ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT