diff --git a/Notify_growl.md b/Notify_growl.md new file mode 100644 index 0000000..9ba367d --- /dev/null +++ b/Notify_growl.md @@ -0,0 +1,32 @@ +## Growl Notifications +* **Source**: http://growl.info/ +* **Icon Support**: Yes +* **Message Format**: Text +* **Message Limit**: 32768 Characters per message + +Growl requires this script to pre-register the notifications it sends before being able to actually send something. Make sure you are configured to allow application registration! + +### Syntax +Valid syntaxes are as follows: +* **growl**:://**{hostname}** +* **growl**:://**{hostname}**:**{port}** +* **growl**:://**{password}**@**{hostname}** +* **growl**:://**{password}**@**{hostname}**:**{port}** + +Depending on the version of your Apple OS, you may wish to enable the legacy protocol version (v1.4) as follows if you have problems receiving the icon in version 2 (the default): +* **growl**://**{password}**@**{hostname}**?version=**1** + +### Parameter Breakdown +| Variable | Required | Description +| ----------- | -------- | ----------- +| hostname | Yes | The server Growl server is listening on. +| port | No | The port Growl Server is listening on. By default the port is **23053**. You will probably never have to change this. +| password | No | The password associated with the Growl server if you set one up. +| version | No | The default version is 2, but you can specify the attribute ?version=1 if you would require the 1.4 version of the protocol. + +#### Example +Send a Growl notification to our server +```bash +# Assuming our {hostname} is growl.server.local +notify.py growl://growl.server.local +``` \ No newline at end of file