More doc updates.

etsy · Jun 6, 2014 · 29f8554 · 29f8554
1 parent 8562c4c
commit 29f8554
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/docs/formatters.md b/docs/formatters.md
@@ -79,7 +79,10 @@ end
 
 ### Naming Convention
 
-* Formatters live in ``lib/nagios-herald/formatters/``.
+* Built-in formatters live in ``lib/nagios-herald/formatters/``.
+* Custom formatters (those **you'll** write) can live in any location.
+ * Specify the location of your custom formatters via the ``--formatter-dir`` option
+ on the command line or the ``formatter_dir`` variable in the configuration file.
 * The file names **MUST** lower-cased and underscored.
 * The class names **MUST** be CamelCased.
 

diff --git a/docs/nagios-config.md b/docs/nagios-config.md
@@ -15,9 +15,10 @@ define command {
     command_line    /usr/local/nagios-herald/bin/nagios-herald --message-type email --formatter=$_HOSTMESSAGE_FORMATTER_NAME$ --nagios-cgi-url=http://nagios.example.com/nagios/cgi-bin/cmd.cgi --reply-to=nagios@example.com
 }
 
+# specify the location of custom formatters
 define command {
     command_name    notify-service-by-email
-    command_line    /usr/local/nagios-herald/bin/nagios-herald --message-type email --formatter=$_SERVICEMESSAGE_FORMATTER_NAME$ --nagios-cgi-url=http://nagios.example.com/nagios/cgi-bin/cmd.cgi --reply-to=nagios@example.com
+    command_line    /usr/local/nagios-herald/bin/nagios-herald --message-type email --formatter=$_SERVICEMESSAGE_FORMATTER_NAME$ --nagios-cgi-url=http://nagios.example.com/nagios/cgi-bin/cmd.cgi --reply-to=nagios@example.com --formatter-dir=/usr/local/nagios-herald-formatters
 }
 
 # pager
@@ -51,7 +52,7 @@ If ``nagios-herald`` is failing to notify, you can turn up the logging via the `
 more information, like so:
 
 ```
-    command_line    /usr/local/nagios-herald/bin/nagios-herald --message-type email --formatter=$_SERVICEMESSAGE_FORMATTER_NAME$ --nagios-cgi-url=http://nagios.example.com/nagios/cgi-bin/cmd.cgi --reply-to=nagios@example.com --trace
+command_line    /usr/local/nagios-herald/bin/nagios-herald --message-type email --formatter=$_SERVICEMESSAGE_FORMATTER_NAME$ --nagios-cgi-url=http://nagios.example.com/nagios/cgi-bin/cmd.cgi --reply-to=nagios@example.com --trace
 ```
 
 ## Service Configuration