The number of IP addresses you can egress from reliably is often the limiting factor in data scraping and other online activities. This project allows you to use your NordVPN, Windscribe, and/or Private Internet Access credentials to allow programmatic control of a proxy egress point via a set of useful APIs.
export NORDUSER="<user>"
export NORDPASS="<pass>"
export PIAUSER="<user>"
export PIAPASS="<user>"
export WINDUSER="<user"
export WINDPASS="<pass>"
# to check environment variables are correct
env
# Build and spin up the container
make docker_build
OVPN_DOWNLOAD_ON_START=yes docker-compose up -d
Swagger docs http://localhost:8080/api/docs/
Configure SWAGGER_BASE_PATH to server behind a proxy see Swagger docs
Example
SWAGGER_BASE_PATH=/vpn
Setup a python 3.8+ virtual env
Install Dev Requirements
python -m pip install -r requirements-dev.txt
Reformat Code (runs isort, black)
make fmt
Test + Lint
make tox
make docker_build
OVPN_DOWNLOAD_ON_START=yes will download configs on start up. If ommited you will have to
call refresh manually POST localhost:8080/vpn/configs
OVPN_DOWNLOAD_ON_START=yes docker compose up -d
docker compose down -v
python -m pip install -e .
vpnrotate --config=app.dev.yaml --logging=logging.yaml
Download ovpn configs manually to specified config vpn_env.vpnconfigs directory
vpnconfigs --config=app.dev.yaml
See bump2version
Bump version, verify changes and commit to branch.
Example:
bump2version --current-version 0.1.6 --new-version 0.1.7 minor --allow-dirty
Run the following to create an updated ovpn_tcp.zip to replace the
https://vpnrotate.s3.amazonaws.com/ovpn_tcp.zip the current download.
Adding -c will download the windscribe credentials as well to wind-creds.txt
python -m vpnrotate.wind <user> <password>