jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update configuration variables section (#6742)

Browse Source
This commit is contained in:
Fabian Affolter 2018-10-13 12:10:13 +02:00 committed by GitHub
parent 9db4d711a0
commit f495cd1dc7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 41 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
source/_components/notify.xmpp.markdown
View File

@ -13,7 +13,9 @@ ha_release: pre 0.7
--- ---
The `xmpp` platform allows you to deliver notifications from Home Assistant to a [Jabber (XMPP)](http://xmpp.org) account. The `xmpp` notification platform allows you to deliver notifications from Home Assistant to a [Jabber (XMPP)](http://xmpp.org) account.
## {% linkable_title Configuration %}
To enable Jabber notifications in your installation, add the following to your `configuration.yaml` file: To enable Jabber notifications in your installation, add the following to your `configuration.yaml` file:
@ -27,21 +29,47 @@ notify:
recipient: YOUR_RECIPIENT recipient: YOUR_RECIPIENT
``` ```
Configuration variables: {% configuration %}
name:
- **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`. description: "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, e.g. your_name@jabber.org. required: false
- **resource** (*Optional*): Resource part of JID. (e.g. your_name@jabber.org/`HA-cabin`, defaults to `home-assistant`) type: string
- **password** (*Required*): The password for your given Jabber account. default: Random Sensor
- **recipient** (*Required*): The Jabber ID (JID) that will receive the messages. sender:
- **tls** (*Optional*): Force TLS. Defaults to `true`. description: "The Jabber ID (JID) that will act as origin of the messages. Add your JID including the domain, e.g. your_name@jabber.org."
- **verify** (*Optional*): Allow disabling SSL certificate validity check (e.g., self-signed certificate). Defaults to `true`. required: true
- **room** (*Optional*): Room's name (e.g., example@conference.jabber.org). If set, send a message to chatroom instead of the recipient. type: string
resource:
description: "Resource part of JID, e.g., your_name@jabber.org/`HA-cabin`."
required: false
type: string
default: home-assistant
password:
description: The password for your given Jabber account.
required: true
recipient:
description: The Jabber ID (JID) that will receive the messages.
required: true
tls:
description: Force TLS.
required: false
type: boolean
default: true
verify:
description: Allow disabling SSL certificate validity check, e.g., self-signed certificate.
required: false
type: boolean
default: true
room:
description: Room's name (e.g., example@conference.jabber.org). If set, send a message to chatroom instead of the recipient.
required: false
type: string
{% endconfiguration %}
<p class='note'> <p class='note'>
Pre Home-Assistant 0.80 `sleekxmpp` was used to connect to XMPP-servers. Sleekxmpp as of version 1.3.2, does not support >TLS1. If you are running your own XMPP server (e.g. Prosody, ejabberd) make sure to allow using TLS1. Pre Home Assistant 0.81 `sleekxmpp` was used to connect to XMPP servers. `sleekxmpp` as of version 1.3.2, does not support > TLS v1. If you are running your own XMPP server (e.g., Prosody, ejabberd) make sure to allow using TLS v1.
Home-Assistant after 0.80 uses `slixmpp`, which also supports TLSv1.1 and TLSv1.2. Home Assistant after 0.81 uses `slixmpp`, which also supports TLS v1.1 and TLS v1.2.
</p> </p>
All Jabber IDs (JID) must include the domain. Make sure that the password matches the account provided as sender. All Jabber IDs (JID) must include the domain. Make sure that the password matches the account provided as sender.