diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8f144f3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*~ +*.sw[op] +.DS_Store diff --git a/conf/cron b/conf/cron index 02b2a6a..ca08f7f 100644 --- a/conf/cron +++ b/conf/cron @@ -1,7 +1,7 @@ # This is a system cron file, see crontab(5) # m h dom mon dow user command -@daily __APP__ cd __INSTALL_DIR__/live && __YNH_RUBY_LOAD_PATH__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl media remove -@monthly __APP__ cd __INSTALL_DIR__/live && __YNH_RUBY_LOAD_PATH__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl media remove-orphans -@monthly __APP__ cd __INSTALL_DIR__/live && __YNH_RUBY_LOAD_PATH__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl accounts cull -@monthly __APP__ cd __INSTALL_DIR__/live && __YNH_RUBY_LOAD_PATH__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl statuses remove -@monthly __APP__ cd __INSTALL_DIR__/live && __YNH_RUBY_LOAD_PATH__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl preview_cards remove +@daily __APP__ cd __INSTALL_DIR__/live && PATH=__PATH_WITH_RUBY__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl media remove +@monthly __APP__ cd __INSTALL_DIR__/live && PATH=__PATH_WITH_RUBY__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl media remove-orphans +@monthly __APP__ cd __INSTALL_DIR__/live && PATH=__PATH_WITH_RUBY__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl accounts cull +@monthly __APP__ cd __INSTALL_DIR__/live && PATH=__PATH_WITH_RUBY__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl statuses remove +@monthly __APP__ cd __INSTALL_DIR__/live && PATH=__PATH_WITH_RUBY__ __LD_PRELOAD__ RAILS_ENV=production bin/tootctl preview_cards remove diff --git a/conf/glitchsoc-sidekiq.service b/conf/glitchsoc-sidekiq.service index 9dbd3a9..83f6629 100644 --- a/conf/glitchsoc-sidekiq.service +++ b/conf/glitchsoc-sidekiq.service @@ -10,7 +10,7 @@ Environment="__LD_PRELOAD__" Environment="RAILS_ENV=production" Environment="DB_POOL=25" Environment="MALLOC_ARENA_MAX=2" -Environment="__YNH_RUBY_LOAD_PATH__" +Environment="PATH=__PATH_WITH_RUBY__" ExecStart=__INSTALL_DIR__/live/bin/bundle exec sidekiq -c 25 TimeoutSec=15 Restart=always diff --git a/conf/glitchsoc-streaming.service b/conf/glitchsoc-streaming.service index bc5b00e..6b5dbe4 100644 --- a/conf/glitchsoc-streaming.service +++ b/conf/glitchsoc-streaming.service @@ -8,8 +8,8 @@ User=__APP__ WorkingDirectory=__INSTALL_DIR__/live Environment="NODE_ENV=production" Environment="PORT=__PORT_STREAM__" -Environment="__YNH_NODE_LOAD_PATH__" -ExecStart=__YNH_NODE__ ./streaming +Environment="PATH=__PATH_WITH_NODEJS__" +ExecStart=__NODEJS_DIR__/node ./streaming TimeoutSec=15 Restart=always StandardOutput=append:/var/log/__APP__/__APP__-streaming.log diff --git a/conf/glitchsoc-web.service b/conf/glitchsoc-web.service index 133fc3b..f083a8b 100644 --- a/conf/glitchsoc-web.service +++ b/conf/glitchsoc-web.service @@ -9,7 +9,7 @@ WorkingDirectory=__INSTALL_DIR__/live Environment="__LD_PRELOAD__" Environment="RAILS_ENV=production" Environment="PORT=__PORT_WEB__" -Environment="__YNH_RUBY_LOAD_PATH__" +Environment="PATH=__PATH_WITH_RUBY__" ExecStart=__INSTALL_DIR__/live/bin/bundle exec puma -C config/puma.rb ExecReload=/bin/kill -SIGUSR1 $MAINPID TimeoutSec=15 diff --git a/manifest.toml b/manifest.toml index 78dcd70..3cf8384 100644 --- a/manifest.toml +++ b/manifest.toml @@ -60,6 +60,7 @@ ram.runtime = "500M" allow_email = true [resources.install_dir] + group = "www-data:r-x" [resources.permissions] main.url = "/" diff --git a/scripts/_common.sh b/scripts/_common.sh index 4049d21..732de57 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" @@ -32,15 +32,3 @@ then else ld_preload="" fi - -#================================================= -# PERSONAL HELPERS -#================================================= - -#================================================= -# EXPERIMENTAL HELPERS -#================================================= - -#================================================= -# FUTURE OFFICIAL HELPERS -#================================================= diff --git a/scripts/backup b/scripts/backup index f0eba7b..ee90243 100644 --- a/scripts/backup +++ b/scripts/backup @@ -8,46 +8,43 @@ 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 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-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" -ynh_backup --src_path="/var/log/$app/" +ynh_backup "/var/log/$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 e07a841..14c1853 100644 --- a/scripts/install +++ b/scripts/install @@ -25,52 +25,52 @@ max_image_size="8388608" max_video_size="41943040" max_emoji_size="51200" max_remote_emoji_size="204800" -ynh_app_setting_set --app="$app" --key="max_toot_chars" --value="$max_toot_chars" -ynh_app_setting_set --app="$app" --key="max_pinned_toots" --value="$max_pinned_toots" -ynh_app_setting_set --app="$app" --key="max_bio_chars" --value="$max_bio_chars" -ynh_app_setting_set --app="$app" --key="max_profile_fields" --value="$max_profile_fields" -ynh_app_setting_set --app="$app" --key="max_display_name_chars" --value="$max_display_name_chars" -ynh_app_setting_set --app="$app" --key="max_poll_options" --value="$max_poll_options" -ynh_app_setting_set --app="$app" --key="max_poll_option_chars" --value="$max_poll_option_chars" -ynh_app_setting_set --app="$app" --key="max_image_size" --value="$max_image_size" -ynh_app_setting_set --app="$app" --key="max_video_size" --value="$max_video_size" -ynh_app_setting_set --app="$app" --key="max_emoji_size" --value="$max_emoji_size" -ynh_app_setting_set --app="$app" --key="max_remote_emoji_size" --value="$max_remote_emoji_size" +ynh_app_setting_set --key="max_toot_chars" --value="$max_toot_chars" +ynh_app_setting_set --key="max_pinned_toots" --value="$max_pinned_toots" +ynh_app_setting_set --key="max_bio_chars" --value="$max_bio_chars" +ynh_app_setting_set --key="max_profile_fields" --value="$max_profile_fields" +ynh_app_setting_set --key="max_display_name_chars" --value="$max_display_name_chars" +ynh_app_setting_set --key="max_poll_options" --value="$max_poll_options" +ynh_app_setting_set --key="max_poll_option_chars" --value="$max_poll_option_chars" +ynh_app_setting_set --key="max_image_size" --value="$max_image_size" +ynh_app_setting_set --key="max_video_size" --value="$max_video_size" +ynh_app_setting_set --key="max_emoji_size" --value="$max_emoji_size" +ynh_app_setting_set --key="max_remote_emoji_size" --value="$max_remote_emoji_size" # 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" redis_namespace=${app}_production -ynh_app_setting_set --app="$app" --key=redis_namespace --value="$redis_namespace" +ynh_app_setting_set --key=redis_namespace --value="$redis_namespace" 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" active_record_encryption_primary_key=$(ynh_string_random --length=32) -ynh_app_setting_set --app="$app" --key=active_record_encryption_primary_key --value="$active_record_encryption_primary_key" +ynh_app_setting_set --key=active_record_encryption_primary_key --value="$active_record_encryption_primary_key" active_record_encryption_deterministic_key=$(ynh_string_random --length=32) -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=$(ynh_string_random --length=32) -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" #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Installing Ruby..." --weight=1 -ynh_install_ruby --ruby_version=$ruby_version 2>&1 +ynh_script_progression "Installing Ruby..." +ynh_ruby_install 2>&1 -ynh_script_progression --message="Installing NodeJS..." --weight=1 -ynh_install_nodejs --nodejs_version=$nodejs_version 2>&1 +ynh_script_progression "Installing NodeJS..." +ynh_nodejs_install 2>&1 #================================================= # 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 @@ -80,24 +80,23 @@ 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 #================================================= # 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" -chown -R "$app:www-data" "$install_dir" - +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R "$app:www-data" "$install_dir" #================================================= # 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" @@ -107,96 +106,88 @@ language="$(echo $language | head -c 2)" vapid_private_key="" vapid_public_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" -ynh_replace_string --match_string="registrations_mode: 'open'" --replace_string="registrations_mode: 'none'" --target_file="$install_dir/live/config/settings.yml" -ynh_replace_string --match_string="min_invite_role: 'admin'" --replace_string="min_invite_role: 'none'" --target_file="$install_dir/live/config/settings.yml" +ynh_replace --match="registrations_mode: 'open'" --replace="registrations_mode: 'none'" --file="$install_dir/live/config/settings.yml" +ynh_replace --match="min_invite_role: 'admin'" --replace="min_invite_role: 'none'" --file="$install_dir/live/config/settings.yml" -ynh_store_file_checksum --file="$install_dir/live/config/settings.yml" - -chmod 400 "$install_dir/live/config/settings.yml" -chown "$app:$app" "$install_dir/live/config/settings.yml" +ynh_store_file_checksum "$install_dir/live/config/settings.yml" #================================================= # 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 - ynh_exec_as "$app" "$ynh_ruby_load_path" $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN) + + gem update --system + gem install bundler --no-document + ynh_exec_as_app ruby_load_path" $ld_preload bin/bundle config deployment 'true' + ynh_exec_as_app ruby_load_path" $ld_preload bin/bundle config without 'development test' + ynh_exec_as_app ruby_load_path" $ld_preload bin/bundle config set force_ruby_platform true + ynh_exec_as_app ruby_load_path" $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN) # Building assets - ynh_use_nodejs + corepack enable # This export might be removed in yunohost 12 - COREPACK_ENABLE_DOWNLOAD_PROMPT=0 yarn install + yarn install echo "SAFETY_ASSURED=1">> "$config" - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/bundle exec rails db:migrate --quiet 2>&1 - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/bundle exec rails assets:precompile --quiet 2>&1 + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/bundle exec rails db:migrate --quiet 2>&1 + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/bundle exec rails assets:precompile --quiet 2>&1 # Generate vapid keys - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/bundle exec rake mastodon:webpush:generate_vapid_key > key.txt 2>&1 + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/bundle exec rake mastodon:webpush:generate_vapid_key > key.txt 2>&1 # Create the first admin user - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/tootctl accounts create "$admin" --email="$admin_mail" --confirmed --role=Owner > /dev/null 2>&1 + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/tootctl accounts create "$admin" --email="$admin_mail" --confirmed --role=Owner > /dev/null 2>&1 popd # Re-generate config with vapid keys vapid_private_key=$(grep -oP "VAPID_PRIVATE_KEY=\K.+" "$install_dir/live/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/key.txt") -ynh_app_setting_set --app="$app" --key=vapid_public_key --value="$vapid_public_key" -ynh_secure_remove --file="$install_dir/live/key.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=vapid_public_key --value="$vapid_public_key" +ynh_safe_rm "$install_dir/live/key.txt" +ynh_delete_file_checksum "$config" +ynh_config_add --template=".env.production.sample" --destination="$config" +#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$config" +#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown $app:$app "$config" #================================================= # 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="glitchsoc-web.service" +ynh_config_add_systemd --service="$app-web" --template="glitchsoc-web.service" yunohost service add "$app-web" --description="$app web service" -ynh_add_systemd_config --service="$app-sidekiq" --template="glitchsoc-sidekiq.service" +ynh_config_add_systemd --service="$app-sidekiq" --template="glitchsoc-sidekiq.service" yunohost service add "$app-sidekiq" --description="$app sidekiq service" -ynh_add_systemd_config --service="$app-streaming" --template="glitchsoc-streaming.service" +ynh_config_add_systemd --service="$app-streaming" --template="glitchsoc-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) -ynh_use_logrotate -chown "$app:$app" "/var/log/$app" +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" diff --git a/scripts/remove b/scripts/remove index 1385cf4..daabdb3 100644 --- a/scripts/remove +++ b/scripts/remove @@ -10,7 +10,7 @@ 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 yunohost service status "$app-web" >/dev/null 2>&1; then @@ -26,22 +26,22 @@ if yunohost service status "$app-streaming" >/dev/null 2>&1; then 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 @@ -50,4 +50,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 8f41253..396771f 100644 --- a/scripts/restore +++ b/scripts/restore @@ -11,16 +11,16 @@ source /usr/share/yunohost/helpers #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Reinstalling Ruby..." --weight=1 -ynh_install_ruby --ruby_version="$ruby_version" 2>&1 +ynh_script_progression "Reinstalling Ruby..." +ynh_ruby_install 2>&1 -ynh_script_progression --message="Reinstalling NodeJS..." --weight=1 -ynh_install_nodejs --nodejs_version="$nodejs_version" 2>&1 +ynh_script_progression "Reinstalling NodeJS..." +ynh_nodejs_install 2>&1 #================================================= # 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 @@ -30,81 +30,79 @@ 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 #================================================= # 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" - -chmod -R o-rwx "$install_dir" -chown -R "$app:www-data" "$install_dir" +ynh_restore "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R "$app:www-data" "$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_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" < ./db.sql +ynh_psql_db_shell <<< "ALTER USER $db_user CREATEDB;" +ynh_psql_db_shell < ./db.sql #================================================= # BUILD APP #================================================= -ynh_script_progression --message="Rebuilding app..." --weight=1 +ynh_script_progression "Rebuilding app..." 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 install --redownload -j"$(nproc)" - ynh_use_nodejs + gem update --system + gem install bundler --no-document + ynh_exec_as_app ruby_load_path" $ld_preload bin/bundle install --redownload -j"$(nproc)" + # This export might be removed in yunohost 12 - export COREPACK_ENABLE_DOWNLOAD_PROMPT=0 + corepack enable - COREPACK_ENABLE_DOWNLOAD_PROMPT=0 yarn install + yarn install 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" -ynh_restore_file --origin_path="/var/log/$app/" +ynh_restore "/var/log/$app/" -ynh_restore_file --origin_path="/etc/logrotate.d/$app" +ynh_restore "/etc/logrotate.d/$app" #================================================= # 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 7b5571c..75197fa 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,48 +12,49 @@ config="$install_dir/live/.env.production" #================================================= # 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 +# FIXMEhelpers2.1: maybe replace with: ynh_app_setting_set_default --key=service --value="$app-web.service" if [[ -z "${service:-}" ]]; then service="$app-web.service" - ynh_app_setting_set --app="$app" --key=service --value="$service" + ynh_app_setting_set --key=service --value="$service" fi #Remove previous added repository ynh_remove_extra_repo -if ynh_compare_current_package_version --comparison lt --version 2024.05.01~ynh1; then +if ynh_app_upgrading_from_version_before 2024.05.01~ynh1; then active_record_encryption_primary_key=$(ynh_string_random --length=32) - ynh_app_setting_set --app="$app" --key=active_record_encryption_primary_key --value="$active_record_encryption_primary_key" + ynh_app_setting_set --key=active_record_encryption_primary_key --value="$active_record_encryption_primary_key" active_record_encryption_deterministic_key=$(ynh_string_random --length=32) - 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=$(ynh_string_random --length=32) - 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" fi #================================================= # 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}-web" --action="stop" --log_path="/var/log/$app/$app-web.log" -ynh_systemd_action --service_name="${app}-sidekiq" --action="stop" --log_path="/var/log/$app/$app-sidekiq.log" -ynh_systemd_action --service_name="${app}-streaming" --action="stop" --log_path="/var/log/$app/$app-streaming.log" +ynh_systemctl --service="${app}-web" --action="stop" --log_path="/var/log/$app/$app-web.log" +ynh_systemctl --service="${app}-sidekiq" --action="stop" --log_path="/var/log/$app/$app-sidekiq.log" +ynh_systemctl --service="${app}-streaming" --action="stop" --log_path="/var/log/$app/$app-streaming.log" # Rename the database to match packaging v2 defaults db_name (`$app_production` to `$app`) if [[ $db_name = *'_production' ]]; then - ynh_psql_execute_as_root --sql="ALTER DATABASE $db_name RENAME TO $app;" + ynh_psql_db_shell <<< "ALTER DATABASE $db_name RENAME TO $app;" db_name=$app - ynh_app_setting_set --app=$app --key=db_name --value=$db_name + ynh_app_setting_set --key=db_name --value=$db_name fi #================================================= # 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 @@ -63,118 +64,115 @@ 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..." --weight=1 -ynh_install_ruby --ruby_version=$ruby_version 2>&1 +ynh_script_progression "Upgrading Ruby..." +ruby_install 2>&1 -ynh_script_progression --message="Upgrading NodeJS..." --weight=1 -ynh_install_nodejs --nodejs_version=$nodejs_version 2>&1 +ynh_script_progression "Upgrading NodeJS..." +ynh_nodejs_install 2>&1 #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Upgrading source files..." --weight=1 +ynh_script_progression "Upgrading source files..." # Download Mastodon -ynh_setup_source --dest_dir="$install_dir/live" --full_replace=1 --keep="public/system/" - -chmod -R o-rwx "$install_dir" -chown -R "$app:www-data" "$install_dir" +ynh_setup_source --dest_dir="$install_dir/live" --full_replace --keep="public/system/" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod -R o-rwx "$install_dir" +#REMOVEME? Assuming the install dir is setup using ynh_setup_source, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown -R "$app:www-data" "$install_dir" #================================================= # UPDATE A CONFIG FILE #================================================= -ynh_script_progression --message="Updating a config file..." --weight=1 +ynh_script_progression "Updating a config file..." language="$(echo $language | head -c 2)" -ynh_add_config --template=".env.production.sample" --destination="$config" +ynh_config_add --template=".env.production.sample" --destination="$config" -chmod 400 "$config" -chown "$app:$app" "$config" +#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chmod 400 "$config" +#REMOVEME? Assuming the file is setup using ynh_config_add, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown "$app:$app" "$config" #================================================= # 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_as "$app" "$ynh_ruby_load_path" $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN) - ynh_use_nodejs + + gem update --system + gem install bundler --no-document + ynh_exec_as_app ruby_load_path" $ld_preload bin/bundle config deployment 'true' + ynh_exec_as_app ruby_load_path" $ld_preload bin/bundle config without 'development test' + ynh_exec_as_app ruby_load_path" $ld_preload bin/bundle config set force_ruby_platform true --quiet + ynh_exec_as_app ruby_load_path" $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN) + # This export might be removed in yunohost 12 - export COREPACK_ENABLE_DOWNLOAD_PROMPT=0 + corepack enable yarn install if [ -d "$install_dir/live/public/assets" ]; then - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/bundle exec rails assets:clean 2>&1 + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/bundle exec rails assets:clean 2>&1 fi - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/bundle exec rails assets:precompile 2>&1 - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/bundle exec rails db:migrate 2>&1 - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/tootctl cache clear 2>&1 + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/bundle exec rails assets:precompile 2>&1 + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/bundle exec rails db:migrate 2>&1 + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/tootctl cache clear 2>&1 } popd #================================================= # APPLY MIGRATIONS #================================================= -ynh_script_progression --message="Applying migrations..." --weight=1 +ynh_script_progression "Applying migrations..." pushd "$install_dir/live" { - ynh_use_ruby - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/bundle exec rails db:migrate 2>&1 - ynh_exec_as "$app" RAILS_ENV=production COREPACK_ENABLE_DOWNLOAD_PROMPT=0 "$ynh_ruby_load_path" $ld_preload bin/tootctl cache clear 2>&1 + + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/bundle exec rails db:migrate 2>&1 + ynh_exec_as_app RAILS_ENV=production ruby_load_path" $ld_preload bin/tootctl cache clear 2>&1 } popd #================================================= # 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_use_ruby +ynh_config_add_nginx # Create a dedicated systemd config -ynh_add_systemd_config --service="$app-web" --template="glitchsoc-web.service" +ynh_config_add_systemd --service="$app-web" --template="glitchsoc-web.service" yunohost service add "$app-web" --description="$app web service" -ynh_add_systemd_config --service="$app-sidekiq" --template="glitchsoc-sidekiq.service" +ynh_config_add_systemd --service="$app-sidekiq" --template="glitchsoc-sidekiq.service" yunohost service add "$app-sidekiq" --description="$app sidekiq service" -ynh_add_systemd_config --service="$app-streaming" --template="glitchsoc-streaming.service" +ynh_config_add_systemd --service="$app-streaming" --template="glitchsoc-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) -ynh_use_logrotate --non-append -chown "$app:$app" "/var/log/$app" +ynh_config_add_logrotate +#REMOVEME? Assuming ynh_config_add_logrotate is called, the proper chmod/chowns are now already applied and it shouldn't be necessary to tweak perms | chown "$app:$app" "/var/log/$app" #================================================= # START SYSTEMD SERVICE #================================================= -ynh_script_progression --message="Starting $app's systemd service..." --weight=1 +ynh_script_progression "Starting $app's systemd 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" #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Upgrade of $app completed" --last +ynh_script_progression "Upgrade of $app completed"