From c4af4157365711a6033a511406ec2bb29ffa80bf Mon Sep 17 00:00:00 2001
From: Fabian Affolter <fabian@affolter-engineering.ch>
Date: Sat, 22 Jan 2011 19:08:52 +0100
Subject: Small layout updates

---
 doc/server/plugins/misc/trigger.txt | 38 +++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 doc/server/plugins/misc/trigger.txt

(limited to 'doc')

diff --git a/doc/server/plugins/misc/trigger.txt b/doc/server/plugins/misc/trigger.txt
new file mode 100644
index 000000000..7547f2fdd
--- /dev/null
+++ b/doc/server/plugins/misc/trigger.txt
@@ -0,0 +1,38 @@
+.. -*- mode: rst -*-
+
+.. _server-plugins-misc-trigger:
+
+=======
+Trigger
+=======
+
+Trigger is a plugin that calls external scripts (on the server) when
+clients are configured.
+
+Setup
+=====
+
+First, add Trigger to the **plugins** line in ``bcfg2.conf``. Then do the
+following::
+
+    mkdir /var/lib/bcfg2/Trigger
+    echo "#!/bin/sh\necho $1\n" > /var/lib/bcfg2/Trigger/test.sh
+    chmod +x /var/lib/bcfg2/Trigger/test.sh
+
+Use cases
+=========
+
+#. Completing network builds (ie resetting from the build target to the
+   boot PXE target)
+#. Integration with external systems
+
+Trigger Arguments
+=================
+
+Triggers are run with a series of arguments.
+
+#. client hostname
+#. -p
+#. client profile
+#. -g
+#. group1:group2:..:groupN (all client groups)
-- 
cgit v1.2.3-1-g7c22