Skip to content
This repository has been archived by the owner on Jun 13, 2020. It is now read-only.

Commit

Permalink
Updating the docs for custom helpers
Browse files Browse the repository at this point in the history
  • Loading branch information
Katherine Daniels committed Apr 19, 2016
1 parent e834a01 commit 05d634e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ should they arise. If **nagios-herald** isn't sending notifications, **it's a bu
details. Optionally, setting ``trace`` to **true** (equivalent to ``--trace`` on the command line) will
provide a backtrace to aid in debugging.

Similar to the ``formatter_dir`` option, ``message_dir`` and ``helper_dir`` can be used to specify
locations of **your custom message classes and helper classes**, respectively. These classes will get
loaded in addition to default messages and helpers.

### Icinga Support

``nagios-herald`` relies on the environment variables set when a notification is sent.
Expand Down
2 changes: 1 addition & 1 deletion docs/helpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You may write your own helpers and use them with nagios-herald. These helper cl

### Custom Helper Configuration

To use a custom helper, you must add the --helper-dir flag to any stanzas in ``commands.cfg`` that will use that helper class. ``helper-dir`` specifies the directory in which your custom helper class is stored.
To use a custom helper, you must add the --helper-dir flag to any notification command stanzas in ``commands.cfg`` that will use that helper class. ``helper-dir`` specifies the directory in which your custom helper class is stored. You can also define the location of custom helper classes in the ``config.yml`` configuration file.

```
# notify by carrier pigeon
Expand Down

0 comments on commit 05d634e

Please sign in to comment.