diff --git a/conf/systemd.service b/conf/systemd.service index 748a48d..81419fc 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -8,8 +8,8 @@ User=__APP__ Group=__APP__ WorkingDirectory=__INSTALL_DIR__/ Environment="NODE_ENV=production" -Environment="__YNH_NODE_LOAD_PATH__" -ExecStart=__NODEJS_PATH__/pnpm run prod +Environment="PATH=__PATH_WITH_NODEJS__" +ExecStart=__NODEJS_DIR__/pnpm run prod Restart=always # Sandboxing options to harden security diff --git a/manifest.toml b/manifest.toml index 7bb100b..68a262f 100644 --- a/manifest.toml +++ b/manifest.toml @@ -17,7 +17,8 @@ admindoc = "https://etherpad.org/doc/v2.0.2/" code = "https://github.com/ether/etherpad-lite" [integration] -yunohost = ">= 11.2.20" +yunohost = ">= 11.2.29" +helpers_version = "2.1" architectures = "all" multi_instance = true diff --git a/scripts/_common.sh b/scripts/_common.sh index 184eecc..5b01580 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,19 +1,7 @@ #!/bin/bash #================================================= -# COMMON VARIABLES +# COMMON VARIABLES AND CUSTOM HELPERS #================================================= nodejs_version=22 - -#================================================= -# PERSONAL HELPERS -#================================================= - -#================================================= -# EXPERIMENTAL HELPERS -#================================================= - -#================================================= -# FUTURE OFFICIAL HELPERS -#================================================= diff --git a/scripts/backup b/scripts/backup index e21c492..142b7d0 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,37 +1,28 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# DECLARE DATA AND CONF FILES TO BACKUP -#================================================= -ynh_print_info --message="Declaring files to be backed up..." +ynh_print_info "Declaring files to be backed up..." #================================================= # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$install_dir" +ynh_backup "$install_dir" #================================================= # SYSTEM CONFIGURATION #================================================= -ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" -ynh_backup --src_path="/etc/logrotate.d/$app" +ynh_backup "/etc/logrotate.d/$app" -ynh_backup --src_path="/etc/systemd/system/$app.service" +ynh_backup "/etc/systemd/system/$app.service" #================================================= # END OF SCRIPT #================================================= -ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." +ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/change_url b/scripts/change_url index 3f4d2ab..4a5a274 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -1,40 +1,31 @@ #!/bin/bash -#================================================= -# GENERIC STARTING -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers -#================================================= -# STANDARD MODIFICATIONS #================================================= # STOP SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Stopping a systemd service..." --weight=2 +ynh_script_progression "Stopping $app's systemd service..." -ynh_systemd_action --service_name=$app --action=stop --log_path=systemd +ynh_systemctl --service=$app --action=stop --log_path=systemd #================================================= # MODIFY URL IN NGINX CONF #================================================= -ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2 +ynh_script_progression "Updating NGINX web server configuration..." -ynh_change_url_nginx_config +ynh_config_change_url_nginx #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=6 +ynh_script_progression "Starting $app's systemd service..." -# Start a systemd service -ynh_systemd_action --service_name=$app --action=restart --log_path=systemd --line_match="Your Etherpad version is" +ynh_systemctl --service=$app --action=restart --log_path=systemd --wait_until="Your Etherpad version is" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Change of URL completed for $app" --last +ynh_script_progression "Change of URL completed for $app" diff --git a/scripts/install b/scripts/install index 364cc9a..cefd3f9 100644 --- a/scripts/install +++ b/scripts/install @@ -1,57 +1,47 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Installing dependencies..." --weight=6 +ynh_script_progression "Installing dependencies..." -ynh_install_nodejs --nodejs_version=$nodejs_version +ynh_nodejs_install #================================================= # CREATE REDIS DATABASE #================================================= -ynh_script_progression --message="Creating a Redis database..." --weight=5 +ynh_script_progression "Creating a Redis database..." -# Configure redis redis_db=$(ynh_redis_get_free_db) -ynh_app_setting_set --app="$app" --key=redis_db --value="$redis_db" +ynh_app_setting_set --key=redis_db --value="$redis_db" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Setting up source files..." --weight=1 +ynh_script_progression "Setting up source files..." ynh_setup_source --dest_dir=$install_dir -chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" - #================================================= # SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 +ynh_script_progression "Adding system configurations related to $app..." -ynh_add_systemd_config +ynh_config_add_systemd -ynh_add_nginx_config +ynh_config_add_nginx -ynh_use_logrotate +ynh_config_add_logrotate yunohost service add $app --description="Collaborative editor" --log="/var/log/$app/$app.log" #================================================= # APP INITIAL CONFIGURATION #================================================= -ynh_script_progression --message="Adding $app's configuration files..." --weight=1 +ynh_script_progression "Adding $app's configuration files..." abiword_path="null" soffice_path="null" @@ -64,35 +54,28 @@ then soffice_path="\"$(which soffice)\"" fi -ynh_add_config --template="settings.json" --destination="$install_dir/settings.json" -ynh_add_config --template="credentials.json" --destination="$install_dir/credentials.json" - -chmod 600 "$install_dir/settings.json" -chown $app:$app "$install_dir/settings.json" - -chmod 600 "$install_dir/credentials.json" -chown $app:$app "$install_dir/credentials.json" +ynh_config_add --template="settings.json" --destination="$install_dir/settings.json" +ynh_config_add --template="credentials.json" --destination="$install_dir/credentials.json" #================================================= # INSTALL ETHERPAD #================================================= -ynh_script_progression --message="Installing $app..." --weight=10 +ynh_script_progression "Installing $app..." pushd $install_dir - ynh_use_nodejs - ynh_exec_warn_less env $ynh_node_load_PATH corepack enable && COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack prepare pnpm@latest --activate - ynh_exec_warn_less env $ynh_node_load_PATH pnpm --recursive i --production + ynh_hide_warnings corepack enable && corepack prepare pnpm@latest --activate + ynh_hide_warnings pnpm --recursive i --production popd #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=6 +ynh_script_progression "Starting $app's systemd service..." -ynh_systemd_action --service_name=$app --action=restart --log_path=systemd --line_match="Your Etherpad version is" +ynh_systemctl --service=$app --action=restart --log_path=systemd --wait_until="Your Etherpad version is" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Installation of Etherpad completed" --last +ynh_script_progression "Installation of Etherpad completed" diff --git a/scripts/remove b/scripts/remove index 39a81ca..b6f4450 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,39 +1,31 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers -#================================================= -# STANDARD REMOVE #================================================= # REMOVE SERVICE INTEGRATION IN YUNOHOST #================================================= -ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 +ynh_script_progression "Removing system configurations related to $app..." -if ynh_exec_warn_less yunohost service status $app >/dev/null +if ynh_hide_warnings yunohost service status $app >/dev/null then - ynh_script_progression --message="Removing $app service integration..." --weight=2 + ynh_script_progression "Removing $app service integration..." yunohost service remove $app fi -ynh_remove_systemd_config +ynh_config_remove_systemd -ynh_remove_logrotate +ynh_config_remove_logrotate -ynh_remove_nodejs +ynh_nodejs_remove ynh_redis_remove_db "$redis_db" -ynh_remove_nginx_config +ynh_config_remove_nginx #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Removal of $app completed" --last +ynh_script_progression "Removal of $app completed" diff --git a/scripts/restore b/scripts/restore index 1c79226..8e66a0d 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,67 +1,51 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= # RESTORE THE APP MAIN DIR #================================================= -ynh_script_progression --message="Restoring the app main directory..." --weight=2 +ynh_script_progression "Restoring the app main directory..." -ynh_restore_file --origin_path="$install_dir" - -chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" - -chmod 600 "$install_dir/settings.json" -chown $app:$app "$install_dir/settings.json" - -chmod 600 "$install_dir/credentials.json" -chown $app:$app "$install_dir/credentials.json" +ynh_restore "$install_dir" #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=7 +ynh_script_progression "Reinstalling dependencies..." -ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version +ynh_nodejs_install pushd "$install_dir" - ynh_use_nodejs - ynh_exec_warn_less env $ynh_node_load_PATH corepack enable && COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack prepare pnpm@latest --activate + ynh_hide_warnings corepack enable && corepack prepare pnpm@latest --activate popd #================================================= # RESTORE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 +ynh_script_progression "Restoring system configurations related to $app..." -ynh_restore_file --origin_path="/etc/systemd/system/$app.service" +ynh_restore "/etc/systemd/system/$app.service" systemctl enable $app.service --quiet -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_restore "/etc/nginx/conf.d/$domain.d/$app.conf" -ynh_restore_file --origin_path="/etc/logrotate.d/$app" +ynh_restore "/etc/logrotate.d/$app" yunohost service add $app --description="Collaborative editor" --log="/var/log/$app/$app.log" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=8 +ynh_script_progression "Starting $app's systemd service..." -ynh_systemd_action --service_name=$app --action=restart --log_path=systemd --line_match="Your Etherpad version is" +ynh_systemctl --service=$app --action=restart --log_path=systemd --wait_until="Your Etherpad version is" -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemctl --service=nginx --action=reload #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Restoration completed for $app" --last +ynh_script_progression "Restoration completed for $app" diff --git a/scripts/upgrade b/scripts/upgrade index e6bbe3f..4e3f55f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,78 +1,54 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers -#================================================= -# STANDARD UPGRADE STEPS #================================================= # STOP SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Stopping a systemd service..." --weight=42 +ynh_script_progression "Stopping $app's systemd service..." -ynh_systemd_action --service_name=$app --action=stop --log_path="systemd" +ynh_systemctl --service=$app --action=stop --log_path="systemd" #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=2 +ynh_script_progression "Ensuring downward compatibility..." -if [ -z "${language:-}" ]; then - # If upgrading from a version which doesn't support translations, set language to English by default - language=en - ynh_app_setting_set --app=$app --key=language --value=$language -fi +ynh_app_setting_set_default --key=language --value=en -if [ -z "${export:-}" ]; then - export=none - ynh_app_setting_set --app=$app --key=export --value=$export -fi +ynh_app_setting_set_default --key=export --value=none -if [ -z "${path:-}" ]; then - path="/" - ynh_app_setting_set --app=$app --key=path --value=$path -fi +ynh_app_setting_set_default --key=path --value="/" -if [ -z "${password:-}" ]; then - password=$(ynh_string_random --length=32) - ynh_app_setting_set --app=$app --key=password --value="$password" -fi +ynh_app_setting_set_default --key=password --value=$(ynh_string_random --length=32) #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Upgrading source files..." --weight=1 +ynh_script_progression "Upgrading source files..." -ynh_setup_source --dest_dir="$install_dir" --full_replace=1 --keep="settings.json credentials.json" - -chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" +ynh_setup_source --dest_dir="$install_dir" --full_replace --keep="settings.json credentials.json" #================================================= # NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=3 +ynh_script_progression "Upgrading NGINX web server configuration..." -ynh_add_nginx_config +ynh_config_add_nginx -ynh_install_nodejs --nodejs_version=$nodejs_version +ynh_nodejs_install -ynh_add_systemd_config +ynh_config_add_systemd -ynh_use_logrotate --non-append +ynh_config_add_logrotate yunohost service add $app --description="Collaborative editor" --log="/var/log/$app/$app.log" #================================================= # CONFIGURE ETHERPAD #================================================= -ynh_script_progression --message="Configure $app..." --weight=3 +ynh_script_progression "Configure $app..." abiword_path="null" soffice_path="null" @@ -85,36 +61,29 @@ then soffice_path="\"$(which soffice)\"" fi -ynh_add_config --template="settings.json" --destination="$install_dir/settings.json" -ynh_add_config --template="credentials.json" --destination="$install_dir/credentials.json" - -chmod 600 "$install_dir/settings.json" -chown $app:$app "$install_dir/settings.json" - -chmod 600 "$install_dir/credentials.json" -chown $app:$app "$install_dir/credentials.json" +ynh_config_add --template="settings.json" --destination="$install_dir/settings.json" +ynh_config_add --template="credentials.json" --destination="$install_dir/credentials.json" #================================================= # INSTALL ETHERPAD #================================================= -ynh_script_progression --message="Installing $app..." --weight=10 +ynh_script_progression "Installing $app..." pushd $install_dir - ynh_use_nodejs - ynh_exec_warn_less env $ynh_node_load_PATH corepack enable && COREPACK_ENABLE_DOWNLOAD_PROMPT=0 corepack prepare pnpm@latest --activate - ynh_exec_warn_less env $ynh_node_load_PATH pnpm --recursive i --production - ynh_secure_remove --file="$install_dir/var/minified*" + ynh_hide_warnings corepack enable && corepack prepare pnpm@latest --activate + ynh_hide_warnings pnpm --recursive i --production + ynh_safe_rm "$install_dir/var/minified*" popd #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=6 +ynh_script_progression "Starting $app's systemd service..." -ynh_systemd_action --service_name=$app --action=restart --log_path=systemd --line_match="Your Etherpad version is" +ynh_systemctl --service=$app --action=restart --log_path=systemd --wait_until="Your Etherpad version is" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Upgrade of $app completed" --last +ynh_script_progression "Upgrade of $app completed"