From 003c1b9843c03c70fa39092e9bfcd12b055ff0f4 Mon Sep 17 00:00:00 2001
From: Alarig Le Lay <alarig@swordarmor.fr>
Date: Sun, 22 Mar 2020 22:31:27 +0100
Subject: [PATCH] README.md: adding some basic config

---
 README.md | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5722cf6..7b39e8b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,23 @@
 # nrpe-bird
 
+## Description
+
 Collection of scripts used to monitor bird sessions and route limits
 
-It’s not well tested against bird2 yet, but using -4 for either IPv4 and IPv6
-should be sufficient.
+For bird2, just use -4 for either IPv4 and IPv6.
+
+## Configuration
+
+```
+ln -s $(pwd)/check_bird2_oneshot /usr/local/lib64/nagios/plugins/check_bird2_oneshot
+```
+
+`/etc/sudoers`:
+```
+nagios ALL=(ALL) NOPASSWD: /usr/bin/birdc
+```
+
+`/etc/nagios/nrpe.cfg`:
+```
+command[check_bird2_oneshot]=/usr/local/lib64/nagios/plugins/check_bird2_oneshot -s
+```