Set up service-specific docs

Clean up new pushover docs from wolfdancer; import screenshots directly
into repo; move non-readme docs into doc; etc.
This commit is contained in:
John Reese 2013-09-09 11:36:27 -07:00
parent 897541a328
commit b0f35781e7
4 changed files with 26 additions and 7 deletions

View File

@ -1,5 +1,5 @@
ZNC Push 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 for any private message or channel highlight that matches a configurable set of
@ -78,7 +78,11 @@ At this point, it should start sending notifications every time you get a privat
or someone says your name in a channel. If this is everything you wanted, congratulations, or someone says your name in a channel. If this is everything you wanted, congratulations,
you're done! you're done!
**Here is the [documenation](pushover.md) specifically for [Pushover][] after you install the module.** For further, detailed instructions specific to each push notification service, the following
documentation is available:
* [Pushover](doc/pushover.md)
Commands Commands
-------- --------

View File

@ -1,43 +1,58 @@
ZNC Push via Pushover
=====================
This section contains the specific steps to configure for [Pushover][] after you install the This section contains the specific steps to configure for [Pushover][] after you install the
module by following the above steps. module by following the above steps.
Install Pushover Client with Registered Account Install Pushover Client with Registered Account
----------------------------- -----------------------------
Go to [Pushover.net](http://www.pushover.net) and sign up for a free account. Install one of the
[clients](https://pushover.net/clients) and make sure that you are logged in. After you log in from Go to [Pushover.net][Pushover] and sign up for a free account. Install one of the
[clients][] and make sure that you are logged in. After you log in from
the client, it will show up in the web UI. the client, it will show up in the web UI.
Name your device to something you prefer, e.g., iphone4. This will be the value for the "target" in· Name your device to something you prefer, e.g., iphone4. This will be the value for the "target" in
push configuration below push configuration below
You can also see your **user key** thorugh the web UI after you log in. Copy it down. This will be You can also see your **user key** thorugh the web UI after you log in. Copy it down. This will be
the value for "username" field in the push configuration below the value for "username" field in the push configuration below
Create an Application on Pushover Create an Application on Pushover
------------------------------- -------------------------------
Through pushover website, create an applicatino by clicking on the "Create" button and give it a name Through pushover website, create an applicatino by clicking on the "Create" button and give it a name
you prefer. You will come to the application detail page, which will have the **API Token/Key**. you prefer. You will come to the application detail page, which will have the **API Token/Key**.
Copy it down. This will be the value for "secret" field in the push configuration below. Copy it down. This will be the value for "secret" field in the push configuration below.
Configure push module Configure push module
----------------------------- -----------------------------
Following these steps in your IRC client that is connected to your bouncer: Following these steps in your IRC client that is connected to your bouncer:
* set secret to the **API Token/Key**: <code>/msg *push set secrete your-api-token-key</code> * set secret to the **API Token/Key**: <code>/msg *push set secrete your-api-token-key</code>
* set service to 'pushover': <code>/msg *push set service pushover</code> * set service to 'pushover': <code>/msg *push set service pushover</code>
* set target to your device name: <code>/msg *push set target iphone4</code> * set target to your device name: <code>/msg *push set target iphone4</code>
* set username to your **user key**: <code>/msg *push set username your-user-key</code> * set username to your **user key**: <code>/msg *push set username your-user-key</code>
You should be all set with the rest of the default. But here is how you can test it. You should be all set with the rest of the default. But here is how you can test it.
* Turn debug on in case of test failure: <code>/msg *push set debug on</code> * Turn debug on in case of test failure: <code>/msg *push set debug on</code>
* Send yourself a message: <code>/msg *push send test</code> * Send yourself a message: <code>/msg *push send test</code>
* You should see debugging message in the IRC channel. If it works, you should get a push notification * You should see debugging message in the IRC channel. If it works, you should get a push notification
on your phone. If not, the debugging message will give you more information on your phone. If not, the debugging message will give you more information
* Turn the debug off when you are done: <code>/msg *push set debug off</code> * Turn the debug off when you are done: <code>/msg *push set debug off</code>
Screenshots Screenshots
-------------------------------- --------------------------------
The following are the screenshots to illustrate how you can find out the information The following are the screenshots to illustrate how you can find out the information
![pushover1](https://f.cloud.github.com/assets/18065/1100408/3c6c3b98-175a-11e3-8d37-b42dc26924d4.png) ![pushover1](pushover1.png)
![pushover2](https://f.cloud.github.com/assets/18065/1100407/3c49eafc-175a-11e3-9377-0ee173d665f7.png) ![pushover2](pushover2.png)
[Pushover]: http://pushover.net [Pushover]: http://pushover.net
[clients]: http://pushover.net/clients

BIN
doc/pushover1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 339 KiB

BIN
doc/pushover2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 174 KiB