summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authormortzu <mortzu@users.noreply.github.com>2017-11-08 22:48:51 +0100
committerNeil Lathwood <neil@lathwood.co.uk>2017-11-08 21:48:51 +0000
commit853480fca54492a38feaa4fa76941e88f54f11a8 (patch)
treeab35a950fb20994efe1d854df02858bc6793c472 /docs
parentb19721a62aff7112c891ef13ebaa4fa944d6cb5b (diff)
feature: Added hook for XMPP MUC (#951)
* Added hook for XMPP MUC * Updated dockerfile * Added timeout to prevent oxidized to stop on XMPP error * Updated README
Diffstat (limited to 'docs')
-rw-r--r--docs/Hooks.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/Hooks.md b/docs/Hooks.md
index 12e3ab7..bf6ea54 100644
--- a/docs/Hooks.md
+++ b/docs/Hooks.md
@@ -141,3 +141,28 @@ hooks:
```
Note the channel name must be in quotes.
+
+## Hook type: xmppdiff
+
+The `xmppdiff` hook posts config diffs to a [XMPP](https://en.wikipedia.org/wiki/XMPP) chatroom of your choice. It only triggers for `post_store` events.
+
+You will need to manually install the `xmpp4r` gem on your system:
+
+```
+gem install xmpp4r
+```
+
+Configuration example:
+
+``` yaml
+hooks:
+ slack:
+ type: xmppdiff
+ events: [post_store]
+ jid: "user@server.tld/resource"
+ password: "password"
+ channel: "room@server.tld"
+ nick: "nickname"
+```
+
+Note the channel name must be in quotes.