README.md in openvpn-status-web-0.0.1 vs README.md in openvpn-status-web-1.0.0
- old
+ new
@@ -1,17 +1,60 @@
# openvpn-status-web
-Small (another word for naive in this case, it's simple and serves my needs) [rack](http://rack.github.com/) app
-providing the information the [OpenVPN](http://openvpn.net/index.php/open-source.html) server collects in it's status file
-especially including a list of currently connected clients (common name, remote address, traffic, ...).
-It comes with a Debian 6 compatible init.d file.
+[](https://travis-ci.org/cmur2/openvpn-status-web)
+## Description
+
+Small (another word for naive in this case, it's simple and serves my needs) [Rack](http://rack.github.com/) application providing the information the [OpenVPN](http://openvpn.net/index.php/open-source.html) server collects in it's status file especially including a list of currently connected clients (common name, remote address, traffic, ...).
+
It lacks:
-* authentication
-* caching (parses file on each request, page does auto-refresh every minute as OpenVPN updates the status file these often)
+* 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
+
+Install the gem:
+
+ gem install openvpn-status-web
+
+Create a configuration file in YAML format somewhere:
+
+```yaml
+# listen address and port
+host: "0.0.0.0"
+port: "8080"
+# optional: drop priviliges in case you want to but you should give this user at least read access on the log files
+user: "nobody"
+group: "nogroup"
+# logfile is optional, logs to STDOUT else
+logfile: "openvpn-status-web.log"
+# display name for humans and the status file path
+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
+
+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
+
+The [Debian 6 init.d script](init.d/debian-6-openvpn-status-web) assumes that openvpn-status-web is installed into the system ruby (no RVM support) and the config.yaml is at /opt/openvpn-status-web/config.yaml. Modify to your needs.
## License
openvpn-statsu-web is licensed under the Apache License, Version 2.0. See LICENSE for more information.