aboutsummaryrefslogtreecommitdiff
path: root/scripts
diff options
context:
space:
mode:
authorSalamandar <6552989+Salamandar@users.noreply.github.com>2024-05-27 14:56:29 +0200
committerGitHub <noreply@github.com>2024-05-27 14:56:29 +0200
commit8003baea29c5a5679c7475078ef16263e911b116 (patch)
treecf5d2bb10ddb7e32b53ba0de888007b6f8341782 /scripts
parenta75e6726bca8d3b8a076da4164cd7a18ed29d06e (diff)
parent7727e250c3c616bc59c311f20ec6d3e7f773d5da (diff)
downloadmastodon_ynh-8003baea29c5a5679c7475078ef16263e911b116.tar.gz
mastodon_ynh-8003baea29c5a5679c7475078ef16263e911b116.tar.bz2
mastodon_ynh-8003baea29c5a5679c7475078ef16263e911b116.zip
Merge pull request #449 from YunoHost-Apps/testing
Testing Packaging v2
Diffstat (limited to 'scripts')
-rw-r--r--scripts/_common.sh9
-rw-r--r--scripts/backup29
-rw-r--r--scripts/install218
-rw-r--r--scripts/remove74
-rw-r--r--scripts/restore122
-rw-r--r--scripts/upgrade309
-rw-r--r--scripts/ynh_add_swap7
-rw-r--r--scripts/ynh_install_ruby__2310
8 files changed, 197 insertions, 881 deletions
diff --git a/scripts/_common.sh b/scripts/_common.sh
index d6028ea..4049d21 100644
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -4,17 +4,14 @@
# COMMON VARIABLES
#=================================================
-# dependencies used by the app (must be on a single line)
-pkg_dependencies="imagemagick ffmpeg libpq-dev libxml2-dev libxslt1-dev file git-core g++ libprotobuf-dev protobuf-compiler pkg-config gcc autoconf bison build-essential libssl-dev libyaml-dev libreadline6-dev zlib1g-dev libncurses5-dev libffi-dev libgdbm3|libgdbm6 libgdbm-dev redis-tools redis-server postgresql postgresql-contrib libidn11-dev libicu-dev libjemalloc-dev curl apt-transport-https"
-build_pkg_dependencies=""
-
memory_needed="2560"
ruby_version=3.2.2
-nodejs_version=16
+nodejs_version=20
# Workaround for Mastodon on Bullseye
# See https://github.com/mastodon/mastodon/issues/15751#issuecomment-873594463
-if [ "$(lsb_release --codename --short)" = "bullseye" ]; then
+if [ "$(lsb_release --codename --short)" = "bullseye" ];
+then
case $YNH_ARCH in
amd64)
ld_preload="LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so"
diff --git a/scripts/backup b/scripts/backup
index 96a895d..de1ba98 100644
--- a/scripts/backup
+++ b/scripts/backup
@@ -11,27 +11,6 @@ source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers
#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-ynh_clean_setup () {
- true
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_print_info --message="Loading installation settings..."
-
-app=$YNH_APP_INSTANCE_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)
-
-#=================================================
# DECLARE DATA AND CONF FILES TO BACKUP
#=================================================
ynh_print_info --message="Declaring files to be backed up..."
@@ -40,7 +19,7 @@ ynh_print_info --message="Declaring files to be backed up..."
# BACKUP THE APP MAIN DIR
#=================================================
-ynh_backup --src_path="$final_path"
+ynh_backup --src_path="$install_dir"
#=================================================
# BACKUP THE NGINX CONFIGURATION
@@ -51,6 +30,12 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# SPECIFIC BACKUP
#=================================================
+# BACKUP LOGROTATE
+#=================================================
+
+ynh_backup --src_path="/etc/logrotate.d/$app"
+
+#=================================================
# BACKUP SYSTEMD
#=================================================
diff --git a/scripts/install b/scripts/install
index d5976f7..1385a30 100644
--- a/scripts/install
+++ b/scripts/install
@@ -7,125 +7,34 @@
#=================================================
source _common.sh
-source ynh_install_ruby__2
source ynh_add_swap
source /usr/share/yunohost/helpers
-#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-ynh_clean_setup () {
- true
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# RETRIEVE ARGUMENTS FROM THE MANIFEST
-#=================================================
-
-domain=$YNH_APP_ARG_DOMAIN
-path_url="/"
-is_public=$YNH_APP_ARG_IS_PUBLIC
-language=$YNH_APP_ARG_LANGUAGE
-admin=$YNH_APP_ARG_ADMIN
-
-app=$YNH_APP_INSTANCE_NAME
-
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"
#=================================================
-# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
-#=================================================
-ynh_script_progression --message="Validating installation parameters..." --weight=1
-
-final_path=/var/www/$app
-test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
-
-# Register (book) web path
-ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
-
-#=================================================
-# STORE SETTINGS FROM MANIFEST
-#=================================================
-ynh_script_progression --message="Storing installation settings..." --weight=1
-
-ynh_app_setting_set --app=$app --key=domain --value=$domain
-ynh_app_setting_set --app=$app --key=path --value=$path_url
-ynh_app_setting_set --app=$app --key=language --value=$language
-ynh_app_setting_set --app=$app --key=admin --value=$admin
-
-#=================================================
-# STANDARD MODIFICATIONS
-#=================================================
-# FIND AND OPEN A PORT
-#=================================================
-ynh_script_progression --message="Finding an available port..." --weight=1
-
-# Find an available port
-port_web=$(ynh_find_port --port=3000)
-ynh_app_setting_set --app=$app --key=port_web --value=$port_web
-
-port_stream=$(ynh_find_port --port=4000)
-ynh_app_setting_set --app=$app --key=port_stream --value=$port_stream
-
-#=================================================
-# INSTALL DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Installing dependencies..." --weight=1
-
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies $build_pkg_dependencies
-ynh_exec_warn_less ynh_install_ruby --ruby_version=$ruby_version
-ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
-ynh_exec_warn_less ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg"
-
-#=================================================
-# CREATE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Configuring system user..." --weight=1
-
-# Create a system user
-ynh_system_user_create --username=$app --home_dir="$final_path"
-
-#=================================================
-# CREATE A POSTGRESQL DATABASE
-#=================================================
-ynh_script_progression --message="Creating a PostgreSQL database..." --weight=1
-
-db_name=$(ynh_sanitize_dbid --db_name="${app}_production")
-db_user=$(ynh_sanitize_dbid --db_name=$app)
-ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-ynh_app_setting_set --app=$app --key=db_user --value=$db_user
-ynh_psql_test_if_first_run
-ynh_psql_setup_db --db_user=$db_user --db_name=$db_name
-ynh_psql_execute_as_root --sql="ALTER USER $db_user CREATEDB;"
-db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
-
+# APP "BUILD" (DEPLOYING SOURCES, VENV, COMPILING ETC)
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
ynh_script_progression --message="Setting up source files..." --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
-ynh_setup_source --dest_dir="$final_path/live"
+ynh_setup_source --dest_dir="$install_dir/live"
-chmod 750 "$final_path"
-chmod -R o-rwx "$final_path"
-chown -R $app:www-data "$final_path"
+chown -R $app:www-data "$install_dir"
#=================================================
-# NGINX CONFIGURATION
+# INSTALL DEPENDENCIES
#=================================================
-ynh_script_progression --message="Configuring NGINX web server..." --weight=1
+ynh_script_progression --message="Installing Ruby and NodeJS..." --weight=1
-# Create a dedicated NGINX config
-ynh_add_nginx_config
+ynh_exec_warn_less ynh_install_ruby --ruby_version=$ruby_version
+ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
#=================================================
-# SPECIFIC SETUP
-#=================================================
# ADD SWAP IF NEEDED
#=================================================
ynh_script_progression --message="Adding swap if needed..." --weight=1
@@ -138,7 +47,8 @@ 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 --message="Adding $swap_needed Mo to swap..." --weight=1
+
ynh_add_swap --size=$swap_needed
#=================================================
@@ -146,7 +56,7 @@ ynh_add_swap --size=$swap_needed
#=================================================
ynh_script_progression --message="Adding a configuration file..." --weight=1
-config="$final_path/live/.env.production"
+config="$install_dir/live/.env.production"
language="$(echo $language | head -c 2)"
@@ -159,28 +69,29 @@ ynh_app_setting_set --app="$app" --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"
+# We need rake to build vapid keys, we generate them later once the app is installed
vapid_private_key=""
vapid_public_key=""
-ynh_add_config --template="../conf/.env.production.sample" --destination="$config"
-
+ynh_add_config --template=".env.production.sample" --destination="$config"
chmod 400 "$config"
chown $app:$app "$config"
-ynh_replace_string --match_string="registrations_mode: 'open'" --replace_string="registrations_mode: 'none'" --target_file="$final_path/live/config/settings.yml"
-ynh_replace_string --match_string="min_invite_role: 'admin'" --replace_string="min_invite_role: 'none'" --target_file="$final_path/live/config/settings.yml"
+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_store_file_checksum --file="$final_path/live/config/settings.yml"
+ynh_store_file_checksum --file="$install_dir/live/config/settings.yml"
-chmod 400 "$final_path/live/config/settings.yml"
-chown $app:$app "$final_path/live/config/settings.yml"
+chmod 400 "$install_dir/live/config/settings.yml"
+chown $app:$app "$install_dir/live/config/settings.yml"
#=================================================
# BUILD APP
#=================================================
ynh_script_progression --message="Building app..." --weight=1
-pushd "$final_path/live"
+pushd "$install_dir/live"
+ # Building ruby packages
ynh_use_ruby
ynh_gem update --system
ynh_gem install bundler --no-document
@@ -188,92 +99,65 @@ pushd "$final_path/live"
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)
+ # Building assets
ynh_use_nodejs
- ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH yarn install --pure-lockfile
+ ynh_exec_warn_less ynh_exec_as $app $ynh_node_load_PATH yarn install --pure-lockfile --production --network-timeout 600000
echo "SAFETY_ASSURED=1">> $config
- ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails db:setup --quiet
+ 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
+ # Generate vapid keys
ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rake mastodon:webpush:generate_vapid_key > key.txt
+ # 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 modify "$admin" --approve
popd
-vapid_private_key=$(grep -oP "VAPID_PRIVATE_KEY=\K.+" "$final_path/live/key.txt")
+# 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"
-
-vapid_public_key=$(grep -oP "VAPID_PUBLIC_KEY=\K.+" "$final_path/live/key.txt")
+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="$final_path/live/key.txt"
-
+ynh_secure_remove --file="$install_dir/live/key.txt"
ynh_delete_file_checksum --file="$config"
-
-ynh_add_config --template="../conf/.env.production.sample" --destination="$config"
-
+ynh_add_config --template=".env.production.sample" --destination="$config"
chmod 400 "$config"
chown $app:$app "$config"
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-ynh_package_autoremove
-
#=================================================
-# SETUP SYSTEMD
+# SYSTEM CONFIGURATION
#=================================================
-ynh_script_progression --message="Configuring a systemd service..." --weight=1
+ynh_script_progression --message="Adding system configurations related to $app..." --weight=1
+
+# Create a dedicated NGINX config using the conf/nginx.conf template
+ynh_add_nginx_config
# Create a dedicated systemd config
ynh_add_systemd_config --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"
+yunohost service add "$app-sidekiq" --description="$app sidekiq service"
+
ynh_add_systemd_config --service="$app-streaming" --template="mastodon-streaming.service"
+yunohost service add "$app-streaming" --description="$app streaming service"
-#=================================================
-# SETUP THE CRON FILE
-#=================================================
-ynh_script_progression --message="Setuping the cron file..." --weight=1
+# Create a cron file
+ynh_add_config --template="cron" --destination="/etc/cron.d/$app"
-ynh_add_config --template="../conf/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
#=================================================
# GENERIC FINALIZATION
#=================================================
-# INTEGRATE SERVICE IN YUNOHOST
-#=================================================
-ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
-
-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"
-
-#=================================================
# START SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=1
-
-ynh_systemd_action --service_name=${app}-web --action="start" --log_path=systemd --line_match="Listening on"
-ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=systemd --line_match="Schedules Loaded"
-ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=systemd --line_match="Streaming API now listening"
-
-#=================================================
-# SETUP SSOWAT
-#=================================================
-ynh_script_progression --message="Configuring permissions..." --weight=1
-
-# Make app public if necessary
-if [ $is_public -eq 1 ]
-then
- # Everyone can access the app.
- # The "main" permission is automatically created before the install script.
- ynh_permission_update --permission="main" --add="visitors"
-fi
-
-ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
-
-#=================================================
-# RELOAD NGINX
-#=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=1
+ynh_script_progression --message="Starting all systemd services..." --weight=1
-ynh_systemd_action --service_name=nginx --action=reload
+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"
#=================================================
# END OF SCRIPT
diff --git a/scripts/remove b/scripts/remove
index 69fc9ec..c8ca3a3 100644
--- a/scripts/remove
+++ b/scripts/remove
@@ -7,27 +7,15 @@
#=================================================
source _common.sh
-source ynh_install_ruby__2
source ynh_add_swap
source /usr/share/yunohost/helpers
#=================================================
-# LOAD SETTINGS
+# REMOVE SYSTEM CONFIGURATIONS
#=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
-
-app=$YNH_APP_INSTANCE_NAME
-
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_user=$(ynh_app_setting_get --app=$app --key=db_user)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-
-#=================================================
-# STANDARD REMOVE
-#=================================================
-# REMOVE SERVICE INTEGRATION IN YUNOHOST
+# REMOVE SYSTEMD SERVICE
#=================================================
+ynh_script_progression --message="Removing system configurations related to $app..." --weight=1
# 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
@@ -48,74 +36,28 @@ then
yunohost service remove "$app-streaming"
fi
-#=================================================
-# STOP AND REMOVE SERVICE
-#=================================================
-ynh_script_progression --message="Stopping and removing the systemd service..." --weight=1
-
# 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"
-#=================================================
-# REMOVE THE POSTGRESQL DATABASE
-#=================================================
-ynh_script_progression --message="Removing the PostgreSQL database..." --weight=1
-
-# Remove a database if it exists, along with the associated user
-ynh_psql_remove_db --db_user=$db_user --db_name=$db_name
-
-#=================================================
-# REMOVE APP MAIN DIR
-#=================================================
-ynh_script_progression --message="Removing app main directory..." --weight=1
-
-# Remove the app directory securely
-ynh_secure_remove --file="$final_path"
-
-#=================================================
-# REMOVE NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
-
# Remove the dedicated NGINX config
ynh_remove_nginx_config
-#=================================================
-# REMOVE DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Removing dependencies..." --weight=1
+# Remove a cron file
+ynh_secure_remove --file="/etc/cron.d/$app"
+
+# Remote logrotate config
+ynh_remove_logrotate
# Remove metapackage and its dependencies
ynh_remove_ruby
ynh_remove_nodejs
-ynh_remove_app_dependencies
-
-#=================================================
-# SPECIFIC REMOVE
-#=================================================
-# REMOVE VARIOUS FILES
-#=================================================
-ynh_script_progression --message="Removing various files..." --weight=1
-
-# Remove a cron file
-ynh_secure_remove --file="/etc/cron.d/$app"
# Remove swap
ynh_del_swap
#=================================================
-# GENERIC FINALIZATION
-#=================================================
-# REMOVE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Removing the dedicated system user..." --weight=1
-
-# Delete a system user
-ynh_system_user_delete --username=$app
-
-#=================================================
# END OF SCRIPT
#=================================================
diff --git a/scripts/restore b/scripts/restore
index a03e3ba..77e934b 100644
--- a/scripts/restore
+++ b/scripts/restore
@@ -8,90 +8,27 @@
# 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_install_ruby__2
source ../settings/scripts/ynh_add_swap
source /usr/share/yunohost/helpers
#=================================================
-# MANAGE SCRIPT FAILURE
-#=================================================
-
-ynh_clean_setup () {
- true
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
-
-app=$YNH_APP_INSTANCE_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=$(ynh_app_setting_get --app=$app --key=db_user)
-
-#=================================================
-# CHECK IF THE APP CAN BE RESTORED
-#=================================================
-ynh_script_progression --message="Validating restoration parameters..." --weight=1
-
-test ! -d $final_path \
- || ynh_die --message="There is already a directory: $final_path "
-
-#=================================================
# STANDARD RESTORATION STEPS
#=================================================
-# RECREATE THE DEDICATED USER
-#=================================================
-ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
-
-# Create the dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
-
-#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
ynh_script_progression --message="Restoring the app main directory..." --weight=1
-ynh_restore_file --origin_path="$final_path"
-
-chmod 750 "$final_path"
-chmod -R o-rwx "$final_path"
-chown -R $app:www-data "$final_path"
-
-#=================================================
-# SPECIFIC RESTORATION
-#=================================================
-# REINSTALL DEPENDENCIES
-#=================================================
-ynh_script_progression --message="Reinstalling dependencies..." --weight=1
-
-# Define and install dependencies
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies $build_pkg_dependencies
-ynh_exec_warn_less ynh_install_ruby --ruby_version=$ruby_version
-ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
-ynh_exec_warn_less ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg"
-
-#=================================================
-# RESTORE THE NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1
+ynh_restore_file --origin_path="$install_dir"
-ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
+chmod 750 "$install_dir"
+chmod -R o-rwx "$install_dir"
+chown -R $app:www-data "$install_dir"
#=================================================
# RESTORE THE POSTGRESQL DATABASE
#=================================================
ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=1
-ynh_psql_test_if_first_run
-db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
-ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
ynh_psql_execute_as_root --sql="ALTER USER $db_user CREATEDB;"
ynh_psql_execute_file_as_root --file="./db.sql" --database="$db_name"
@@ -109,64 +46,63 @@ if [ $total_memory -lt $memory_needed ]; then
fi
ynh_script_progression --message="Adding $swap_needed Mo to swap..." --weight=1
+
ynh_add_swap --size=$swap_needed
#=================================================
+# REINSTALL DEPENDENCIES
+#=================================================
+ynh_script_progression --message="Reinstalling Ruby and NodeJS..." --weight=1
+
+ynh_exec_warn_less ynh_install_ruby --ruby_version=$ruby_version
+ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
+
+#=================================================
# BUILD APP
#=================================================
ynh_script_progression --message="Building app..." --weight=1
-pushd "$final_path/live"
+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)
popd
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-ynh_package_autoremove
-
#=================================================
-# RESTORE VARIOUS FILES
+# RESTORE SYSTEM CONFIGURATIONS
#=================================================
-ynh_script_progression --message="Restoring various files..." --weight=1
-
-ynh_restore_file --origin_path="/etc/cron.d/$app"
-
-#=================================================
-# RESTORE SYSTEMD
+# RESTORE THE PHP-FPM CONFIGURATION
#=================================================
-ynh_script_progression --message="Restoring the systemd configuration..." --weight=1
+ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1
+
+ynh_restore_file --origin_path="/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"
systemctl enable "$app-web" "$app-sidekiq" "$app-streaming" --quiet
-#=================================================
-# INTEGRATE SERVICE IN YUNOHOST
-#=================================================
-ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
-
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"
-#=================================================
-# START SYSTEMD SERVICE
-#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=1
+ynh_restore_file --origin_path="/etc/cron.d/$app"
-ynh_systemd_action --service_name=${app}-web --action="start" --log_path=systemd --line_match="Listening on"
-ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=systemd --line_match="Schedules Loaded"
-ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=systemd --line_match="Streaming API now listening"
+mkdir -p /var/log/$app
+chown -R $app:$app /var/log/$app
+ynh_restore_file --origin_path="/etc/logrotate.d/$app"
#=================================================
# GENERIC FINALIZATION
#=================================================
-# RELOAD NGINX
+# RELOAD NGINX AND THE APP SERVICE
#=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=1
+ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1
+
+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_systemd_action --service_name=nginx --action=reload
diff --git a/scripts/upgrade b/scripts/upgrade
index e041939..2dd3d32 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -7,235 +7,110 @@
#=================================================
source _common.sh
-source ynh_install_ruby__2
source ynh_add_swap
source /usr/share/yunohost/helpers
-#=================================================
-# LOAD SETTINGS
-#=================================================
-ynh_script_progression --message="Loading installation settings..." --weight=1
-
-app=$YNH_APP_INSTANCE_NAME
-
-domain=$(ynh_app_setting_get --app=$app --key=domain)
-path_url=$(ynh_app_setting_get --app=$app --key=path)
-language=$(ynh_app_setting_get --app=$app --key=language)
-admin=$(ynh_app_setting_get --app=$app --key=admin)
-final_path=$(ynh_app_setting_get --app=$app --key=final_path)
-redis_namespace=$(ynh_app_setting_get --app=$app --key=db_name)
-db_name=$(ynh_app_setting_get --app=$app --key=db_name)
-db_user=$(ynh_app_setting_get --app=$app --key=db_user)
-db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
-admin_mail=$(ynh_user_get_info --username=$admin --key='mail')
-port_web=$(ynh_app_setting_get --app=$app --key=port_web)
-port_stream=$(ynh_app_setting_get --app=$app --key=port_stream)
-
-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)
-
-config="$final_path/live/.env.production"
-
-#=================================================
-# CHECK VERSION
-#=================================================
-ynh_script_progression --message="Checking version..." --weight=1
-
upgrade_type=$(ynh_check_app_version_changed)
+config="$install_dir/live/.env.production"
#=================================================
-# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
-#=================================================
-ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1
-
-# Backup the current version of the app
-ynh_backup_before_upgrade
-ynh_clean_setup () {
- # Restore it if the upgrade fails
- ynh_restore_upgradebackup
-}
-# Exit if an error occurs during the execution of the script
-ynh_abort_if_errors
-
-#=================================================
-# STANDARD UPGRADE STEPS
-#=================================================
# STOP SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Stopping a systemd service..." --weight=1
-ynh_systemd_action --service_name=${app}-web --action="stop" --log_path=systemd
-ynh_systemd_action --service_name=${app}-sidekiq --action="stop" --log_path=systemd
-ynh_systemd_action --service_name=${app}-streaming --action="stop" --log_path=systemd
+if ynh_compare_current_package_version --comparison lt --version "4.2.8~ynh2"; then
+ # Workaround for pre-packagingv2 versions
+ ynh_systemd_action --service_name=${app}-web --action="stop" --log_path="systemd" --line_match="Goodbye"
+ ynh_systemd_action --service_name=${app}-sidekiq --action="stop" --log_path="systemd" --line_match="Bye"
+ ynh_systemd_action --service_name=${app}-streaming --action="stop" --log_path="systemd"
+else
+ ynh_systemd_action --service_name=${app}-web --action="stop" --log_path=/var/log/$app/$app-web.log --line_match="Goodbye"
+ ynh_systemd_action --service_name=${app}-sidekiq --action="stop" --log_path=/var/log/$app/$app-sidekiq.log --line_match="Bye"
+ ynh_systemd_action --service_name=${app}-streaming --action="stop" --log_path=/var/log/$app/$app-streaming.log
+fi
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
-# Cleaning legacy permissions
-if ynh_legacy_permissions_exists; then
- ynh_legacy_permissions_delete_all
-
- ynh_app_setting_delete --app=$app --key=is_public
-fi
-
-# Create a permission if needed
-if ! ynh_permission_exists --permission="api"; then
- ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true"
-fi
-
-# If port_web doesn't exist, create it, needed for old install
-if [[ -z "$port_web" ]]; then
- port_web=3000
- ynh_app_setting_set --app=$app --key=port_web --value=$port_web
-fi
-
-# If port_web doesn't exist, create it, needed for old install
-if [[ -z "$port_stream" ]]; then
- port_stream=4000
- ynh_app_setting_set --app=$app --key=port_stream --value=$port_stream
-fi
-
-# If db_user doesn't exist, create it, needed for old install
-if [[ -z "$db_user" ]]; then
- db_user=$(ynh_sanitize_dbid --db_name=$app)
- ynh_app_setting_set --app=$app --key=db_user --value=$db_user
+# 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
-# If db_pwd doesn't exist, create it, needed for old install
-if [[ -z "$db_pwd" ]]; then
- db_pwd=$(ynh_string_random)
- 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 --match_string="DB_PASS=" --replace_string="DB_PASS=${db_pwd}" --target_file="$config"
-fi
+# Remove previous added repository
+ynh_remove_extra_repo
-# Remove paperclip_secret
-ynh_app_setting_delete --app=$app --key=paperclip_secret
+if ynh_compare_current_package_version --comparison lt --version "4.2.8~ynh2"; then
+ # Rename legacy database
+ if ynh_psql_database_exists --database="${app}_production"; then
+ db_name=$(ynh_sanitize_dbid --db_name="$app")
+ ynh_app_setting_set --app="$app" --key="db_name" --value="$db_name"
-# If secret_key_base doesn't exist, retrieve it or create it
-if [[ -z "$secret_key_base" ]]; then
- secret_key_base=$(grep -oP "SECRET_KEY_BASE=\K\w+" $config)
- if [[ -z "$secret_key_base" ]]; then
- secret_key_base=$(ynh_string_random --length=128)
+ # Remove the newly created db by resources, and rename legacy db
+ ynh_psql_execute_as_root --sql="DROP DATABASE IF EXISTS $db_name;"
+ ynh_psql_execute_as_root --sql="ALTER DATABASE ${app}_production RENAME TO $db_name;"
fi
- ynh_app_setting_set --app=$app --key=secret_key_base --value="$secret_key_base"
-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"
-# If otp_secret doesn't exist, retrieve it or create it
-if [[ -z "$otp_secret" ]]; then
- otp_secret=$(grep -oP "OTP_SECRET=\K\w+" $config)
- if [[ -z "$otp_secret" ]]; then
- otp_secret=$(ynh_string_random --length=128)
+ ynh_psql_execute_as_root --sql="DROP USER IF EXISTS $db_user;"
+ ynh_psql_execute_as_root --sql="ALTER USER ${app}_production RENAME $db_user;"
fi
- ynh_app_setting_set --app=$app --key=otp_secret --value="$otp_secret"
-fi
-
-# If vapid_private_key doesn't exist, retrieve it or create it
-if [[ -z "$vapid_private_key" ]]; then
- vapid_private_key=$(grep -oP "VAPID_PRIVATE_KEY=\K.+" $config)
- vapid_public_key=$(grep -oP "VAPID_PUBLIC_KEY=\K.+" $config)
- ynh_app_setting_set "$app" vapid_private_key "$vapid_private_key"
- ynh_app_setting_set "$app" vapid_public_key "$vapid_public_key"
-fi
-
-# If redis_namespace doesn't exist, create it
-if [[ -z "$redis_namespace" ]]; then
- redis_namespace=${app}_production
- ynh_app_setting_set --app=$app --key=redis_namespace --value=$redis_namespace
fi
-#Remove previous added repository
-ynh_remove_extra_repo
-
-#=================================================
-# CREATE DEDICATED USER
#=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
-
-# Create a dedicated user (if not existing)
-ynh_system_user_create --username=$app --home_dir="$final_path"
-
-#=================================================
-# DOWNLOAD, CHECK AND UNPACK SOURCE
+# ADD SWAP IF NEEDED
#=================================================
+ynh_script_progression --message="Adding swap if needed..." --weight=1
-if [ "$upgrade_type" == "UPGRADE_APP" ]
-then
- ynh_script_progression --message="Upgrading source files..." --weight=1
-
- # Download Mastodon
- tmpdir="$(mktemp -d)"
-
- mkdir $tmpdir/system
- if [ -d "$final_path/live/public/system" ]; then
- mv --verbose --no-target-directory --backup=numbered "$final_path/live/public/system" "$final_path/system.tmp"
- fi
- rsync -a "$config" "$tmpdir/."
- ynh_secure_remove --file="$final_path/live"
-
- ynh_setup_source --dest_dir="$final_path/live"
-
- if [ -d "$final_path/system.tmp" ]; then
- mv --verbose --no-target-directory "$final_path/system.tmp" "$final_path/live/public/system"
- fi
- rsync -a "$tmpdir/.env.production" "$final_path/live/."
- ynh_secure_remove --file="$tmpdir"
+total_memory=$(ynh_get_ram --total)
+swap_needed=0
- # Clean files which are not needed anymore
- ynh_secure_remove --file="$final_path/live/config/initializers/timeout.rb"
+if [ $total_memory -lt $memory_needed ]; then
+ # Need a minimum of 8Go of memory
+ swap_needed=$(($memory_needed - $total_memory))
fi
-chmod 750 "$final_path"
-chmod -R o-rwx "$final_path"
-chown -R $app:www-data "$final_path"
+ynh_script_progression --message="Adding $swap_needed Mo to swap..."
+ynh_add_swap --size=$swap_needed
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
-ynh_script_progression --message="Upgrading dependencies..." --weight=1
+ynh_script_progression --message="Upgrading Ruby and NodeJS..." --weight=1
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies $build_pkg_dependencies
ynh_exec_warn_less ynh_install_ruby --ruby_version=$ruby_version
ynh_exec_warn_less ynh_install_nodejs --nodejs_version=$nodejs_version
-ynh_exec_warn_less ynh_install_extra_app_dependencies --repo="deb https://dl.yarnpkg.com/debian/ stable main" --package="yarn" --key="https://dl.yarnpkg.com/debian/pubkey.gpg"
-
-#=================================================
-# NGINX CONFIGURATION
-#=================================================
-ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
-
-# Create a dedicated NGINX config
-ynh_add_nginx_config
#=================================================
-# SPECIFIC UPGRADE
+# "REBUILD" THE APP (DEPLOY NEW SOURCES, RERUN NPM BUILD...)
#=================================================
-# ADD SWAP IF NEEDED
+# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-ynh_script_progression --message="Adding swap if needed..." --weight=1
-total_memory=$(ynh_get_ram --total)
-swap_needed=0
+if [ "$upgrade_type" == "UPGRADE_APP" ]
+then
+ ynh_script_progression --message="Upgrading source files..." --weight=1
-if [ $total_memory -lt $memory_needed ]; then
- # Need a minimum of 8Go of memory
- swap_needed=$(($memory_needed - $total_memory))
-fi
+ # Download Mastodon
+ ynh_setup_source --dest_dir="$install_dir/live" --keep="public/system/"
-ynh_script_progression --message="Adding $swap_needed Mo to swap..."
-ynh_add_swap --size=$swap_needed
+ chmod 750 "$install_dir"
+ chmod -R o-rwx "$install_dir"
+ chown -R $app:www-data "$install_dir"
+fi
#=================================================
-# BUILD APP
+# BUILD ASSETS
#=================================================
-ynh_script_progression --message="Building app..." --weight=1
+ynh_script_progression --message="Building assets..." --weight=1
-pushd "$final_path/live"
+pushd "$install_dir/live"
ynh_use_ruby
ynh_gem update --system
ynh_gem install bundler --no-document
@@ -244,71 +119,71 @@ pushd "$final_path/live"
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
- ynh_exec_as $app $ynh_node_load_PATH yarn install --pure-lockfile
+ ynh_exec_as $app $ynh_node_load_PATH yarn install --pure-lockfile --production --network-timeout 600000
ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails assets:clean
ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails assets:precompile
- ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/bundle exec rails db:migrate
- ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/tootctl cache clear
popd
-ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
-ynh_package_autoremove
+chown "$app:www-data" "$install_dir"
+chown -R "$app:www-data" "$install_dir/live/public"
#=================================================
-# UPDATE A CONFIG FILE
+# REAPPLY SYSTEM CONFIGURATIONS
#=================================================
-ynh_script_progression --message="Updating a config file..." --weight=1
-
-language="$(echo $language | head -c 2)"
-
-ynh_add_config --template="../conf/.env.production.sample" --destination="$config"
-
-chmod 400 "$config"
-chown $app:$app "$config"
+ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1
-#=================================================
-# SETUP SYSTEMD
-#=================================================
-ynh_script_progression --message="Upgrading systemd configuration..." --weight=1
+ynh_add_nginx_config
# Create a dedicated systemd config
ynh_add_systemd_config --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"
+yunohost service add "$app-sidekiq" --description="$app sidekiq service"
+
ynh_add_systemd_config --service="$app-streaming" --template="mastodon-streaming.service"
+yunohost service add "$app-streaming" --description="$app streaming service"
-#=================================================
-# SETUP THE CRON FILE
-#=================================================
-ynh_script_progression --message="Setuping the cron file..." --weight=1
+ynh_add_config --template="cron" --destination="/etc/cron.d/$app"
-ynh_add_config --template="../conf/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
#=================================================
-# GENERIC FINALIZATION
+# RECONFIGURE THE APP (UPDATE CONF, APPLY MIGRATIONS...)
#=================================================
-# INTEGRATE SERVICE IN YUNOHOST
+# UPDATE A CONFIG FILE
#=================================================
-ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
+ynh_script_progression --message="Updating a config file..." --weight=1
-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"
+language="$(echo $language | head -c 2)"
+
+ynh_add_config --template=".env.production.sample" --destination="$config"
+
+chmod 400 "$config"
+chown $app:$app "$config"
#=================================================
-# START SYSTEMD SERVICE
+# APPLY MIGRATIONS
#=================================================
-ynh_script_progression --message="Starting a systemd service..." --weight=1
+ynh_script_progression --message="Applying migrations..." --weight=1
-ynh_systemd_action --service_name=${app}-web --action="start" --log_path=systemd --line_match="Listening on"
-ynh_systemd_action --service_name=${app}-sidekiq --action="start" --log_path=systemd --line_match="Schedules Loaded"
-ynh_systemd_action --service_name=${app}-streaming --action="start" --log_path=systemd --line_match="Streaming API now listening"
+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
+ ynh_exec_warn_less ynh_exec_as $app RAILS_ENV=production $ynh_ruby_load_path $ld_preload bin/tootctl cache clear
+popd
#=================================================
-# RELOAD NGINX
+# START SYSTEMD SERVICE
#=================================================
-ynh_script_progression --message="Reloading NGINX web server..." --weight=1
+ynh_script_progression --message="Starting a systemd service..." --weight=1
-ynh_systemd_action --service_name=nginx --action=reload
+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"
#=================================================
# END OF SCRIPT
diff --git a/scripts/ynh_add_swap b/scripts/ynh_add_swap
index d7ec44b..aa82c51 100644
--- a/scripts/ynh_add_swap
+++ b/scripts/ynh_add_swap
@@ -19,6 +19,13 @@ ynh_add_swap () {
SD_CARD_CAN_SWAP=${SD_CARD_CAN_SWAP:-0}
+ # Can't swap inside an LXD
+ if [ "$(systemd-detect-virt)" == "lxc" ]
+ then
+ ynh_print_warn --message="You are inside a LXC container, swap will not be added, but that can cause troubles for the app $app. Please make sure you have more than 2.5G available RAM."
+ return
+ fi
+
# Swap on SD card only if it's is specified
if ynh_is_main_device_a_sd_card && [ "$SD_CARD_CAN_SWAP" == "0" ]
then
diff --git a/scripts/ynh_install_ruby__2 b/scripts/ynh_install_ruby__2
deleted file mode 100644
index a2a83d0..0000000
--- a/scripts/ynh_install_ruby__2
+++ /dev/null
@@ -1,310 +0,0 @@
-#!/bin/bash
-
-ynh_ruby_try_bash_extension() {
- if [ -x src/configure ]; then
- src/configure && make -C src || {
- ynh_print_info --message="Optional bash extension failed to build, but things will still work normally."
- }
- fi
-}
-
-rbenv_install_dir="/opt/rbenv"
-ruby_version_path="$rbenv_install_dir/versions"
-# RBENV_ROOT is the directory of rbenv, it needs to be loaded as a environment variable.
-export RBENV_ROOT="$rbenv_install_dir"
-export rbenv_root="$rbenv_install_dir"
-
-ruby_dependencies=""
-build_ruby_dependencies="libjemalloc-dev curl build-essential libreadline-dev zlib1g-dev libsqlite3-dev libssl-dev libxml2-dev libxslt-dev autoconf automake bison libtool"
-pkg_dependencies="$pkg_dependencies $ruby_dependencies"
-build_pkg_dependencies="$build_pkg_dependencies $build_ruby_dependencies"
-
-# Load the version of Ruby for an app, and set variables.
-#
-# ynh_use_ruby has to be used in any app scripts before using Ruby for the first time.
-# This helper will provide alias and variables to use in your scripts.
-#
-# To use gem or Ruby, use the alias `ynh_gem` and `ynh_ruby`
-# Those alias will use the correct version installed for the app
-# For example: use `ynh_gem install` instead of `gem install`
-#
-# With `sudo` or `ynh_exec_as`, use instead the fallback variables `$ynh_gem` and `$ynh_ruby`
-# And propagate $PATH to sudo with $ynh_ruby_load_path
-# Exemple: `ynh_exec_as $app $ynh_ruby_load_path $ynh_gem install`
-#
-# $PATH contains the path of the requested version of Ruby.
-# However, $PATH is duplicated into $ruby_path to outlast any manipulation of $PATH
-# You can use the variable `$ynh_ruby_load_path` to quickly load your Ruby version
-# in $PATH for an usage into a separate script.
-# Exemple: $ynh_ruby_load_path $final_path/script_that_use_gem.sh`
-#
-#
-# Finally, to start a Ruby service with the correct version, 2 solutions
-# Either the app is dependent of Ruby or gem, but does not called it directly.
-# In such situation, you need to load PATH
-# `Environment="__YNH_RUBY_LOAD_PATH__"`
-# `ExecStart=__FINALPATH__/my_app`
-# You will replace __YNH_RUBY_LOAD_PATH__ with $ynh_ruby_load_path
-#
-# Or Ruby start the app directly, then you don't need to load the PATH variable
-# `ExecStart=__YNH_RUBY__ my_app run`
-# You will replace __YNH_RUBY__ with $ynh_ruby
-#
-#
-# one other variable is also available
-# - $ruby_path: The absolute path to Ruby binaries for the chosen version.
-#
-# usage: ynh_use_ruby
-#
-# Requires YunoHost version 3.2.2 or higher.
-ynh_use_ruby () {
- ruby_version=$(ynh_app_setting_get --app=$app --key=ruby_version)
-
- # Get the absolute path of this version of Ruby
- ruby_path="$ruby_version_path/$YNH_APP_INSTANCE_NAME/bin"
-
- # Allow alias to be used into bash script
- shopt -s expand_aliases
-
- # Create an alias for the specific version of Ruby and a variable as fallback
- ynh_ruby="$ruby_path/ruby"
- alias ynh_ruby="$ynh_ruby"
- # And gem
- ynh_gem="$ruby_path/gem"
- alias ynh_gem="$ynh_gem"
-
- # Load the path of this version of Ruby in $PATH
- if [[ :$PATH: != *":$ruby_path"* ]]; then
- PATH="$ruby_path:$PATH"
- fi
- # Create an alias to easily load the PATH
- ynh_ruby_load_path="PATH=$PATH"
-
- # Sets the local application-specific Ruby version
- pushd $final_path
- $rbenv_install_dir/bin/rbenv local $ruby_version
- popd
-}
-
-# Install a specific version of Ruby
-#
-# ynh_install_ruby will install the version of Ruby provided as argument by using rbenv.
-#
-# This helper creates a /etc/profile.d/rbenv.sh that configures PATH environment for rbenv
-# for every LOGIN user, hence your user must have a defined shell (as opposed to /usr/sbin/nologin)
-#
-# Don't forget to execute ruby-dependent command in a login environment
-# (e.g. sudo --login option)
-# When not possible (e.g. in systemd service definition), please use direct path
-# to rbenv shims (e.g. $RBENV_ROOT/shims/bundle)
-#
-# usage: ynh_install_ruby --ruby_version=ruby_version
-# | arg: -v, --ruby_version= - Version of ruby to install.
-#
-# Requires YunoHost version 3.2.2 or higher.
-ynh_install_ruby () {
- # Declare an array to define the options of this helper.
- local legacy_args=v
- local -A args_array=( [v]=ruby_version= )
- local ruby_version
- # Manage arguments with getopts
- ynh_handle_getopts_args "$@"
-
- # Load rbenv path in PATH
- local CLEAR_PATH="$rbenv_install_dir/bin:$PATH"
-
- # Remove /usr/local/bin in PATH in case of Ruby prior installation
- PATH=$(echo $CLEAR_PATH | sed 's@/usr/local/bin:@@')
-
- # Move an existing Ruby binary, to avoid to block rbenv
- test -x /usr/bin/ruby && mv /usr/bin/ruby /usr/bin/ruby_rbenv
-
- # Install or update rbenv
- rbenv="$(command -v rbenv $rbenv_install_dir/bin/rbenv | grep "$rbenv_install_dir/bin/rbenv" | head -1)"
- if [ -n "$rbenv" ]; then
- ynh_print_info --message="rbenv already seems installed in \`$rbenv'."
- pushd "${rbenv%/*/*}"
- if git remote -v 2>/dev/null | grep "https://github.com/rbenv/rbenv.git"; then
- ynh_print_info --message="Trying to update with git..."
- git pull -q --tags origin master
- ynh_ruby_try_bash_extension
- else
- ynh_print_info --message="Reinstalling rbenv with git..."
- cd ..
- ynh_secure_remove --file=$rbenv_install_dir
- mkdir -p $rbenv_install_dir
- cd $rbenv_install_dir
- git init -q
- git remote add -f -t master origin https://github.com/rbenv/rbenv.git > /dev/null 2>&1
- git checkout -q -b master origin/master
- ynh_ruby_try_bash_extension
- rbenv=$rbenv_install_dir/bin/rbenv
- fi
- popd
- else
- ynh_print_info --message="Installing rbenv with git..."
- mkdir -p $rbenv_install_dir
- pushd $rbenv_install_dir
- git init -q
- git remote add -f -t master origin https://github.com/rbenv/rbenv.git > /dev/null 2>&1
- git checkout -q -b master origin/master
- ynh_ruby_try_bash_extension
- rbenv=$rbenv_install_dir/bin/rbenv
- popd
- fi
-
- ruby_build="$(command -v "$rbenv_install_dir"/plugins/*/bin/rbenv-install rbenv-install | head -1)"
- if [ -n "$ruby_build" ]; then
- ynh_print_info --message="\`rbenv install' command already available in \`$ruby_build'."
- pushd "${ruby_build%/*/*}"
- if git remote -v 2>/dev/null | grep "https://github.com/rbenv/ruby-build.git"; then
- ynh_print_info --message="Trying to update rbenv with git..."
- git pull -q origin master
- fi
- popd
- else
- ynh_print_info --message="Installing ruby-build with git..."
- mkdir -p "${rbenv_install_dir}/plugins"
- git clone -q https://github.com/rbenv/ruby-build.git "${rbenv_install_dir}/plugins/ruby-build"
- fi
-
- rbenv_alias="$(command -v "$rbenv_install_dir"/plugins/*/bin/rbenv-alias rbenv-alias | head -1)"
- if [ -n "$rbenv_alias" ]; then
- ynh_print_info --message="\`rbenv alias' command already available in \`$rbenv_alias'."
- pushd "${rbenv_alias%/*/*}"
- if git remote -v 2>/dev/null | grep "https://github.com/tpope/rbenv-aliases.git"; then
- ynh_print_info --message="Trying to update rbenv-aliases with git..."
- git pull -q origin master
- fi
- popd
- else
- ynh_print_info --message="Installing rbenv-aliases with git..."
- mkdir -p "${rbenv_install_dir}/plugins"
- git clone -q https://github.com/tpope/rbenv-aliases.git "${rbenv_install_dir}/plugins/rbenv-aliase"
- fi
-
- rbenv_latest="$(command -v "$rbenv_install_dir"/plugins/*/bin/rbenv-latest rbenv-latest | head -1)"
- if [ -n "$rbenv_latest" ]; then
- ynh_print_info --message="\`rbenv latest' command already available in \`$rbenv_latest'."
- pushd "${rbenv_latest%/*/*}"
- if git remote -v 2>/dev/null | grep "https://github.com/momo-lab/xxenv-latest.git"; then
- ynh_print_info --message="Trying to update xxenv-latest with git..."
- git pull -q origin master
- fi
- popd
- else
- ynh_print_info --message="Installing xxenv-latest with git..."
- mkdir -p "${rbenv_install_dir}/plugins"
- git clone -q https://github.com/momo-lab/xxenv-latest.git "${rbenv_install_dir}/plugins/xxenv-latest"
- fi
-
- # Enable caching
- mkdir -p "${rbenv_install_dir}/cache"
-
- # Create shims directory if needed
- mkdir -p "${rbenv_install_dir}/shims"
-
- # Restore /usr/local/bin in PATH
- PATH=$CLEAR_PATH
-
- # And replace the old Ruby binary
- test -x /usr/bin/ruby_rbenv && mv /usr/bin/ruby_rbenv /usr/bin/ruby
-
- # Install the requested version of Ruby
- local final_ruby_version=$(rbenv latest --print $ruby_version)
- if ! [ -n "$final_ruby_version" ]; then
- final_ruby_version=$ruby_version
- fi
- ynh_print_info --message="Installing Ruby-$final_ruby_version"
- CONFIGURE_OPTS="--disable-install-doc --with-jemalloc" MAKE_OPTS="-j2" rbenv install --skip-existing $final_ruby_version > /dev/null 2>&1
-
- # Store ruby_version into the config of this app
- ynh_app_setting_set --app=$YNH_APP_INSTANCE_NAME --key=ruby_version --value=$final_ruby_version
-
- # Remove app virtualenv
- if `rbenv alias --list | grep --quiet "$YNH_APP_INSTANCE_NAME " 1>/dev/null 2>&1`
- then
- rbenv alias $YNH_APP_INSTANCE_NAME --remove
- fi
-
- # Create app virtualenv
- rbenv alias $YNH_APP_INSTANCE_NAME $final_ruby_version
-
- # Cleanup Ruby versions
- ynh_cleanup_ruby
-
- # Set environment for Ruby users
- echo "#rbenv
-export RBENV_ROOT=$rbenv_install_dir
-export PATH=\"$rbenv_install_dir/bin:$PATH\"
-eval \"\$(rbenv init -)\"
-#rbenv" > /etc/profile.d/rbenv.sh
-
- # Load the environment
- eval "$(rbenv init -)"
-}
-
-# Remove the version of Ruby used by the app.
-#
-# This helper will also cleanup Ruby versions
-#
-# usage: ynh_remove_ruby
-ynh_remove_ruby () {
- local ruby_version=$(ynh_app_setting_get --app=$YNH_APP_INSTANCE_NAME --key=ruby_version)
-
- # Load rbenv path in PATH
- local CLEAR_PATH="$rbenv_install_dir/bin:$PATH"
-
- # Remove /usr/local/bin in PATH in case of Ruby prior installation
- PATH=$(echo $CLEAR_PATH | sed 's@/usr/local/bin:@@')
-
- rbenv alias $YNH_APP_INSTANCE_NAME --remove
-
- # Remove the line for this app
- ynh_app_setting_delete --app=$YNH_APP_INSTANCE_NAME --key=ruby_version
-
- # Cleanup Ruby versions
- ynh_cleanup_ruby
-}
-
-# Remove no more needed versions of Ruby used by the app.
-#
-# This helper will check what Ruby version are no more required,
-# and uninstall them
-# If no app uses Ruby, rbenv will be also removed.
-#
-# usage: ynh_cleanup_ruby
-ynh_cleanup_ruby () {
-
- # List required Ruby versions
- local installed_apps=$(yunohost app list | grep -oP 'id: \K.*$')
- local required_ruby_versions=""
- for installed_app in $installed_apps
- do
- local installed_app_ruby_version=$(ynh_app_setting_get --app=$installed_app --key="ruby_version")
- if [[ $installed_app_ruby_version ]]
- then
- required_ruby_versions="${installed_app_ruby_version}\n${required_ruby_versions}"
- fi
- done
-
- # Remove no more needed Ruby versions
- local installed_ruby_versions=$(rbenv versions --bare --skip-aliases | grep -Ev '/')
- for installed_ruby_version in $installed_ruby_versions
- do
- if ! `echo ${required_ruby_versions} | grep "${installed_ruby_version}" 1>/dev/null 2>&1`
- then
- ynh_print_info --message="Removing of Ruby-$installed_ruby_version"
- $rbenv_install_dir/bin/rbenv uninstall --force $installed_ruby_version
- fi
- done
-
- # If none Ruby version is required
- if [[ ! $required_ruby_versions ]]
- then
- # Remove rbenv environment configuration
- ynh_print_info --message="Removing of rbenv-$rbenv_version"
- ynh_secure_remove --file="$rbenv_install_dir"
- ynh_secure_remove --file="/etc/profile.d/rbenv.sh"
- fi
-}