From b039aa2608c3cfd678422dd773e3810e32299c40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Sun, 7 Jan 2024 20:58:17 +0100 Subject: [PATCH 1/6] Manifestv2 --- check_process | 28 ---------- conf/app.src | 5 -- conf/endpoint.nginx.conf | 16 +++--- conf/nginx.conf | 11 ++-- manifest.json | 56 -------------------- manifest.toml | 59 +++++++++++++++++++++ scripts/backup | 21 +------- scripts/change_url | 92 ++------------------------------- scripts/install | 86 +++---------------------------- scripts/remove | 51 ++----------------- scripts/restore | 54 ++++---------------- scripts/upgrade | 107 +++++++++------------------------------ tests.toml | 15 ++++++ 13 files changed, 138 insertions(+), 463 deletions(-) delete mode 100644 check_process delete mode 100644 conf/app.src delete mode 100644 manifest.json create mode 100644 manifest.toml create mode 100644 tests.toml diff --git a/check_process b/check_process deleted file mode 100644 index 3637847..0000000 --- a/check_process +++ /dev/null @@ -1,28 +0,0 @@ -;; Test complet - ; pre-install - sudo yunohost tools update apps - sudo yunohost app install https://github.com/YunoHost-Apps/synapse_ynh/tree/1c36215f03e5bc1b4c22ec42f93e6188f73a9f36 -a "domain=sub.domain.tld&server_name=$server_name&is_free_registration=$is_free_registration&jitsi_server=$jitsi_server" --force - ; Manifest - domain="domain.tld" - synapse_app="synapse" - synapse_domain="sub.domain.tld" - is_public=1 - ; Checks - pkg_linter=1 - setup_sub_dir=0 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - upgrade=1 from_commit=4eaa242f11e8e9c6ed7afbb7cdf07fd95f8d04a1 - backup_restore=1 - multi_instance=0 - change_url=1 -;;; Options -Email= -Notification=none -;;; Upgrade options - ; commit=4eaa242f11e8e9c6ed7afbb7cdf07fd95f8d04a1 - name=Upgrade from 0.8.5~ynh5 and remove app build - manifest_arg=domain=DOMAIN&synapse_app=synapse&synapse_domain=sub.domain.tld& diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index 6ade810..0000000 --- a/conf/app.src +++ /dev/null @@ -1,5 +0,0 @@ -SOURCE_URL=https://github.com/Awesome-Technologies/synapse-admin/releases/download/0.8.7/synapse-admin-0.8.7-dirty.tar.gz -SOURCE_SUM=3f74cbfec0a3b14b5684d1bded4816a7946d2e9b88b7186767189c14811224e9 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true \ No newline at end of file diff --git a/conf/endpoint.nginx.conf b/conf/endpoint.nginx.conf index c034595..4dd3d0d 100644 --- a/conf/endpoint.nginx.conf +++ b/conf/endpoint.nginx.conf @@ -1,13 +1,13 @@ location /_synapse/admin { - proxy_pass http://127.0.0.1:__SYNAPSE_PORT__; - proxy_set_header X-Forwarded-For $remote_addr; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header Host $host; + proxy_pass http://127.0.0.1:__SYNAPSE_PORT__; + proxy_set_header X-Forwarded-For $remote_addr; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header Host $host; - client_max_body_size 100M; + client_max_body_size 100M; - proxy_http_version 1.1; - - more_set_headers "Access-Control-Allow-Origin: https://__DOMAIN__"; + proxy_http_version 1.1; + + more_set_headers "Access-Control-Allow-Origin: https://__DOMAIN__"; } diff --git a/conf/nginx.conf b/conf/nginx.conf index 0ac62b9..4e95090 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,11 +1,10 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; location __PATH__/ { + alias __INSTALL_DIR__/; - alias __FINAL_PATH__/; + index index.html; + try_files $uri $uri/ /index.html; - index index.html; - try_files $uri $uri/ /index.html; - - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; } diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 44c8d4d..0000000 --- a/manifest.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "name": "Synapse Admin", - "id": "synapse-admin", - "packaging_format": 1, - "description": { - "en": "Admin UI for Synapse", - "fr": "Admin UI pour Synapse" - }, - "version": "0.8.7~ynh2", - "url": "https://github.com/Awesome-Technologies/synapse-admin", - "upstream": { - "license": "Apache-2.0", - "code": "https://github.com/Awesome-Technologies/synapse-admin" - }, - "license": "Apache-2.0", - "maintainer": { - "name": "" - }, - "requirements": { - "yunohost": ">= 11.2" - }, - "multi_instance": false, - "services": [ - "nginx" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "synapse_app", - "type": "string", - "ask": { - "en": "Input the Synapse app ID you wish to connect to.", - "fr": "Entrez l'ID de l'app Synapse à laquelle vous souhaitez vous connecter." - }, - "help": { - "en": "Leave the default value if you have only one Synapse server installed.", - "fr": "Laissez la valeur par défaut si vous n'avez installé qu'un seul serveur Synapse." - }, - "default": "synapse" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "If enabled, Synapse Admin will be accessible by people who do not have an account. This can be changed later via the webadmin.", - "fr": "Si cette case est cochée, Synapse Admin sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." - }, - "default": true - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..94fdeba --- /dev/null +++ b/manifest.toml @@ -0,0 +1,59 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "synapse-admin" +name = "Synapse Admin" +description.en = "Admin UI for Synapse" +description.fr = "Admin UI pour Synapse" + +version = "0.8.7~ynh3" + +maintainers = [] + +[upstream] +license = "Apache-2.0" +code = "https://github.com/Awesome-Technologies/synapse-admin" + +[integration] +yunohost = ">= 11.2" +architectures = "all" +multi_instance = false +ldap = true +sso = true +disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ... +ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... +ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ... + +[install] + [install.domain] + type = "domain" + + [install.synapse_app] + ask.en = "Input the Synapse app ID you wish to connect to." + ask.fr = "Entrez l'ID de l'app Synapse à laquelle vous souhaitez vous connecter." + help.en = "Leave the default value if you have only one Synapse server installed." + help.fr = "Laissez la valeur par défaut si vous n'avez installé qu'un seul serveur Synapse." + type = "app" + default = "synapse" + + [install.init_main_permission] + help.en = "If enabled, Synapse Admin will be accessible by people who do not have an account. This can be changed later via the webadmin." + help.fr = "Si cette case est cochée, Synapse Admin sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." + type = "group" + default = "visitors" + +[resources] + [resources.sources.main] + url = "https://github.com/Awesome-Technologies/synapse-admin/releases/download/0.8.7/synapse-admin-0.8.7-dirty.tar.gz" + sha256 = "3f74cbfec0a3b14b5684d1bded4816a7946d2e9b88b7186767189c14811224e9" + + autoupdate.strategy = "latest_github_release" + autoupdate.asset = "synapse-admin-.*.tar.gz" + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" diff --git a/scripts/backup b/scripts/backup index 8fd8f89..1b290e6 100644 --- a/scripts/backup +++ b/scripts/backup @@ -9,25 +9,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -synapse_app=$(ynh_app_setting_get --app=$app --key=synapse_app) -synapse_domain=$(ynh_app_setting_get --app=$app --key=synapse_domain) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -37,7 +18,7 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index 3ac2903..beaae0c 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,98 +9,16 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up $app before changing its URL (may take a while)..." --weight=1 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. - ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - -#================================================= -# STANDARD MODIFICATIONS #================================================= # MODIFY URL IN NGINX CONF #================================================= -ynh_script_progression --message="Updating Nginx web server configuration..." --weight=1 +ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf +ynh_change_url_nginx_config -# Change the path in the nginx config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original nginx config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for nginx helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated nginx config - ynh_add_nginx_config -fi - -# Change the domain for nginx -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location - ynh_delete_file_checksum --file="$nginx_conf_path" - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location - ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi - -#================================================= -# GENERIC FINALISATION -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +synapse_domain=$(ynh_app_setting_get --app=$synapse_app --key=domain) +synapse_port=$(ynh_app_setting_get --app=$synapse_app --key=synapse_port) +ynh_add_config --template="endpoint.nginx.conf" --destination="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index 0fe4e0a..92c0723 100644 --- a/scripts/install +++ b/scripts/install @@ -9,102 +9,30 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -domain=$YNH_APP_ARG_DOMAIN -path_url="/" -is_public=$YNH_APP_ARG_IS_PUBLIC -synapse_app=$YNH_APP_ARG_SYNAPSE_APP -synapse_domain=$(ynh_app_setting_get --app=$synapse_app --key=domain) -synapse_port=$(ynh_app_setting_get --app=$synapse_app --key=synapse_port) - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -ynh_script_progression --message="Storing installation settings..." --weight=2 - -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url -ynh_app_setting_set --app=$app --key=synapse_app --value=$synapse_app -ynh_app_setting_set --app=$app --key=synapse_domain --value=$synapse_domain -ynh_app_setting_set --app=$app --key=synapse_port --value=$synapse_port - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=3 - -# Create a system user -ynh_system_user_create --username=$app --home_dir=$final_path - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=2 -ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir=$final_path +ynh_setup_source --dest_dir=$install_dir -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= -# NGINX CONFIGURATION +# SYSTEM CONFIGURATION #================================================= -ynh_script_progression --message="Configuring NGINX web server..." --weight=2 +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 # Create a dedicated NGINX config ynh_add_nginx_config # Create NGINX config to access /_synapse/admin endpoint +synapse_domain=$(ynh_app_setting_get --app=$synapse_app --key=domain) +synapse_port=$(ynh_app_setting_get --app=$synapse_app --key=synapse_port) ynh_add_config --template="endpoint.nginx.conf" --destination="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" -#================================================= -# SPECIFIC SETUP -#============================================== -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary or protect it -if [ $is_public -eq 1 ] -then - ynh_permission_update --permission="main" --add="visitors" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=2 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index 7aae0d6..1e11c2e 100644 --- a/scripts/remove +++ b/scripts/remove @@ -10,58 +10,15 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS +# REMOVE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -synapse_app=$(ynh_app_setting_get --app=$app --key=synapse_app) -synapse_domain=$(ynh_app_setting_get --app=$synapse_app --key=domain) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE SERVICE INTEGRATION IN YUNOHOST -#================================================= - -# Remove the service from the list of services known by Yunohost (added from `yunohost service add`) -if ynh_exec_warn_less yunohost service status $app >/dev/null -then - ynh_script_progression --message="Removing $app service..." --weight=1 - yunohost service remove $app -fi - -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=6 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - -#================================================= -# REMOVE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." --weight=5 - -# Remove NGINX config that enabled /_synapse/admin endpoint -ynh_secure_remove --file="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app +# Remove NGINX config that enabled /_synapse/admin endpoint +ynh_secure_remove --file="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 7c7ec30..ef97584 100644 --- a/scripts/restore +++ b/scripts/restore @@ -10,60 +10,24 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# RESTORE THE APP MAIN DIR #================================================= +ynh_script_progression --message="Restoring the app main directory..." --weight=1 + +ynh_restore_file --origin_path="$install_dir" + +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors #================================================= -# LOAD SETTINGS +# RESTORE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Loading settings..." --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) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -synapse_domain=$(ynh_app_setting_get --app=$app --key=synapse_domain) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=2 - -test ! -d $final_path || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX configuration..." +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" ynh_restore_file --origin_path="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - -#================================================= -# RESTORE THE APP MAIN DIR -#================================================= -ynh_script_progression --message="Restoring the app main directory..." --weight=60 - -ynh_restore_file --origin_path="$final_path" - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - #================================================= # GENERIC FINALIZATION #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index bfd2104..39acb5b 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,123 +9,66 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=2 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -port=$(ynh_app_setting_get --app=$app --key=port) -synapse_app=$(ynh_app_setting_get --app=$app --key=synapse_app) - -#================================================= -# CHECK VERSION -#================================================= - upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up $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 - #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -if ynh_compare_current_package_version --comparison le --version 0.8.3~ynh2 -then - ynh_die --message="Upgrade from version 0.8.3 is not possible. You must uninstall and reinstall Synapse-admin package manually" -fi -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public +if ynh_compare_current_package_version --comparison le --version 0.8.3~ynh2; then + ynh_die --message="Upgrade from version 0.8.3 is not possible. You must uninstall and reinstall Synapse-admin package manually" fi # If synapse_app doesn't exist, create it and assume it is `synapse` if [ -z "$synapse_app" ]; then - synapse_app="synapse" - ynh_app_setting_set --app=$app --key=synapse_app --value=$synapse_app + synapse_app="synapse" + ynh_app_setting_set --app=$app --key=synapse_app --value=$synapse_app fi # Delete service and nodejs dependencies -if ynh_compare_current_package_version --comparison lt --version 0.8.7~ynh1 -then - ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" - yunohost service remove $app - ynh_remove_nodejs - ynh_remove_logrotate - ynh_remove_app_dependencies +if ynh_compare_current_package_version --comparison lt --version 0.8.7~ynh1; then + yunohost service remove $app + ynh_remove_systemd_config - ynh_app_setting_delete --app=$app --key=synapse_port - ynh_app_setting_delete --app=$app --key=port + ynh_remove_nodejs + ynh_remove_logrotate + + ynh_app_setting_delete --app=$app --key=synapse_port + ynh_app_setting_delete --app=$app --key=port fi -# Reload and store Synapse's settings, in case of they changed -synapse_domain=$(ynh_app_setting_get --app=$synapse_app --key=domain) -synapse_port=$(ynh_app_setting_get --app=$synapse_app --key=synapse_port) -ynh_app_setting_set --app=$app --key=synapse_domain --value=$synapse_domain -ynh_app_setting_set --app=$app --key=synapse_port --value=$synapse_port - -#================================================= -# STANDARD UPGRADE STEPS -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" +if ynh_compare_current_package_version --comparison lt --version 0.8.7~ynh3; then + ynh_app_setting_delete --app=$app --key=synapse_domain + ynh_app_setting_delete --app=$app --key=synapse_port +fi #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." --weight=2 +if [ "$upgrade_type" == "UPGRADE_APP" ]; then + ynh_script_progression --message="Upgrading source files..." --weight=2 - ynh_setup_source --dest_dir="$final_path" + ynh_setup_source --dest_dir="$install_dir" fi -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= -# NGINX CONFIGURATION +# REAPPLY SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1 +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 # Create a dedicated nginx config ynh_add_nginx_config # Create NGINX config to access /_synapse/admin endpoint +synapse_domain=$(ynh_app_setting_get --app=$synapse_app --key=domain) +synapse_port=$(ynh_app_setting_get --app=$synapse_app --key=synapse_port) ynh_add_config --template="endpoint.nginx.conf" --destination="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..abc6f9c --- /dev/null +++ b/tests.toml @@ -0,0 +1,15 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + preinstall = """ + sudo yunohost tools update apps + sudo yunohost app install \ + https://github.com/YunoHost-Apps/synapse_ynh/tree/1c36215f03e5bc1b4c22ec42f93e6188f73a9f36 \ + -a "domain=sub.domain.tld&server_name=$server_name&is_free_registration=$is_free_registration&jitsi_server=$jitsi_server" \ + --force + """ + + test_upgrade_from.4eaa242f.name = "Upgrade from 0.8.5~ynh5 and remove app build" From 587fd9a45bf399baf7d13ff14522de43b5e4c435 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 7 Jan 2024 19:58:22 +0000 Subject: [PATCH 2/6] Auto-update README --- README.md | 2 +- README_fr.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9a473d9..8a1dac2 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Admin UI for Synapse -**Shipped version:** 0.8.7~ynh2 +**Shipped version:** 0.8.7~ynh3 ## Screenshots diff --git a/README_fr.md b/README_fr.md index e953c36..4fc9e5c 100644 --- a/README_fr.md +++ b/README_fr.md @@ -18,7 +18,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po Admin UI pour Synapse -**Version incluse :** 0.8.7~ynh2 +**Version incluse :** 0.8.7~ynh3 ## Captures d’écran From 0784dd0f377dd7c39770bb2e39535d02a7d136a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Sun, 7 Jan 2024 21:01:19 +0100 Subject: [PATCH 3/6] add doc/description --- doc/DESCRIPTION.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/DESCRIPTION.md diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..c4965f7 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1 @@ +And admin UI for Matrix Synapse homeserver. From b5d596d2ea43f726d54bc74f49d73100d7bf7b6f Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 7 Jan 2024 20:01:24 +0000 Subject: [PATCH 4/6] Auto-update README --- README.md | 3 ++- README_fr.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8a1dac2..51163cf 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,8 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Admin UI for Synapse +And admin UI for Matrix Synapse homeserver. + **Shipped version:** 0.8.7~ynh3 diff --git a/README_fr.md b/README_fr.md index 4fc9e5c..49395b4 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,7 +16,8 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -Admin UI pour Synapse +And admin UI for Matrix Synapse homeserver. + **Version incluse :** 0.8.7~ynh3 From 8b62a08c3132d84f82be1936c489ad48bfcbf419 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Sun, 7 Jan 2024 21:11:43 +0100 Subject: [PATCH 5/6] for debug --- scripts/install | 4 ++-- scripts/remove | 6 ++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/scripts/install b/scripts/install index 92c0723..ac20a0d 100644 --- a/scripts/install +++ b/scripts/install @@ -29,8 +29,8 @@ ynh_script_progression --message="Adding system configurations related to $app.. ynh_add_nginx_config # Create NGINX config to access /_synapse/admin endpoint -synapse_domain=$(ynh_app_setting_get --app=$synapse_app --key=domain) -synapse_port=$(ynh_app_setting_get --app=$synapse_app --key=synapse_port) +synapse_domain=$(ynh_app_setting_get --app="$synapse_app" --key=domain) +synapse_port=$(ynh_app_setting_get --app="$synapse_app" --key=synapse_port) ynh_add_config --template="endpoint.nginx.conf" --destination="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" #================================================= diff --git a/scripts/remove b/scripts/remove index 1e11c2e..2479a96 100644 --- a/scripts/remove +++ b/scripts/remove @@ -14,12 +14,18 @@ source /usr/share/yunohost/helpers #================================================= ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 +ynh_exec_warn ls -lah "/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" + # Remove the dedicated NGINX config ynh_remove_nginx_config +ynh_exec_warn ls -lah "/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" + # Remove NGINX config that enabled /_synapse/admin endpoint ynh_secure_remove --file="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" +ynh_exec_warn ls -lah "/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" + #================================================= # END OF SCRIPT #================================================= From 6a6b3c0a949b51d581fe1a578517df602c005a20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9lix=20Pi=C3=A9dallu?= Date: Mon, 8 Jan 2024 12:11:02 +0100 Subject: [PATCH 6/6] fix upgrade synapse domain --- scripts/_common.sh | 19 +++++++++++++++++++ scripts/change_url | 11 +++++++---- scripts/install | 11 +++++++++-- scripts/remove | 6 ------ scripts/restore | 1 - scripts/upgrade | 7 +++++++ 6 files changed, 42 insertions(+), 13 deletions(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index 944a65e..95d5663 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -8,6 +8,25 @@ # PERSONAL HELPERS #================================================= +#================================================= +# UPDATE SYNAPSE ENDPOINT +#================================================= + +_update_synapse_nginx_config() { + # This helper fixes when synapse changes domain, shouldn't happen though... + old_synapse_domain="$synapse_domain" + synapse_domain=$(ynh_app_setting_get --app="$synapse_app" --key=domain) + synapse_port=$(ynh_app_setting_get --app="$synapse_app" --key=synapse_port) + ynh_app_setting_set --app=$app --key=synapse_domain --value="$synapse_domain" + + if [[ "${synapse_domain}" != "${old_synapse_domain}" ]]; then + ynh_backup_if_checksum_is_different --file="/etc/nginx/conf.d/${old_synapse_domain}.d/$app.endpoint.conf" + ynh_delete_file_checksum --file="/etc/nginx/conf.d/${old_synapse_domain}.d/$app.endpoint.conf" + ynh_secure_remove --file="/etc/nginx/conf.d/${old_synapse_domain}.d/$app.endpoint.conf" + fi + + ynh_add_config --template="endpoint.nginx.conf" --destination="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" +} #================================================= # EXPERIMENTAL HELPERS #================================================= diff --git a/scripts/change_url b/scripts/change_url index beaae0c..a693ba5 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,6 +9,13 @@ source _common.sh source /usr/share/yunohost/helpers +#================================================= +# UPDATE SYNAPSE ENDPOINT +#================================================= +ynh_script_progression --message="Updating NGINX web server configuration for Synapse..." --weight=2 + +_update_synapse_nginx_config + #================================================= # MODIFY URL IN NGINX CONF #================================================= @@ -16,10 +23,6 @@ ynh_script_progression --message="Updating NGINX web server configuration..." -- ynh_change_url_nginx_config -synapse_domain=$(ynh_app_setting_get --app=$synapse_app --key=domain) -synapse_port=$(ynh_app_setting_get --app=$synapse_app --key=synapse_port) -ynh_add_config --template="endpoint.nginx.conf" --destination="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index ac20a0d..c6cb612 100644 --- a/scripts/install +++ b/scripts/install @@ -9,6 +9,15 @@ source _common.sh source /usr/share/yunohost/helpers +#================================================= +# GET SYNAPSE SETTINGS +#================================================= +ynh_script_progression --message="Getting settings from Synapse..." --weight=2 + +synapse_domain=$(ynh_app_setting_get --app="$synapse_app" --key=domain) +synapse_port=$(ynh_app_setting_get --app="$synapse_app" --key=synapse_port) +ynh_app_setting_set --app=$app --key=synapse_domain --value="$synapse_domain" + #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -29,8 +38,6 @@ ynh_script_progression --message="Adding system configurations related to $app.. ynh_add_nginx_config # Create NGINX config to access /_synapse/admin endpoint -synapse_domain=$(ynh_app_setting_get --app="$synapse_app" --key=domain) -synapse_port=$(ynh_app_setting_get --app="$synapse_app" --key=synapse_port) ynh_add_config --template="endpoint.nginx.conf" --destination="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" #================================================= diff --git a/scripts/remove b/scripts/remove index 2479a96..1e11c2e 100644 --- a/scripts/remove +++ b/scripts/remove @@ -14,18 +14,12 @@ source /usr/share/yunohost/helpers #================================================= ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 -ynh_exec_warn ls -lah "/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" - # Remove the dedicated NGINX config ynh_remove_nginx_config -ynh_exec_warn ls -lah "/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" - # Remove NGINX config that enabled /_synapse/admin endpoint ynh_secure_remove --file="/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" -ynh_exec_warn ls -lah "/etc/nginx/conf.d/${synapse_domain}.d/$app.endpoint.conf" - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index ef97584..45fd866 100644 --- a/scripts/restore +++ b/scripts/restore @@ -19,7 +19,6 @@ ynh_restore_file --origin_path="$install_dir" chmod -R o-rwx "$install_dir" chown -R $app:www-data "$install_dir" - #================================================= # RESTORE SYSTEM CONFIGURATIONS #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 39acb5b..21ad0a9 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -56,6 +56,13 @@ fi chmod -R o-rwx "$install_dir" chown -R $app:www-data "$install_dir" +#================================================= +# UPDATE SYNAPSE ENDPOINT +#================================================= +ynh_script_progression --message="Updating NGINX web server configuration for Synapse..." --weight=2 + +_update_synapse_nginx_config + #================================================= # REAPPLY SYSTEM CONFIGURATIONS #=================================================