README.Debian: Be a bit more verbose about how to setup Gearman mode.

[pkg-pnp4nagios.git] / debian / README.Debian

diff --git a/debian/README.Debian b/debian/README.Debian
index 5364f0a5a9f1397c493ca89387d4d549e8d73217..7e746239ef4674789683ae8c363c418e2e3726a5 100644 (file)
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -42,10 +42,28 @@ Using Gearman mode
 ------------------
 
 Starting with version 0.6.12, PNP4Nagios may operate as a Gearman worker. This
-is useful in large, distributed setups using Nagios's mod_gearman. To enable
-the PNP Gearman worker, set 'RUN' to 'yes' in /etc/default/pnp_gearman_worker.
-Also, you'll need a running mod_gearman environment. See
+is useful in large, distributed setups using Nagios's mod_gearman. To use
+the PNP Gearman worker, you'll need a running mod_gearman environment. See
 <http://labs.consol.de/lang/en/nagios/mod-gearman/> for detailed setup
 instructions.
 
+In addition, the following configuration is required to get you started:
+
+- Enable processing of performance data in Nagios: set
+  'process_performance_data=1' in "/etc/nagios3/nagios.cfg" and reload your
+  Nagios server: /etc/init.d/nagios3 reload.
+
+- Enable the PNP Gearman worker daemon by setting 'RUN' to 'yes' in
+  /etc/default/pnp_gearman_worker. Check the Gearman related options in
+  "/etc/pnp4nagios/process_perfdata.cfg" (GEARMAN_HOST and encryption
+  settings) and start the Gearman worker: /etc/init.d/pnp_gearman_worker start
+
+- Enable distribution of performance data in mod_gearman by setting the
+  'perfdata=yes' option.
+
+When operating in Gearman mode, process_perfdata.pl requires the
+Gearman::Worker, MIME::Base64, and Crypt::Rijndael Perl modules. These are
+available in the libgearman-client-perl, perl, and libcrypt-rijndael-perl
+Debian packages (see packages suggested by pnp4nagios-bin).
+
  -- Sebastian Harl <tokkee@debian.org>  Wed, 27 Apr 2011 09:32:52 +0200