chibisafe_ynh/scripts/upgrade

116 lines
4.6 KiB
Text
Raw Normal View History

2014-10-20 12:55:53 -04:00
#!/bin/bash
2017-06-02 12:44:37 -04:00
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
2017-06-05 07:06:35 -04:00
source _common.sh
2017-06-02 12:44:37 -04:00
source /usr/share/yunohost/helpers
### Settings are automatically loaded as bash variables
### in every app script context, therefore typically these will exist:
### - $domain
### - $path
### - $language
### - $install_dir
### - $port
### ...
### In the context of upgrade,
### - resources are automatically provisioned / updated / deleted (depending on existing resources)
### - a safety backup is automatically created by the core and will be restored if the upgrade fails
2019-04-18 13:58:47 -04:00
#=================================================
# STOP SYSTEMD SERVICE
#=================================================
2024-06-20 17:49:43 -04:00
ynh_script_progression "Stopping $app's systemd service..."
2024-06-20 17:49:43 -04:00
ynh_systemctl --service="$app" --action="stop"
2017-06-02 12:44:37 -04:00
#=================================================
2017-06-17 12:02:28 -04:00
# ENSURE DOWNWARD COMPATIBILITY
2017-06-02 12:44:37 -04:00
#=================================================
2024-06-20 17:49:43 -04:00
#ynh_script_progression "Ensuring downward compatibility..."
2017-06-02 12:44:37 -04:00
### N.B. : the following setting migration 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 17:55:51 -04:00
# If db_name doesn't exist, create it
2024-09-03 08:11:28 -04:00
# ynh_app_setting_set_default --key=db_name --value="$(ynh_sanitize_dbid --db_name=$app)"
2017-06-02 12:44:37 -04:00
# If install_dir doesn't exist, create it
2024-09-03 08:11:28 -04:00
# ynh_app_setting_set_default --key=install_dir --value="/var/www/$app"
2017-08-28 17:55:51 -04:00
2017-06-02 12:44:37 -04:00
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
2024-06-20 17:49:43 -04:00
ynh_script_progression "Upgrading source files..."
2019-04-18 13:58:47 -04:00
### ynh_setup_source can wipe the destination dir if called with --full_replace.
### On upgrade, that is certainly what you want, to remove any old source file that
### does not exist in the new version of the software.
### You can list with --keep every file/directory to *not* wipe or overwrite,
### useful for configuration files, data directories, or plugins.
# Download, check integrity, uncompress and patch the source from manifest.toml
ynh_setup_source --dest_dir="$install_dir" --full_replace --keep=".env data"
2017-06-02 12:44:37 -04:00
### $install_dir will automatically be initialized with some decent
2024-09-03 07:55:06 -04:00
### permissions by default... however, you may need to recursively reapply
### ownership to all files such as after the ynh_setup_source step
2023-12-29 21:02:42 -05:00
chown -R "$app:www-data" "$install_dir"
#=================================================
2021-03-12 10:41:18 -05:00
# UPDATE A CONFIG FILE
#=================================================
2024-06-20 17:49:43 -04:00
ynh_script_progression "Updating $app's configuration files..."
2021-03-12 10:41:18 -05:00
### Same as during install
###
### The file will automatically be backed-up if it's found to be manually modified (because
2024-06-20 17:49:43 -04:00
### ynh_config_add keeps track of the file's checksum)
2024-11-07 04:33:47 -05:00
ynh_config_add --template="run.sh" --destination="$install_dir/run.sh"
# 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
2024-11-07 04:33:47 -05:00
chmod +x "$install_dir/run.sh"
chmod 400 "$install_dir/run.sh"
chown "$app:$app" "$install_dir/run.sh"
2021-03-12 10:41:18 -05:00
### For more complex cases where you want to replace stuff using regexes,
2024-06-20 17:49:43 -04:00
### you shoud rely on ynh_replace (which is basically a wrapper for sed)
2021-03-12 10:41:18 -05:00
### When doing so, you also need to manually call ynh_store_file_checksum
###
2024-06-20 17:49:43 -04:00
### ynh_replace --match="match_string" --replace="replace_string" --file="$install_dir/some_config_file"
### ynh_store_file_checksum "$install_dir/some_config_file"
2017-06-02 12:44:37 -04:00
#=================================================
# REAPPLY SYSTEM CONFIGURATIONS
#=================================================
2024-06-20 17:49:43 -04:00
ynh_script_progression "Upgrading system configurations related to $app..."
### This should be a literal copypaste of what happened in the install's "System configuration" section
2024-06-20 17:49:43 -04:00
ynh_config_add_nginx
2024-06-20 17:49:43 -04:00
ynh_config_add_systemd
2024-11-07 04:33:47 -05:00
yunohost service add "$app" --description="A modern and self-hosted take on file uploading services that can handle anything you throw at it thanks to it's robust and fast API, chunked uploads support and more." --log="/var/log/$app/$app.log"
2024-06-20 17:49:43 -04:00
ynh_config_add_logrotate
2019-05-02 14:44:22 -04:00
#=================================================
# START SYSTEMD SERVICE
#=================================================
2024-06-20 17:49:43 -04:00
ynh_script_progression "Starting $app's systemd service..."
2019-05-02 14:44:22 -04:00
2024-06-20 17:49:43 -04:00
ynh_systemctl --service="$app" --action="start"
2019-05-02 14:44:22 -04:00
2019-02-10 09:02:38 -05:00
#=================================================
# END OF SCRIPT
#=================================================
2024-06-20 17:49:43 -04:00
ynh_script_progression "Upgrade of $app completed"