VPN-Speed-Comparison-Tool
VPN Speed Comparison Tool
This is a tool, written in Python, for assessing network speed over VPN connections.
It is composed of two main parts: the daemon, which is invoked using the vpnspeedd command, and the client, which is invoked using the vpnspeed command. The daemon awaits instructions from the client and executes the given tests in the background. The client controls the test configuration and daemon life-cycle.
Detailed whitepaper with the methodology can be found here:
Dependencies:
apt-transport-https 
ca-certificates 
curl 
docker-ce 
docker-compose 
git 
gnupg 
jq 
python3-dev 
python3-pip 
python3-setuptools 
python3-wheel 
python3-yaml 
software-properties-common 
wireguard 
Notes:
Test can be started by running scripts/setup.sh, which will install all dependencies.
This project was build and mainly tested using debian 10, other distribution of debian can be incompatible.
IP geolocation
For test execution ip geoservice is needed. In this project ipapi.co was selected.

Usage

First, clone the repository with the following command:

$ git clone

After cloning the repository and before starting the testing process, edit the configuration file to add VPN provider credentials and further customize test execution.

$ vi vpnspeed.yaml

Run using scripts/setup.sh

$ sudo ./scripts/setup.sh

Note:

Adding --dry-run to setup.sh will only install, but not start test with configuration.

$ sudo scripts/setup.sh --dry-run`

Local - manually

To run the tests locally, run the following commands in the project root. The following commands will start a docker container, start the vpnspeedd daemon on it and leave it running in the background:

$ cd ./docker

$ docker-compose up -d

[/center]