From 1b2ef562c5c56e7c98f1895888d0860e3613a60d Mon Sep 17 00:00:00 2001 From: tituspijean Date: Tue, 31 May 2022 23:25:54 +0200 Subject: [PATCH 1/3] Fix NGINX conf --- conf/nginx.conf | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/conf/nginx.conf b/conf/nginx.conf index a62e2f0..37869dd 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -9,20 +9,14 @@ location __PATH__/ { # Common parameter to increase upload size limit in conjunction with dedicated php-fpm file #client_max_body_size 50M; - try_files $uri $uri/ @rewrite; + # Bug in Nginx with locations and aliases (see http://stackoverflow.com/a/35102259 ) + try_files $uri $uri/ __PATH__/__PATH__/index.php$is_args$args; - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; + location ~* \.php$ { fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; fastcgi_index index.php; include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; fastcgi_param SCRIPT_FILENAME $request_filename; } } - -location @rewrite { - rewrite ^/(.+)$ __PATH__/index.php?page=$1 last; -} From fcc2686a99fa34e92c31993bb1271c67d183eca0 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Tue, 31 May 2022 23:26:46 +0200 Subject: [PATCH 2/3] Send email to admin with login credentials --- conf/msg_install | 8 ++ scripts/install | 12 ++- scripts/ynh_send_readme_to_admin__2 | 128 ++++++++++++++++++++++++++++ 3 files changed, 147 insertions(+), 1 deletion(-) create mode 100644 conf/msg_install create mode 100644 scripts/ynh_send_readme_to_admin__2 diff --git a/conf/msg_install b/conf/msg_install new file mode 100644 index 0000000..255784f --- /dev/null +++ b/conf/msg_install @@ -0,0 +1,8 @@ +__APP__ was successfully installed :) + +A user was created: + +__USER_NAME__ +__USER_PASS__ + +Please open your __APP__ dashboard with these credentials: https://__DOMAIN____PATH_URL__/dashboard diff --git a/scripts/install b/scripts/install index 208aa9b..5788353 100755 --- a/scripts/install +++ b/scripts/install @@ -7,6 +7,7 @@ #================================================= source _common.sh +source ynh_send_readme_to_admin__2 source /usr/share/yunohost/helpers #================================================= @@ -99,7 +100,9 @@ ynh_add_fpm_config #================================================= ynh_script_progression --message="Setting up the first user..." --weight=1 -php${phpversion} $final_path/automad/console createuser +user_info=$(ynh_exec_as $app php${phpversion} $final_path/automad/console createuser) +user_name=$(echo "$user_info" | grep "Name:") +user_pass=$(echo "$user_info" | grep "Password:") #================================================= # SETUP SSOWAT @@ -119,6 +122,13 @@ ynh_script_progression --message="Reloading NGINX web server..." --weight=1 ynh_systemd_action --service_name=nginx --action=reload +#================================================= +# SEND A README FOR THE ADMIN +#================================================= +ynh_script_progression --message="Sending a readme for the admin..." + +ynh_send_readme_to_admin --app_message="../conf/msg_install" --recipients="root@$domain" --type="install" + #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/ynh_send_readme_to_admin__2 b/scripts/ynh_send_readme_to_admin__2 new file mode 100644 index 0000000..6a0ba70 --- /dev/null +++ b/scripts/ynh_send_readme_to_admin__2 @@ -0,0 +1,128 @@ +#!/bin/bash + +# Send an email to inform the administrator +# +# 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' +# +# Requires YunoHost version 4.1.0 or higher. +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 + + ynh_handle_getopts_args "$@" + app_message="${app_message:-}" + recipients="${recipients:-root}" + type="${type:-install}" + + # 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 + + ynh_add_config --template="$app_message" --destination="../conf/msg_to_send" + + ynh_delete_file_checksum --file="../conf/msg_to_send" + local mail_message="This is an automated message from your beloved YunoHost server. + +Specific information for the application $app. + +$(cat "../conf/msg_to_send")" + + # 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 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 + 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" +} From 11e97e74c5556db4b0029060f90167b77208561d Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Tue, 31 May 2022 21:27:02 +0000 Subject: [PATCH 3/3] Auto-update README --- README.md | 21 +++++++++++---------- README_fr.md | 27 ++++++++++++++++----------- 2 files changed, 27 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 44f3f34..7fb04cd 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # Automad for YunoHost -[![Integration level](https://dash.yunohost.org/integration/automad.svg)](https://dash.yunohost.org/appci/app/automad) ![](https://ci-apps.yunohost.org/ci/badges/automad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/automad.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/automad.svg)](https://dash.yunohost.org/appci/app/automad) ![Working status](https://ci-apps.yunohost.org/ci/badges/automad.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/automad.maintain.svg) [![Install Automad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=automad) *[Lire ce readme en français.](./README_fr.md)* @@ -23,29 +23,30 @@ A flat-file content management system and template engine ## Screenshots -![](./doc/screenshots/readme.png) +![Screenshot of Automad](./doc/screenshots/readme.png) ## Disclaimers / important information Create an user account in order to use the browser-based user interface called the Dashboard. Therefore navigate to `https://yoursite.com/dashboard` and follow the instructions. ## Documentation and resources -* Official app website: https://automad.org/ -* Official user documentation: https://automad.org/user-guide -* Official admin documentation: https://automad.org/getting-started -* Upstream app code repository: https://github.com/marcantondahmen/automad -* YunoHost documentation for this app: https://yunohost.org/app_automad -* Report a bug: https://github.com/YunoHost-Apps/automad_ynh/issues +* Official app website: +* Official user documentation: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/automad_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/automad_ynh/tree/testing --debug or sudo yunohost app upgrade automad -u https://github.com/YunoHost-Apps/automad_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 5e603f1..dfe4e9d 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # Automad pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/automad.svg)](https://dash.yunohost.org/appci/app/automad) ![](https://ci-apps.yunohost.org/ci/badges/automad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/automad.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/automad.svg)](https://dash.yunohost.org/appci/app/automad) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/automad.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/automad.maintain.svg) [![Installer Automad avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=automad) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer Automad rapidement et simplement sur un serveur YunoHost. Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* @@ -19,29 +23,30 @@ A flat-file content management system and template engine ## Captures d'écran -![](./doc/screenshots/readme.png) +![Capture d'écran de Automad](./doc/screenshots/readme.png) ## Avertissements / informations importantes Create an user account in order to use the browser-based user interface called the Dashboard. Therefore navigate to `https://yoursite.com/dashboard` and follow the instructions. ## Documentations et ressources -* Site officiel de l'app : https://automad.org/ -* Documentation officielle utilisateur : https://automad.org/user-guide -* Documentation officielle de l'admin : https://automad.org/getting-started -* Dépôt de code officiel de l'app : https://github.com/marcantondahmen/automad -* Documentation YunoHost pour cette app : https://yunohost.org/app_automad -* Signaler un bug : https://github.com/YunoHost-Apps/automad_ynh/issues +* Site officiel de l'app : +* Documentation officielle utilisateur : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/automad_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/automad_ynh/tree/testing --debug ou sudo yunohost app upgrade automad -u https://github.com/YunoHost-Apps/automad_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :**