From 87d9ea302fbc52a57bd89248ff975d00bd5c48a2 Mon Sep 17 00:00:00 2001 From: cn Date: Fri, 3 May 2013 16:12:11 +0200 Subject: [PATCH] Update README --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ed8c280..55a42a1 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ Small (another word for naive in this case, it's simple and serves my needs) [Ra It lacks: -* caching (parses file on each request, page does auto-refresh every minute as OpenVPN updates the status file these often) -* newer status file versions than v1 -* management interface support * tracking multiple status at the same time +* newer status file versions than v1 +* caching (parses file on each request, page does auto-refresh every minute as OpenVPN updates the status file these often by default) +* management interface support * *possibly more...* ## Usage @@ -29,9 +29,20 @@ name: "My Small VPN" status_file: "/var/log/openvpn-status.log" ``` +Your OpenVPN configuration should contain something like this: + +``` +# ...snip... +status /var/log/openvpn-status.log +status-version 1 +# ...snip... +``` + ## Advanced topics -## Authentication +### Authentication + +If the information exposed is important to you serve it via the VPN or use a webserver as a proxy to handle SSL and/or HTTP authentication. ### Init scripts