Installing DirX Audit System Services

The installed tools and containers (Message Broker and Server) are set up to be started as system services so that they start automatically on system start-up (on default settings). This option is available on both supported Windows and UNIX platforms. There is also the configuration option to disable the automatic startup service start and select the manual start, which means that the user will need to launch the service manually in order to be able to use it.

The services are installed by the configuration procedure. This chapter describes how to perform this step manually on the Linux platform if you cannot or do not want to do it with the configurator (e.g., you cannot run it as root). The service for Tomcat, which is used as a container for the DirX Audit Manager application, is configured using Tomcat native tools and configuration; for example, see http://tomcat.apache.org/tomcat-9.0-doc/setup.html.

Warning: You must configure DirX Audit before you start the services or restart the system. Starting the services or restarting the system without first configuring DirX Audit will create an inconsistent installation that you will need to reconfigure manually to restore to proper operation. See the chapter “Configuring DirX Audit” for instructions.

Linux

The operating system must use systemd to run system services.

To install the DirX Audit applications as system services:

  1. Update the startup scripts to use the correct paths and other properties.

  2. Register the service within the system.

The startup scripts are located at:

  • Message broker:
    install_path/message_broker/bin/service/linux_x86_64/dirx-audit-messagebroker

  • Server container (per tenant):
    install_path/server_container/tenants/tenantID/bin/dirx-audit-server-container

In each file, update values by checking and correcting the properties in this file. You need to fill in at least the correct values (user and group name) into the properties RUN_AS_USER and RUN_AS_GROUP or comment them out.

To install the service, run the following command in a shell as root:
pathToServiceScript install

where pathToServiceScript is the path to the updated startup script (see the location information in this section for the paths and names).

Example (replace 4f753e1d-d0de-4aef-bb22-caace7342e99 with the correct tenant ID):
install_path/message_broker/bin/service/linux_x86_64/dirx-audit-messagebroker install

install_path/server_container/tenants/4f753e1d-d0de-4aef-bb22-caace7342e99/bin/dirx-audit-server-container install

Once the service is successfully installed, you can start and stop the service or get its status via the
systemctl command (adjust the service name if you modified the default value in the script file, replace 4f753e1d-d0de-4aef-bb22-caace7342e99 with the correct tenant ID):

systemctl start dirx-audit-messagebroker.service

systemctl stop dirx-audit-messagebroker.service

systemctl status dirx-audit-messagebroker.service

systemctl start dirx-audit-server-4f753e1d-d0de-4aef-bb22-caace7342e99.service

systemctl stop dirx-audit-server-4f753e1d-d0de-4aef-bb22-caace7342e99.service

systemctl status dirx-audit-server-4f753e1d-d0de-4aef-bb22-caace7342e99.service

To unregister the service from the system, run the init script with the remove command:
pathToServiceScript remove

Important: If you installed the services manually, you must manually stop and unregister the services before you start the uninstallation procedure.