NXLog Documentation

NXLog Agent Minder Command line options

The server can be started from the command line by typing the following.

start command
MINDER_LOG=info minder --api-addr 0.0.0.0:8080 --agent-addr 0.0.0.0:4041 --connect-to 1.2.3.4:8080 --cert /path/to/certificate.pem --key /path/to/private/key.pem

The recommended method for starting and stopping minder is via systemd. The package comes with a pre-configured unit file.

systemctl start minder.service

Logging configuration is stored in the file /opt/minder/conf/MINDER_LOG. The file contains an environment variable.

MINDER_LOG=info
Table 1. command line options
option description

--log LOGLEVEL

specify the desired log level for minder, as one of error, warn, info, debug or trace

--log-config configuration_file

the file specifies should hold the logging settings in log4rs configuration format

--api-addr 0.0.0.0:8080

where the public API should listen (default value: 0.0.0.0:8080)

--api-creds USER[:PASSWORD]

credentials to access public API (no authentication required if unspecified)

--api-cert FILE (default value: ROOT_DIR\conf\cert\api-cert.pem)

specify the path to the certificate for the public API

--api-key FILE (default value: ROOT_DIR\conf\cert\api-key.pem)

specify the path to the private key for the public API

--agent-addr 0.0.0.0:4041

where NXLog Agent Minder listens for incoming agent connections (default value: 0.0.0.0:4041)

--connect-to 1.2.3.4:8080

agents in listening-mode for NXLog Agent Minder to connect to

--cert FILE (default value: ROOT_DIR\conf\cert\minder-cert.pem)

specify the path to the certificate for the server

--key FILE (default value: ROOT_DIR\conf\cert\minder-key.pem)

specify the path to the private key for the server

--ca-cert FILE (default value: ROOT_DIR\conf\PKI\ca-cert.pem)

specify the path to the CA certificate for the server

--ca-key FILE (default value: ROOT_DIR\conf\PKI\ca-key.pem)

specify the path to the CA private key for the server

--ca-pass PASSPHRASE

passphrase for the CA private key for the server if it’s encrypted

--probe-period PROBE_PERIOD

period (in seconds) with which to probe connected agents; accepted value: 60-1200s (from 1 to 20 minutes); defaults to 60s

--root_dir DIR (default value: /opt/minder on Unix-like platforms or C:\Program Files\minder on Windows)

specify the root directory of the minder’s file hierarchy; directories like ROOT_DIR/conf/cert should exist