Enhancement of OCS Inventory Notifications Engine

This code represents an improvement of notification mechanism already present in OCS Inventory NG.

📝 Requirements:

For use this code, it's necessary the Docker's correlated package is installed in your machine. Thus, make sure:

• The docker main packages in your machine was installed.
• The docker-compose was installed, too.
• The current directory of work contains all files of here. These files are essecial for configuration of containers.

ℹ️ How to Use:

Once installed this preview packages and in possession of these files here, execute this following comands inside a directory that contains the config files aforementioned.

⚠️ Note, there is a dot in the final of below command. Remember, this dot represent a special directory on GNU/Linux system, that is, the itself directory.

$ sudo docker build -t ocsinventory-docker-image-ctic:2.8 .

⚠️ Before to execute the next command, don't forget to configure the database password credentials inside the docker-compose.yml file. These credentials are:

• OCS_DB_PASS
• MYSQL_ROOT_PASSWORD
• MYSQL_PASSWORD

$ sudo docker-compose up -d

These command will be building your base image of OCS Inventory application and make the deploy of this application in an new docker container. Furthermore, remember, this application bring with you a database. Therefore, a MySQL container will be building in this process.

If everything works as expected, the both containers, OCS application and MySQL, will be running !

For verify this, use this docker command below:

$ sudo docker ps -a

Acessing the OCS application

For acess the application, it's naturally necessary to know the IP address of the machine. Known this, in some browser, insert this URL:

http://IP_of_the_machine/ocsreports

And with this, you will be welcomed with a login screen. The default credentials is:

• user: admin
• password: admin

❗ It's no longer necessary to say the extremely required to change these credentials, once inside the system.

Configuring the credentials of notifications

Inside the system go to Configuration > Notifications. You will see this following page:

Some fields of this page is self explanatory. But is also important specify all these fields. Therefore:

• NOTIF_FOLLOW: A checklist to activate the notification by email.
• NOTIF_MAIL_ADMIN: Administrator mail to receive notifications.
• NOTIF_NAME_ADMIN: Username of administrator.
• NOTIF_SEND_MODE: Type of mail send mode. In the other words: With criptography(SSL | TLS) or not(Only SMTP). Remember, the most mail clients doesn't allowed send mails without some criptography. Thus, is extremely recommended to use SSL or TLS protocol in this process.
• NOTIF_SMTP_HOST: Your host smtp to send mail. e.g. smtp.gmail.com for google mails. Remember, if you pretend use an organization mail, consult your network admin for more information about SMTP host of its organization.
• NOTIF_PORT_SMTP: This field depends of protocol used in NOTIF_SEND_MODE. That is, if TLS is being used, then, the port number is 587. Else, if SSL is being used, then, the port number is 465.
• NOTIF_PASSWD_SMTP: Your password mail.

After finish this configuration remember to save in UPDATE.

Configuring the crontab

Now, it's necessary to configure the execution of script in crontab, that using these credentials afore configured to send the emails to administrator. Therefore, in the line showed below, there is an example of crontab line that can be insert in your machine crontab file of docker host.

0 11 * * 1-6 root docker exec container-id php73 /usr/share/ocsinventory-reports/ocsreports/require/components/cron_mailer.php

ℹ️ The line above means that crontab will be executed the php script cronmailer.php every 11:00 a.m from Monday to Friday.

⚠️ Remember to change the container-id of the line above by the container ID of your OCS application.