summaryrefslogtreecommitdiffstats
path: root/health/notifications/irc
diff options
context:
space:
mode:
Diffstat (limited to 'health/notifications/irc')
-rw-r--r--health/notifications/irc/README.md20
1 files changed, 9 insertions, 11 deletions
diff --git a/health/notifications/irc/README.md b/health/notifications/irc/README.md
index 9ea86e92d..36590eb79 100644
--- a/health/notifications/irc/README.md
+++ b/health/notifications/irc/README.md
@@ -2,15 +2,15 @@
This is what you will get:
-IRCCloud web client:
+IRCCloud web client:\
![image](https://user-images.githubusercontent.com/31221999/36793487-3735673e-1ca6-11e8-8880-d1d8b6cd3bc0.png)
Irssi terminal client:
![image](https://user-images.githubusercontent.com/31221999/36793486-3713ada6-1ca6-11e8-8c12-70d956ad801e.png)
-
You need:
-1. The `nc` utility. If you do not set the path, netdata will search for it in your system `$PATH`.
+
+1. The `nc` utility. If you do not set the path, Netdata will search for it in your system `$PATH`.
Set the path for `nc` in `/etc/netdata/health_alarm_notify.conf` (to edit it on your system run `/etc/netdata/edit-config health_alarm_notify.conf`), like this:
@@ -22,12 +22,11 @@ Set the path for `nc` in `/etc/netdata/health_alarm_notify.conf` (to edit it on
# If empty, the system $PATH will be searched for it.
# If not found, irc notifications will be silently disabled.
nc="/usr/bin/nc"
-
```
-2. Αn `IRC_NETWORK` to which your preffered channels belong to.
-3. One or more channels ( `DEFAULT_RECIPIENT_IRC` ) to post the messages to.
-4. An `IRC_NICKNAME` and an `IRC_REALNAME` to identify in IRC.
+2. Αn `IRC_NETWORK` to which your preffered channels belong to.
+3. One or more channels ( `DEFAULT_RECIPIENT_IRC` ) to post the messages to.
+4. An `IRC_NICKNAME` and an `IRC_REALNAME` to identify in IRC.
Set them in `/etc/netdata/health_alarm_notify.conf` (to edit it on your system run `/etc/netdata/edit-config health_alarm_notify.conf`), like this:
@@ -57,11 +56,10 @@ IRC_NICKNAME="netdata-alarm-user"
# The irc realname which is required in order to make the connection and is an
# extra identifier.
IRC_REALNAME="netdata-user"
-
```
-You can define multiple channels like this: `#system-alarms #networking-alarms`.
-You can also filter the notifications like this: `#system-alarms|critical`.
+You can define multiple channels like this: `#system-alarms #networking-alarms`.\
+You can also filter the notifications like this: `#system-alarms|critical`.\
You can give different channels per **role** using these (at the same file):
```
@@ -72,4 +70,4 @@ role_recipients_irc[webmaster]="#networking-alarms"
The keywords `#user-alarms`, `#networking-alarms`, `#system-alarms`, `#databases-alarms` are irc channels which belong to the specified IRC network.
-[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fhealth%2Fnotifications%2Firc%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fhealth%2Fnotifications%2Firc%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)