About

Thank you for installing the Ginger Technology service checking system. Below is documentation on the current modules that I provide and how to use them.

To add a check, edit /etc/gingertechengine/checks.json and add a new block (or replace on of the example ones). The format is:

{
    "title": "The title of the check",
    "command": "The command to run. For example 'echo 0'. Note that these commands will not be forced to exit, they'll run until they end.",
    "expected": "The expected output of that command.",
    "good": false,
    "asof": ""
}
    

Currently I have built modules to check SSH, FTP, POP3, SMTP, and DNS. The MySQL plugin is currently broken. These are stored in /usr/lib/gingertechengine/plugins, and examples of the usage is available by running them with the --help flag, or by looking in /etc/gingertechengine/example.json.

Commands will be written as the gogios user, who by default has no root privileges. If possible, I suggest keeping it that way.

---