mirror of
https://github.com/cmur2/openvpn-status-web.git
synced 2024-12-22 12:54:24 +01:00
Small Rack (Ruby) application serving OpenVPN status file
bin | ||
examples | ||
init.d | ||
lib | ||
.gitignore | ||
.travis.yml | ||
Gemfile | ||
LICENSE | ||
openvpn-status-web.gemspec | ||
Rakefile | ||
README.md |
openvpn-status-web
Small (another word for naive in this case, it's simple and serves my needs) Rack application providing the information the OpenVPN server collects in it's status file especially including a list of currently connected clients (common name, remote address, traffic, ...).
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
- possibly more...
Usage
Install the gem:
gem install openvpn-status-web
Create a configuration file in YAML format somewhere:
# listen address and port
host: "0.0.0.0"
port: "8080"
# 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"
Advanced topics
Authentication
Init scripts
The Debian 6 init.d script 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.