cn/openvpn-status-web
1
0
Fork 0
mirror of https://github.com/cmur2/openvpn-status-web.git synced 2024-12-22 02:54:23 +01:00
Code Releases Activity
Small Rack (Ruby) application serving OpenVPN status file
65 Commits 1 Branch 13 Tags 738 KiB
Ruby 85.7%
HTML 14.3%
586ae8ae0f
Go to file
cn 586ae8ae0f gem: add editorconfig
2020-08-14 14:07:47 +02:00
docs release: 3.0.0 2020-07-14 20:08:06 +02:00
examples Convert into gem 2013-05-03 15:32:08 +02:00
exe gem: adopt frozen string literals 2020-03-07 01:30:57 +01:00
lib gems: update rubocop to version 0.89.0 2020-08-07 08:32:29 +02:00
spec gem: adopt frozen string literals 2020-03-07 01:30:57 +01:00
.editorconfig gem: add editorconfig 2020-08-14 14:07:47 +02:00
.gitignore gem: add solargraph support 2020-03-01 22:12:38 +01:00
.rubocop.yml gem: upgrade rubocop to version 0.88.0 2020-07-14 20:06:06 +02:00
.solargraph.yml gem: add solargraph support 2020-03-01 22:12:38 +01:00
.travis.yml gem: bump minimum required Ruby version to Ruby 2.5 (#14) 2020-07-14 19:57:25 +02:00
Gemfile gem: adopt frozen string literals 2020-03-07 01:30:57 +01:00
LICENSE Add license 2013-02-25 22:56:33 +01:00
openvpn-status-web.gemspec gems: update rubocop to version 0.89.0 2020-08-07 08:32:29 +02:00
Rakefile gem: adopt frozen string literals 2020-03-07 01:30:57 +01:00
README.md docs: add example Dockerfile 2020-07-13 10:39:30 +02:00

README.md

openvpn-status-web

Build Status Depfu

Description

Small (another word for naive in this case, it's simple and serves my needs) Rack application providing the information an 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 by default)
  • management interface support
  • 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"
# 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"
# hash with each VPNs display name for humans as key and further config as value
vpns:
  My Small VPN:
    # the status file path and status file format version are required
    version: 1
    status_file: "/var/log/openvpn-status.log"
  My Other VPN:
    version: 3
    status_file: "/var/log/other-openvpn-status.log"

Your OpenVPN configuration should contain something like this:

# ...snip...
status /var/log/openvpn-status.log
status-version 1
# ...snip...

For more information about OpenVPN status file and version, see their man page. openvpn-status-web is able to parse all versions from 1 to 3.

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.

Startup

There is a Dockerfile that can be used to build a Docker image for running openvpn-status-web.

The Debian 6 init 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-status-web is licensed under the Apache License, Version 2.0. See LICENSE for more information.