SeanOMik
/
znc-push
mirror of https://github.com/SeanOMik/znc-push.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated readme with support for Nexmo configurations

This commit is contained in:
Erhan Justice 2014-10-16 04:26:31 -07:00 committed by John Reese
parent ff4518cad8
commit aba8e6003d
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -2,7 +2,7 @@ ZNC Push
======== ========
ZNC Push is a module for [ZNC][] that will send notifications to multiple push notification ZNC Push is a module for [ZNC][] that will send notifications to multiple push notification
services for any private message or channel highlight that matches a configurable set of services, or SMS for any private message or channel highlight that matches a configurable set of
conditions. ZNC Push current supports the following services: conditions. ZNC Push current supports the following services:
* [Boxcar][] * [Boxcar][]
@ -14,6 +14,7 @@ conditions. ZNC Push current supports the following services:
* [PushBullet][] * [PushBullet][]
* [Airgram][] * [Airgram][]
* [Faast][] * [Faast][]
* [Nexmo][]
* Custom URL GET requests * Custom URL GET requests
This project is still a Work In Progress, but should be functional enough and stable enough This project is still a Work In Progress, but should be functional enough and stable enough
@ -96,8 +97,7 @@ options across multiple networks, load it like this:
/msg *status loadmod --type=user push /msg *status loadmod --type=user push
Or you can use either the web admin page for the user to enable the "push" module, or you can If you prefer to use ZNC's "controlpanel" module, you may do so like this:
use ZNC's "controlpanel" module:
/msg *status loadmod controlpanel /msg *status loadmod controlpanel
/msg *controlpanel loadmod push /msg *controlpanel loadmod push
@ -232,13 +232,14 @@ to something similar to "http://domain/#channel/2011-03-09 14:25:09", or
* `supertoasty` * `supertoasty`
* `pushbullet` * `pushbullet`
* `airgram` * `airgram`
* `nexmo`
* `<url>` * `<url>`
* `username` Default: ` ` * `username` Default: ` `
User account that should receive push notifications. User account that should receive push notifications.
This option must be set when using Boxcar or Pushover. For Airgram authenticated services, this is the service key. This option must be set when using Boxcar, or Pushover. For Airgram authenticated services and Nexmo, this is the service/api key.
When using the custom URL service, if this option is set it will enable HTTP basic When using the custom URL service, if this option is set it will enable HTTP basic
authentication and be used as username. authentication and be used as username.
@ -247,7 +248,7 @@ to something similar to "http://domain/#channel/2011-03-09 14:25:09", or
Authentication token for push notifications. Authentication token for push notifications.
This option must be set when using Notify My Android, Pushover, Prowl, Supertoasty, Airgram authenticated services, or PushBullet. This option must be set when using Notify My Android, Pushover, Prowl, Supertoasty, Airgram authenticated services, PushBullet, or Nexmo.
When using the custom URL service, if this option is set it will enable HTTP basic When using the custom URL service, if this option is set it will enable HTTP basic
authentication and be used as password. authentication and be used as password.
@ -259,6 +260,8 @@ to something similar to "http://domain/#channel/2011-03-09 14:25:09", or
When using Pushover, this option allows you to specify a single device name to send When using Pushover, this option allows you to specify a single device name to send
notifications to; if blank or unset, notifications will be sent to all devices. notifications to; if blank or unset, notifications will be sent to all devices.
When using Nexmo, this option allows you to specify the SMS destination number. The number must be in international format.
This option must be set when using PushBullet and Airgram. This module supports both `device_id` (older, numeric id) and the `device_iden` (newer, alphanumeric id) used by PushBullet. You can find your `device_iden` by navigating to a device page and noting the last part of the URL. When using Airgram, this is the email address of the end user. This option must be set when using PushBullet and Airgram. This module supports both `device_id` (older, numeric id) and the `device_iden` (newer, alphanumeric id) used by PushBullet. You can find your `device_iden` by navigating to a device page and noting the last part of the URL. When using Airgram, this is the email address of the end user.
@ -284,6 +287,8 @@ to something similar to "http://domain/#channel/2011-03-09 14:25:09", or
Title that will be provided for the push notification. Keyword expansion is performed Title that will be provided for the push notification. Keyword expansion is performed
on this value. on this value.
When using Nexmo, this value is where the SMS is "from". In most cases, you must use a valid number in international format.
* `message_uri` Default: ` ` * `message_uri` Default: ` `
URI that will be sent with the push notification. This could be a web address or a URI that will be sent with the push notification. This could be a web address or a
@ -469,6 +474,7 @@ This project is licensed under the MIT license. See the `LICENSE` file for deta
[PushBullet]: https://www.pushbullet.com/ [PushBullet]: https://www.pushbullet.com/
[Airgram]: http://airgramapp.com/ [Airgram]: http://airgramapp.com/
[Faast]: http://faast.io/ [Faast]: http://faast.io/
[Nexmo]: https://www.nexmo.com
[issues]: http://github.com/jreese/znc-push/issues [issues]: http://github.com/jreese/znc-push/issues
[ZNC]: http://en.znc.in "ZNC, an advanced IRC bouncer" [ZNC]: http://en.znc.in "ZNC, an advanced IRC bouncer"