diff --git a/doc/examples.md b/doc/examples.md new file mode 100644 index 0000000..52b207f --- /dev/null +++ b/doc/examples.md @@ -0,0 +1,59 @@ +Example Configurations +====================== + + +Default Behavior +---------------- + +Most users that are new to ZNC Push expect to receive a push notification any +time they get mentioned in a channel or receive a private message. However, +by default, ZNC Push is configured to only send notifications when it's likely +that the user is either away from their computer, or not paying attention to +the conversation in question. This will ideally prevent you from getting +"spammed" with notifications every time you get mentioned or receive a PM, +especially when you are actively participating in discussion. + +### Configuration + + channel_conditions: all + query_conditions: all + + away_only: no + client_count_less_than: 0 + highlight: + idle: 0 + last_active: 180 + last_notification: 300 + replied: yes + +### Explanation + +The use of `channel_conditions: all` and `query_conditions: all` means that +ZNC Push will evaluate all of the other conditions, and require that all of +them "pass" in order for a notification to be sent. + +But the real key to understanding the default configuration is the use of +`last_active`, `last_notification`, and `replied` to try and determine if the +user is "active" in the conversation whenever they get highlighted or receive +a private message. + +* `last_active` looks for whether the user has performed an action that would + generall require direct involvement, such as sending a message to a channel, + sending a private message, or sending an action (`/me ...`). This is + specific to the context in which the user receives a message. So by default, + if the user gets highlighted or receives a private message, a notification + will only get sent if the user hasn't sent a message to that context in the + last 180 seconds (three minutes). + +* `last_notification` looks for the last time that a notification was sent to + the user. This is specific to the context in which a user receives a + message. So by default, if the user gets highlighted or receives a private + message, they will only get a notification if they haven't already received + a notification for that context within the last 300 seconds (five minutes). + +* `replied` looks to see if the user has responded since the last time a + notification was sent. This is specific to the context in which the user + receives a message. By default, if the user gets highlighted or receives a + private message, a notification is only sent if the user has not yet received + a notification for that context, or if they have gotten a notification and + have since responded to that context. diff --git a/doc/faq.md b/doc/faq.md new file mode 100644 index 0000000..20e5207 --- /dev/null +++ b/doc/faq.md @@ -0,0 +1,36 @@ +FAQ +=== + + +### Why don't I get notifications? + +Most users that are new to ZNC Push expect to receive a push notification any +time they get mentioned in a channel or receive a private message. However, +by default, ZNC Push is configured to only send notifications when it's likely +that the user is either away from their computer, or not paying attention to +the conversation in question. This will ideally prevent you from getting +"spammed" with notifications every time you get mentioned or receive a PM, +especially when you are actively participating in discussion. + +If you don't like this default behavior, then take a look either at the +[conditions section][conditions] of the readme, or read through the +[example configuration guide][examples]. ZNC Push is highly configurable. + +In some cases though, you may not receive notifications because your preferred +notification service is not configured correctly, or the service itself might +be having issues on their end. The easiest way to verify that ZNC Push is +configured correctly is by sending a test message: + + /msg *push send Test message + +If you see an error message like "secret not set", or something similar, then +you should verify that you've entered the appropriate value for that option. +The [push services section][services] of the readme has details on which +options are required for which notification services, and what values are +expected. + + + +[conditions]: ../README.md#conditions +[services]: ../README.md#push-services +[examples]: examples.md