From 80d89a6b90e1f4a0cb0806c3bacb11bf02692017 Mon Sep 17 00:00:00 2001
From: Pinga <121483313+getpinga@users.noreply.github.com>
Date: Tue, 2 Jan 2024 00:23:46 +0200
Subject: [PATCH] Update for documentation

---
 automation/config.php.dist |  2 +-
 docs/install.md            | 14 +++++++-------
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/automation/config.php.dist b/automation/config.php.dist
index c2b318a..d6f5649 100644
--- a/automation/config.php.dist
+++ b/automation/config.php.dist
@@ -50,7 +50,7 @@ return [
     'urs_imap_username' => 'your_username',
     'urs_imap_password' => 'your_password',
     
-    // Notifications Configuration
+    // Message Broker Configuration
     'mailer' => 'phpmailer', // sendgrid, mailgun are also available
     'mailer_api_key' => 'YOUR_API_KEY',
     'mailer_domain' => 'example.com',
diff --git a/docs/install.md b/docs/install.md
index a48237b..77010c9 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -419,9 +419,13 @@ This command will install one of the packages which are essential for the messag
 
 To set up automated tasks for Namingo, open the example crontab file located at ```/opt/registry/automation/crontab.example```. Review the contents and copy the relevant lines into your system's crontab file. Remember to adjust the paths and timings as necessary to suit your environment.
 
-### Running the `messagebroker.php` Script in the Background
+### Configuring the Message Broker
 
-To run the messagebroker.php script as a background process, execute the following command: ```/usr/bin/php /opt/registry/automation/messagebroker.php &```. This will start the script and place it in the background, allowing it to run independently of your current terminal session.
+You can easily configure the message broker for email delivery in ```config.php```. It is compatible with SendGrid, Mailgun API, and PHPMailer for those opting to use their own SMTP server. All necessary settings are conveniently located under the mailer_ lines within the file.
+
+For establishing your own mail server, Mox, available at [GitHub](https://github.com/mjl-/mox), provides a comprehensive solution. Install Mox following its GitHub instructions, then enter the required details in the ```config.php``` file.
+
+To run the messagebroker.php script, execute the following command: ```/usr/bin/php /opt/registry/automation/messagebroker.php &```. This will start the script and place it in the background, allowing it to run independently of your current terminal session.
 
 ### Setting Up an Audit Trail Database for Namingo
 
@@ -770,8 +774,4 @@ Run the monitoring tool using:
 prometheus --config.file=/etc/prometheus/prometheus.yml
 ```
 
-The tool will be available at ```http://<your_server_ip>:9090```
-
-## 16. Setup Mail Server:
-
-For establishing your own mail server, Mox, available at [Mox GitHub](https://github.com/mjl-/mox), provides a comprehensive solution. Install Mox following its GitHub instructions, then integrate with Namingo. This setup ensures a cohesive and efficient operation of your mail server.
\ No newline at end of file
+The tool will be available at ```http://<your_server_ip>:9090```
\ No newline at end of file