]> gitweb.michael.orlitzky.com - dead/check_openvpn-simple.git/blob - README.txt
Replace GPL-3 with AGPL-3, and update the project URL.
[dead/check_openvpn-simple.git] / README.txt
1 == Overview ==
2
3 A Nagios plugin for checking whether or not an OpenVPN server is
4 alive.
5
6 We don't actually interact with the OpenVPN server; we merely send it
7 a a magic (heretofore unexplained) byte sequence and ensure that we
8 get some kind of response.
9
10 If the server uses a TLS auth key, the response will be empty but at
11 least it will come, preventing a timeout.
12
13 == Examples ==
14
15 Perform a basic check using the default port and protocol:
16
17 $ check_openvpn-simple vpn1.example.com
18 OK 22.471ms
19
20 Check a server that runs on TCP/443 (this is used to sneak past
21 firewalls that allow HTTPS but block other traffic):
22
23 $ check_openvpn-simple --tcp --port 443 vpn2.example.com
24 OK 14.801ms