Skip to content

Commit 458c969

Browse files
committed
Merge pull request home-assistant#331 from robbiet480/gntp
Add GNTP documentation
2 parents cca8120 + 387686f commit 458c969

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
layout: page
3+
title: "GNTP (Growl)"
4+
description: "Instructions for adding GNTP/Growl notifications to Home Assistant."
5+
date: 2016-03-25 18:18
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: gntp.png
11+
ha_category: Notifications
12+
---
13+
14+
15+
[GNTP](http://www.growlforwindows.com/gfw/help/gntp.aspx) is a specification for sending and receiving notifications between computers. The most well known server implementations are [Growl](http://growl.info) for Mac and [Growl for Windows](http://www.growlforwindows.com/gfw/).
16+
17+
To use GNTP notifications, add the following to your `configuration.yaml` file:
18+
19+
```yaml
20+
# Example configuration.yaml entry
21+
notify:
22+
name: NOTIFER_NAME
23+
platform: gntp
24+
```
25+
26+
GNTP will attempt to connect to a local server running on port 23053 if no `hostname` is provided.
27+
28+
Configuration variables:
29+
30+
- **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`.
31+
- **app_name** (*Optional*): The application name that will be displayed on every notification and will be registered with the server.
32+
- **app_icon** (*Optional*): The icon that will be displayed on every notification. You can provide a HTTP URL or a `file://` URL. File URLs only work if Home Assistant and the GNTP server are running on the same machine. If no `app_icon` is set a local copy of the Home Assistant logo will be used. If you choose to use a HTTP URL please make the maximum image size 150 px by 150 px as Growl for Mac will sometimes timeout when registering.
33+
- **hostname** (*Optional*): The hostname or IP address of the GNTP server to contact.
34+
- **password** (*Optional*): The password to authenticate to the GNTP server with.
35+
- **port** (*Optional*): The port that the GNTP server runs on. The specification states that servers should not allow users to use any port other than 23053 but `port` is provided here just in case.
71.3 KB
Loading

0 commit comments

Comments
 (0)