Docs
Administration

Command line

The 3rmonitor command on the master and on agent servers, and where the logs are.

The installer puts the 3rmonitor command in /usr/local/bin, and since 1.1.1 also in /usr/bin, where sudo finds it on AlmaLinux, Rocky, RHEL and CentOS too (see Troubleshooting for older versions). Most commands need root: run them with sudo. Commands that read a configuration file accept -c CONFIG to use another file than the default (/etc/3rmonitor/master.conf or /etc/3rmonitor/agent.conf). 3rmonitor --help lists them in your language.

Any server

3rmonitor status        # installation mode and status of the services on this server
3rmonitor version       # installed version

On the master

sudo 3rmonitor user list                       # panel accounts and last sign-in
sudo 3rmonitor user add alice                  # add an account (asks for the password)
sudo 3rmonitor user passwd admin               # reset a forgotten password
sudo 3rmonitor user del alice                  # delete an account
sudo 3rmonitor server list                     # registered servers
sudo 3rmonitor server add --name web-2 --group Production   # register a server and print its token
sudo 3rmonitor mail-test --to me@example.com   # send a test email with the panel's SMTP settings

On an agent server

sudo 3rmonitor agent --print       # collect this server's data once and print it, without reporting (for troubleshooting)
sudo 3rmonitor agent --test        # enroll if needed, report once now and show the result
sudo 3rmonitor bind --master URL --token TOKEN     # point the agent to another master, or use a new token
sudo 3rmonitor bind --master URL --enroll KEY --name web-2 --group Production   # same, with an enrollment key
sudo 3rmonitor inventory           # print the software inventory used for vulnerability checks (not reported)
sudo 3rmonitor firewall status     # show this server's blocklist / allowlist rules
sudo 3rmonitor firewall off        # remove the blocking rules now and stop enforcing them (if you are locked out)
sudo 3rmonitor firewall on         # let the panel manage the rules again

bind also accepts --insecure for a master with a self-signed certificate.

The agent's user and the AI

sudo 3rmonitor agent secure        # run the agent as the unprivileged user 3rmonitor-agent, with the root helper
sudo 3rmonitor ai status           # what the panel's AI may run on this server
sudo 3rmonitor ai off              # the AI runs nothing here
sudo 3rmonitor ai read             # only read-only and sandboxed diagnostics
sudo 3rmonitor ai on               # also approved repairs (the default)
sudo 3rmonitor approvers list      # the keys this server trusts for AI approvals
sudo 3rmonitor approvers trust     # trust the master's signing key and the administrators' passkeys (compare the fingerprints)
sudo 3rmonitor approvers reset     # trust no key any more
  • agent secure is done by the installer, and by older agents when they update themselves. Run it by hand if the installer reported that it failed. See AI on-call.
  • ai off, ai read and ai on are written to agent.conf (ai = off | read | on) and restart the agent. The agent itself can't change them. High-risk commands are never run by the AI, whatever you choose.
  • approvers trust accepts --master-key FP --approvers FP,… to trust without questions, as the install command does. See Passkeys.

Services and logs

ServiceWhat it is
3rmonitor-masterThe master: panel, checks and emails
3rmonitor-agentThe agent, running as the unprivileged user 3rmonitor-agent
3rmonitor-helperThe agent's root helper: the collectors that need root, the blocklist firewall, agent updates, and the final check and execution of AI operations
3rmonitor-update.path / 3rmonitor-update.serviceInstalls the updates started from the panel
sudo systemctl status 3rmonitor-master
sudo systemctl restart 3rmonitor-master      # after editing master.conf
sudo systemctl restart 3rmonitor-agent       # after editing agent.conf
journalctl -u 3rmonitor-master -f            # master log
journalctl -u 3rmonitor-agent -f             # agent log
journalctl -u 3rmonitor-agent -n 50          # last 50 lines
journalctl -u 3rmonitor-helper -f            # root helper log (AI operations, firewall, updates)

Installer

Run from the release package directory, or from /opt/3rmonitor for uninstall:

sudo bash install.sh                                # interactive menu
sudo bash install.sh both|master|agent [options]    # install
sudo bash install.sh upgrade                        # upgrade, keeping configuration and data
sudo bash /opt/3rmonitor/install.sh uninstall [--purge]
sudo bash install.sh --help                         # all options

See Install the master for every option.

The commands use the terminal's language; see Languages.

On this page