From 3112ba558c4a05a20d382cef8f78653fb0a64d71 Mon Sep 17 00:00:00 2001 From: Lucian Pricop Date: Wed, 29 Jun 2022 13:42:57 +0300 Subject: [PATCH] Update README.md A few updates to wording --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index aed3165..1f627f2 100644 --- a/README.md +++ b/README.md @@ -56,11 +56,11 @@ Here's how the email subject should look like if you want to set a due date to t ## Requirements This app requires php-curl, php-mbstring ,php-imap and some sort of imap server (e.g. Postfix with Courier). ## NC new user -Create a new user from User Management on your NC server, which will have to function as a bot. We chose to call him *deckbot*, but you can call it however you want.
-__Note__: that you have to assign *deckbot* on each board you want to add new cards from email. +Create a new user from User Management on your NC server, which shall to function as a bot to post cards received as mail. We chose to call it *deckbot*, but you can call it whatever you want.
+__Note__: that you have to give *deckbot* permissions on each board you want to add new cards from email. ## Configure Email ### Option 1 - Set up Postfix for incoming email -You can setup Posfix mail server folowing the instructions on [Posfix setup](https://docs.gitlab.com/ee/administration/reply_by_email_postfix_setup.html), and after that add "+" delimiter (which separe the user from the board in the email address) using the command:
+You can setup Posfix mail server folowing the instructions on [Posfix setup](https://docs.gitlab.com/ee/administration/reply_by_email_postfix_setup.html), and after that add "+" delimiter (which separates the user from the board name in the email address) using the command:
``` sudo postconf -e "recipient_delimiter = +" ``` @@ -81,11 +81,11 @@ cp config.example.php config.php sudo vim config.php ``` *You can refer to https://www.php.net/manual/en/function.imap-open.php for setting the value of MAIL_SERVER_FLAGS* -#### Add a cronjob which will run mail2deck. +#### Add a cronjob to run mail2deck. ``` sudo crontab -u incoming -e ``` -Add the following line in the opened file: +Add the following line in the opened file (in this example, it runs every 5 minutes): */5 * * * * /usr/bin/php /home/incoming/mail2deck/index.php >/dev/null 2>&1 ### Docker installation