openvpn-monitor

This tool provides a visual way to show the status of your OpenVPN server. Providing the folder the OpenVPN configuration status files are stored, it will show the status of the server and the number of clients connected. Each vpn will have its own tab. The service updates itself using a polling approach.

requirements

nodejs 16.0.0 or higher
yarn 1.22.17 or higher
openvpn 2.3.10 or higher

installation

  # clone the repository
  git clone git@github.com:TheTw3ys/openvpn-monitor.git

  # install dependencies
  yarn install

  # start the service
  yarn start

  # start the service in development mode
  yarn dev

configuration

The service can be configured using the following environment variables:

Variable	Meaning	Default Value
`OPENVPN_LOG_PATH`	The folder where the OpenVPN status files are stored	`./example-logs`
`FILE_OS_TYPE`	The type of the operating system	`linux`
`LISTEN_HOST`	The host(ipaddress) the service is bound to	`0.0.0.0`
`LISTEN_PORT`	The port the service is listening to	`3000`
`PUBLIC_PATH`	Location of static content of the webserver	`/../public`
`INFLUXDB_IS_USED`	Should we use influx to store some statistics	`false`
`INFLUXDB_URL`	Location of the influxdb API	`http://127.0.0.1:8086`
`INFLUXDB_TOKEN`	Token to get access to the influxdb org and bucket.	`has to be generated using influx web interface`