From a5d25d3d6391c66afc5c0dc59af6e1b608336e50 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 13 Oct 2015 22:07:04 +0200 Subject: [PATCH] Add variable description --- source/components/notify.xmpp.markdown | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/source/components/notify.xmpp.markdown b/source/components/notify.xmpp.markdown index 11d251c3b4f..a622df258d6 100644 --- a/source/components/notify.xmpp.markdown +++ b/source/components/notify.xmpp.markdown @@ -22,10 +22,14 @@ notify: recipient: YOUR_RECIPIENT ``` -Setting the optional parameter `name` allows multiple notifiers to be created. -The default value is `notify`. The notifier will bind to the service -`notify.NOTIFIER_NAME`. +Configuration variables: + +- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. +- **sender** (*Required*): The Jabber ID (JID) that will act as origin of the messages. Add your JID including the domain, eg. your_name@jabber.org. +- **password** (*Required*): The password for your given Jabber account. +- **priority** (*Required*): The Jabber ID (JID) that will receive the messages. All Jabber IDs (JID) must include the domain. Make sure that the password matches the account provided as sender. + To use notifications, please see the [getting started with automation page]({{site_root}}/components/automation.html).