aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoryalh76 <yalh@yahoo.com>2019-05-10 16:34:57 +0200
committeryalh76 <yalh@yahoo.com>2019-05-10 16:34:57 +0200
commitae5845526a964e0ab8161acf74b060f733191c5e (patch)
treea035fb13e9d1b039593a4ea5ff1749ac8eef170f
parent629b59bc5357860b33417fe69eceb413185b68da (diff)
downloadmastodon_ynh-ae5845526a964e0ab8161acf74b060f733191c5e.tar.gz
mastodon_ynh-ae5845526a964e0ab8161acf74b060f733191c5e.tar.bz2
mastodon_ynh-ae5845526a964e0ab8161acf74b060f733191c5e.zip
Apply example_ynh
-rw-r--r--scripts/backup48
-rw-r--r--scripts/change_url68
-rw-r--r--scripts/install10
-rw-r--r--scripts/remove42
-rw-r--r--scripts/restore79
-rw-r--r--scripts/upgrade165
6 files changed, 203 insertions, 209 deletions
diff --git a/scripts/backup b/scripts/backup
index ca9212d..ebf6361 100644
--- a/scripts/backup
+++ b/scripts/backup
@@ -23,43 +23,43 @@ ynh_abort_if_errors
#=================================================
# LOAD SETTINGS
#=================================================
-ynh_print_info "Loading installation settings..."
+ynh_script_progression --message="Loading installation settings..." --time --weight=1
app=$YNH_APP_INSTANCE_NAME
-final_path=$(ynh_app_setting_get $app final_path)
-domain=$(ynh_app_setting_get $app domain)
-db_name=$(ynh_app_setting_get $app db_name)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
#=================================================
-# STOP MASTODON SERVICES
+# STANDARD BACKUP STEPS
+#=================================================
+# STOP SYSTEMD SERVICE
#=================================================
-ynh_print_info "Stopping Mastodon services..."
+ynh_script_progression --message="Stopping a systemd service..." --time --weight=1
-ynh_systemd_action --action=stop --service_name=${app}-web --line_match="Stopped" --log_path=systemd
-ynh_systemd_action --action=stop --service_name=${app}-sidekiq --line_match="Stopped" --log_path=systemd
-ynh_systemd_action --action=stop --service_name=${app}-streaming --line_match="Stopped" --log_path=systemd
+ynh_systemd_action --service_name=${app}-web --action="stop" --log_path=systemd --line_match="Stopped"
+ynh_systemd_action --service_name=${app}-sidekiq --action="stop" --log_path=systemd --line_match="Stopped"
+ynh_systemd_action --service_name=${app}-streaming --action="stop" --log_path=systemd --line_match="Stopped"
#=================================================
-# STANDARD BACKUP STEPS
-#=================================================
# BACKUP THE APP MAIN DIR
#=================================================
-ynh_print_info "Backing up the main app directory..."
+ynh_script_progression --message="Backing up the main app directory..." --time --weight=1
-ynh_backup "$final_path"
+ynh_backup --src_path="$final_path"
#=================================================
# BACKUP THE NGINX CONFIGURATION
#=================================================
-ynh_print_info "Backing up nginx web server configuration..."
+ynh_script_progression --message="Backing up nginx web server configuration..." --time --weight=1
-ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# BACKUP THE POSTGRESQL DATABASE
#=================================================
-ynh_print_info "Backing up the PostgreSQL database..."
+ynh_script_progression --message="Backing up the PostgreSQL database..." --time --weight=1
ynh_psql_dump_db "$db_name" > db.sql
@@ -68,22 +68,22 @@ ynh_psql_dump_db "$db_name" > db.sql
#=================================================
# BACKUP SYSTEMD
#=================================================
-ynh_print_info "Backing up systemd configuration..."
+ynh_script_progression --message="Backing up systemd configuration..." --time --weight=1
-ynh_backup "/etc/systemd/system/$app-web.service"
-ynh_backup "/etc/systemd/system/$app-sidekiq.service"
-ynh_backup "/etc/systemd/system/$app-streaming.service"
+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"
#=================================================
# BACKUP A CRON FILE
#=================================================
-ynh_backup "/etc/cron.d/$app"
+ynh_backup --src_path="/etc/cron.d/$app"
#=================================================
-# START MASTODON SERVICES
+# START SYSTEMD SERVICE
#=================================================
-ynh_print_info "Starting Mastodon services..."
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
ynh_systemd_action --action=start --service_name=${app}-web --line_match="Listening on tcp" --log_path=systemd
ynh_systemd_action --action=start --service_name=${app}-sidekiq --line_match="Starting processing" --log_path=systemd
@@ -93,4 +93,4 @@ ynh_systemd_action --action=start --service_name=${app}-streaming --line_match="
# END OF SCRIPT
#=================================================
-ynh_print_info "Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."
+ynh_script_progression --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." --time --last
diff --git a/scripts/change_url b/scripts/change_url
index e87b369..784aa40 100644
--- a/scripts/change_url
+++ b/scripts/change_url
@@ -24,24 +24,16 @@ app=$YNH_APP_INSTANCE_NAME
#=================================================
# LOAD SETTINGS
#=================================================
-ynh_print_info "Loading installation settings..."
+ynh_script_progression --message="Loading installation settings..." --time --weight=1
# Needed for helper "ynh_add_nginx_config"
-final_path=$(ynh_app_setting_get $app final_path)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
# Add settings here as needed by your application
-#db_name=$(ynh_app_setting_get "$app" db_name)
-#db_pwd=$(ynh_app_setting_get $app db_pwd)
-admin_mail=$(ynh_app_setting_get $app admin_mail)
-
-#=================================================
-# CHECK THE SYNTAX OF THE PATHS
-#=================================================
-
-test -n "$old_path" || old_path="/"
-test -n "$new_path" || new_path="/"
-new_path=$(ynh_normalize_url_path $new_path)
-old_path=$(ynh_normalize_url_path $old_path)
+#db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+#db_user=$db_name
+#db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
+admin_mail=$(ynh_app_setting_get --app=$app --key=admin_mail)
#=================================================
# CHECK WHICH PARTS SHOULD BE CHANGED
@@ -62,9 +54,18 @@ fi
#=================================================
# STANDARD MODIFICATIONS
#=================================================
+# STOP SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Stopping a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=${app}-web --action="stop" --log_path=systemd --line_match="Stopped"
+ynh_systemd_action --service_name=${app}-sidekiq --action="stop" --log_path=systemd --line_match="Stopped"
+ynh_systemd_action --service_name=${app}-streaming --action="stop" --log_path=systemd --line_match="Stopped"
+
+#=================================================
# MODIFY URL IN NGINX CONF
#=================================================
-ynh_print_info "Updating nginx web server configuration..."
+ynh_script_progression --message="Updating nginx web server configuration..." --time --weight=1
nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
@@ -72,7 +73,7 @@ nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
if [ $change_path -eq 1 ]
then
# Make a backup of the original nginx config file if modified
- ynh_backup_if_checksum_is_different "$nginx_conf_path"
+ ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
# Set global variables for nginx helper
domain="$old_domain"
path_url="$new_path"
@@ -84,49 +85,40 @@ fi
if [ $change_domain -eq 1 ]
then
# Delete file checksum for the old conf file location
- ynh_delete_file_checksum "$nginx_conf_path"
+ ynh_delete_file_checksum --file="$nginx_conf_path"
mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
# Store file checksum for the new config file location
- ynh_store_file_checksum "/etc/nginx/conf.d/$new_domain.d/$app.conf"
+ ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
fi
#=================================================
# SPECIFIC MODIFICATIONS
#=================================================
-# STOP MASTODON SERVICES
-#=================================================
-ynh_print_info "Stopping Mastodon services..."
-
-ynh_systemd_action --action=stop --service_name=${app}-web --line_match="Stopped" --log_path=systemd
-ynh_systemd_action --action=stop --service_name=${app}-sidekiq --line_match="Stopped" --log_path=systemd
-ynh_systemd_action --action=stop --service_name=${app}-streaming --line_match="Stopped" --log_path=systemd
-
-#=================================================
# CHANGE CONFIGURATION
#=================================================
-ynh_replace_string "LOCAL_DOMAIN=.*" "LOCAL_DOMAIN=${domain}" "${final_path}/live/.env.production"
+ynh_replace_string --match_string="LOCAL_DOMAIN=.*" --replace_string="LOCAL_DOMAIN=${domain}" --target_file="${final_path}/live/.env.production"
#=================================================
-# START MASTODON SERVICES
+# GENERIC FINALISATION
+#=================================================
+# START SYSTEMD SERVICE
#=================================================
-ynh_print_info "Starting Mastodon services..."
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
-ynh_systemd_action --action=start --service_name=${app}-web --line_match="Listening on tcp" --log_path=systemd
-ynh_systemd_action --action=start --service_name=${app}-sidekiq --line_match="Starting processing" --log_path=systemd
-ynh_systemd_action --action=start --service_name=${app}-streaming --line_match="Worker 1 now listening" --log_path=systemd
+ynh_systemd_action --service_name=${app}-web --action="start" --log_path=systemd --line_match="Listening on tcp"
+ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=systemd --line_match="Starting processing"
+ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=systemd --line_match="Worker 1 now listening"
#=================================================
-# GENERIC FINALISATION
-#=================================================
# RELOAD NGINX
#=================================================
-ynh_print_info "Reloading nginx web server..."
+ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
-ynh_print_info "Change of URL completed for $app"
+ynh_script_progression --message="Change of URL completed for $app" --time --last
diff --git a/scripts/install b/scripts/install
index ffbe22d..647c6b4 100644
--- a/scripts/install
+++ b/scripts/install
@@ -103,7 +103,7 @@ fi
ynh_install_extra_repo --repo="deb https://dl.yarnpkg.com/debian/ stable main" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" --append
# install nodejs
-ynh_install_nodejs 8
+ynh_install_nodejs --nodejs_version="8"
ynh_install_app_dependencies $pkg_dependencies
@@ -130,7 +130,7 @@ ynh_script_progression --message="Setting up source files..." --time --weight=1
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
# Download, check integrity, uncompress and patch the source from app.src
mkdir $final_path
-ynh_setup_source "$final_path/live"
+ynh_setup_source --dest_dir="$final_path/live"
#=================================================
# NGINX CONFIGURATION
@@ -272,9 +272,9 @@ yunohost service add "$app-streaming"
#=================================================
ynh_script_progression --message="Starting a systemd service..." --time --weight=1
-ynh_systemd_action --action=start --service_name=${app}-web --line_match="Listening on tcp" --log_path=systemd
-ynh_systemd_action --action=start --service_name=${app}-sidekiq --line_match="Starting processing" --log_path=systemd
-ynh_systemd_action --action=start --service_name=${app}-streaming --line_match="Worker 1 now listening" --log_path=systemd
+ynh_systemd_action --service_name=${app}-web --action="start" --log_path=systemd --line_match="Listening on tcp"
+ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=systemd --line_match="Starting processing"
+ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=systemd --line_match="Worker 1 now listening"
#=================================================
# SETUP SSOWAT
diff --git a/scripts/remove b/scripts/remove
index 303ccf7..f72f13c 100644
--- a/scripts/remove
+++ b/scripts/remove
@@ -14,13 +14,14 @@ source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
-ynh_print_info "Loading installation settings..."
+ynh_script_progression --message="Loading installation settings..." --time --weight=1
app=$YNH_APP_INSTANCE_NAME
-domain=$(ynh_app_setting_get $app domain)
-db_name=$(ynh_app_setting_get $app db_name)
-final_path=$(ynh_app_setting_get $app final_path)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+db_user==$app
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# STANDARD REMOVE
@@ -31,26 +32,26 @@ final_path=$(ynh_app_setting_get $app final_path)
# Remove a service from the admin panel, added by `yunohost service add`
if yunohost service status "$app-web" >/dev/null 2>&1
then
- ynh_print_info "Removing $app-web service"
+ ynh_script_progression --message="Removing $app-web service..." --time --weight=1
yunohost service remove "$app-web"
fi
if yunohost service status "$app-sidekiq" >/dev/null 2>&1
then
- ynh_print_info "Removing $app-sidekiq service"
+ ynh_script_progression --message="Removing $app-sidekiq service..." --time --weight=1
yunohost service remove "$app-sidekiq"
fi
if yunohost service status "$app-streaming" >/dev/null 2>&1
then
- ynh_print_info "Removing $app-streaming service"
+ ynh_script_progression --message="Removing $app-streaming service..." --time --weight=1
yunohost service remove "$app-streaming"
fi
#=================================================
# STOP AND REMOVE SERVICE
#=================================================
-ynh_print_info "Stopping and removing the systemd service"
+ynh_script_progression --message="Stopping and removing the systemd service..." --time --weight=1
# Remove the dedicated systemd config
ynh_remove_systemd_config "$app-web"
@@ -60,18 +61,15 @@ ynh_remove_systemd_config "$app-streaming"
#=================================================
# REMOVE THE POSTGRESQL DATABASE
#=================================================
-ynh_print_info "Removing the PostgreSQL database"
+ynh_script_progression --message="Removing the PostgreSQL database..." --time --weight=1
-ynh_psql_execute_as_root "\connect $db_name
-SELECT pg_terminate_backend (pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = '$db_name';"
-
-# delete postgresql database & user
-ynh_psql_remove_db --db_name="$db_name" --db_user="$app"
+# Remove a database if it exists, along with the associated user
+ynh_psql_remove_db --db_user="$db_user" --db_name="$db_name"
#=================================================
# REMOVE DEPENDENCIES
#=================================================
-ynh_print_info "Removing dependencies"
+ynh_script_progression --message="Removing dependencies..." --time --weight=1
# Remove metapackage and its dependencies
ynh_remove_ruby
@@ -82,15 +80,15 @@ ynh_remove_extra_repo
#=================================================
# REMOVE APP MAIN DIR
#=================================================
-ynh_print_info "Removing app main directory"
+ynh_script_progression --message="Removing app main directory..." --time --weight=1
# Remove the app directory securely
-ynh_secure_remove "$final_path"
+ynh_secure_remove --file="$final_path"
#=================================================
# REMOVE NGINX CONFIGURATION
#=================================================
-ynh_print_info "Removing nginx web server configuration"
+ynh_script_progression --message="Removing nginx web server configuration..." --time --weight=1
# Remove the dedicated nginx config
ynh_remove_nginx_config
@@ -102,20 +100,20 @@ ynh_remove_nginx_config
#=================================================
# Remove a cron file
-ynh_secure_remove "/etc/cron.d/$app"
+ynh_secure_remove --file="/etc/cron.d/$app"
#=================================================
# GENERIC FINALIZATION
#=================================================
# REMOVE DEDICATED USER
#=================================================
-ynh_print_info "Removing the dedicated system user"
+ynh_script_progression --message="Removing the dedicated system user..." --time --weight=1
# Delete a system user
-ynh_system_user_delete $app
+ynh_system_user_delete --username=$app
#=================================================
# END OF SCRIPT
#=================================================
-ynh_print_info "Removal of $app completed"
+ynh_script_progression --message="Removal of $app completed" --time --last
diff --git a/scripts/restore b/scripts/restore
index 97b77cf..0b5bde2 100644
--- a/scripts/restore
+++ b/scripts/restore
@@ -25,51 +25,54 @@ ynh_abort_if_errors
#=================================================
# LOAD SETTINGS
#=================================================
-ynh_print_info "Loading settings..."
+ynh_script_progression --message="Loading settings..." --time --weight=1
app=$YNH_APP_INSTANCE_NAME
-domain=$(ynh_app_setting_get $app domain)
-path_url=$(ynh_app_setting_get $app path)
-final_path=$(ynh_app_setting_get $app final_path)
-db_name=$(ynh_app_setting_get $app db_name)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+path_url=$(ynh_app_setting_get --app=$app --key=path)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
+db_user=$app
#=================================================
# CHECK IF THE APP CAN BE RESTORED
#=================================================
-ynh_print_info "Validating restoration parameters..."
+ynh_script_progression --message="Validating restoration parameters..." --time --weight=1
-ynh_webpath_available $domain $path_url \
- || ynh_die "Path not available: ${domain}${path_url}"
+ynh_webpath_available --domain=$domain --path_url=$path_url \
+ || ynh_die --message="Path not available: ${domain}${path_url}"
test ! -d $final_path \
-|| ynh_die "There is already a directory: $final_path "
+ || ynh_die --message="There is already a directory: $final_path "
#=================================================
# STANDARD RESTORATION STEPS
#=================================================
# RESTORE THE NGINX CONFIGURATION
#=================================================
+ynh_script_progression --message="Restoring nginx configuration..." --time --weight=1
-ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf"
+ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
-ynh_print_info "Restoring the app main directory..."
+ynh_script_progression --message="Restoring the app main directory..." --time --weight=1
-ynh_restore_file "$final_path"
+ynh_restore_file --origin_path="$final_path"
#=================================================
# RECREATE THE DEDICATED USER
#=================================================
-ynh_print_info "Recreating the dedicated system user..."
+ynh_script_progression --message="Recreating the dedicated system user..." --time --weight=1
# Create the dedicated user (if not existing)
-ynh_system_user_create $app $final_path
+ynh_system_user_create --username=$app --home_dir=$final_path
#=================================================
# RESTORE USER RIGHTS
#=================================================
+ynh_script_progression --message="Restoring users rights..." --time --weight=1
# Restore permissions on app files
chown -R $app: $final_path
@@ -79,7 +82,7 @@ chown -R $app: $final_path
#=================================================
# REINSTALL DEPENDENCIES
#=================================================
-ynh_print_info "Reinstalling dependencies..."
+ynh_script_progression --message="Reinstalling dependencies..." --time --weight=1
# Import debian archive pubkey, need on ARM arch
arch=$(uname -m)
@@ -95,13 +98,14 @@ fi
ynh_install_extra_repo --repo="deb https://dl.yarnpkg.com/debian/ stable main" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" --append
# install nodejs
-ynh_install_nodejs 8
+ynh_install_nodejs --nodejs_version="8"
ynh_install_app_dependencies $pkg_dependencies
#=================================================
# INSTALLING RUBY AND BUNDLER
#=================================================
+ynh_script_progression --message="Installing Ruby..." --time --weight=1
ynh_install_ruby --ruby_version=2.6.0
/opt/rbenv/versions/2.6.0/bin/gem update --system
@@ -109,60 +113,61 @@ ynh_install_ruby --ruby_version=2.6.0
#=================================================
# RESTORE THE POSTGRESQL DATABASE
#=================================================
-ynh_print_info "Restoring the PostgreSQL database..."
+ynh_script_progression --message="Restoring the PostgreSQL database..." --time --weight=1
db_pwd=$(ynh_app_setting_get "$app" db_pwd)
ynh_psql_test_if_first_run
-ynh_psql_create_user "$app" "$db_pwd"
-ynh_psql_execute_as_root \
-"CREATE DATABASE $db_name ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER $app;"
-ynh_psql_execute_file_as_root ./db.sql "$db_name"
+ynh_psql_create_user "$db_user" "$db_pwd"
+ynh_psql_execute_as_root --sql="CREATE DATABASE $db_name ENCODING 'UTF8' LC_COLLATE='C' LC_CTYPE='C' template=template0 OWNER $db_user;"
+ynh_psql_execute_file_as_root --file="./db.sql" --database="$db_name"
#=================================================
# RESTORE SYSTEMD
#=================================================
-ynh_print_info "Restoring the systemd configuration..."
+ynh_script_progression --message="Restoring the systemd configuration..." --time --weight=1
-ynh_restore_file "/etc/systemd/system/$app-web.service"
-ynh_restore_file "/etc/systemd/system/$app-sidekiq.service"
-ynh_restore_file "/etc/systemd/system/$app-streaming.service"
+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"
systemctl enable "$app-web" "$app-sidekiq" "$app-streaming"
#=================================================
# ADVERTISE SERVICE IN ADMIN PANEL
#=================================================
+ynh_script_progression --message="Advertising service in admin panel..." --time --weight=1
yunohost service add $app-web
yunohost service add $app-sidekiq
yunohost service add $app-streaming
#=================================================
-# RESTORE THE CRON FILE
+# START SYSTEMD SERVICE
#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
-ynh_restore_file "/etc/cron.d/$app"
+ynh_systemd_action --service_name=${app}-web --action="start" --log_path=systemd --line_match="Listening on tcp"
+ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=systemd --line_match="Starting processing"
+ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=systemd --line_match="Worker 1 now listening"
#=================================================
-# GENERIC FINALIZATION
-#=================================================
-# START MASTODON SERVICES
+# RESTORE THE CRON FILE
#=================================================
-ynh_print_info "Starting Mastodon services..."
+ynh_script_progression --message="Restoring a cron job for removing cache..." --time --weight=1
-ynh_systemd_action --action=start --service_name=${app}-web --line_match="Listening on tcp" --log_path=systemd
-ynh_systemd_action --action=start --service_name=${app}-sidekiq --line_match="Starting processing" --log_path=systemd
-ynh_systemd_action --action=start --service_name=${app}-streaming --line_match="Worker 1 now listening" --log_path=systemd
+ynh_restore_file --origin_path="/etc/cron.d/$app"
#=================================================
+# GENERIC FINALIZATION
+#=================================================
# RELOAD NGINX
#=================================================
-ynh_print_info "Reloading nginx web server..."
+ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
-ynh_print_info "Restoration completed for $app"
+ynh_script_progression --message="Restoration completed for $app" --time --last
diff --git a/scripts/upgrade b/scripts/upgrade
index 0bfe6c8..d42b889 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -14,44 +14,44 @@ source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
-ynh_print_info "Loading installation settings..."
+ynh_script_progression --message="Loading installation settings..." --time --weight=1
app=$YNH_APP_INSTANCE_NAME
-domain=$(ynh_app_setting_get $app domain)
-path_url=$(ynh_app_setting_get $app path)
-admin=$(ynh_app_setting_get $app admin)
-is_public=$(ynh_app_setting_get $app is_public)
-final_path=$(ynh_app_setting_get $app final_path)
-language=$(ynh_app_setting_get $app language)
-db_name=$(ynh_app_setting_get $app db_name)
+domain=$(ynh_app_setting_get --app=$app --key=domain)
+path_url=$(ynh_app_setting_get --app=$app --key=path)
+admin=$(ynh_app_setting_get --app=$app --key=admin)
+is_public=$(ynh_app_setting_get --app=$app --key=is_public)
+final_path=$(ynh_app_setting_get --app=$app --key=final_path)
+language=$(ynh_app_setting_get --app=$app --key=language)
+db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_pwd=$(ynh_app_setting_get $app db_pwd)
-admin_mail=$(ynh_user_get_info $admin 'mail')
-port_web=$(ynh_app_setting_get "$app" port_web)
-port_stream=$(ynh_app_setting_get "$app" port_stream)
+db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
+admin_mail=$(ynh_user_get_info --app=$app --key=mail)
+port_web=$(ynh_app_setting_get --app=$app --key=port_web)
+port_stream=$(ynh_app_setting_get --app=$app --key=port_stream)
-paperclip_secret=$(ynh_app_setting_get "$app" paperclip_secret)
-secret_key_base=$(ynh_app_setting_get "$app" secret_key_base)
-otp_secret=$(ynh_app_setting_get "$app" otp_secret)
-vapid_private_key=$(ynh_app_setting_get "$app" vapid_private_key)
-vapid_public_key=$(ynh_app_setting_get "$app" vapid_public_key)
+paperclip_secret=$(ynh_app_setting_get --app=$app --key=paperclip_secret)
+secret_key_base=$(ynh_app_setting_get --app=$app --key=secret_key_base)
+otp_secret=$(ynh_app_setting_get --app=$app --key=otp_secret)
+vapid_private_key=$(ynh_app_setting_get --app=$app --key=vapid_private_key)
+vapid_public_key=$(ynh_app_setting_get --app=$app --key=vapid_public_key)
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
-ynh_print_info "Ensuring downward compatibility..."
+ynh_script_progression --message="Ensuring downward compatibility..." --time --weight=1
# If db_name doesn't exist, create it
-if [ -z $db_name ]; then
+if [ -z "$db_name" ]; then
db_name="${app}_production"
- ynh_app_setting_set $app db_name $db_name
+ ynh_app_setting_set --app=$app --key=db_name --value=$db_name
fi
# If final_path doesn't exist, create it
-if [ -z $final_path ]; then
+if [ -z "$final_path" ]; then
final_path=/var/www/$app
- ynh_app_setting_set $app final_path $final_path
+ ynh_app_setting_set --app=$app --key=final_path --value=$final_path
fi
# Check if admin is not null
@@ -63,10 +63,10 @@ fi
# If db_pwd doesn't exist, create it, need for old install
if [[ -z "$db_pwd" ]]; then
db_pwd=$(ynh_string_random)
- ynh_app_setting_set $app db_pwd $db_pwd
+ ynh_app_setting_set --app=$app --key=db_pwd --value=$db_pwd
ynh_psql_test_if_first_run
sudo --login --user=postgres psql -c"ALTER user $app WITH PASSWORD '$db_pwd'" postgres
- ynh_replace_string "DB_PASS=" "DB_PASS=${db_pwd}" "${final_path}/live/.env.production"
+ ynh_replace_string --match_string="DB_PASS=" --replace_string="DB_PASS=${db_pwd}" --target_file="${final_path}/live/.env.production"
fi
# If paperclip_secret doesn't exist, retrieve it or create it
@@ -75,7 +75,7 @@ if [[ -z "$paperclip_secret" ]]; then
if [[ -z "$paperclip_secret" ]]; then
paperclip_secret=$(head -n128 /dev/urandom | tail -n +1 | tr -dc -d 'a-z0-9' | head -c128)
fi
- ynh_app_setting_set "$app" paperclip_secret "$paperclip_secret"
+ ynh_app_setting_set --app=$app --key=paperclip_secret --value="$paperclip_secret"
fi
# If secret_key_base doesn't exist, retrieve it or create it
@@ -84,7 +84,7 @@ if [[ -z "$secret_key_base" ]]; then
if [[ -z "$secret_key_base" ]]; then
secret_key_base=$(head -n128 /dev/urandom | tail -n +1 | tr -dc -d 'a-z0-9' | head -c128)
fi
- ynh_app_setting_set "$app" secret_key_base "$secret_key_base"
+ ynh_app_setting_set --app=$app --key=secret_key_base --value="$secret_key_base"
fi
# If otp_secret doesn't exist, retrieve it or create it
@@ -93,13 +93,13 @@ if [[ -z "$otp_secret" ]]; then
if [[ -z "$otp_secret" ]]; then
otp_secret=$(head -n128 /dev/urandom | tail -n +1 | tr -dc -d 'a-z0-9' | head -c128)
fi
- ynh_app_setting_set "$app" otp_secret "$otp_secret"
+ ynh_app_setting_set --app=$app --key=otp_secret --value="$otp_secret"
fi
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
-ynh_print_info "Backing up the app before upgrading (may take a while)..."
+ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --time --weight=1
# Backup the current version of the app
ynh_backup_before_upgrade
@@ -116,27 +116,27 @@ ynh_abort_if_errors
#=================================================
# Normalize the URL path syntax
-path_url=$(ynh_normalize_url_path $path_url)
+path_url=$(ynh_normalize_url_path --path_url=$path_url)
#=================================================
# STANDARD UPGRADE STEPS
#=================================================
-# STOP MASTODON SERVICES
+# STOP SYSTEMD SERVICE
#=================================================
-ynh_print_info "Stopping Mastodon services..."
+ynh_script_progression --message="Stopping a systemd service..." --time --weight=1
-ynh_systemd_action --action=stop --service_name=${app}-web --line_match="Stopped" --log_path=systemd
-ynh_systemd_action --action=stop --service_name=${app}-sidekiq --line_match="Stopped" --log_path=systemd
-ynh_systemd_action --action=stop --service_name=${app}-streaming --line_match="Stopped" --log_path=systemd
+ynh_systemd_action --service_name=${app}-web --action="stop" --log_path=systemd --line_match="Stopped"
+ynh_systemd_action --service_name=${app}-sidekiq --action="stop" --log_path=systemd --line_match="Stopped"
+ynh_systemd_action --service_name=${app}-streaming --action="stop" --log_path=systemd --line_match="Stopped"
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-ynh_print_info "Upgrading source files..."
+ynh_script_progression --message="Upgrading source files..." --time --weight=1
# Download Mastodon
mv "$final_path/live" "$final_path/live_back"
-ynh_setup_source "$final_path/live"
+ynh_setup_source --dest_dir="$final_path/live"
if [ -z $final_path/live_back/public/system ]; then
rsync -a "$final_path/live_back/public/system" "$final_path/live_back/public/."
fi
@@ -144,21 +144,19 @@ rsync -a "$final_path/live_back/.env.production" "$final_path/live/."
rm -Rf "$final_path/live_back"
# Clean files which are not needed anymore
-ynh_secure_remove $final_path/live/config/initializers/timeout.rb
+ynh_secure_remove --file="$final_path/live/config/initializers/timeout.rb"
#=================================================
# NGINX CONFIGURATION
#=================================================
-ynh_print_info "Upgrading nginx web server configuration..."
+ynh_script_progression --message="Upgrading nginx web server configuration..." --time --weight=1
-ynh_replace_string "__PORT_WEB__" "$port_web" "../conf/nginx.conf"
-ynh_replace_string "__PORT_STREAM__" "$port_stream" "../conf/nginx.conf"
-ynh_add_nginx_config
+ynh_add_nginx_config 'port_web port_stream'
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
-ynh_print_info "Upgrading dependencies..."
+ynh_script_progression --message="Upgrading dependencies..." --time --weight=1
# Install extra_repo debian package backports & yarn
if [ "$(lsb_release --codename --short)" == "jessie" ]; then
@@ -167,7 +165,7 @@ fi
ynh_install_extra_repo --repo="deb https://dl.yarnpkg.com/debian/ stable main" --key="https://dl.yarnpkg.com/debian/pubkey.gpg" --append
# Install nodejs
-ynh_install_nodejs 8
+ynh_install_nodejs --nodejs_version="8"
# TODO: use the same mecanism with other files
ynh_install_app_dependencies $pkg_dependencies
@@ -175,10 +173,10 @@ ynh_install_app_dependencies $pkg_dependencies
#=================================================
# CREATE DEDICATED USER
#=================================================
-ynh_print_info "Making sure dedicated system user exists..."
+ynh_script_progression --message="Making sure dedicated system user exists..." --time --weight=1
# Create a dedicated user (if not existing)
-ynh_system_user_create $app
+ynh_system_user_create --username=$app --home_dir=$final_path
#=================================================
# SPECIFIC UPGRADE
@@ -193,27 +191,28 @@ ynh_install_ruby --ruby_version=2.6.0
#=================================================
# MODIFY A CONFIG FILE
#=================================================
+ynh_script_progression --message="Modifying a config file..." --time --weight=1
cp -f ../conf/.env.production.sample "$final_path/live/.env.production"
-ynh_replace_string "__DB_USER__" "$app" "$final_path/live/.env.production"
-ynh_replace_string "__DB_NAME__" "$db_name" "$final_path/live/.env.production"
-ynh_replace_string "__DB_PWD__" "$db_pwd" "$final_path/live/.env.production"
-ynh_replace_string "__DOMAIN__" "$domain" "$final_path/live/.env.production"
-ynh_replace_string "__SMTP_FROM_ADDRESS__" "$admin_mail" "${final_path}/live/.env.production"
+ynh_replace_string --match_string="__DB_USER__" --replace_string="$app" --target_file="$final_path/live/.env.production"
+ynh_replace_string --match_string="__DB_NAME__" --replace_string="$db_name" --target_file="$final_path/live/.env.production"
+ynh_replace_string --match_string="__DB_PWD__" --replace_string="$db_pwd" --target_file="$final_path/live/.env.production"
+ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$final_path/live/.env.production"
+ynh_replace_string --match_string="__SMTP_FROM_ADDRESS__" --replace_string="$admin_mail" --target_file="${final_path}/live/.env.production"
language="$(echo $language | head -c 2)"
-ynh_replace_string "__LANGUAGE__" "$language" "$final_path/live/.env.production"
+ynh_replace_string --match_string="__LANGUAGE__" --replace_string="$language" --target_file="$final_path/live/.env.production"
-ynh_replace_string "PAPERCLIP_SECRET=" "PAPERCLIP_SECRET=$paperclip_secret" "${final_path}/live/.env.production"
+ynh_replace_string --match_string="PAPERCLIP_SECRET=" --replace_string="PAPERCLIP_SECRET=$paperclip_secret" --target_file="${final_path}/live/.env.production"
-ynh_replace_string "__SECRET_KEY_BASE__" "$secret_key_base" "$final_path/live/.env.production"
+ynh_replace_string --match_string="__SECRET_KEY_BASE__" --replace_string="$secret_key_base" --target_file="$final_path/live/.env.production"
-ynh_replace_string "__OTP_SECRET__" "$otp_secret" "$final_path/live/.env.production"
+ynh_replace_string --match_string="__OTP_SECRET__" --replace_string="$otp_secret" --target_file="$final_path/live/.env.production"
#=================================================
# UPGRADE MASTODON
#=================================================
-ynh_print_info "Upgrading Mastodon..."
+ynh_script_progression --message="Upgrading Mastodon..." --time --weight=1
chown -R "$app": "$final_path"
@@ -235,44 +234,35 @@ if [[ -z "$vapid_private_key" ]]; then
sudo -u "$app" env PATH=$PATH RAILS_ENV=production /opt/rbenv/versions/2.6.0/bin/bundle exec rake mastodon:webpush:generate_vapid_key > key.txt
vapid_private_key=$(grep -oP "VAPID_PRIVATE_KEY=\K\w+" "$final_path/live/key.txt")
vapid_public_key=$(grep -oP "VAPID_PUBLIC_KEY=\K\w+" "$final_path/live/key.txt")
- ynh_app_setting_set "$app" vapid_private_key "$vapid_private_key"
- ynh_app_setting_set "$app" vapid_public_key "$vapid_public_key"
- ynh_secure_remove "$final_path/live/key.txt"
+ ynh_app_setting_set --app="$app" --key=vapid_private_key --value="$vapid_private_key"
+ ynh_app_setting_set --app="$app" --key=vapid_public_key --value="$vapid_public_key"
+ ynh_secure_remove --file="$final_path/live/key.txt"
fi
# Recalculate and store the checksum of the file for the next upgrade.
-ynh_store_file_checksum "${final_path}/live/.env.production"
+ynh_store_file_checksum --file="${final_path}/live/.env.production"
#=================================================
# SETUP CRON JOB FOR REMOVING CACHE
#=================================================
-ynh_print_info "Setuping a cron job for removing cache..."
+ynh_script_progression --message="Setuping a cron job for removing cache..." --time --weight=1
-ynh_replace_string "__FINAL_PATH__" "$final_path" ../conf/cron
-ynh_replace_string "__USER__" "$app" ../conf/cron
+ynh_replace_string --match_string="__FINAL_PATH__" --replace_string="$final_path" --target_file="conf/cron"
+ynh_replace_string --match_string="__USER__" --replace_string="$app" --target_file="../conf/cron"
sudo cp -f ../conf/cron /etc/cron.d/$app
#=================================================
# SETUP SYSTEMD
#=================================================
-ynh_print_info "Upgrading systemd configuration..."
+ynh_script_progression --message="Upgrading systemd configuration..." --time --weight=1
# Create a dedicated systemd config
-ynh_replace_string "__PORT_WEB__" "$port_web" "../conf/mastodon-web.service"
-ynh_replace_string "__PORT_STREAM__" "$port_stream" "../conf/mastodon-streaming.service"
-ynh_replace_string "__NODEJS_PATH__" "$nodejs_path" "../conf/mastodon-streaming.service"
-ynh_add_systemd_config "$app-web" "mastodon-web.service"
-ynh_add_systemd_config "$app-sidekiq" "mastodon-sidekiq.service"
-ynh_add_systemd_config "$app-streaming" "mastodon-streaming.service"
-
-#=================================================
-# START MASTODON SERVICES
-#=================================================
-ynh_print_info "Starting Mastodon services..."
-
-ynh_systemd_action --action=start --service_name=${app}-web --line_match="Listening on tcp" --log_path=systemd
-ynh_systemd_action --action=start --service_name=${app}-sidekiq --line_match="Starting processing" --log_path=systemd
-ynh_systemd_action --action=start --service_name=${app}-streaming --line_match="Worker 1 now listening" --log_path=systemd
+ynh_replace_string --match_string="__PORT_WEB__" --replace_string="$port_web" --target_file="../conf/mastodon-web.service"
+ynh_replace_string --match_string="__PORT_STREAM__" --replace_string="$port_stream" --target_file="../conf/mastodon-streaming.service"
+ynh_replace_string --match_string="__NODEJS_PATH__" --replace_string="$nodejs_path" --target_file="../conf/mastodon-streaming.service"
+ynh_add_systemd_config --service="$app-web" --template="mastodon-web.service"
+ynh_add_systemd_config --service="$app-sidekiq" --template="mastodon-sidekiq.service"
+ynh_add_systemd_config --service="$app-streaming" --template="mastodon-streaming.service"
#=================================================
# GENERIC FINALIZATION
@@ -286,24 +276,33 @@ chown -R $app: $final_path
#=================================================
# SETUP SSOWAT
#=================================================
-ynh_print_info "Upgrading SSOwat configuration..."
+ynh_script_progression --message="Upgrading SSOwat configuration..." --time --weight=1
# Make app public if necessary
if [ $is_public -eq 1 ]
then
# unprotected_uris allows SSO credentials to be passed anyway
- ynh_app_setting_set $app unprotected_uris "/"
+ ynh_app_setting_set --app=$app --key=unprotected_uris --value="/"
fi
#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+
+ynh_systemd_action --service_name=${app}-web --action="start" --log_path=systemd --line_match="Listening on tcp"
+ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=systemd --line_match="Starting processing"
+ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=systemd --line_match="Worker 1 now listening"
+
+#=================================================
# RELOAD NGINX
#=================================================
-ynh_print_info "Reloading nginx web server..."
+ynh_script_progression --message="Reloading nginx web server..." --time --weight=1
-systemctl reload nginx
+ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
-ynh_print_info "Upgrade of $app completed"
+ynh_script_progression --message="Upgrade of $app completed" --time --last