zydronium/getnamingo-registry
1
0
Fork 0
mirror of https://github.com/getnamingo/registry.git synced 2025-06-29 07:33:27 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update for documentation

Browse source
This commit is contained in:
Pinga 2024-01-02 00:23:46 +02:00
parent 85f247773e
commit 80d89a6b90
2 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
automation/config.php.dist
View file

@ -50,7 +50,7 @@ return [
'urs_imap_username' => 'your_username', 'urs_imap_username' => 'your_username',
'urs_imap_password' => 'your_password', 'urs_imap_password' => 'your_password',
// Notifications Configuration // Message Broker Configuration
'mailer' => 'phpmailer', // sendgrid, mailgun are also available 'mailer' => 'phpmailer', // sendgrid, mailgun are also available
'mailer_api_key' => 'YOUR_API_KEY', 'mailer_api_key' => 'YOUR_API_KEY',
'mailer_domain' => 'example.com', 'mailer_domain' => 'example.com',

12
docs/install.md
View file

@ -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. 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 ### Setting Up an Audit Trail Database for Namingo
@ -771,7 +775,3 @@ prometheus --config.file=/etc/prometheus/prometheus.yml
``` ```
The tool will be available at ```http://<your_server_ip>:9090``` 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.