diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh new file mode 100755 index 0000000..2422a5e --- /dev/null +++ b/.github/workflows/updater.sh @@ -0,0 +1,136 @@ +#!/bin/bash + +#================================================= +# PACKAGE UPDATING HELPER +#================================================= + +# This script is meant to be run by GitHub Actions +# The YunoHost-Apps organisation offers a template Action to run this script periodically +# Since each app is different, maintainers can adapt its contents so as to perform +# automatic actions when a new upstream release is detected. + +# Remove this exit command when you are ready to run this Action +#exit 1 + +#================================================= +# FETCHING LATEST RELEASE AND ITS ASSETS +#================================================= + +# Fetching information +current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') +repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') +# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) +version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) +assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) + +# Later down the script, we assume the version has only digits and dots +# Sometimes the release name starts with a "v", so let's filter it out. +# You may need more tweaks here if the upstream repository has different naming conventions. +if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then + version=${version:1} +fi + +# Setting up the environment variables +echo "Current version: $current_version" +echo "Latest release from upstream: $version" +echo "VERSION=$version" >> $GITHUB_ENV +# For the time being, let's assume the script will fail +echo "PROCEED=false" >> $GITHUB_ENV + +# Proceed only if the retrieved version is greater than the current one +if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then + echo "::warning ::No new version available" + exit 0 +# Proceed only if a PR for this new version does not already exist +elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then + echo "::warning ::A branch already exists for this update" + exit 0 +fi + +# Each release can hold multiple assets (e.g. binaries for different architectures, source code, etc.) +echo "${#assets[@]} available asset(s)" + +#================================================= +# UPDATE SOURCE FILES +#================================================= + +# Here we use the $assets variable to get the resources published in the upstream release. +# Here is an example for Grav, it has to be adapted in accordance with how the upstream releases look like. + +# Let's loop over the array of assets URLs +for asset_url in ${assets[@]}; do + +echo "Handling asset at $asset_url" + +# Assign the asset to a source file in conf/ directory +# Here we base the source file name upon a unique keyword in the assets url (admin vs. update) +# Leave $src empty to ignore the asset +case $asset_url in + *"admin"*) + src="app" + ;; + *"update"*) + src="app-upgrade" + ;; + *) + src="" + ;; +esac + +# If $src is not empty, let's process the asset +if [ ! -z "$src" ]; then + +# Create the temporary directory +tempdir="$(mktemp -d)" + +# Download sources and calculate checksum +filename=${asset_url##*/} +curl --silent -4 -L $asset_url -o "$tempdir/$filename" +checksum=$(sha256sum "$tempdir/$filename" | head -c 64) + +# Delete temporary directory +rm -rf $tempdir + +# Get extension +if [[ $filename == *.tar.gz ]]; then + extension=tar.gz +else + extension=${filename##*.} +fi + +# Rewrite source file +cat < conf/$src.src +SOURCE_URL=$asset_url +SOURCE_SUM=$checksum +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=$extension +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME= +EOT +echo "... conf/$src.src updated" + +else +echo "... asset ignored" +fi + +done + +#================================================= +# SPECIFIC UPDATE STEPS +#================================================= + +# Any action on the app's source code can be done. +# The GitHub Action workflow takes care of committing all changes after this script ends. + +#================================================= +# GENERIC FINALIZATION +#================================================= + +# Replace new version in manifest +echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json + +# No need to update the README, yunohost-bot takes care of it + +# The Action will proceed only if the PROCEED environment variable is set to true +echo "PROCEED=true" >> $GITHUB_ENV +exit 0 diff --git a/README.md b/README.md index 34b1045..99ac663 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,19 @@ The Mumble protocol uses TCP for control and UDP for voice. Running in a browser ![Screenshot of Mumble Web](./doc/screenshots/screenshot.png) +## Disclaimers / important information + +## Setup + +- In order to use *Mumble web*, you need to install [Mumble server](https://github.com/YunoHost-Apps/mumbleserver_ynh) first. +- This installation assumes that *Mumble server* is served by port `64738` +- Various configuration options are available for Mumble web on this configuration file `/var/www/mumble-web/dist/config.local.js` + +## Documentation + +- Murmur documentation: https://wiki.mumble.info/wiki/Murmurguide +- Framasoft documentation: https://docs.framasoft.org/fr/jitsimeet/mumble.html + ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 415e3d6..9182d65 100644 --- a/README_fr.md +++ b/README_fr.md @@ -27,6 +27,19 @@ Le protocole Mumble utilise TCP pour le contrôle et UDP pour la voix. Fonctionn ![Capture d’écran de Mumble Web](./doc/screenshots/screenshot.png) +## Avertissements / informations importantes + +## Configuration + +- Pour utiliser *Mumble web*, vous devez d'abord installer le [server Mumble](https://github.com/YunoHost-Apps/mumbleserver_ynh). +- Cette installation suppose que le serveur Mumble est servi par le port `64738` +- Diverses options de configuration sont disponibles pour *Mumble web* sur ce fichier de configuration `/var/www/mumble-web/dist/config.local.js` + +## Documentation + +- Documentation Murmur : https://wiki.mumble.info/wiki/Murmurguide +- Documentation Framasoft : https://docs.framasoft.org/fr/jitsimeet/mumble.html + ## Documentations et ressources * Site officiel de l’app : diff --git a/check_process b/check_process new file mode 100644 index 0000000..a598357 --- /dev/null +++ b/check_process @@ -0,0 +1,22 @@ +;; Test complet + ; Manifest + domain="domain.tld" + path="/path" + 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 + backup_restore=1 + multi_instance=1 + change_url=1 +;;; Options +Email= +Notification=none +;;; Upgrade options + ; commit= + name= diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..f91a691 --- /dev/null +++ b/conf/app.src @@ -0,0 +1,5 @@ +SOURCE_URL=https://github.com/Johni0702/mumble-web/archive/4ef594c8a097d180700d22d91e9a7fea3bab08ac.tar.gz +SOURCE_SUM=27ced80fc7a3035af531226658903ecd8a18881e045ebb5684d0a503ef67fb1d +SOURCE_SUM_PRG=sha256sum +ARCH_FORMAT=tar.gz +SOURCE_IN_SUBDIR=true diff --git a/conf/nginx.conf b/conf/nginx.conf index d0497cf..b4e82f8 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,18 +1,18 @@ location ^~ / { - proxy_pass http://127.0.0.1:__PORT__/; - proxy_redirect off; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Host $server_name; + proxy_pass http://127.0.0.1:__PORT__/; + proxy_redirect off; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Host $server_name; - proxy_http_version 1.1; - proxy_set_header Connection "upgrade"; - proxy_set_header Upgrade $http_upgrade; + proxy_http_version 1.1; + proxy_set_header Connection "upgrade"; + proxy_set_header Upgrade $http_upgrade; - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; - more_clear_input_headers 'Accept-Encoding'; + # Include SSOWAT user panel. + include conf.d/yunohost_panel.conf.inc; + more_clear_input_headers 'Accept-Encoding'; } diff --git a/conf/systemd.service b/conf/systemd.service index 2d16b83..df7f518 100644 --- a/conf/systemd.service +++ b/conf/systemd.service @@ -7,12 +7,12 @@ After=network.target #mumbleserver.service [Service] Type=simple User=__APP__ -Environment="__YNH_NODE_LOAD_PATH__" +Environment="PATH=__ENV_PATH__" Environment=NODE_ENV=production -ExecStart=/usr/bin/websockify --web=__INSTALL_DIR__/dist/ --ssl-target 127.0.0.1:__PORT__ 127.0.0.1:64738 +ExecStart=/usr/bin/websockify --web=__FINALPATH__/dist/ --ssl-target 127.0.0.1:__PORT__ 127.0.0.1:64738 # Sandboxing options to harden security -# Depending on specificities of your service/app, you may need to tweak these +# Depending on specificities of your service/app, you may need to tweak these # .. but this should be a good baseline # Details for these options: https://www.freedesktop.org/software/systemd/man/systemd.exec.html NoNewPrivileges=yes @@ -39,7 +39,7 @@ CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW -CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG +CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG [Install] WantedBy=multi-user.target diff --git a/doc/ADMIN.md b/doc/ADMIN.md deleted file mode 100644 index 2a397d2..0000000 --- a/doc/ADMIN.md +++ /dev/null @@ -1,6 +0,0 @@ - -Various configuration options are available for Mumble web on this configuration file `__INSTALL_DIR__/dist/config.local.js` - -Here are online documentations: -- Murmur documentation: -- Framasoft documentation: diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md deleted file mode 100644 index 5b1b82e..0000000 --- a/doc/ADMIN_fr.md +++ /dev/null @@ -1,5 +0,0 @@ -Diverses options de configuration sont disponibles pour *Mumble web* sur ce fichier de configuration `__INSTALL_DIR__/dist/config.local.js` - -Voici de la documentation en ligne : -- Documentation Murmur : -- Documentation Framasoft : diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..8553727 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,10 @@ +## Setup + +- In order to use *Mumble web*, you need to install [Mumble server](https://github.com/YunoHost-Apps/mumbleserver_ynh) first. +- This installation assumes that *Mumble server* is served by port `64738` +- Various configuration options are available for Mumble web on this configuration file `/var/www/mumble-web/dist/config.local.js` + +## Documentation + +- Murmur documentation: https://wiki.mumble.info/wiki/Murmurguide +- Framasoft documentation: https://docs.framasoft.org/fr/jitsimeet/mumble.html diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..421bf49 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -0,0 +1,10 @@ +## Configuration + +- Pour utiliser *Mumble web*, vous devez d'abord installer le [server Mumble](https://github.com/YunoHost-Apps/mumbleserver_ynh). +- Cette installation suppose que le serveur Mumble est servi par le port `64738` +- Diverses options de configuration sont disponibles pour *Mumble web* sur ce fichier de configuration `/var/www/mumble-web/dist/config.local.js` + +## Documentation + +- Documentation Murmur : https://wiki.mumble.info/wiki/Murmurguide +- Documentation Framasoft : https://docs.framasoft.org/fr/jitsimeet/mumble.html diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md deleted file mode 100644 index 3032223..0000000 --- a/doc/PRE_INSTALL.md +++ /dev/null @@ -1,2 +0,0 @@ -- In order to use *Mumble web*, you need to install [Mumble server](https://github.com/YunoHost-Apps/mumbleserver_ynh) first. -- This installation assumes that *Mumble server* is served by port `64738` diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md deleted file mode 100644 index cf4526e..0000000 --- a/doc/PRE_INSTALL_fr.md +++ /dev/null @@ -1,2 +0,0 @@ -- Pour utiliser *Mumble web*, vous devez d'abord installer le [server Mumble](https://github.com/YunoHost-Apps/mumbleserver_ynh). -- Cette installation suppose que le serveur Mumble est servi par le port `64738` diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..397b318 --- /dev/null +++ b/manifest.json @@ -0,0 +1,43 @@ +{ + "name": "Mumble Web", + "id": "mumble-web", + "packaging_format": 1, + "description": { + "en": "Web interface for voice chat software (VoIP)", + "fr": "Interface web pour voix sur IP (VoIP)" + }, + "version": "1.3.0~ynh4", + "url": "https://mumble.info", + "upstream": { + "license": "BSD-3-Clause", + "website": "https://mumble.info", + "demo": "https://web.mumble.framatalk.org/", + "admindoc": "https://docs.framasoft.org/fr/jitsimeet/mumble.html", + "code": "https://github.com/Johni0702/mumble-web/" + }, + "license": "BSD-3-Clause", + "maintainer": { + "name": "eric_G", + "email": "" + }, + "requirements": { + "yunohost": ">= 11.0.9" + }, + "multi_instance": true, + "services": [ + "nginx" + ], + "arguments": { + "install" : [ + { + "name": "domain", + "type": "domain" + }, + { + "name": "is_public", + "type": "boolean", + "default": true + } + ] + } +} diff --git a/manifest.toml b/manifest.toml deleted file mode 100644 index 7f4d071..0000000 --- a/manifest.toml +++ /dev/null @@ -1,60 +0,0 @@ -#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json - -packaging_format = 2 - -id = "mumble-web" -name = "Mumble Web" -description.en = "Web interface for voice chat software (VoIP)" -description.fr = "Interface web pour voix sur IP (VoIP)" - -version = "1.3.0~ynh4" - -maintainers = ["eric_G"] - -[upstream] -license = "BSD-3-Clause" -website = "https://mumble.info" -demo = "https://web.mumble.framatalk.org/" -admindoc = "https://docs.framasoft.org/fr/jitsimeet/mumble.html" -code = "https://github.com/Johni0702/mumble-web/" - -[integration] -yunohost = ">= 11.2" -architectures = "all" -multi_instance = true - -ldap = false - -sso = false - -disk = "50M" -ram.build = "1500M" -ram.runtime = "50M" - -[install] - [install.domain] - type = "domain" - - [install.init_main_permission] - type = "group" - default = "visitors" - -[resources] - [resources.sources.main] - url = "https://github.com/Johni0702/mumble-web/archive/4ef594c8a097d180700d22d91e9a7fea3bab08ac.tar.gz" - sha256 = "27ced80fc7a3035af531226658903ecd8a18881e045ebb5684d0a503ef67fb1d" - autoupdate.upstream = "https://github.com/Johni0702/mumble-web" - autoupdate.strategy = "latest_github_commit" - - [resources.system_user] - - [resources.install_dir] - - [resources.permissions] - main.url = "/" - - [resources.ports] - main.default = 64737 - - [resources.apt] - packages = ["websockify"] diff --git a/scripts/_common.sh b/scripts/_common.sh index 6825a97..4cee197 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,6 +4,9 @@ # COMMON VARIABLES #================================================= +# dependencies used by the app +pkg_dependencies="websockify" + # NodeJS version nodejs_version="14" diff --git a/scripts/backup b/scripts/backup index a151df9..b30dde3 100644 --- a/scripts/backup +++ b/scripts/backup @@ -9,6 +9,22 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= + +ynh_abort_if_errors + +#================================================= +# LOAD SETTINGS +#================================================= +ynh_print_info --message="Loading installation settings..." + +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) + #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -18,7 +34,7 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$install_dir" +ynh_backup --src_path="$final_path" #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index d50b2a4..0ff627b 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,6 +9,60 @@ 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="/" + +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) +port=$(ynh_app_setting_get --app=$app --key=port) + +#================================================= +# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP +#================================================= +ynh_script_progression --message="Backing up the 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 #================================================= @@ -16,21 +70,52 @@ source /usr/share/yunohost/helpers #================================================= ynh_script_progression --message="Stopping a systemd service..." --weight=1 -ynh_systemd_action --service_name="$app" --action="stop" --log_path="systemd" +ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" #================================================= # MODIFY URL IN NGINX CONF #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 -ynh_change_url_nginx_config +nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf +# 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 #================================================= # START SYSTEMD SERVICE #================================================= ynh_script_progression --message="Starting a systemd service..." --weight=1 -ynh_systemd_action --service_name="$app" --action="start" --log_path="systemd" +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 #================================================= # END OF SCRIPT diff --git a/scripts/install b/scripts/install index d61cf82..0814955 100644 --- a/scripts/install +++ b/scripts/install @@ -9,68 +9,166 @@ source _common.sh source /usr/share/yunohost/helpers -path="/" +#================================================= +# MANAGE SCRIPT FAILURE +#================================================= -# Testing if mumbleserver is installed -yunohost app list | grep -q "id: mumbleserver" || ynh_die "mumble-server is needed, but it is not installed." +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors + +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= + +# Retrieve arguments +domain=$YNH_APP_ARG_DOMAIN +path_url="/" +is_public=$YNH_APP_ARG_IS_PUBLIC + +app=$YNH_APP_INSTANCE_NAME + +if [ ${PACKAGE_CHECK_EXEC:-0} -eq 1 ]; then + : +else + # Testing if mumbleserver is installed + yunohost app list | grep -q "id: mumbleserver" || ynh_die "mumble-server is needed, but it is not installed." +fi + +#================================================= +# 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 "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 + +# Save app settings +ynh_app_setting_set --app=$app --key=domain --value=$domain +ynh_app_setting_set --app=$app --key=path --value=$path_url + +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# FIND AND OPEN A PORT +#================================================= +ynh_script_progression --message="Finding an available port..." --weight=1 + +port=$(ynh_find_port --port=64737) +ynh_app_setting_set --app=$app --key=port --value=$port #================================================= # INSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Installing NodeJS..." --weight=4 +ynh_script_progression --message="Installing dependencies..." --weight=4 -ynh_install_nodejs --nodejs_version="$nodejs_version" +# Install Mumble Debian package via apt +ynh_install_app_dependencies $pkg_dependencies + +ynh_install_nodejs --nodejs_version=$nodejs_version + +#================================================= +# 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" #================================================= # INSTALL Mumble-web #================================================= ynh_script_progression --message="Setting up source files..." --weight=1 -# Download, check integrity, uncompress and patch the source -ynh_setup_source --dest_dir="$install_dir" +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" -chmod -R o-rwx "$install_dir" -chown -R "$app:www-data" "$install_dir" +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" #================================================= -# BUILD CODE +# NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Building Mumble web client..." --weight=1 +ynh_script_progression --message="Configuring NGINX web server..." --weight=4 -pushd "$install_dir" - ynh_use_nodejs - ynh_exec_warn_less ynh_exec_as "$app" "$ynh_node_load_PATH" "$ynh_npm" install --save --loglevel warn - ynh_exec_warn_less ynh_exec_as "$app" "$ynh_node_load_PATH" "$ynh_npm" run build -popd +# Create a dedicated NGINX config +ynh_add_nginx_config + +#================================================= +# SPECIFIC SETUP +#================================================= +# mumble server conf.ini +#================================================= +ynh_script_progression --message="Configuring Mumble web client..." --weight=1 + +ynh_use_nodejs +( + cd $final_path + chown -R $app: $final_path + ynh_exec_warn_less ynh_exec_as "$app" PATH="$nodejs_path:$PATH" "$nodejs_path/npm" install --save --loglevel warn + ynh_exec_warn_less ynh_exec_as "$app" PATH="$nodejs_path:$PATH" "$nodejs_path/npm" run build + ls -lah +) #================================================= # ADD A CONFIGURATION #================================================= ynh_script_progression --message="Adding a configuration file..." --weight=1 -ynh_add_config --template="config.local.js" --destination="$install_dir/dist/config.local.js" -chmod 400 "$install_dir/dist/config.local.js" -chown "$app" "$install_dir/dist/config.local.js" +ynh_add_config --template="../conf/config.local.js" --destination="$final_path/dist/config.local.js" + +chmod 400 "$final_path/dist/config.local.js" +chown $app "$final_path/dist/config.local.js" #================================================= -# SYSTEM CONFIGURATION +# SETUP SYSTEMD #================================================= -ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 +ynh_script_progression --message="Configuring a systemd service..." --weight=10 -# Create a dedicated NGINX config -ynh_add_nginx_config +ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH" --target_file="../conf/systemd.service" -# Create a dedicated systemd config ynh_add_systemd_config -yunohost service add "$app" --description="Mumble web client" --log="/var/log/$app/$app.log" +#================================================= +# INTEGRATE SERVICE IN YUNOHOST +#================================================= +ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 + +yunohost service add $app --description="Mumble web client" --log="/var/log/$app/$app.log" #================================================= # START SYSTEMD SERVICE #================================================= ynh_script_progression --message="Starting a systemd service..." --weight=3 -ynh_systemd_action --service_name="$app" --action=restart --log_path="systemd" +ynh_systemd_action --service_name=$app --action=restart --log_path="systemd" + +#================================================= +# SETUP SSOWAT +#================================================= +ynh_script_progression --message="Configuring permissions..." --weight=1 + +# Make app public if necessary +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=1 + +ynh_systemd_action --service_name=nginx --action=reload #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 5367c1a..3d07b4b 100644 --- a/scripts/remove +++ b/scripts/remove @@ -9,27 +9,74 @@ 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) +path=$(ynh_app_setting_get --app=$app --key=path) +port=$(ynh_app_setting_get --app=$app --key=port) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) + #================================================= # STANDARD REMOVE #================================================= # REMOVE SERVICE FROM ADMIN PANEL #================================================= -ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 # 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 integration..." --weight=1 - yunohost service remove $app +if ynh_exec_warn_less yunohost service status $app >/dev/null +then + ynh_script_progression --message="Removing $app service integration..." --weight=1 + yunohost service remove $app fi +#================================================= +# STOP AND REMOVE SERVICE +#================================================= +ynh_script_progression --message="Stopping and removing the systemd service..." --weight=2 + # Remove the dedicated systemd config ynh_remove_systemd_config +#================================================= +# REMOVE DEPENDENCIES +#================================================= +ynh_script_progression --message="Removing dependencies..." --weight=1 + +# Remove metapackage and its dependencies +ynh_remove_app_dependencies +# Remove NodeJS +ynh_remove_nodejs + +#================================================= +# REMOVE APP MAIN DIR +#================================================= +ynh_script_progression --message="Removing app main directory..." --weight=2 + +# Remove the app directory securely +ynh_secure_remove --file="$final_path" + +#================================================= +# REMOVE NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1 + # Remove the dedicated nginx config ynh_remove_nginx_config -# Remove NodeJS -ynh_remove_nodejs +#================================================= +# 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" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 9a6cd1d..e27a3a0 100644 --- a/scripts/restore +++ b/scripts/restore @@ -10,42 +10,97 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= -# REINSTALL DEPENDENCIES +# MANAGE SCRIPT FAILURE #================================================= -ynh_script_progression --message="Reinstalling NodeJS..." --weight=4 -ynh_install_nodejs --nodejs_version="$nodejs_version" +ynh_abort_if_errors + +#================================================= +# 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) +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) + +#================================================= +# CHECK IF THE APP CAN BE RESTORED +#================================================= +ynh_script_progression --message="Validating restoration parameters..." --weight=1 + +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..." --weight=1 + +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.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=2 -ynh_restore_file --origin_path="$install_dir" +ynh_restore_file --origin_path="$final_path" -chmod -R o-rwx "$install_dir" -chown -R "$app:www-data" "$install_dir" +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" #================================================= -# RESTORE SYSTEM CONFIGURATIONS +# REINSTALL DEPENDENCIES #================================================= -ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 +ynh_script_progression --message="Reinstalling dependencies..." --weight=4 -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" +# Define and install dependencies +ynh_install_app_dependencies $pkg_dependencies + +ynh_install_nodejs --nodejs_version=$nodejs_version + +#================================================= +# RESTORE SYSTEMD +#================================================= +ynh_script_progression --message="Restoring the systemd configuration..." --weight=1 ynh_restore_file --origin_path="/etc/systemd/system/$app.service" -systemctl enable "$app.service" --quiet +systemctl enable $app.service --quiet -yunohost service add "$app" --description="Mumble web client" --log="/var/log/$app/$app.log" +#================================================= +# ADVERTISE SERVICE IN ADMIN PANEL +#================================================= +ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 + +# Add Mumble as a YunoHost service +yunohost service add $app --description="Mumble web client" --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="systemd" #================================================= # GENERIC FINALIZATION #================================================= -# RELOAD NGINX AND PHP-FPM OR THE APP SERVICE +# RELOAD NGINX AND PHP-FPM #================================================= -ynh_script_progression --message="Reloading NGINX web server and $app's service..." --weight=1 - -ynh_systemd_action --service_name="$app" --action="start" --log_path="systemd" +ynh_script_progression --message="Reloading NGINX web server..." --weight=1 ynh_systemd_action --service_name=nginx --action=reload diff --git a/scripts/upgrade b/scripts/upgrade index a290c41..9c0793f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,61 +9,128 @@ 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) +path_url=$(ynh_app_setting_get --app=$app --key=path) +port=$(ynh_app_setting_get --app=$app --key=port) +final_path=$(ynh_app_setting_get --app=$app --key=final_path) + +#================================================= +# 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 + #================================================= # STOP SYSTEMD SERVICE #================================================= ynh_script_progression --message="Stopping a systemd service..." --weight=1 -ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" +ynh_systemd_action --service_name=$app --action="stop" --log_path="/var/log/$app/$app.log" #================================================= -# INSTALL DEPENDENCIES +# ENSURE DOWNWARD COMPATIBILITY #================================================= -ynh_script_progression --message="Upgrading NodeJS..." --weight=1 +ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -ynh_install_nodejs --nodejs_version=$nodejs_version -ynh_use_nodejs +# 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 --home_dir="$final_path" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -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="$install_dir" --full_replace=1 --keep="dist/config.local.js" +if [ "$upgrade_type" == "UPGRADE_APP" ] +then + ynh_script_progression --message="Upgrading source files..." --weight=1 -chmod -R o-rwx "$install_dir" -chown -R "$app:www-data" "$install_dir" + # Download, check integrity, uncompress and patch the source from app.src + ynh_setup_source --dest_dir="$final_path" --keep="dist/config.local.js" +fi + +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" #================================================= -# BUILD CODE +# NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Building Mumble web client..." --weight=1 - -pushd "$install_dir" - ynh_exec_warn_less ynh_exec_as "$app" "$ynh_node_load_PATH" "$ynh_npm" install --save --loglevel warn - ynh_exec_warn_less ynh_exec_as "$app" "$ynh_node_load_PATH" "$ynh_npm" run build -popd - -#================================================= -# REAPPLY SYSTEM CONFIGURATIONS -#================================================= -ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 +ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=5 # Create a dedicated NGINX config ynh_add_nginx_config +#================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Upgrading dependencies..." --weight=1 + +ynh_install_app_dependencies $pkg_dependencies + +ynh_install_nodejs --nodejs_version=$nodejs_version + +#================================================= +# SETUP SYSTEMD +#================================================= +ynh_script_progression --message="Upgrading systemd configuration..." --weight=2 + # Create a dedicated systemd config +ynh_replace_string --match_string="__ENV_PATH__" --replace_string="$PATH" --target_file="../conf/systemd.service" + ynh_add_systemd_config -yunohost service add "$app" --description="Mumble web client" --log="/var/log/$app/$app.log" +#================================================= +# ADVERTISE SERVICE IN ADMIN PANEL +#================================================= + +# Add Mumble as a YunoHost service +yunohost service add $app --description="Mumble web client" --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="systemd" +ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" + +#================================================= +# 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/tests.toml b/tests.toml deleted file mode 100644 index 328ace0..0000000 --- a/tests.toml +++ /dev/null @@ -1,17 +0,0 @@ -#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json - -test_format = 1.0 - -[default] - - preinstall = """ - yunohost tools update apps - yunohost domain add mumble.domain.tld - yunohost app install \ - https://github.com/YunoHost-Apps/mumbleserver_ynh/tree/05ee188491d4570eb2ed64dab4ca1e7a45e44d5f \ - -a "domain=mumble.domain.tld&welcometext=Welcome®istername=Root" \ - --force - - """ - - test_upgrade_from.a647bf5a79ad41f0f346c8d302890eaf3cef4db5.name = "Last packaging v1 version"