mirror of
https://github.com/YunoHost-Apps/mautrix_signal_ynh.git
synced 2024-09-03 19:46:07 +02:00
275 lines
10 KiB
Bash
275 lines
10 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
|
|
|
|
botname=$(ynh_app_setting_get --app=$app --key=botname)
|
|
encryption=$(ynh_app_setting_get --app=$app --key=encryption)
|
|
botadmin=$(ynh_app_setting_get --app=$app --key=botadmin)
|
|
botusers=$(ynh_app_setting_get --app=$app --key=botusers)
|
|
domain=$(ynh_app_setting_get --app=$app --key=domain)
|
|
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
|
|
previous_mautrix_version=$(ynh_app_setting_get --app=$app --key=mautrix_version)
|
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
|
db_user=$db_name
|
|
db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd)
|
|
port=$(ynh_app_setting_get --app=$app --key=port)
|
|
synapse_instance=$(ynh_app_setting_get --app=$app --key=synapse_instance)
|
|
server_name=$(ynh_app_setting_get --app=$app --key=server_name)
|
|
mautrix_version=$(ynh_app_upstream_version)
|
|
synapse_db_name="matrix_$synapse_instance"
|
|
signald_user="signald" # This is actually chosen by the signald dependency
|
|
enable_relaybot=true
|
|
|
|
#=================================================
|
|
# GET CONFIG PANEL SETTINGS
|
|
#=================================================
|
|
appserviceid=$(ynh_app_setting_get --app=$app --key=appserviceid)
|
|
displayname=$(ynh_app_setting_get --app=$app --key=displayname)
|
|
avatar=$(ynh_app_setting_get --app=$avatar --key=avatar)
|
|
ephemeral_events=$(ynh_app_setting_get --app=$app --key=ephemeral_events)
|
|
enable_metrics=$(ynh_app_setting_get --app=$app --key=enable_metrics)
|
|
metrics_listen_port=$(ynh_app_setting_get --app=$app --key=metrics_listen_port)
|
|
registration_enabled=$(ynh_app_setting_get --app=$app --key=registration_enabled)
|
|
enable_disappearing_messages_in_groups=$(ynh_app_setting_get --app=$app --key=enable_disappearing_messages_in_groups)
|
|
username_template=$(ynh_app_setting_get --app=$app --key=username_template)
|
|
contact_list_names=$(ynh_app_setting_get --app=$app --key=contact_list_names)
|
|
federate_rooms=$(ynh_app_setting_get --app=$app --key=federate_rooms)
|
|
encryption_default=$(ynh_app_setting_get --app=$app --key=encryption_default)
|
|
print_level=$(ynh_app_setting_get --app=$app --key=print_level)
|
|
|
|
|
|
#=================================================
|
|
# CHECK VERSION
|
|
#=================================================
|
|
ynh_script_progression --message="Checking version..." --weight=1
|
|
|
|
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=5
|
|
|
|
# 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
|
|
|
|
# SET STANDARD SETTINGS FROM DEFAULT CONFIG
|
|
|
|
if [ -z "$appserviceid" ]
|
|
then
|
|
appserviceid=$botname
|
|
ynh_app_setting_set --app=$app --key=appserviceid --value=$appserviceid
|
|
fi
|
|
if [ -z "$displayname" ]
|
|
then
|
|
displayname="Signal bridge bot"
|
|
ynh_app_setting_set --app=$app --key=displayname --value=$displayname
|
|
fi
|
|
|
|
if [ -z "$avatar" ]
|
|
then
|
|
avatar="mxc://maunium.net/wPJgTQbZOtpBFmDNkiNEMDUp"
|
|
ynh_app_setting_set --app=$app --key=avatar --value=$avatar
|
|
fi
|
|
|
|
if [ -z "$enable_metrics" ]
|
|
then
|
|
enable_metrics=false
|
|
ynh_app_setting_set --app=$app --key=enable_metrics --value=$enable_metrics
|
|
fi
|
|
|
|
if [ -z "$metrics_listen_port" ]
|
|
then
|
|
metrics_listen_port=8000
|
|
ynh_app_setting_set --app=$app --key=metrics_listen_port --value=$metrics_listen_port
|
|
fi
|
|
|
|
if [ -z "$registration_enabled" ]
|
|
then
|
|
registration_enabled=true
|
|
ynh_app_setting_set --app=$app --key=registration_enabled --value=$registration_enabled
|
|
fi
|
|
|
|
if [ -z "$enable_disappearing_messages_in_groups" ]
|
|
then
|
|
enable_disappearing_messages_in_groups=false
|
|
ynh_app_setting_set --app=$app --key=enable_disappearing_messages_in_groups --value=$enable_disappearing_messages_in_groups
|
|
fi
|
|
|
|
if [ -z "$username_template" ]
|
|
then
|
|
username_template="sg_{userid}"
|
|
ynh_app_setting_set --app=$app --key=username_template --value=$username_template
|
|
fi
|
|
|
|
if [ -z "$contact_list_names" ]
|
|
then
|
|
contact_list_names=disallow
|
|
ynh_app_setting_set --app=$app --key=contact_list_names --value=$contact_list_names
|
|
fi
|
|
|
|
if [ -z "$federate_rooms" ]
|
|
then
|
|
federate_rooms=true
|
|
ynh_app_setting_set --app=$app --key=federate_rooms --value=$federate_rooms
|
|
fi
|
|
|
|
if [ -z "$encryption_default" ]
|
|
then
|
|
encryption_default=false
|
|
ynh_app_setting_set --app=$app --key=encryption_default --value=$encryption_default
|
|
fi
|
|
|
|
if [ -z "$print_level" ]
|
|
then
|
|
print_level=INFO
|
|
ynh_app_setting_set --app=$app --key=print_level --value=$print_level
|
|
fi
|
|
|
|
# Fix possible permission issues with a previous signald version, esp. with stickers
|
|
mkdir -p /var/lib/signald/{avatars,attachments,stickers}
|
|
chown $signald_user:$signald_user /var/lib/signald/{avatars,attachments,stickers}
|
|
chmod -R g+rwX /var/lib/signald/{avatars,attachments,stickers}
|
|
|
|
#=================================================
|
|
# 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" --groups="$signald_user"
|
|
|
|
#=================================================
|
|
# DOWNLOAD, CHECK AND UNPACK SOURCE
|
|
#=================================================
|
|
|
|
if [ "$upgrade_type" == "UPGRADE_APP" ]
|
|
then
|
|
ynh_script_progression --message="Upgrading source files..." --weight=1
|
|
|
|
# Download, check integrity, uncompress and patch the source from app.src
|
|
ynh_setup_source --dest_dir="$final_path/src"
|
|
fi
|
|
|
|
chmod 750 "$final_path"
|
|
chmod -R o-rwx "$final_path"
|
|
chown -R $app:$app "$final_path"
|
|
|
|
#=================================================
|
|
# UPGRADE DEPENDENCIES
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading dependencies..." --weight=5
|
|
|
|
ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies
|
|
ynh_install_extra_app_dependencies --repo="https://updates.signald.org unstable main" --package="$extra_dependencies" --key="https://updates.signald.org/apt-signing-key.asc"
|
|
|
|
#=================================================
|
|
# SPECIFIC UPGRADE
|
|
#=================================================
|
|
# UPDATE A CONFIG FILE
|
|
#=================================================
|
|
ynh_script_progression --message="Updating a configuration file..." --weight=2
|
|
|
|
ynh_add_config --template="../conf/config.yaml" --destination="$final_path/config.yaml"
|
|
|
|
chmod 400 "$final_path/config.yaml"
|
|
chown $app:$app "$final_path/config.yaml"
|
|
|
|
#=================================================
|
|
# UPGRADE MAUTRIX-BRIDGE PYTHON MODULE
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading Mautrix-Bridge Python Module..." --weight=2
|
|
|
|
python3 -m venv $final_path
|
|
export HOME=$final_path
|
|
$final_path/bin/pip3 install --upgrade pip setuptools wheel
|
|
$final_path/bin/pip3 install --upgrade $final_path/src/mautrix-signal.tar.gz[metrics,e2be,formattednumbers,qrlink,stickers]
|
|
|
|
#=================================================
|
|
# REGISTER SYNAPSE APP-SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Registering Synapse app-service" --weight=1
|
|
|
|
$final_path/bin/python3 -m mautrix_signal -g -c $final_path/config.yaml -r /etc/matrix-$synapse_instance/app-service/$app.yaml
|
|
/opt/yunohost/matrix-$synapse_instance/update_synapse_for_appservice.sh || ynh_die "Synapse can't restart with the appservice configuration"
|
|
|
|
# Set permissions on app files
|
|
chown -R $app:$app "$final_path"
|
|
ynh_store_file_checksum --file="/etc/matrix-$synapse_instance/app-service/$app.yaml"
|
|
ynh_store_file_checksum --file="$final_path/config.yaml"
|
|
|
|
#=================================================
|
|
# SETUP SYSTEMD
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading systemd configuration..." --weight=4
|
|
|
|
# Create a dedicated systemd config
|
|
ynh_add_systemd_config
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SETUP LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1
|
|
|
|
# Use logrotate to manage app-specific logfile(s)
|
|
ynh_use_logrotate --nonappend
|
|
chmod -R 600 "/var/log/$app"
|
|
chmod 700 "/var/log/$app"
|
|
chown -R $app:$app /var/log/$app
|
|
|
|
#=================================================
|
|
# INTEGRATE SERVICE IN YUNOHOST
|
|
#=================================================
|
|
ynh_script_progression --message="Integrating service in YunoHost..." --weight=1
|
|
|
|
yunohost service add $app --description="$app daemon for bridging Signal and Matrix messages" --log="/var/log/$app/$app.log"
|
|
|
|
#=================================================
|
|
# START SYSTEMD SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Starting a systemd service..." --weight=1
|
|
|
|
# Start a systemd service
|
|
ynh_systemd_action --service_name=$app --action="start"
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Upgrade of $app completed" --last
|