diff options
Diffstat (limited to 'scripts')
| -rw-r--r-- | scripts/_common.sh | 14 | ||||
| -rw-r--r-- | scripts/backup | 31 | ||||
| -rw-r--r-- | scripts/install | 128 | ||||
| -rw-r--r-- | scripts/remove | 38 | ||||
| -rw-r--r-- | scripts/restore | 68 | ||||
| -rw-r--r-- | scripts/upgrade | 180 | ||||
| -rw-r--r-- | scripts/ynh_add_swap | 4 |
7 files changed, 179 insertions, 284 deletions
diff --git a/scripts/_common.sh b/scripts/_common.sh index e894197..182e391 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -1,7 +1,7 @@ #!/bin/bash #================================================= -# COMMON VARIABLES +# COMMON VARIABLES AND CUSTOM HELPERS #================================================= memory_needed="2560" @@ -25,15 +25,3 @@ case $YNH_ARCH in ld_preload="LD_PRELOAD=/usr/lib/i386-linux-gnu/libjemalloc.so" ;; esac - -#================================================= -# PERSONAL HELPERS -#================================================= - -#================================================= -# EXPERIMENTAL HELPERS -#================================================= - -#================================================= -# FUTURE OFFICIAL HELPERS -#================================================= diff --git a/scripts/backup b/scripts/backup index de1ba98..e9b18e8 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,31 +1,22 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts 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" #================================================= # SPECIFIC BACKUP @@ -33,31 +24,31 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" # BACKUP LOGROTATE #================================================= -ynh_backup --src_path="/etc/logrotate.d/$app" +ynh_backup "/etc/logrotate.d/$app" #================================================= # BACKUP SYSTEMD #================================================= -ynh_backup --src_path="/etc/systemd/system/$app-web.service" -ynh_backup --src_path="/etc/systemd/system/$app-sidekiq.service" -ynh_backup --src_path="/etc/systemd/system/$app-streaming.service" +ynh_backup "/etc/systemd/system/$app-web.service" +ynh_backup "/etc/systemd/system/$app-sidekiq.service" +ynh_backup "/etc/systemd/system/$app-streaming.service" #================================================= # BACKUP VARIOUS FILES #================================================= -ynh_backup --src_path="/etc/cron.d/$app" +ynh_backup "/etc/cron.d/$app" #================================================= # BACKUP THE POSTGRESQL DATABASE #================================================= -ynh_print_info --message="Backing up the PostgreSQL database..." +ynh_print_info "Backing up the PostgreSQL database..." -ynh_psql_dump_db --database="$db_name" > db.sql +ynh_psql_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/install b/scripts/install index 2d3e68d..7e400d5 100644 --- a/scripts/install +++ b/scripts/install @@ -1,45 +1,38 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source ynh_add_swap source /usr/share/yunohost/helpers admin_mail=$(ynh_user_get_info --username=$admin --key=mail) # Set `service` settings to support `yunohost app shell` command -ynh_app_setting_set --app="$app" --key=service --value="$app-web.service" +ynh_app_setting_set --key=service --value="$app-web.service" #================================================= -# APP "BUILD" (DEPLOYING SOURCES, VENV, COMPILING ETC) +# INSTALL DEPENDENCIES +#================================================= +ynh_script_progression "Installing Ruby and NodeJS..." + +ynh_ruby_install +ynh_nodejs_install + #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Setting up source files..." --weight=1 +ynh_script_progression "Setting up source files..." -# Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$install_dir/live" # Download redis migration script ynh_setup_source --source_id=redis_migration --dest_dir="$install_dir/live" +chmod -R 775 "$install_dir" +chmod o-rwx "$install_dir" chown -R $app:www-data "$install_dir" #================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing Ruby and NodeJS..." --weight=1 - -ynh_exec_warn_less ynh_install_ruby --ruby_version=$ruby_version -ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version - -#================================================= # ADD SWAP IF NEEDED #================================================= -ynh_script_progression --message="Adding swap if needed..." --weight=1 +ynh_script_progression "Adding swap if needed..." total_memory=$(ynh_get_ram --total) swap_needed=0 @@ -49,24 +42,24 @@ if [ $total_memory -lt $memory_needed ]; then swap_needed=$(($memory_needed - $total_memory)) fi -ynh_script_progression --message="Adding $swap_needed Mo to swap..." --weight=1 +ynh_script_progression "Adding $swap_needed Mo to swap..." ynh_add_swap --size=$swap_needed #================================================= # ADD A CONFIGURATION #================================================= -ynh_script_progression --message="Adding a configuration file..." --weight=1 +ynh_script_progression "Adding $app's configuration..." config="$install_dir/live/.env.production" language="$(echo $language | head -c 2)" secret_key_base=$(ynh_string_random --length=128) -ynh_app_setting_set --app="$app" --key=secret_key_base --value="$secret_key_base" +ynh_app_setting_set --key=secret_key_base --value="$secret_key_base" otp_secret=$(ynh_string_random --length=128) -ynh_app_setting_set --app="$app" --key=otp_secret --value="$otp_secret" +ynh_app_setting_set --key=otp_secret --value="$otp_secret" # We need bundle exec rails to build vapid keys, we generate them later once the app is installed vapid_private_key="" @@ -77,101 +70,92 @@ active_record_encryption_deterministic_key="" active_record_encryption_key_derivation_salt="" active_record_encryption_primary_key="" -ynh_add_config --template=".env.production.sample" --destination="$config" -chmod 400 "$config" -chown $app:$app "$config" +ynh_config_add --template=".env.production.sample" --destination="$config" #================================================= # BUILD APP #================================================= -ynh_script_progression --message="Building app..." --weight=1 +ynh_script_progression "Building app..." pushd "$install_dir/live" - # Building ruby packages - ynh_use_ruby - ynh_gem update --system - ynh_gem install bundler --no-document - ynh_exec_as $app $ynh_ruby_load_path $ld_preload bin/bundle config deployment 'true' - ynh_exec_as $app $ynh_ruby_load_path $ld_preload bin/bundle config without 'development test' - ynh_exec_as $app $ynh_ruby_load_path $ld_preload bin/bundle config set force_ruby_platform true --quiet - ynh_exec_warn_less ynh_exec_as $app $ynh_ruby_load_path $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN) - ynh_use_nodejs - env $ynh_node_load_PATH corepack enable - echo Y | ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn workspaces focus --production - ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn install --immutable + gem update --system + gem install bundler --no-document + ynh_hide_warnings ynh_exec_as_app $ld_preload bin/bundle config deployment 'true' + ynh_hide_warnings ynh_exec_as_app $ld_preload bin/bundle config without 'development test' + ynh_hide_warnings ynh_exec_as_app $ld_preload bin/bundle config set force_ruby_platform true --quiet + ynh_hide_warnings ynh_exec_as_app $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN) + + env corepack enable + echo Y | ynh_hide_warnings ynh_exec_as_app yarn workspaces focus --production + ynh_hide_warnings ynh_exec_as_app yarn install --immutable echo "SAFETY_ASSURED=1">> $config # Generate vapid keys - ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails mastodon:webpush:generate_vapid_key > vapid_key.txt + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/bundle exec rails mastodon:webpush:generate_vapid_key > vapid_key.txt # Generate active record encryption - ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails db:encryption:init > active_record_encryption.txt + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/bundle exec rails db:encryption:init > active_record_encryption.txt popd # Re-generate config with vapid keys and active record encryption vapid_private_key=$(grep -oP "VAPID_PRIVATE_KEY=\K.+" "$install_dir/live/vapid_key.txt") -ynh_app_setting_set --app="$app" --key=vapid_private_key --value="$vapid_private_key" +ynh_app_setting_set --key=vapid_private_key --value="$vapid_private_key" vapid_public_key=$(grep -oP "VAPID_PUBLIC_KEY=\K.+" "$install_dir/live/vapid_key.txt") -ynh_app_setting_set --app="$app" --key=vapid_public_key --value="$vapid_public_key" -ynh_secure_remove --file="$install_dir/live/vapid_key.txt" +ynh_app_setting_set --key=vapid_public_key --value="$vapid_public_key" +ynh_safe_rm "$install_dir/live/vapid_key.txt" active_record_encryption_deterministic_key=$(grep -oP "ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY=\K.+" "$install_dir/live/active_record_encryption.txt") -ynh_app_setting_set --app="$app" --key=active_record_encryption_deterministic_key --value="$active_record_encryption_deterministic_key" +ynh_app_setting_set --key=active_record_encryption_deterministic_key --value="$active_record_encryption_deterministic_key" active_record_encryption_key_derivation_salt=$(grep -oP "ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT=\K.+" "$install_dir/live/active_record_encryption.txt") -ynh_app_setting_set --app="$app" --key=active_record_encryption_key_derivation_salt --value="$active_record_encryption_key_derivation_salt" +ynh_app_setting_set --key=active_record_encryption_key_derivation_salt --value="$active_record_encryption_key_derivation_salt" active_record_encryption_primary_key=$(grep -oP "ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY=\K.+" "$install_dir/live/active_record_encryption.txt") -ynh_app_setting_set --app="$app" --key=active_record_encryption_primary_key --value="$active_record_encryption_primary_key" -ynh_secure_remove --file="$install_dir/live/active_record_encryption.txt" -ynh_delete_file_checksum --file="$config" -ynh_add_config --template=".env.production.sample" --destination="$config" -chmod 400 "$config" -chown $app:$app "$config" +ynh_app_setting_set --key=active_record_encryption_primary_key --value="$active_record_encryption_primary_key" +ynh_safe_rm "$install_dir/live/active_record_encryption.txt" +ynh_delete_file_checksum "$config" +ynh_config_add --template=".env.production.sample" --destination="$config" pushd "$install_dir/live" - ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails db:migrate --quiet - ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails db:seed --quiet - ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails assets:precompile --quiet + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/bundle exec rails db:migrate --quiet + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/bundle exec rails db:seed --quiet + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/bundle exec rails assets:precompile --quiet # Create the first admin user - ynh_exec_quiet ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/tootctl accounts create "$admin" --email="$admin_mail" --confirmed --role=Owner - ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/tootctl accounts approve "$admin" + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/tootctl accounts create "$admin" --email="$admin_mail" --confirmed --role=Owner + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/tootctl accounts approve "$admin" popd #================================================= # 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 NGINX config using the conf/nginx.conf template -ynh_add_nginx_config +ynh_config_add_nginx # Create a dedicated systemd config -ynh_add_systemd_config --service="$app-web" --template="mastodon-web.service" +ynh_config_add_systemd --service="$app-web" --template="mastodon-web.service" yunohost service add "$app-web" --description="$app web service" -ynh_add_systemd_config --service="$app-sidekiq" --template="mastodon-sidekiq.service" +ynh_config_add_systemd --service="$app-sidekiq" --template="mastodon-sidekiq.service" yunohost service add "$app-sidekiq" --description="$app sidekiq service" -ynh_add_systemd_config --service="$app-streaming" --template="mastodon-streaming.service" +ynh_config_add_systemd --service="$app-streaming" --template="mastodon-streaming.service" yunohost service add "$app-streaming" --description="$app streaming service" # Create a cron file -ynh_add_config --template="cron" --destination="/etc/cron.d/$app" +ynh_config_add --template="cron" --destination="/etc/cron.d/$app" # Use logrotate to manage application logfile(s) mkdir -p /var/log/$app -chown $app:$app /var/log/$app -ynh_use_logrotate +ynh_config_add_logrotate #================================================= -# GENERIC FINALIZATION -#================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting all systemd services..." --weight=1 +ynh_script_progression "Starting all systemd services..." -ynh_systemd_action --service_name=${app}-web --action="start" --log_path=/var/log/$app/$app-web.log --line_match="Listening on" -ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=/var/log/$app/$app-sidekiq.log --line_match="Schedules Loaded" -ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=/var/log/$app/$app-streaming.log --line_match="Streaming API now listening" +ynh_systemctl --service=${app}-web --action="start" --log_path=/var/log/$app/$app-web.log --wait_until="Listening on" +ynh_systemctl --service=${app}-sidekiq --action="start" --log_path=/var/log/$app/$app-sidekiq.log --wait_until="Schedules Loaded" +ynh_systemctl --service=${app}-streaming --action="start" --log_path=/var/log/$app/$app-streaming.log --wait_until="Streaming API now listening" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Installation of $app completed" --last +ynh_script_progression "Installation of $app completed"
\ No newline at end of file diff --git a/scripts/remove b/scripts/remove index c8ca3a3..297786f 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,11 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source ynh_add_swap source /usr/share/yunohost/helpers @@ -15,44 +9,44 @@ source /usr/share/yunohost/helpers #================================================= # 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-web" >/dev/null +if ynh_hide_warnings yunohost service status "$app-web" >/dev/null then - ynh_script_progression --message="Removing $app-web service integration..." --weight=1 + ynh_script_progression "Removing $app-web service integration..." yunohost service remove "$app-web" fi -if ynh_exec_warn_less yunohost service status "$app-sidekiq" >/dev/null +if ynh_hide_warnings yunohost service status "$app-sidekiq" >/dev/null then - ynh_script_progression --message="Removing $app-sidekiq service integration..." --weight=1 + ynh_script_progression "Removing $app-sidekiq service integration..." yunohost service remove "$app-sidekiq" fi -if ynh_exec_warn_less yunohost service status "$app-streaming" >/dev/null +if ynh_hide_warnings yunohost service status "$app-streaming" >/dev/null then - ynh_script_progression --message="Removing $app-streaming service integration..." --weight=1 + ynh_script_progression "Removing $app-streaming service integration..." yunohost service remove "$app-streaming" fi # Remove the dedicated systemd config -ynh_remove_systemd_config --service="$app-web" -ynh_remove_systemd_config --service="$app-sidekiq" -ynh_remove_systemd_config --service="$app-streaming" +ynh_config_remove_systemd "$app-web" +ynh_config_remove_systemd "$app-sidekiq" +ynh_config_remove_systemd "$app-streaming" # Remove the dedicated NGINX config -ynh_remove_nginx_config +ynh_config_remove_nginx # Remove a cron file -ynh_secure_remove --file="/etc/cron.d/$app" +ynh_safe_rm "/etc/cron.d/$app" # Remote logrotate config -ynh_remove_logrotate +ynh_config_remove_logrotate # Remove metapackage and its dependencies -ynh_remove_ruby -ynh_remove_nodejs +ynh_ruby_remove +ynh_nodejs_remove # Remove swap ynh_del_swap @@ -61,4 +55,4 @@ ynh_del_swap # 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 48e1384..0becd6c 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,11 +1,5 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source ../settings/scripts/ynh_add_swap @@ -16,26 +10,22 @@ source /usr/share/yunohost/helpers #================================================= # RESTORE THE APP MAIN DIR #================================================= -ynh_script_progression --message="Restoring the app main directory..." --weight=1 - -ynh_restore_file --origin_path="$install_dir" +ynh_script_progression "Restoring the app main directory..." -chmod 750 "$install_dir" -chmod -R o-rwx "$install_dir" -chown -R $app:www-data "$install_dir" +ynh_restore "$install_dir" #================================================= # RESTORE THE POSTGRESQL DATABASE #================================================= -ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=1 +ynh_script_progression "Restoring the PostgreSQL database..." -ynh_psql_execute_as_root --sql="ALTER USER $db_user CREATEDB;" -ynh_psql_execute_file_as_root --file="./db.sql" --database="$db_name" +ynh_psql_db_shell <<< "ALTER USER $db_user CREATEDB;" +ynh_psql_db_shell < "./db.sql" #================================================= # ADD SWAP IF NEEDED #================================================= -ynh_script_progression --message="Adding swap if needed..." --weight=1 +ynh_script_progression "Adding swap if needed..." total_memory=$(ynh_get_ram --total) swap_needed=0 @@ -45,28 +35,27 @@ if [ $total_memory -lt $memory_needed ]; then swap_needed=$(($memory_needed - $total_memory)) fi -ynh_script_progression --message="Adding $swap_needed Mo to swap..." --weight=1 +ynh_script_progression "Adding $swap_needed Mo to swap..." ynh_add_swap --size=$swap_needed #================================================= # REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling Ruby and NodeJS..." --weight=1 +ynh_script_progression "Reinstalling Ruby and NodeJS..." -ynh_exec_warn_less ynh_install_ruby --ruby_version=$ruby_version -ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version +ynh_ruby_install +ynh_nodejs_install #================================================= # BUILD APP #================================================= -ynh_script_progression --message="Building app..." --weight=1 +ynh_script_progression "Building app..." pushd "$install_dir/live" - ynh_use_ruby - ynh_gem update --system - ynh_gem install bundler --no-document - ynh_exec_warn_less ynh_exec_as $app $ynh_ruby_load_path $ld_preload bin/bundle install --redownload -j$(getconf _NPROCESSORS_ONLN) + gem update --system + gem install bundler --no-document + ynh_hide_warnings ynh_exec_as_app $ld_preload bin/bundle install --redownload -j$(getconf _NPROCESSORS_ONLN) popd #================================================= @@ -74,40 +63,37 @@ popd #================================================= # 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/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-web.service" -ynh_restore_file --origin_path="/etc/systemd/system/$app-sidekiq.service" -ynh_restore_file --origin_path="/etc/systemd/system/$app-streaming.service" +ynh_restore "/etc/systemd/system/$app-web.service" +ynh_restore "/etc/systemd/system/$app-sidekiq.service" +ynh_restore "/etc/systemd/system/$app-streaming.service" systemctl enable "$app-web" "$app-sidekiq" "$app-streaming" --quiet yunohost service add "$app-web" --description="$app web service" yunohost service add "$app-sidekiq" --description="$app sidekiq service" yunohost service add "$app-streaming" --description="$app streaming service" -ynh_restore_file --origin_path="/etc/cron.d/$app" +ynh_restore "/etc/cron.d/$app" mkdir -p /var/log/$app -chown -R $app:$app /var/log/$app -ynh_restore_file --origin_path="/etc/logrotate.d/$app" +ynh_restore "/etc/logrotate.d/$app" #================================================= -# GENERIC FINALIZATION -#================================================= # RELOAD NGINX AND 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=${app}-web --action="start" --log_path=/var/log/$app/$app-web.log --line_match="Listening on" -ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=/var/log/$app/$app-sidekiq.log --line_match="Schedules Loaded" -ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=/var/log/$app/$app-streaming.log --line_match="Streaming API now listening" +ynh_systemctl --service=${app}-web --action="start" --log_path=/var/log/$app/$app-web.log --wait_until="Listening on" +ynh_systemctl --service=${app}-sidekiq --action="start" --log_path=/var/log/$app/$app-sidekiq.log --wait_until="Schedules Loaded" +ynh_systemctl --service=${app}-streaming --action="start" --log_path=/var/log/$app/$app-streaming.log --wait_until="Streaming API now listening" -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 746d009..769b47c 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,77 +1,39 @@ #!/bin/bash -#================================================= -# GENERIC START -#================================================= -# IMPORT GENERIC HELPERS -#================================================= - source _common.sh source ynh_add_swap source /usr/share/yunohost/helpers -upgrade_type=$(ynh_check_app_version_changed) config="$install_dir/live/.env.production" +if ynh_app_upgrading_from_version_before 4.2.8~ynh2; then + ynh_die "Your installation is to old to update to this version. \ + \nPlease first manually update with 4.4.3~ynh1 with the following command: \ + \n's\0u\0d\0o yunohost app upgrade $app -u https://github.com/YunoHost-Apps/mastodon_ynh/commit/8fb1c6c7818430e8ac49f3ae589c6575614f5e4b' \ + \nOnce done you can upgrade to the latest version." +fi + #================================================= # STOP SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Stopping a systemd service..." --weight=1 -if ynh_compare_current_package_version --comparison lt --version "4.2.8~ynh2"; then - # Workaround for pre-packagingv2 versions - ynh_systemd_action --service_name=${app}-web --action="stop" --log_path="systemd" --line_match="Goodbye" - ynh_systemd_action --service_name=${app}-sidekiq --action="stop" --log_path="systemd" --line_match="Bye" - ynh_systemd_action --service_name=${app}-streaming --action="stop" --log_path="systemd" -else - ynh_systemd_action --service_name=${app}-web --action="stop" --log_path=/var/log/$app/$app-web.log --line_match="Goodbye" - ynh_systemd_action --service_name=${app}-sidekiq --action="stop" --log_path=/var/log/$app/$app-sidekiq.log --line_match="Bye" - ynh_systemd_action --service_name=${app}-streaming --action="stop" --log_path=/var/log/$app/$app-streaming.log -fi +ynh_script_progression "Stopping $app's systemd service..." + ynh_systemctl --service=${app}-web --action="stop" --log_path=/var/log/$app/$app-web.log --wait_until="Goodbye" + ynh_systemctl --service=${app}-sidekiq --action="stop" --log_path=/var/log/$app/$app-sidekiq.log --wait_until="Bye" + ynh_systemctl --service=${app}-streaming --action="stop" --log_path=/var/log/$app/$app-streaming.log #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 +ynh_script_progression "Ensuring downward compatibility..." # Set `service` settings to support `yunohost app shell` command -if [[ -z "${service:-}" ]]; then - service="$app-web.service" - ynh_app_setting_set --app="$app" --key=service --value="$service" -fi -# Set `redis_namespace` settings -if [[ -z "${redis_namespace:-}" ]]; then - redis_namespace=${app}_production - ynh_app_setting_set --app="$app" --key=redis_namespace --value="$redis_namespace" -fi - -# Remove previous added repository -ynh_remove_extra_repo - -if ynh_compare_current_package_version --comparison lt --version "4.2.8~ynh2"; then - # Rename legacy database - if ynh_psql_database_exists --database="${app}_production"; then - db_name=$(ynh_sanitize_dbid --db_name="$app") - ynh_app_setting_set --app="$app" --key="db_name" --value="$db_name" - - # Remove the newly created db by resources, and rename legacy db - ynh_psql_execute_as_root --sql="DROP DATABASE IF EXISTS $db_name;" - ynh_psql_execute_as_root --sql="ALTER DATABASE ${app}_production RENAME TO $db_name;" - fi - # Same with user - if ynh_psql_user_exists --user="${app}_production"; then - db_user="$db_name" - ynh_app_setting_set --app="$app" --key="db_user" --value="$db_user" - - ynh_psql_execute_as_root --sql="DROP USER IF EXISTS $db_user;" - ynh_psql_execute_as_root --sql="ALTER USER ${app}_production RENAME $db_user;" - fi -fi +ynh_app_setting_set_default --key=service --value="$app-web.service" #================================================= # ADD SWAP IF NEEDED #================================================= -ynh_script_progression --message="Adding swap if needed..." --weight=1 +ynh_script_progression "Adding swap if needed..." total_memory=$(ynh_get_ram --total) swap_needed=0 @@ -81,16 +43,16 @@ if [ $total_memory -lt $memory_needed ]; then swap_needed=$(($memory_needed - $total_memory)) fi -ynh_script_progression --message="Adding $swap_needed Mo to swap..." +ynh_script_progression "Adding $swap_needed Mo to swap..." ynh_add_swap --size=$swap_needed #================================================= # UPGRADE DEPENDENCIES #================================================= -ynh_script_progression --message="Upgrading Ruby and NodeJS..." --weight=1 +ynh_script_progression "Upgrading Ruby and NodeJS..." -ynh_exec_warn_less ynh_install_ruby --ruby_version=$ruby_version -ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version +ynh_ruby_install +ynh_nodejs_install #================================================= # "REBUILD" THE APP (DEPLOY NEW SOURCES, RERUN NPM BUILD...) @@ -98,113 +60,103 @@ ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." --weight=1 +ynh_script_progression "Upgrading source files..." - # Download, check integrity, uncompress and patch the source from manifest.toml - ynh_setup_source --dest_dir="$install_dir/live" --full_replace=1 --keep="public/system .env.production" - # Download redis migration script - ynh_setup_source --source_id=redis_migration --dest_dir="$install_dir/live" +# Download, check integrity, uncompress and patch the source from manifest.toml +ynh_setup_source --dest_dir="$install_dir/live" --full_replace --keep="public/system .env.production" +# Download redis migration script +ynh_setup_source --source_id=redis_migration --dest_dir="$install_dir/live" - chmod 750 "$install_dir" - chmod -R o-rwx "$install_dir" - chown -R $app:www-data "$install_dir" -fi +chmod -R 775 "$install_dir" +chmod o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # BUILD ASSETS #================================================= -ynh_script_progression --message="Building assets..." --weight=1 +ynh_script_progression "Building assets..." pushd "$install_dir/live" - ynh_use_ruby - ynh_gem update --system - ynh_gem install bundler --no-document - ynh_exec_as $app $ynh_ruby_load_path $ld_preload bin/bundle config deployment 'true' - ynh_exec_as $app $ynh_ruby_load_path $ld_preload bin/bundle config without 'development test' - ynh_exec_as $app $ynh_ruby_load_path $ld_preload bin/bundle config set force_ruby_platform true --quiet - ynh_exec_warn_less ynh_exec_as $app $ynh_ruby_load_path $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN) - ynh_use_nodejs - env $ynh_node_load_PATH corepack enable - echo Y | ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn workspaces focus --production - ynh_exec_warn_less ynh_exec_as $app env $ynh_node_load_PATH yarn install --immutable + gem update --system + gem install bundler --no-document + ynh_hide_warnings ynh_exec_as_app $ld_preload bin/bundle config deployment 'true' + ynh_hide_warnings ynh_exec_as_app $ld_preload bin/bundle config without 'development test' + ynh_hide_warnings ynh_exec_as_app $ld_preload bin/bundle config set force_ruby_platform true --quiet + ynh_hide_warnings ynh_exec_as_app $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN) + + env corepack enable + echo Y | ynh_hide_warnings ynh_exec_as_app yarn workspaces focus --production + ynh_hide_warnings ynh_exec_as_app yarn install --immutable popd -chown "$app:www-data" "$install_dir" chown -R "$app:www-data" "$install_dir/live/public" #================================================= # REAPPLY SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 +ynh_script_progression "Upgrading system configurations related to $app..." -ynh_add_nginx_config +ynh_config_add_nginx # Create a dedicated systemd config -ynh_add_systemd_config --service="$app-web" --template="mastodon-web.service" +ynh_config_add_systemd --service="$app-web" --template="mastodon-web.service" yunohost service add "$app-web" --description="$app web service" -ynh_add_systemd_config --service="$app-sidekiq" --template="mastodon-sidekiq.service" +ynh_config_add_systemd --service="$app-sidekiq" --template="mastodon-sidekiq.service" yunohost service add "$app-sidekiq" --description="$app sidekiq service" -ynh_add_systemd_config --service="$app-streaming" --template="mastodon-streaming.service" +ynh_config_add_systemd --service="$app-streaming" --template="mastodon-streaming.service" yunohost service add "$app-streaming" --description="$app streaming service" -ynh_add_config --template="cron" --destination="/etc/cron.d/$app" +ynh_config_add --template="cron" --destination="/etc/cron.d/$app" # Use logrotate to manage app-specific logfile(s) mkdir -p /var/log/$app -chown $app:$app /var/log/$app -ynh_use_logrotate --non-append +ynh_config_add_logrotate #================================================= # RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS...) #================================================= # UPDATE A CONFIG FILE #================================================= -ynh_script_progression --message="Updating a config file..." --weight=1 +ynh_script_progression "Updating a config file..." -if ynh_compare_current_package_version --comparison lt --version "4.3.2~ynh1"; then +if ynh_app_upgrading_from_version_before 4.3.2~ynh1; then pushd "$install_dir/live" - ynh_use_ruby + # Generate active record encryption - ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails db:encryption:init > active_record_encryption.txt + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/bundle exec rails db:encryption:init > active_record_encryption.txt active_record_encryption_deterministic_key=$(grep -oP "ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY=\K.+" "$install_dir/live/active_record_encryption.txt") - ynh_app_setting_set --app="$app" --key=active_record_encryption_deterministic_key --value="$active_record_encryption_deterministic_key" + ynh_app_setting_set --key=active_record_encryption_deterministic_key --value="$active_record_encryption_deterministic_key" active_record_encryption_key_derivation_salt=$(grep -oP "ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT=\K.+" "$install_dir/live/active_record_encryption.txt") - ynh_app_setting_set --app="$app" --key=active_record_encryption_key_derivation_salt --value="$active_record_encryption_key_derivation_salt" + ynh_app_setting_set --key=active_record_encryption_key_derivation_salt --value="$active_record_encryption_key_derivation_salt" active_record_encryption_primary_key=$(grep -oP "ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY=\K.+" "$install_dir/live/active_record_encryption.txt") - ynh_app_setting_set --app="$app" --key=active_record_encryption_primary_key --value="$active_record_encryption_primary_key" - ynh_secure_remove --file="$install_dir/live/active_record_encryption.txt" + ynh_app_setting_set --key=active_record_encryption_primary_key --value="$active_record_encryption_primary_key" + ynh_safe_rm "$install_dir/live/active_record_encryption.txt" popd fi language="$(echo $language | head -c 2)" -ynh_add_config --template=".env.production.sample" --destination="$config" - -chmod 400 "$config" -chown $app:$app "$config" +ynh_config_add --template=".env.production.sample" --destination="$config" #================================================= # APPLY MIGRATIONS #================================================= -ynh_script_progression --message="Applying migrations..." --weight=1 +ynh_script_progression "Applying migrations..." pushd "$install_dir/live" - ynh_use_ruby - ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails db:migrate --quiet - ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails assets:precompile --quiet + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/bundle exec rails db:migrate --quiet + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/bundle exec rails assets:precompile --quiet # Apply redis namespace migration (https://github.com/mastodon/redis_namespace_migration) - ynh_exec_warn_less ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/rails runner rename.rb - redis_namespace="$(ynh_app_setting_get --app=$app --key=redis_namespace)" + ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 $ld_preload bin/rails runner rename.rb + redis_namespace="$(ynh_app_setting_get --key=redis_namespace)" if [ $redis_namespace ]; then - if [ ynh_app_setting_get --app=$app --key=es_enabled == "true" ] && [ ynh_app_setting_get --app=$app --key=es_prefix == "" ]; then - ynh_app_setting_set --app=$app --key=es_prefix --value=$redis_namespace + if [ ynh_app_setting_get --key=es_enabled == "true" ] && [ ynh_app_setting_get --key=es_prefix == "" ]; then + ynh_app_setting_set --key=es_prefix --value=$redis_namespace else - ynh_app_setting_delete --app=$app --key=redis_namespace + ynh_app_setting_delete --key=redis_namespace fi fi popd @@ -212,14 +164,14 @@ popd #================================================= # 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}-web --action="restart" --log_path=/var/log/$app/$app-web.log --line_match="Listening on" -ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=/var/log/$app/$app-sidekiq.log --line_match="Schedules Loaded" -ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=/var/log/$app/$app-streaming.log --line_match="Streaming API now listening" +ynh_systemctl --service=${app}-web --action="restart" --log_path=/var/log/$app/$app-web.log --wait_until="Listening on" +ynh_systemctl --service=${app}-sidekiq --action="start" --log_path=/var/log/$app/$app-sidekiq.log --wait_until="Schedules Loaded" +ynh_systemctl --service=${app}-streaming --action="start" --log_path=/var/log/$app/$app-streaming.log --wait_until="Streaming API now listening" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Upgrade of $app completed" --last +ynh_script_progression "Upgrade of $app completed" diff --git a/scripts/ynh_add_swap b/scripts/ynh_add_swap index aa82c51..f99e1a7 100644 --- a/scripts/ynh_add_swap +++ b/scripts/ynh_add_swap @@ -22,14 +22,14 @@ ynh_add_swap () { # Can't swap inside an LXD if [ "$(systemd-detect-virt)" == "lxc" ] then - ynh_print_warn --message="You are inside a LXC container, swap will not be added, but that can cause troubles for the app $app. Please make sure you have more than 2.5G available RAM." + ynh_print_warn "You are inside a LXC container, swap will not be added, but that can cause troubles for the app $app. Please make sure you have more than 2.5G available RAM." return fi # Swap on SD card only if it's is specified if ynh_is_main_device_a_sd_card && [ "$SD_CARD_CAN_SWAP" == "0" ] then - ynh_print_warn --message="The main mountpoint of your system '/' is on an SD card, swap will not be added to prevent some damage of this one, but that can cause troubles for the app $app. If you still want activate the swap, you can relaunch the command preceded by 'SD_CARD_CAN_SWAP=1'" + ynh_print_warn "The main mountpoint of your system '/' is on an SD card, swap will not be added to prevent some damage of this one, but that can cause troubles for the app $app. If you still want activate the swap, you can relaunch the command preceded by 'SD_CARD_CAN_SWAP=1'" return fi |