diff --git a/conf/arm b/conf/arm
new file mode 100644
index 0000000..37e01e4
--- /dev/null
+++ b/conf/arm
@@ -0,0 +1,6 @@
+SOURCE_URL=https://github.com/42wim/matterbridge/releases/download/v1.21.0/matterbridge-1.21.0-linux-armv6
+SOURCE_SUM=0082baafa52f22e54378927d95442b98c4494a70998dd59d34eabea39aea9b04
+SOURCE_SUM_PRG=sha256sum
+SOURCE_IN_SUBDIR=true
+SOURCE_FILENAME=
+SOURCE_EXTRACT=true
diff --git a/conf/arm64.src b/conf/arm64.src
new file mode 100644
index 0000000..33e7b6f
--- /dev/null
+++ b/conf/arm64.src
@@ -0,0 +1,6 @@
+SOURCE_URL=https://github.com/42wim/matterbridge/releases/download/v1.21.0/matterbridge-1.21.0-linux-arm64
+SOURCE_SUM=214485475aa8e4d7c767e871459f3712026741ba09809ff041fee5b4ed731608
+SOURCE_SUM_PRG=sha256sum
+SOURCE_IN_SUBDIR=true
+SOURCE_FILENAME=
+SOURCE_EXTRACT=true
diff --git a/conf/x86-64.src b/conf/x86-64.src
new file mode 100644
index 0000000..7967d11
--- /dev/null
+++ b/conf/x86-64.src
@@ -0,0 +1,6 @@
+SOURCE_URL=https://github.com/42wim/matterbridge/releases/download/v1.21.0/matterbridge-1.21.0-linux-64bit
+SOURCE_SUM=0a321cbc90ba467d05c1bd5ec7a1c3b10fb2ba142710311b015f5e8235d39fe6
+SOURCE_SUM_PRG=sha256sum
+SOURCE_IN_SUBDIR=true
+SOURCE_FILENAME=
+SOURCE_EXTRACT=true
diff --git a/manifest.json b/manifest.json
index 7aea83b..b7899fe 100644
--- a/manifest.json
+++ b/manifest.json
@@ -6,7 +6,7 @@
"en": "matterbridge package for YunoHost.",
"fr": "matterbridge pour YunoHost."
},
- "version": "1.17.4",
+ "version": "1.21.0~ynh1",
"url": "https://github.com/42wim/matterbridge",
"license": "GPL-3.0",
"maintainer": {
@@ -14,7 +14,7 @@
"email": "liberodark@gmail.com"
},
"requirements": {
- "yunohost": ">= 2.7.2"
+ "yunohost": ">= 3.8.1"
},
"multi_instance": false,
"services": [
diff --git a/scripts/_common.sh b/scripts/_common.sh
index 0f53f77..fb6b70c 100644
--- a/scripts/_common.sh
+++ b/scripts/_common.sh
@@ -1,112 +1,185 @@
#!/bin/bash
-# =============================================================================
-# YUNOHOST 2.7 FORTHCOMING HELPERS
-# =============================================================================
+#=================================================
+# COMMON VARIABLES
+#=================================================
-# Create a dedicated nginx config
+# dependencies used by the app
+pkg_dependencies="coturn acl"
+
+#=================================================
+# PERSONAL HELPERS
+#=================================================
+
+#=================================================
+# EXPERIMENTAL HELPERS
+#=================================================
+
+# Send an email to inform the administrator
#
-# usage: ynh_add_nginx_config
-ynh_add_nginx_config () {
- finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf"
- ynh_backup_if_checksum_is_different "$finalnginxconf"
- sudo cp ../conf/nginx.conf "$finalnginxconf"
+# usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]
+# | arg: -m --app_message= - The file with the content to send to the administrator.
+# | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root
+# example: "root admin@domain"
+# If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
+# example: "root admin@domain user1 user2"
+# | arg: -t, --type= - Type of mail, could be 'backup', 'change_url', 'install', 'remove', 'restore', 'upgrade'
+ynh_send_readme_to_admin() {
+ # Declare an array to define the options of this helper.
+ declare -Ar args_array=( [m]=app_message= [r]=recipients= [t]=type= )
+ local app_message
+ local recipients
+ local type
+ # Manage arguments with getopts
- # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
- # Substitute in a nginx config file only if the variable is not empty
- if test -n "${path_url:-}"; then
- ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf"
- fi
- if test -n "${domain:-}"; then
- ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf"
- fi
- if test -n "${port:-}"; then
- ynh_replace_string "__PORT__" "$port" "$finalnginxconf"
- fi
- if test -n "${app:-}"; then
- ynh_replace_string "__NAME__" "$app" "$finalnginxconf"
- fi
- if test -n "${final_path:-}"; then
- ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf"
- fi
- ynh_store_file_checksum "$finalnginxconf"
+ ynh_handle_getopts_args "$@"
+ app_message="${app_message:-}"
+ recipients="${recipients:-root}"
+ type="${type:-install}"
- sudo systemctl reload nginx
+ # Get the value of admin_mail_html
+ admin_mail_html=$(ynh_app_setting_get $app admin_mail_html)
+ admin_mail_html="${admin_mail_html:-0}"
+
+ # Retrieve the email of users
+ find_mails () {
+ local list_mails="$1"
+ local mail
+ local recipients=" "
+ # Read each mail in argument
+ for mail in $list_mails
+ do
+ # Keep root or a real email address as it is
+ if [ "$mail" = "root" ] || echo "$mail" | grep --quiet "@"
+ then
+ recipients="$recipients $mail"
+ else
+ # But replace an user name without a domain after by its email
+ if mail=$(ynh_user_get_info "$mail" "mail" 2> /dev/null)
+ then
+ recipients="$recipients $mail"
+ fi
+ fi
+ done
+ echo "$recipients"
+ }
+ recipients=$(find_mails "$recipients")
+
+ # Subject base
+ local mail_subject="☁️🆈🅽🅷☁️: \`$app\`"
+
+ # Adapt the subject according to the type of mail required.
+ if [ "$type" = "backup" ]; then
+ mail_subject="$mail_subject has just been backup."
+ elif [ "$type" = "change_url" ]; then
+ mail_subject="$mail_subject has just been moved to a new URL!"
+ elif [ "$type" = "remove" ]; then
+ mail_subject="$mail_subject has just been removed!"
+ elif [ "$type" = "restore" ]; then
+ mail_subject="$mail_subject has just been restored!"
+ elif [ "$type" = "upgrade" ]; then
+ mail_subject="$mail_subject has just been upgraded!"
+ else # install
+ mail_subject="$mail_subject has just been installed!"
+ fi
+
+ local mail_message="This is an automated message from your beloved YunoHost server.
+
+Specific information for the application $app.
+
+$(if [ -n "$app_message" ]
+then
+ cat "$app_message"
+else
+ echo "...No specific information..."
+fi)
+
+---
+Automatic diagnosis data from YunoHost
+
+__PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')__PRE_TAG2__"
+
+ # Store the message into a file for further modifications.
+ echo "$mail_message" > mail_to_send
+
+ # If a html email is required. Apply html tags to the message.
+ if [ "$admin_mail_html" -eq 1 ]
+ then
+ # Insert 'br' tags at each ending of lines.
+ ynh_replace_string "$" "
" mail_to_send
+
+ # Insert starting HTML tags
+ sed --in-place '1s@^@\n\n\n\n@' mail_to_send
+
+ # Keep tabulations
+ ynh_replace_string " " "\ \ " mail_to_send
+ ynh_replace_string "\t" "\ \ " mail_to_send
+
+ # Insert url links tags
+ ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "\1" mail_to_send
+
+ # Insert pre tags
+ ynh_replace_string "__PRE_TAG1__" "" mail_to_send
+ ynh_replace_string "__PRE_TAG2__" "<\pre>" mail_to_send
+
+ # Insert finishing HTML tags
+ echo -e "\n\n" >> mail_to_send
+
+ # Otherwise, remove tags to keep a plain text.
+ else
+ # Remove URL tags
+ ynh_replace_string "__URL_TAG[1,3]__" "" mail_to_send
+ ynh_replace_string "__URL_TAG2__" ": " mail_to_send
+
+ # Remove PRE tags
+ ynh_replace_string "__PRE_TAG[1-2]__" "" mail_to_send
+ fi
+
+ # Define binary to use for mail command
+ if [ -e /usr/bin/bsd-mailx ]
+ then
+ local mail_bin=/usr/bin/bsd-mailx
+ else
+ local mail_bin=/usr/bin/mail.mailutils
+ fi
+
+ if [ "$admin_mail_html" -eq 1 ]
+ then
+ content_type="text/html"
+ else
+ content_type="text/plain"
+ fi
+
+ # Send the email to the recipients
+ cat mail_to_send | $mail_bin -a "Content-Type: $content_type; charset=UTF-8" -s "$mail_subject" "$recipients"
}
-# Remove the dedicated nginx config
+#=================================================
+# FUTURE OFFICIAL HELPERS
+#=================================================
+
+# Check the architecture
#
-# usage: ynh_remove_nginx_config
-ynh_remove_nginx_config () {
- ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf"
- sudo systemctl reload nginx
-}
-
-# Create a dedicated php-fpm config
+# example: architecture=$(ynh_detect_arch)
#
-# usage: ynh_add_fpm_config
-ynh_add_fpm_config () {
- finalphpconf="/etc/php5/fpm/pool.d/$app.conf"
- ynh_backup_if_checksum_is_different "$finalphpconf"
- sudo cp ../conf/php-fpm.conf "$finalphpconf"
- ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf"
- ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf"
- ynh_replace_string "__USER__" "$app" "$finalphpconf"
- sudo chown root: "$finalphpconf"
- ynh_store_file_checksum "$finalphpconf"
-
- if [ -e "../conf/php-fpm.ini" ]
- then
- finalphpini="/etc/php5/fpm/conf.d/20-$app.ini"
- ynh_backup_if_checksum_is_different "$finalphpini"
- sudo cp ../conf/php-fpm.ini "$finalphpini"
- sudo chown root: "$finalphpini"
- ynh_store_file_checksum "$finalphpini"
- fi
-
- sudo systemctl reload php5-fpm
-}
-
-# Remove the dedicated php-fpm config
+# usage: ynh_detect_arch
#
-# usage: ynh_remove_fpm_config
-ynh_remove_fpm_config () {
- ynh_secure_remove "/etc/php5/fpm/pool.d/$app.conf"
- ynh_secure_remove "/etc/php5/fpm/conf.d/20-$app.ini" 2>&1
- sudo systemctl reload php5-fpm
-}
-
-# Create a dedicated systemd config
-#
-# usage: ynh_add_systemd_config
-ynh_add_systemd_config () {
- finalsystemdconf="/etc/systemd/system/$app.service"
- ynh_backup_if_checksum_is_different "$finalsystemdconf"
- sudo cp ../conf/systemd.service "$finalsystemdconf"
-
- # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
- # Substitute in a nginx config file only if the variable is not empty
- if test -n "${final_path:-}"; then
- ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf"
- fi
- if test -n "${app:-}"; then
- ynh_replace_string "__APP__" "$app" "$finalsystemdconf"
- fi
- ynh_store_file_checksum "$finalsystemdconf"
-
- sudo chown root: "$finalsystemdconf"
- sudo systemctl enable $app
- sudo systemctl daemon-reload
-}
-
-# Remove the dedicated systemd config
-#
-# usage: ynh_remove_systemd_config
-ynh_remove_systemd_config () {
- finalsystemdconf="/etc/systemd/system/$app.service"
- if [ -e "$finalsystemdconf" ]; then
- sudo systemctl stop $app
- sudo systemctl disable $app
- ynh_secure_remove "$finalsystemdconf"
- fi
+# Requires YunoHost version 2.2.4 or higher.
+
+ynh_detect_arch(){
+ local architecture
+ if [ -n "$(uname -m | grep arm64)" ] || [ -n "$(uname -m | grep aarch64)" ]; then
+ architecture="arm64"
+ elif [ -n "$(uname -m | grep 64)" ]; then
+ architecture="x86-64"
+ elif [ -n "$(uname -m | grep armv7)" ]; then
+ architecture="arm"
+ elif [ -n "$(uname -m | grep armv6)" ]; then
+ architecture="arm"
+ elif [ -n "$(uname -m | grep armv5)" ]; then
+ architecture="arm"
+ else
+ architecture="unknown"
+ fi
+ echo $architecture
}
diff --git a/scripts/install b/scripts/install
index 5db65d8..81a9ac6 100644
--- a/scripts/install
+++ b/scripts/install
@@ -27,50 +27,38 @@ ynh_abort_if_errors
# Retrieve arguments
is_public=$YNH_APP_ARG_IS_PUBLIC
-### If it's a multi-instance app, meaning it can be installed several times independently
-### The id of the app as stated in the manifest is available as $YNH_APP_ID
-### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
-### The app instance name is available as $YNH_APP_INSTANCE_NAME
-### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
-### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
-### - ynhexample__{N} for the subsequent installations, with N=3,4, ...
-### The app instance name is probably what interests you most, since this is
-### guaranteed to be unique. This is a good unique identifier to define installation path,
-### db names, ...
app=$YNH_APP_INSTANCE_NAME
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
+ynh_script_progression --message="Validating installation parameters..." --time --weight=1
-### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app".
-### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app"
-final_path=/opt/$app
-test ! -e "$final_path" || ynh_die "This path already contains a folder"
-
-ynh_app_setting_set $app is_public $is_public
+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
#=================================================
# INSTALL DEPENDENCIES
#=================================================
+ynh_script_progression --message="Installing dependencies..." --time --weight=1
-ynh_print_info "Installing dependencies..."
-
-### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
-### Those deb packages will be installed as dependencies of this package.
-### If you're not using this helper:
-### - Remove the section "REMOVE DEPENDENCIES" in the remove script
-### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
-### - And the section "UPGRADE DEPENDENCIES" in the upgrade script
+#ynh_install_app_dependencies $pkg_dependencies
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE
#=================================================
-ynh_app_setting_set $app final_path $final_path
+#=================================================
+# DOWNLOAD, CHECK AND UNPACK SOURCE
+#=================================================
+ynh_script_progression --message="Setting up source files..." --time --weight=1
+
+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 "$final_path"
+ynh_setup_source --dest_dir="$final_path"
#=================================================
# NGINX CONFIGURATION
@@ -82,9 +70,10 @@ ynh_setup_source "$final_path"
#=================================================
# CREATE DEDICATED USER
#=================================================
+ynh_script_progression --message="Configuring system user..." --time --weight=1
# Create a system user
-ynh_system_user_create $app
+ynh_system_user_create --username=$app
#=================================================
# MODIFY A CONFIG FILE
@@ -103,9 +92,17 @@ cp -a ../conf/matterbridge.toml $final_path/matterbridge.toml
#=================================================
# SETUP SYSTEMD
#=================================================
+ynh_script_progression --message="Configuring a systemd service..." --time --weight=1
+# Create a dedicated systemd config
ynh_add_systemd_config
-systemctl enable $app.service
+
+#=================================================
+# INTEGRATE SERVICE IN YUNOHOST
+#=================================================
+ynh_script_progression --message="Integrating service in YunoHost..." --time --weight=1
+
+yunohost service add $app --description="A short description of the app" --log="/var/log/$app/$app.log"
#=================================================
# STORE THE CONFIG FILE CHECKSUM
@@ -125,13 +122,20 @@ systemctl enable $app.service
# SECURE FILES AND DIRECTORIES
#=================================================
-### For security reason, any app should set the permissions to root: before anything else.
-### Then, if write authorization is needed, any access should be given only to directories
-### that really need such authorization.
-
# Set permissions to app files
chmod +x $final_path/matterbridge
chown -R $app: $final_path
+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+
# Reload services
-systemctl restart $app
+ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/$app.log"
+
+#=================================================
+# END OF SCRIPT
+#=================================================
+
+ynh_script_progression --message="Installation of $app completed" --time --last