garage_ynh/scripts/upgrade

209 lines
7.6 KiB
Text
Raw Permalink Normal View History

2014-10-20 16:55:53 +00:00
#!/bin/bash
2017-06-02 16:44:37 +00:00
#=================================================
2017-06-17 16:02:28 +00:00
# GENERIC START
2017-06-02 16:44:37 +00:00
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
2017-06-05 11:06:35 +00:00
source _common.sh
2017-06-02 16:44:37 +00:00
source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
2019-04-18 17:58:47 +00:00
ynh_script_progression --message="Loading installation settings..." --time --weight=1
app=$YNH_APP_INSTANCE_NAME
2014-10-20 16:55:53 +00:00
2019-04-15 22:32:39 +00:00
domain=$(ynh_app_setting_get --app=$app --key=domain)
2022-07-30 12:02:57 +00:00
port=$(ynh_app_setting_get --app=$app --key=port)
rpc_secret=$(ynh_app_setting_get --app=$app --key=rpc_secret)
port_api=$(ynh_app_setting_get --app=$app --key=port_api)
port_web=$(ynh_app_setting_get --app=$app --key=port_web)
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
bootstrap_peers=$(ynh_app_setting_get --app=$app --key=bootstrap_peers)
2017-06-02 16:44:37 +00:00
2019-04-18 17:58:47 +00:00
#=================================================
# CHECK VERSION
#=================================================
### This helper will compare the version of the currently installed app and the version of the upstream package.
### $upgrade_type can have 2 different values
### - UPGRADE_APP if the upstream app version has changed
### - UPGRADE_PACKAGE if only the YunoHost package has changed
### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
upgrade_type=$(ynh_check_app_version_changed)
2021-05-09 18:26:00 +00:00
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
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
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..." --time --weight=1
ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log"
2017-06-02 16:44:37 +00:00
#=================================================
2017-06-17 16:02:28 +00:00
# ENSURE DOWNWARD COMPATIBILITY
2017-06-02 16:44:37 +00:00
#=================================================
2019-04-18 17:58:47 +00:00
ynh_script_progression --message="Ensuring downward compatibility..." --time --weight=1
2017-06-02 16:44:37 +00:00
#
# N.B. : the followings setting migrations snippets are provided as *EXAMPLES*
# of what you may want to do in some cases (e.g. a setting was not defined on
# some legacy installs and you therefore want to initiaze stuff during upgrade)
#
2017-08-28 21:55:51 +00:00
# If db_name doesn't exist, create it
#if [ -z "$db_name" ]; then
# db_name=$(ynh_sanitize_dbid --db_name=$app)
# ynh_app_setting_set --app=$app --key=db_name --value=$db_name
#fi
2017-06-02 16:44:37 +00:00
2017-08-28 21:55:51 +00:00
# If final_path doesn't exist, create it
#if [ -z "$final_path" ]; then
# final_path=/var/www/$app
# ynh_app_setting_set --app=$app --key=final_path --value=$final_path
#fi
2017-08-28 21:55:51 +00:00
2021-01-06 12:31:32 +00:00
### If nobody installed your app before 4.1,
### then you may safely remove these lines
2020-02-08 16:16:25 +00:00
2021-01-06 12:39:27 +00:00
# Cleaning legacy permissions
2021-01-06 12:31:32 +00:00
if ynh_legacy_permissions_exists; then
ynh_legacy_permissions_delete_all
ynh_app_setting_delete --app=$app --key=is_public
fi
if ! ynh_permission_exists --permission="admin"; then
2021-01-06 12:31:32 +00:00
# Create the required permissions
ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin
fi
# Create a permission if needed
if ! ynh_permission_exists --permission="api"; then
2021-04-09 19:16:25 +00:00
ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --show_tile="false" --protected="true"
2020-02-08 16:16:25 +00:00
fi
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --time --weight=1
# Create a dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
2017-06-02 16:44:37 +00:00
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
2019-04-18 17:58:47 +00:00
if [ "$upgrade_type" == "UPGRADE_APP" ]
then
ynh_script_progression --message="Upgrading source files..." --time --weight=1
# Download, check integrity, uncompress and patch the source from app.src
2022-07-30 12:02:57 +00:00
pushd $final_path
install_garage
popd
2019-04-18 17:58:47 +00:00
fi
2017-06-02 16:44:37 +00:00
# FIXME: this should be managed by the core in the future
# Here, as a packager, you may have to tweak the ownerhsip/permissions
# such that the appropriate users (e.g. maybe www-data) can access
# files in some cases.
# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
# this will be treated as a security issue.
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
2022-07-30 12:02:57 +00:00
chown -R $app:$app "$final_path"
2017-06-02 16:44:37 +00:00
2022-05-30 23:56:33 +00:00
#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Upgrading NGINX web server configuration..." --time --weight=1
# Create a dedicated NGINX config
ynh_add_nginx_config
2017-06-02 16:44:37 +00:00
#=================================================
# SPECIFIC UPGRADE
#=================================================
# ...
#=================================================
#=================================================
2021-03-12 15:41:18 +00:00
# UPDATE A CONFIG FILE
#=================================================
2021-04-29 19:08:10 +00:00
ynh_script_progression --message="Updating a configuration file..." --time --weight=1
2021-03-12 15:41:18 +00:00
### For more complex cases where you want to replace stuff using regexes,
### you shoud rely on ynh_replace_string (which is basically a wrapper for sed)
### When doing so, you also need to manually call ynh_store_file_checksum
###
### ynh_replace_string --match_string="match_string" --replace_string="replace_string" --target_file="$final_path/some_config_file"
### ynh_store_file_checksum --file="$final_path/some_config_file"
2017-06-02 16:44:37 +00:00
2021-04-23 18:00:41 +00:00
#=================================================
# SETUP SYSTEMD
#=================================================
ynh_script_progression --message="Upgrading systemd configuration..." --time --weight=1
# Create a dedicated systemd config
ynh_add_systemd_config
2017-06-02 16:44:37 +00:00
#=================================================
# GENERIC FINALIZATION
2017-06-02 16:44:37 +00:00
#=================================================
# SETUP LOGROTATE
2019-04-18 17:58:47 +00:00
#=================================================
ynh_script_progression --message="Upgrading logrotate configuration..." --time --weight=1
2017-06-17 16:02:28 +00:00
# Use logrotate to manage app-specific logfile(s)
ynh_use_logrotate --non-append
2019-04-18 17:58:47 +00:00
2017-06-02 16:44:37 +00:00
#=================================================
2020-06-16 21:07:13 +00:00
# INTEGRATE SERVICE IN YUNOHOST
2017-06-02 16:44:37 +00:00
#=================================================
2020-06-16 21:07:13 +00:00
ynh_script_progression --message="Integrating service in YunoHost..." --time --weight=1
2017-06-02 16:44:37 +00:00
2022-07-30 12:02:57 +00:00
yunohost service add --needs_exposed_ports $app --description="s3 storage" --log="/var/log/$app/$app.log"
2017-06-02 16:44:37 +00:00
2019-05-02 18:44:22 +00:00
#=================================================
# START SYSTEMD SERVICE
#=================================================
ynh_script_progression --message="Starting a systemd service..." --time --weight=1
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
2017-06-02 16:44:37 +00:00
#=================================================
# RELOAD NGINX
#=================================================
2020-08-02 14:00:17 +00:00
ynh_script_progression --message="Reloading NGINX web server..." --time --weight=1
2017-06-02 16:44:37 +00:00
2019-04-18 17:58:47 +00:00
ynh_systemd_action --service_name=nginx --action=reload
2019-02-10 14:02:38 +00:00
#=================================================
# END OF SCRIPT
#=================================================
2019-04-18 17:58:47 +00:00
ynh_script_progression --message="Upgrade of $app completed" --time --last