# #!/bin/bash # See # https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update # #================================================= # # GENERIC START # #================================================= # # IMPORT GENERIC HELPERS # #================================================= # source _common.sh # source /usr/share/yunohost/helpers # #================================================= # # LOAD SETTINGS # #================================================= # ynh_script_progression --message="Loading installation settings..." --time --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) # admin=$(ynh_app_setting_get --app=$app --key=admin) # 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) # #================================================= # # 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) # #================================================= # # 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" # #================================================= # # ENSURE DOWNWARD COMPATIBILITY # #================================================= # ynh_script_progression --message="Ensuring downward compatibility..." --time --weight=1 # # # # 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) # # # # 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 # # 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 # ### If nobody installed your app before 4.1, # ### then you may safely remove these lines # # Cleaning legacy permissions # 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 # # 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 # ynh_permission_create --permission="api" --url="/api" --allowed="visitors" --show_tile="false" --protected="true" # 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" # #================================================= # # DOWNLOAD, CHECK AND UNPACK SOURCE # #================================================= # 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 # ynh_setup_source --dest_dir="$final_path" # fi # # 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" # chown -R $app:www-data "$final_path" # #================================================= # # NGINX CONFIGURATION # #================================================= # ynh_script_progression --message="Upgrading NGINX web server configuration..." --time --weight=1 # # Create a dedicated NGINX config # ynh_add_nginx_config # #================================================= # # UPGRADE DEPENDENCIES # #================================================= # ynh_script_progression --message="Upgrading dependencies..." --time --weight=1 # ynh_install_app_dependencies $pkg_dependencies # #================================================= # # PHP-FPM CONFIGURATION # #================================================= # ynh_script_progression --message="Upgrading PHP-FPM configuration..." --time --weight=1 # # Create a dedicated PHP-FPM config # ynh_add_fpm_config # #================================================= # # SPECIFIC UPGRADE # #================================================= # # ... # #================================================= # #================================================= # # UPDATE A CONFIG FILE # #================================================= # ynh_script_progression --message="Updating a configuration file..." --time --weight=1 # ### Same as during install # ### # ### The file will automatically be backed-up if it's found to be manually modified (because # ### ynh_add_config keeps track of the file's checksum) # ynh_add_config --template="some_config_file" --destination="$final_path/some_config_file" # # FIXME: this should be handled by the core in the future # # You may need to use chmod 600 instead of 400, # # for example if the app is expected to be able to modify its own config # chmod 400 "$final_path/some_config_file" # chown $app:$app "$final_path/some_config_file" # ### 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" # #================================================= # # SETUP SYSTEMD # #================================================= # ynh_script_progression --message="Upgrading systemd configuration..." --time --weight=1 # # Create a dedicated systemd config # ynh_add_systemd_config # #================================================= # # GENERIC FINALIZATION # #================================================= # # SETUP LOGROTATE # #================================================= # ynh_script_progression --message="Upgrading logrotate configuration..." --time --weight=1 # # Use logrotate to manage app-specific logfile(s) # ynh_use_logrotate --non-append # #================================================= # # INTEGRATE SERVICE IN YUNOHOST # #================================================= # ynh_script_progression --message="Integrating service in YunoHost..." --time --weight=1 # yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log" # #================================================= # # 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" # #================================================= # # UPGRADE FAIL2BAN # #================================================= # ynh_script_progression --message="Reconfiguring Fail2Ban..." --time --weight=1 # # Create a dedicated Fail2Ban config # ynh_add_fail2ban_config --logpath="/var/log/nginx/${domain}-error.log" --failregex="Regex to match into the log for a failed login" # #================================================= # # RELOAD NGINX # #================================================= # ynh_script_progression --message="Reloading NGINX web server..." --time --weight=1 # ynh_systemd_action --service_name=nginx --action=reload # #================================================= # # END OF SCRIPT # #================================================= # ynh_script_progression --message="Upgrade of $app completed" --time --last