From 3731b7ad50d617c7c7771833d251ededa3fe27a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?E=CC=81ric=20Gaspar?= <46165813+ericgaspar@users.noreply.github.com> Date: Fri, 21 Jun 2024 08:42:46 +0200 Subject: [PATCH] cleaning --- .gitignore | 3 ++ config_panel.toml.example | 39 -------------------------- manifest.toml | 1 + scripts/_common.sh | 16 ++--------- scripts/backup | 25 ++++++----------- scripts/change_url | 30 ++++++-------------- scripts/config | 26 ++++++----------- scripts/install | 53 ++++++++++++++++------------------- scripts/remove | 23 ++++++--------- scripts/restore | 34 +++++++++------------- scripts/upgrade | 59 ++++++++++++++++++--------------------- 11 files changed, 105 insertions(+), 204 deletions(-) create mode 100644 .gitignore delete mode 100644 config_panel.toml.example diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8727f14 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*~ +~.sw[op] +.DS_Store diff --git a/config_panel.toml.example b/config_panel.toml.example deleted file mode 100644 index e7e457d..0000000 --- a/config_panel.toml.example +++ /dev/null @@ -1,39 +0,0 @@ -version = "1.0" - -[main] -name = "BookStack configuration" -services = ["__APP__"] - - [main.maintenance_mode] - name = "Maintenance mode" - - [main.maintenance_mode.maintenance_mode] - ask = "Enable maintenance mode" - type = "boolean" - default = "0" - - [main.php_fpm_config] - name = "PHP-FPM configuration" - - [main.php_fpm_config.fpm_footprint] - ask = "Memory footprint" - type = "select" - choices.low = "Low, <= 20Mb per pool" - choices.medium = "Medium, between 20Mb and 40Mb per pool" - choices.high = "High, > 40Mb per pool" - choices.specific = "Use specific value" - default = "low" - - [main.php_fpm_config.fpm_free_footprint] - visible = "fpm_footprint == 'specific'" - ask = "Memory footprint of the service?" - type = "number" - default = "0" - help = "Free field to specify exactly the footprint in Mb if you don't want to use one of the three previous values." - - [main.php_fpm_config.fpm_usage] - ask = "Expected usage" - type = "select" - choices = ["low", "medium", "high"] - default = "low" - help = "low: Personal usage, behind the SSO. No RAM footprint when not used, but the impact on the processor can be high if many users are using the service.
medium: Low usage, few people or/and publicly accessible. Low RAM footprint, medium processor footprint when used.
high: High usage, frequently visited website. High RAM footprint, but lower on processor usage and quickly responding." diff --git a/manifest.toml b/manifest.toml index 2a0d205..26f760b 100644 --- a/manifest.toml +++ b/manifest.toml @@ -19,6 +19,7 @@ code = "https://github.com/BookStackApp/BookStack" [integration] yunohost = ">= 11.2.12" +helpers_version = "2.1" architectures = "all" multi_instance = true diff --git a/scripts/_common.sh b/scripts/_common.sh index cfc7520..4ebac4e 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,19 +1,7 @@ #!/bin/bash #================================================= -# COMMON VARIABLES +# COMMON VARIABLES AND CUSTOM HELPERS #================================================= -YNH_COMPOSER_VERSION=2.5.8 - -#================================================= -# PERSONAL HELPERS -#================================================= - -#================================================= -# EXPERIMENTAL HELPERS -#================================================= - -#================================================= -# FUTURE OFFICIAL HELPERS -#================================================= +composer_version=2.5.8 diff --git a/scripts/backup b/scripts/backup index bc34329..35ecc75 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,44 +1,35 @@ #!/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" #================================================= # BACKUP THE NGINX 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/php/$phpversion/fpm/pool.d/$app.conf" +ynh_backup "/etc/php/$php_version/fpm/pool.d/$app.conf" -ynh_backup --src_path="/etc/systemd/system/$app.service" +ynh_backup "/etc/systemd/system/$app.service" #================================================= # BACKUP THE MYSQL DATABASE #================================================= -ynh_print_info --message="Backing up the MySQL database..." +ynh_print_info "Backing up the MySQL database..." -ynh_mysql_dump_db --database="$db_name" > db.sql +ynh_mysql_dump_db > db.sql #================================================= # 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 49a7f35..6d277e0 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -1,56 +1,44 @@ #!/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=1 +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" -#================================================= -# STANDARD MODIFICATIONS #================================================= # MODIFY URL IN NGINX CONF #================================================= -ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 +ynh_script_progression "Updating NGINX web server configuration..." -ynh_change_url_nginx_config +ynh_config_change_url_nginx #================================================= # MODIFY A CONFIG FILE #================================================= -ynh_script_progression --message="Reconfiguring congif file.." --weight=1 +ynh_script_progression "Reconfiguring congif file.." old_app_url_domain="https://${old_domain}${old_path%/}" pushd $install_dir - yes | php$phpversion artisan bookstack:update-url $old_app_url_domain https://${new_domain}${new_path} + yes | php$php_version artisan bookstack:update-url $old_app_url_domain https://${new_domain}${new_path} popd sed -i "/APP_URL=/c\APP_URL=https://${new_domain}${new_path}" $install_dir/.env -#================================================= -# GENERIC FINALISATION #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=1 +ynh_script_progression "Starting $app's systemd service..." -ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" +ynh_systemctl --service=$app --action="start" --log_path="systemd" #================================================= # 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/config b/scripts/config index c13b81b..e183917 100644 --- a/scripts/config +++ b/scripts/config @@ -1,11 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC STARTING -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers @@ -15,8 +9,8 @@ ynh_abort_if_errors # RETRIEVE ARGUMENTS #================================================= -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -current_fpm_footprint=$(ynh_app_setting_get --app=$app --key=fpm_footprint) +php_version=$(ynh_app_setting_get --key=php_version) +current_fpm_footprint=$(ynh_app_setting_get --key=fpm_footprint) #================================================= # SPECIFIC GETTERS FOR TOML SHORT KEY @@ -62,33 +56,31 @@ get__free_footprint() { set__maintenance_mode() { if [ "$maintenance_mode" -eq "1" ]; then # If maintenance_mode was set to 1, enable maintenance mode - (cd "$install_dir" && ynh_exec_as "$app" \ + (cd "$install_dir" && ynh_exec_as_app \ echo "Site under maintenance." > .maintenance) ynh_print_info "Maintenance mode disabled" elif [ "$maintenance_mode" -eq "0" ]; then # If maintenance_mode was set to 0, disable maintenance mode - ynh_secure_remove --file=$install_dir/.maintenance + ynh_safe_rm $install_dir/.maintenance ynh_print_info "Maintenance mode enabled" fi - ynh_app_setting_set --app=$app --key=maintenance_mode --value="$maintenance_mode" + ynh_app_setting_set --key=maintenance_mode --value="$maintenance_mode" } set__fpm_footprint() { if [ "$fpm_footprint" != "specific" ] then - ynh_app_setting_set --app=$app --key=fpm_footprint --value="$fpm_footprint" + ynh_app_setting_set --key=fpm_footprint --value="$fpm_footprint" fi } set__fpm_free_footprint() { if [ "$fpm_footprint" = "specific" ] then - ynh_app_setting_set --app=$app --key=fpm_footprint --value="$fpm_free_footprint" + ynh_app_setting_set --key=fpm_footprint --value="$fpm_free_footprint" fi } -#================================================= -# GENERIC FINALIZATION #================================================= ynh_app_config_validate() { @@ -103,7 +95,7 @@ ynh_app_config_validate() { if [ "$fpm_footprint" == "0" ] then - ynh_print_err --message="When selecting 'specific', you have to set a footprint value into the field below." + ynh_print_warn "When selecting 'specific', you have to set a footprint value into the field below." exit 0 fi @@ -113,7 +105,7 @@ ynh_app_config_validate() { ynh_app_config_apply() { _ynh_app_config_apply - ynh_add_fpm_config --phpversion=$phpversion --usage=$fpm_usage --footprint=$fpm_footprint + ynh_config_add_phpfpm } ynh_app_config_run $1 diff --git a/scripts/install b/scripts/install index 5d56d3e..b7b38d9 100644 --- a/scripts/install +++ b/scripts/install @@ -1,11 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers @@ -17,58 +11,59 @@ timezone="$(cat /etc/timezone)" redis_db=$(ynh_redis_get_free_db) email=$(ynh_user_get_info --username=$admin --key=mail) -fpm_footprint="low" -fpm_free_footprint=0 -fpm_usage="low" +#REMOVEME? fpm_footprint="low" +#REMOVEME? fpm_free_footprint=0 +#REMOVEME? fpm_usage="low" #================================================= # STORE SETTINGS FROM MANIFEST #================================================= -ynh_app_setting_set --app=$app --key=redis_db --value=$redis_db -ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint -ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint -ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage +ynh_app_setting_set --key=redis_db --value=$redis_db +ynh_app_setting_set --key=fpm_footprint --value=$fpm_footprint +ynh_app_setting_set --key=fpm_free_footprint --value=$fpm_free_footprint +ynh_app_setting_set --key=fpm_usage --value=$fpm_usage #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Setting up source files..." --weight=7 +ynh_script_progression "Setting up source files..." ynh_setup_source --dest_dir="$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 ..." # Create a dedicated PHP-FPM config -ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint +ynh_config_add_phpfpm # Create a dedicated NGINX config -ynh_add_nginx_config +ynh_config_add_nginx # Create a dedicated systemd config -ynh_add_systemd_config +ynh_config_add_systemd yunohost service add $app --description="BookStack Queue Worker" --log="/var/log/$app/$app.log" #================================================= # INSTALL BOOKSTACK WITH COMPOSER #================================================= -ynh_script_progression --message="Installing BookStack with Composer..." --weight=5 +ynh_script_progression "Installing BookStack with Composer..." # Install composer -ynh_install_composer +ynh_composer_install +ynh_composer_exec install --no-dev #================================================= # MODIFY A CONFIG FILE #================================================= -ynh_script_progression --message="Adding a configuration file..." --weight=1 +ynh_script_progression "Adding $app's configuration..." app_url_domain="https://$domain${path%/}" -ynh_add_config --template=.env --destination=$install_dir/.env +ynh_config_add --template=.env --destination=$install_dir/.env chmod 640 $install_dir/.env chown $app:$app $install_dir/.env @@ -76,12 +71,12 @@ chown $app:$app $install_dir/.env #================================================= # FINAL BOOKSTACK INSTALL #================================================= -ynh_script_progression --message="Install BookStack" --weight=5 +ynh_script_progression "Install BookStack" pushd $install_dir - php$phpversion artisan key:generate --no-interaction --force - php$phpversion artisan migrate --no-interaction --force - php$phpversion artisan bookstack:create-admin --email="$email" --name="$admin" --external-auth-id="$admin" + php$php_version artisan key:generate --no-interaction --force + php$php_version artisan migrate --no-interaction --force + php$php_version artisan bookstack:create-admin --email="$email" --name="$admin" --external-auth-id="$admin" popd #================================================= @@ -95,13 +90,13 @@ chown -R $app:www-data $install_dir #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=1 +ynh_script_progression "Starting $app's systemd service..." # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" +ynh_systemctl --service=$app --action="start" --log_path="systemd" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Installation of $app completed" --last +ynh_script_progression "Installation of $app completed" diff --git a/scripts/remove b/scripts/remove index 38872bb..c585619 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,41 +1,36 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers #================================================= # REMOVE SYSTEM CONFIGURATIONS #================================================= -# REMOVE SYSTEMD SERVICE +# REMOVE SYSTEMD SERVICE + #================================================= -ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 +ynh_script_progression "Removing system configurations related to $app..." # 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 +if ynh_hide_warnings yunohost service status $app >/dev/null then - ynh_script_progression --message="Removing $app service integration..." --weight=1 + ynh_script_progression "Removing $app service integration..." yunohost service remove $app fi # Remove the dedicated systemd config -ynh_remove_systemd_config +ynh_config_remove_systemd ynh_redis_remove_db "$redis_db" # Remove the dedicated NGINX config -ynh_remove_nginx_config +ynh_config_remove_nginx # Remove the dedicated PHP-FPM config -ynh_remove_fpm_config +ynh_config_remove_phpfpm #================================================= # 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 a2ea5e3..4b31673 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,20 +1,14 @@ #!/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=1 +ynh_script_progression "Restoring the app main directory..." -ynh_restore_file --origin_path="$install_dir" +ynh_restore "$install_dir" # Restore permissions on app files chmod -R o-rwx $install_dir @@ -25,40 +19,38 @@ chmod 640 $install_dir/.env #================================================= # RESTORE THE MYSQL DATABASE #================================================= -ynh_script_progression --message="Restoring the MySQL database..." --weight=2 +ynh_script_progression "Restoring the MySQL database..." -ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql +ynh_mysql_db_shell < ./db.sql #================================================= # RESTORE SYSTEM CONFIGURATIONS #================================================= # RESTORE THE PHP-FPM CONFIGURATION #================================================= -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/php/$phpversion/fpm/pool.d/$app.conf" +ynh_restore "/etc/php/$php_version/fpm/pool.d/$app.conf" -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/systemd/system/$app.service" +ynh_restore "/etc/systemd/system/$app.service" systemctl enable $app.service --quiet yunohost service add $app --description="BookStack Queue Worker" --log="/var/log/$app/$app.log" -#================================================= -# GENERIC FINALIZATION #================================================= # RELOAD NGINX AND PHP-FPM OR THE APP SERVICE #================================================= -ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1 +ynh_script_progression "Reloading NGINX web server and $app's service..." -ynh_systemd_action --service_name=php$phpversion-fpm --action=reload -ynh_systemd_action --service_name=nginx --action=reload +ynh_systemctl --service=php$php_version-fpm --action=reload +ynh_systemctl --service=nginx --action=reload -ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" +ynh_systemctl --service=$app --action="start" --log_path="systemd" #================================================= # 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 c2e49b7..7cc0c46 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,90 +1,85 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source /usr/share/yunohost/helpers #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 +ynh_script_progression "Ensuring downward compatibility..." # If fpm_footprint doesn't exist, create it if [ -z "${fpm_footprint:-}" ]; then - fpm_footprint=low - ynh_app_setting_set --app=$app --key=fpm_footprint --value=$fpm_footprint + #REMOVEME? fpm_footprint=low + ynh_app_setting_set --key=fpm_footprint --value=$fpm_footprint fi # If fpm_free_footprint doesn't exist, create it if [ -z "${fpm_free_footprint:-}" ]; then - fpm_free_footprint=0 - ynh_app_setting_set --app=$app --key=fpm_free_footprint --value=$fpm_free_footprint + #REMOVEME? fpm_free_footprint=0 + ynh_app_setting_set --key=fpm_free_footprint --value=$fpm_free_footprint fi # If fpm_usage doesn't exist, create it if [ -z "${fpm_usage:-}" ]; then - fpm_usage=low - ynh_app_setting_set --app=$app --key=fpm_usage --value=$fpm_usage + #REMOVEME? fpm_usage=low + ynh_app_setting_set --key=fpm_usage --value=$fpm_usage fi #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Upgrading source files..." --weight=1 +ynh_script_progression "Upgrading source files..." # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$install_dir" --full_replace=1 --keep=".env public/uploads storage/uploads" +ynh_setup_source --dest_dir="$install_dir" --full_replace --keep=".env public/uploads storage/uploads" #================================================= # REAPPLY SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 +ynh_script_progression "Upgrading system configurations related to $app..." # Create a dedicated PHP-FPM config -ynh_add_fpm_config --usage=$fpm_usage --footprint=$fpm_footprint +ynh_config_add_phpfpm # Create a dedicated NGINX config -ynh_add_nginx_config +ynh_config_add_nginx # Create a dedicated systemd config -ynh_add_systemd_config +ynh_config_add_systemd yunohost service add $app --description="BookStack Queue Worker" --log="/var/log/$app/$app.log" #================================================= # INSTALL LYCHEE WITH COMPOSER #================================================= -ynh_script_progression --message="Installing BookStack with Composer..." --weight=5 +ynh_script_progression "Installing BookStack with Composer..." # Install composer -ynh_install_composer +ynh_composer_install +ynh_composer_exec install --no-dev #================================================= # MODIFY A CONFIG FILE #================================================= -#ynh_script_progression --message="Adding a configuration file..." --weight=1 +#ynh_script_progression "Adding $app's configuration..." #timezone="$(cat /etc/timezone)" #app_url_domain="https://$domain${path%/}" -#ynh_add_config --template=.env --destination=$install_dir/.env +#ynh_config_add --template=.env --destination=$install_dir/.env #================================================= # FINAL BOOKSTACK INSTALL #================================================= -ynh_script_progression --message="Install BookStack" --weight=5 +ynh_script_progression "Install BookStack" pushd $install_dir - php$phpversion artisan migrate --force - php$phpversion artisan key:generate --force - php$phpversion artisan cache:clear - php$phpversion artisan config:clear - php$phpversion artisan view:clear + php$php_version artisan migrate --force + php$php_version artisan key:generate --force + php$php_version artisan cache:clear + php$php_version artisan config:clear + php$php_version artisan view:clear popd #================================================= @@ -98,12 +93,12 @@ chown -R $app:www-data $install_dir #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting a systemd service..." --weight=1 +ynh_script_progression "Starting $app's systemd service..." -ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" +ynh_systemctl --service=$app --action="start" --log_path="systemd" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Upgrade of $app completed" --last +ynh_script_progression "Upgrade of $app completed"