mirror of
https://github.com/YunoHost-Apps/mautrix_signal_ynh.git
synced 2024-09-03 19:46:07 +02:00
660cb690eb
* libolm-dev bullseye * remove extra_dep before upgrade * do not specify signald version * Add support for end-to-bridge encryption (#37) * avoid dev headers * Upgrade mautrix-signal to v0.3.0 (#47) * set user in signald group * request yunohost 11 Co-authored-by: nathanael-h <7300309+nathanael-h@users.noreply.github.com> Co-authored-by: Mayeul Cantan <mayeul.cantan@gmail.com> Co-authored-by: yunohost-bot <yunohost@yunohost.org>
226 lines
8.6 KiB
Bash
226 lines
8.6 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)
|
|
server_name=$(ynh_app_setting_get --app=$app --key=server_name)
|
|
port=$(ynh_app_setting_get --app=$app --key=port)
|
|
botname=$(ynh_app_setting_get --app=$app --key=botname)
|
|
synapse_instance=$(ynh_app_setting_get --app=$app --key=synapse_instance)
|
|
encryption=$(ynh_app_setting_get --app=$app --key=encryption)
|
|
botusers=$(ynh_app_setting_get --app=$app --key=botusers)
|
|
botadmin=$(ynh_app_setting_get --app=$app --key=botadmin)
|
|
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_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
|
|
|
|
mautrix_version=$(ynh_app_upstream_version)
|
|
signald_user="signald" # This is actually chosen by the signald dependency
|
|
|
|
#=================================================
|
|
# SET CONSTANTS
|
|
#=================================================
|
|
|
|
enable_relaybot=true
|
|
# https://docs.python.org/3.6/library/logging.html#logging-levels
|
|
log_level="INFO"
|
|
#log_format="$app.log"
|
|
|
|
synapse_db_name="matrix_$synapse_instance"
|
|
bot_synapse_db_user="@$botname:$server_name"
|
|
|
|
#=================================================
|
|
# CHECK VERSION
|
|
#=================================================
|
|
|
|
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"
|
|
|
|
#=================================================
|
|
# 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"
|
|
|
|
#=================================================
|
|
# ENSURE DOWNWARD COMPATIBILITY
|
|
#=================================================
|
|
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
|
|
|
|
# Upgrade from >0.2.0
|
|
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
|
|
db_pwd=$(ynh_app_setting_get --app=$app --key=db_pwd)
|
|
|
|
# Upgrade from <=0.2.0
|
|
if [ -z "$db_name" ]
|
|
then
|
|
db_name=$(ynh_app_setting_get --app=$app --key=$app)
|
|
ynh_app_setting_set --app=$app --key=db_name --value=$db_name
|
|
fi
|
|
if [ -z "$db_pwd" ]
|
|
then
|
|
db_pwd=$(ynh_app_setting_get --app=$app --key=mautrix_bridge_db_pwd)
|
|
ynh_app_setting_set --app=$app --key=db_pwd --value=$db_pwd
|
|
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
|
|
|
|
#=================================================
|
|
# 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"
|
|
chmod 750 $final_path
|
|
chown $app:$app $final_path
|
|
fi
|
|
|
|
#=================================================
|
|
# STORE THE CONFIG FILE CHECKSUM
|
|
#=================================================
|
|
### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script.
|
|
### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it.
|
|
ynh_backup_if_checksum_is_different --file="$final_path/config.yaml"
|
|
ynh_backup_if_checksum_is_different --file="/etc/matrix-$synapse_instance/app-service/$app.yaml"
|
|
|
|
#=================================================
|
|
# UPDATE CONFIGURATION
|
|
#=================================================
|
|
ynh_script_progression --message="Configuring Mautrix Bridge..." --weight=2
|
|
|
|
ynh_add_config --template="../conf/config.yaml" --destination="$final_path/config.yaml"
|
|
chmod -R 750 "$final_path"
|
|
chown -R $app:$app "$final_path"
|
|
|
|
#================================================
|
|
# SETUP SYSTEMD
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading systemd configuration..." --weight=4
|
|
|
|
# Create a dedicated systemd config
|
|
ynh_add_systemd_config
|
|
|
|
#=================================================
|
|
# UPGRADE MAUTRIX-BRIDGE PYTHON MODULE
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading python3 virtual environment" --weight=6
|
|
|
|
mkdir -p /var/log/$app
|
|
# Configure Mautrix-Bridge
|
|
python3 -m venv $final_path
|
|
export HOME=$final_path
|
|
$final_path/bin/pip3 install --upgrade pip setuptools wheel
|
|
|
|
ynh_script_progression --message="Installing with pip" --weight=6
|
|
|
|
# Pre-compiled python-olm to avoid libolm-dev, python3-dev -> does not work for arm
|
|
#$final_path/bin/pip3 install --upgrade python-olm --extra-index-url https://gitlab.matrix.org/api/v4/projects/27/packages/pypi/simple
|
|
# Build with libolm3 end-to-bridge encryption
|
|
$final_path/bin/pip3 install --upgrade $final_path/src/mautrix-signal.tar.gz[metrics,e2be,formattednumbers,qrlink,stickers]
|
|
|
|
#=================================================
|
|
# REGISTER SYNAPSE APP-SERVICE
|
|
#=================================================
|
|
$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"
|
|
|
|
#=================================================
|
|
# STORE THE CONFIG FILE CHECKSUM
|
|
#=================================================
|
|
|
|
# Recalculate and store the checksum of the file for the next upgrade.
|
|
ynh_store_file_checksum --file="$final_path/config.yaml"
|
|
ynh_store_file_checksum --file="/etc/matrix-$synapse_instance/app-service/$app.yaml"
|
|
|
|
#=================================================
|
|
# GENERIC FINALIZATION
|
|
#=================================================
|
|
# SETUP LOGROTATE
|
|
#=================================================
|
|
ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1
|
|
|
|
# Use logrotate to manage application logfile(s)
|
|
ynh_use_logrotate
|
|
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="Bridging Signal and Matrix messages" --log="/var/log/$app/$app.log"
|
|
|
|
#=================================================
|
|
# START SYSTEMD SERVICE
|
|
#=================================================
|
|
ynh_script_progression --message="Starting a systemd service..." --weight=1
|
|
|
|
sleep 2
|
|
chown -R $app:$app "$final_path"
|
|
ynh_systemd_action --service_name=$app --action="start"
|
|
|
|
#=================================================
|
|
# END OF SCRIPT
|
|
#=================================================
|
|
|
|
ynh_script_progression --message="Upgrade of $app completed" --last
|