Add helper ynh_send_readme_to_admin

scripts/experimental_helper.sh

@@ -182,3 +182,52 @@ ynh_remove_systemd_config () {
 		sudo systemctl daemon-reload
 	fi
 }
+
+# Send an email to inform the administrator
+#
+# usage: ynh_send_readme_to_admin app_message [recipients]
+# | arg: app_message - The message to send to the administrator.
+# | arg: 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"
+ynh_send_readme_to_admin() {
+	local app_message="${1:-...No specific information...}"
+	local recipients="${2:-root}"
+
+	# 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")
+
+	local mail_subject="☁️🆈🅽🅷☁️: \`$app\` was just installed!"
+
+	local mail_message="This is an automated message from your beloved YunoHost server.
+Specific information for the application $app.
+$app_message
+---
+Automatic diagnosis data from YunoHost
+$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
+
+	# Send the email to the recipients
+	echo "$mail_message" | mail -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients"
+}

scripts/install

@@ -299,3 +299,19 @@ yunohost service add coturn-$app
 
 systemctl restart coturn-$app.service
 ynh_check_starting "Synapse now listening on port $synapse_tls_port" "/var/log/matrix-$app/homeserver.log" 300 "matrix-$app"
+
+#=================================================
+# SEND A README FOR THE ADMIN
+#=================================================
+
+message="To federate this app you need to add this line in your DNS configuration :
+
+_matrix._tcp.$domain. 3600    IN      SRV     10 0 $synapse_tls_port $domain.
+
+You also need to open the TCP port $synapse_tls_port on your ISP box if it's not automatically done.
+
+Your synapse server also implement a turnserver (for VoIP), to have this fully functional open the TCP and UDP port $turnserver_tls_port and $turnserver_alt_tls_port (if it's not automatically done).
+
+If you facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/synapse_ynh"
+
+ynh_send_readme_to_admin "$message"

scripts/restore

@@ -149,3 +149,19 @@ yunohost service add coturn-$app
 systemctl reload nginx.service
 systemctl restart coturn-$app.service
 ynh_check_starting "Synapse now listening on port $synapse_tls_port" "/var/log/matrix-$app/homeserver.log" 300 "matrix-$app"
+
+#=================================================
+# SEND A README FOR THE ADMIN
+#=================================================
+
+message="To federate this app you need to add this line in your DNS configuration :
+
+_matrix._tcp.$domain. 3600    IN      SRV     10 0 $synapse_tls_port $domain.
+
+You also need to open the TCP port $synapse_tls_port on your ISP box if it's not automatically done.
+
+Your synapse server also implement a turnserver (for VoIP), to have this fully functional open the TCP and UDP port $turnserver_tls_port and $turnserver_alt_tls_port (if it's not automatically done).
+
+If you facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/synapse_ynh"
+
+ynh_send_readme_to_admin "$message"