aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas <51749973+Thovi98@users.noreply.github.com>2025-08-21 10:42:04 +0200
committerThomas <51749973+Thovi98@users.noreply.github.com>2025-08-21 10:42:04 +0200
commite827fbe4a89c0dcd51308457e5f00a9fc5dcc18b (patch)
tree2f1bc893b809539efdd81568897cafcf183a7131
parent1d2bff59e07dba330f3ee73b9ac08835c9a0640b (diff)
downloadmastodon_ynh-e827fbe4a89c0dcd51308457e5f00a9fc5dcc18b.tar.gz
mastodon_ynh-e827fbe4a89c0dcd51308457e5f00a9fc5dcc18b.tar.bz2
mastodon_ynh-e827fbe4a89c0dcd51308457e5f00a9fc5dcc18b.zip
convert to helpers v2.1 and try to upgrade to latest version
-rw-r--r--conf/.env.production.sample1
-rw-r--r--conf/cron10
-rw-r--r--conf/mastodon-sidekiq.service2
-rw-r--r--conf/mastodon-streaming.service4
-rw-r--r--conf/mastodon-web.service2
-rw-r--r--manifest.toml4
-rw-r--r--scripts/_common.sh14
-rw-r--r--scripts/backup31
-rw-r--r--scripts/install119
-rw-r--r--scripts/remove38
-rw-r--r--scripts/restore69
-rw-r--r--scripts/upgrade149
-rw-r--r--tests.toml3
13 files changed, 183 insertions, 263 deletions
diff --git a/conf/.env.production.sample b/conf/.env.production.sample
index 2abf6c5..d934fa8 100644
--- a/conf/.env.production.sample
+++ b/conf/.env.production.sample
@@ -20,7 +20,6 @@ LOCAL_DOMAIN=__DOMAIN__
# -----
REDIS_HOST=localhost
REDIS_PORT=6379
-REDIS_NAMESPACE=__REDIS_NAMESPACE__
# PostgreSQL
# ----------
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/mastodon-sidekiq.service b/conf/mastodon-sidekiq.service
index ad5a6a0..0048c61 100644
--- a/conf/mastodon-sidekiq.service
+++ b/conf/mastodon-sidekiq.service
@@ -10,7 +10,7 @@ Environment="RAILS_ENV=production"
Environment="DB_POOL=25"
Environment="MALLOC_ARENA_MAX=2"
Environment="__LD_PRELOAD__"
-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/mastodon-streaming.service b/conf/mastodon-streaming.service
index 963a316..735fe4c 100644
--- a/conf/mastodon-streaming.service
+++ b/conf/mastodon-streaming.service
@@ -9,8 +9,8 @@ WorkingDirectory=__INSTALL_DIR__/live
Environment="NODE_ENV=production"
Environment="PORT=__PORT_STREAM__"
Environment="STREAMING_CLUSTER_NUM=1"
-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/mastodon-web.service b/conf/mastodon-web.service
index 4804b16..2635c71 100644
--- a/conf/mastodon-web.service
+++ b/conf/mastodon-web.service
@@ -9,7 +9,7 @@ WorkingDirectory=__INSTALL_DIR__/live
Environment="RAILS_ENV=production"
Environment="PORT=__PORT_WEB__"
Environment="__LD_PRELOAD__"
-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 fd14664..2e00d20 100644
--- a/manifest.toml
+++ b/manifest.toml
@@ -19,7 +19,8 @@ cpe = "cpe:2.3:a:joinmastodon:mastodon"
fund = "https://joinmastodon.org/sponsors"
[integration]
-yunohost = ">= 11.2.12"
+yunohost = ">= 12.0.10"
+helpers_version = "2.1"
architectures = "all"
multi_instance = true
@@ -60,6 +61,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 0dbcc15..3421432 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 dfcbb27..6808c69 100644
--- a/scripts/install
+++ b/scripts/install
@@ -1,43 +1,34 @@
#!/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)
#=================================================
# 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"
-
#=================================================
# INSTALL DEPENDENCIES
#=================================================
-ynh_script_progression --message="Installing Ruby and NodeJS..." --weight=1
+ynh_script_progression "Installing 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
#=================================================
# 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
@@ -47,27 +38,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)"
-redis_namespace=${app}_production
-ynh_app_setting_set --app="$app" --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"
# We need bundle exec rails to build vapid keys, we generate them later once the app is installed
vapid_private_key=""
@@ -78,100 +66,93 @@ 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_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_exec_as_app $ld_preload bin/bundle config deployment 'true'
+ ynh_exec_as_app $ld_preload bin/bundle config without 'development test'
+ ynh_exec_as_app $ld_preload bin/bundle config set force_ruby_platform true --quiet
+ ynh_exec_as_app $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN)
+
+ env node_load_PATH 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 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
# Create the first admin user
- ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/tootctl accounts create "$admin" --email="$admin_mail" --confirmed --role=Owner > /dev/null
- ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/tootctl accounts approve "$admin" > /dev/null
+ ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/tootctl accounts create "$admin" --email="$admin_mail" --confirmed --role=Owner > /dev/null
+ ynh_hide_warnings ynh_exec_as_app RAILS_ENV=production $ld_preload bin/tootctl accounts approve "$admin" > /dev/null
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"
diff --git a/scripts/remove b/scripts/remove
index c8ca3a3..85423a4 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 77e934b..9dc84ba 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_script_progression "Restoring the app main directory..."
-ynh_restore_file --origin_path="$install_dir"
-
-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,28 @@ 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_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_exec_as_app $ld_preload bin/bundle install --redownload -j$(getconf _NPROCESSORS_ONLN)
popd
#=================================================
@@ -74,40 +64,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 f7a3573..ed19b64 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -1,77 +1,62 @@
#!/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"
#=================================================
# STOP SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Stopping a systemd service..." --weight=1
+ynh_script_progression "Stopping $app's systemd service..."
-if ynh_compare_current_package_version --comparison lt --version "4.2.8~ynh2"; then
+if ynh_app_upgrading_from_version_before 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"
+ ynh_systemctl --service=${app}-web --action="stop" --log_path="systemd" --wait_until="Goodbye"
+ ynh_systemctl --service=${app}-sidekiq --action="stop" --log_path="systemd" --wait_until="Bye"
+ ynh_systemctl --service=${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
+ 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
fi
#=================================================
# 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
+ynh_app_setting_set_default --key=service --value="$app-web.service"
# Remove previous added repository
ynh_remove_extra_repo
-if ynh_compare_current_package_version --comparison lt --version "4.2.8~ynh2"; then
+if ynh_app_upgrading_from_version_before 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"
+ ynh_app_setting_set --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;"
+ ynh_psql_db_shell <<< "DROP DATABASE IF EXISTS $db_name;"
+ ynh_psql_db_shell <<< "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_app_setting_set --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;"
+ ynh_psql_db_shell <<< "DROP USER IF EXISTS $db_user;"
+ ynh_psql_db_shell <<< "ALTER USER ${app}_production RENAME $db_user;"
fi
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
@@ -81,16 +66,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,115 +83,107 @@ ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-if [ "$upgrade_type" == "UPGRADE_APP" ]
+# FIXME: this is still supported but the recommendation is now to *always* re-setup the app sources wether or not the upstream sources changed
+if ynh_app_upstream_version_changed
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"
-
- chmod 750 "$install_dir"
- 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 .env.production"
fi
#=================================================
# 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
- 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_exec_as_app $ld_preload bin/bundle config deployment 'true'
+ ynh_exec_as_app $ld_preload bin/bundle config without 'development test'
+ ynh_exec_as_app $ld_preload bin/bundle config set force_ruby_platform true --quiet
+ ynh_exec_as_app $ld_preload bin/bundle install -j$(getconf _NPROCESSORS_ONLN)
+
+ env node_load_PATH 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
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/tests.toml b/tests.toml
index c983544..a084d02 100644
--- a/tests.toml
+++ b/tests.toml
@@ -27,4 +27,5 @@ test_format = 1.0
test_upgrade_from.43504e6.args.admin="john"
test_upgrade_from.43504e6.args.language="fr_FR"
- test_upgrade_from.8102fffa52a4e3279bba9fbdafb3a0e5b1fe3e17.name = "Upgrade from 4.2.13~ynh1"
+ test_upgrade_from.8102fffa52a4e3279bba9fbdafb3a0e5b1fe3e17.name = "4.2.13~ynh1"
+ test_upgrade_from.38e8436dd8489140af8921c81d9d891bfa92349e.name = "4.3.9 - Helpers v1"