Platform Supported

Repo Stats

Deployments

VPN Server

• You need a VPN but don't want to pay for it?
• OpenVPN is the solution, but configuring it manually can be a lengthy process.
• Once configured, keeping the instance up all the time costs $$.
• Scaling up/down a VPN server on demand can make that lengthy process an absolute nightmare.
• This module allows you to create your own on demand VPN server in under 2 minutes.
• The solution is fully automated and runs with OpenVPN using AWS EC2.

How it works

• Create an AWS EC2 instance using a pre-built OpenVPN AMI.
• Create a security group with the necessary ports allowed.
• Configure the vpn server using SSH.
• Download the OpenVPN client and connect using public IP of the ec2 instance.
• All set! Now the internet traffic will be routed through the VPN. Verify it using an IP Lookup

To take it a step further, if you have a registered domain in AWS, vpn-server can be accessed with an alias record in route53 pointing to the public IP of the ec2 instance.

• All the above steps are performed automatically when creating a new VPN server.
• This module can also be used to clean up all the AWS resources spun up for creating a vpn server.

ENV Variables

Environment variables are loaded from .env file if present.

Install

python -m pip install vpn-server

Usage

import vpn

# Instantiates the object, takes the same args as env vars.
vpn_server = vpn.VPNServer()  # Defaults to console logging, but supports custom logger.

vpn_server.create_vpn_server()  # Create a VPN Server, login information will be saved to a JSON file.

# Re-configure an existing VPN Server (not required, unless the configuration steps have been interrupted)
# vpn_server.reconfigure_vpn()

# Test an existing VPN Server (not required, as a test is run right after creation anyway)
# vpn_server.test_vpn()

vpn_server.delete_vpn_server()  # Deletes the VPN Server removing the AWS resources acquired during creation.

AWS Resources Used

• EC2
  • Instance - To redirect traffic through the instance's IP
  • SecurityGroup - To allow traffic over specific TCP ports
  • Systems Manager - To access OpenVPN SSM parameter store to retrieve the AMI ID
  • Route53 [Optional] - To access VPN server using an A record in Route 53
• VPC [Default]
• Subnet [Default]

Release Notes

Requirement

python -m pip install changelog-generator

Usage

changelog reverse -f release_notes.rst -t 'Release Notes'

Linting

PreCommit will ensure linting, and the doc creation are run on every commit.

Requirement

pip install sphinx==5.1.1 pre-commit recommonmark

Usage

pre-commit run --all-files

Links

Repository

Runbook

Package

License & copyright

© Vignesh Sivanandha Rao

Licensed under the MIT License