mirror of
https://github.com/YunoHost-Apps/armadietto_ynh.git
synced 2024-09-03 18:06:18 +02:00
242 lines
9.2 KiB
Bash
242 lines
9.2 KiB
Bash
#!/bin/bash
|
|
|
|
#=================================================
|
|
# GENERIC START
|
|
#=================================================
|
|
# IMPORT GENERIC HELPERS
|
|
#=================================================
|
|
|
|
source _common.sh
|
|
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)
|
|
port=$(ynh_app_setting_get --app=$app --key=port)
|
|
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
|
datadir=$(ynh_app_setting_get --app=$app --key=datadir)
|
|
is_signup=$(ynh_app_setting_get --app=$app --key=signup)
|
|
|
|
#=================================================
|
|
# 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)..." --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 --action="stop" --log_path="/var/log/$app/$app.log"
|
|
|
|
#=================================================
|
|
# ENSURE DOWNWARD COMPATIBILITY
|
|
#=================================================
|
|
ynh_script_progression --message="Ensuring downward compatibility..." --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
|
|
|
|
#=================================================
|
|
# 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
|
|
|
|
#=================================================
|
|
# CHECK AND CREATE FINAL_PATH
|
|
#=================================================
|
|
ynh_script_progression --message="Setting up and create final app path..." --weight=1
|
|
|
|
ynh_app_setting_set $app final_path $final_path
|
|
# Download, check integrity, uncompress and patch the source from app.src
|
|
# ynh_setup_source --dest_dir="$final_path"
|
|
|
|
# Create final_path
|
|
mkdir -p "$final_path"
|
|
|
|
#=================================================
|
|
# UPGRADE DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading dependencies..." --weight=4
|
|
|
|
ynh_install_nodejs --nodejs_version=$NODEJS_VERSION
|
|
ynh_use_nodejs
|
|
|
|
#=================================================
|
|
# SPECIFIC UPGRADE
|
|
#=================================================
|
|
# ADD A CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Adding a configuration file..."
|
|
|
|
ynh_add_config --template="../conf/config.sample.yml" --destination="$final_path/config.yml"
|
|
|
|
chmod 400 "$final_path/config.yml"
|
|
chown $app:$app "$final_path/config.yml"
|
|
|
|
#=================================================
|
|
# DEFINE ARMADIETTO OPTIONS & CREATE DATA DIRECTORY
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring armadietto as a service..." --weight=1
|
|
|
|
# Define armadietto module path
|
|
modulepath="$node_version_path/$nodejs_version/lib/node_modules/armadietto/lib"
|
|
|
|
# Create app data folder
|
|
mkdir -p "$datadir"
|
|
|
|
# Using Armadietto as a service in a basic node server
|
|
cp -f ../conf/server.js "$final_path/server.js"
|
|
|
|
ynh_replace_string --match_string="__MODULE_PATH__" --replace_string="$modulepath" --target_file="$final_path/server.js"
|
|
ynh_replace_string --match_string="__DATADIR__" --replace_string="$datadir" --target_file="$final_path/server.js"
|
|
ynh_replace_string --match_string="__PORT__" --replace_string="$port" --target_file="$final_path/server.js"
|
|
ynh_replace_string --match_string="__DOMAIN__" --replace_string="$domain" --target_file="$final_path/server.js"
|
|
ynh_replace_string --match_string="__SIGNUP__" --replace_string="$is_signup" --target_file="$final_path/server.js"
|
|
|
|
#=================================================
|
|
# UPGRADE ARMADIETTO
|
|
#=================================================
|
|
if [ "$upgrade_type" == "UPGRADE_APP" ]
|
|
then
|
|
ynh_script_progression --message="Upgrade armadietto with npm..." --weight=1
|
|
|
|
pushd $final_path
|
|
ynh_npm -g i armadietto
|
|
popd
|
|
|
|
ynh_script_progression --message="Armadietto upgraded..."
|
|
fi
|
|
|
|
#=================================================
|
|
# UPDATE A CONFIG FILE
|
|
#=================================================
|
|
ynh_script_progression --message="Updating a configuration file..." --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..." --weight=1
|
|
|
|
# Create a dedicated systemd config
|
|
ynh_add_systemd_config
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SETUP LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring log rotation..." --weight=1
|
|
|
|
# Use logrotate to manage application logfile(s)
|
|
ynh_use_logrotate
|
|
|
|
#=================================================
|
|
# SECURE FILES AND DIRECTORIES
|
|
#=================================================
|
|
ynh_script_progression --message="Secure files and directories" --weight=1
|
|
|
|
# Set permissions to app files
|
|
chown -R $app:$app "$final_path"
|
|
chmod 0700 $datadir && chown $app:$app $datadir
|
|
|
|
#=================================================
|
|
# INTEGRATE SERVICE IN YUNOHOST
|
|
#=================================================
|
|
ynh_script_progression --message="Integrating service in YunoHost..." --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..." --weight=1
|
|
|
|
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
|
|
|
|
#=================================================
|
|
# RELOAD NGINX
|
|
#=================================================
|
|
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
|
|
|
|
ynh_systemd_action --service_name=nginx --action=reload
|
|
|
|
#=================================================
|
|
# RESTART ARMADIETTO
|
|
#=================================================
|
|
ynh_script_progression --message="Start armadietto web server..." --weight=1
|
|
|
|
# Start a systemd service
|
|
ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Upgrade of $app completed" --last
|