mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-30 14:56:50 +00:00
06a0287769
* Update doc for notify.xmpp Add new optional variable. * Small grammar changes * Removed extra space
43 lines
1.7 KiB
Markdown
43 lines
1.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "Jabber (XMPP)"
|
|
description: "Instructions how to add Jabber (XMPP) notifications to Home Assistant."
|
|
date: 2015-05-08 18:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: xmpp.png
|
|
ha_category: Notifications
|
|
ha_release: pre 0.7
|
|
---
|
|
|
|
|
|
The `xmpp` platform allows you to deliver notifications from Home Assistant to a [Jabber (XMPP)](http://xmpp.org) account.
|
|
|
|
To enable Jabber notifications in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
notify:
|
|
- name: NOTIFIER_NAME
|
|
platform: xmpp
|
|
sender: YOUR_JID
|
|
password: YOUR_JABBER_ACCOUNT_PASSWORD
|
|
recipient: YOUR_RECIPIENT
|
|
```
|
|
|
|
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.
|
|
- **recipient** (*Required*): The Jabber ID (JID) that will receive the messages.
|
|
- **tls** (*Optional*): Allow to disable TLS. Defaults to `true`.
|
|
- **verify** (*Optional*): Allow disabling SSL certificate validity check (e.g., self-signed certificate). Defaults to `true`.
|
|
- **room** (*Optional*): Room's name (e.g., example@conference.jabber.org). If set, send a message to chatroom instead of the sender.
|
|
|
|
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](/getting-started/automation/).
|