Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/networkop/smart-vpn-client
Smart VPN client
https://github.com/networkop/smart-vpn-client
Last synced: 16 days ago
JSON representation
Smart VPN client
- Host: GitHub
- URL: https://github.com/networkop/smart-vpn-client
- Owner: networkop
- Created: 2021-01-23T14:35:24.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-12T20:16:41.000Z (over 2 years ago)
- Last Synced: 2024-06-20T09:20:30.047Z (5 months ago)
- Language: Go
- Size: 61.5 KB
- Stars: 24
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Smart VPN client
Performs all the standard functions of a VPN client, i.e. manages a connection to a VPN headend. The "smart" functionality includes:
* Automatic discovery and probing of all available VPN headends. The client will connect to the headend with the lowest round-trip time.
* Automatic management of routing and NAT masquerade rules required for a VPN client.
* Periodic VPN connection healthchecks - if more than 3 consecutive healthchecks fail, connection is automatically re-established.
* VPN connection QoS tracking -- takes a baseline round-trip time measurement when a new connection is established and triggers reconnect when the weighted average latency exceeds 10 x baseline for 3 consecutive measurements.
## Supported Providers
* [Private Internet Access](https://www.privateinternetaccess.com/) with Wireguard as the VPN tunnel transport (requires wireguard kernel module).
## Installation
To install run:
```
go get github.com/networkop/smart-vpn-client
```
The binary can be found in `$GOPATH/bin/`:
```
# ls -lah $GOPATH/bin/smart-vpn-client
-rwxr-xr-x 1 root root 7.9M Jan 23 14:57 /go/bin/smart-vpn-client
```
## Run
The binary requires `NET_ADMIN` capabilities in order to set up interfaces and manipulate routing, therefore the simplest way is to run it with `sudo`:
```
sudo VPN_PWD= ./smart-vpn-client -user
```
## Using Docker
Build your own docker image with:
```
DOCKER_IMAGE= make docker
```
Alternatively, pull a pre-built docker image from dockerhub:
```
docker pull networkop/smart-vpn-client:latest
```
Start a smart vpn client process:
```
docker run -e VPN_PWD= -d --restart=always --name vpn --net=host --cap-add=NET_ADMIN networkop/smart-vpn-client -user
```
To cleanup all config, first stop the container with `docker rm -f vpn` and then do:
```
docker run --net=host --cap-add=NET_ADMIN networkop/smart-vpn-client -cleanup
```
The last command will run to completion and the container will stop.
To view the container logs at any stage do:
```
docker logs vpn
```
## Monitor
By default, all healthchecks metrics are exposed on `localhost:2112/metrics` and can be scraped with Grafana Agent (or Prometheus) like this:
```
prometheus:
configs:
scrape_configs:
- job_name: vpn
scrape_interval: 5s
static_configs:
- targets: ['localhost:2112']
```
## Manual build
Clone this repo and run:
```
make
```