openvpn-access-server-scripts

openvpn-access-server-scripts

A node module that holds a collection of scripts that will be used by EC2 instances spawned in the openvpn-access-server-infra infrastructure deployment to complete the setup of OpenVPN Access Server and PiHole.

Usage

To run the OpenVPN script:

npx openvpn-access-server-scripts setup-openvpn -d domain.foo-bar.com -e [e-mail] -b foo-bar-bucket -r us-east-1 

To run the PiHole script:

Available Functions

setup-openvpn

This function registers an SSL certificate via Lets Encrypt for the OpenVPN Access Server web interface so that it can be properly accessed via HTTPS. After requesting a new certificate, this function will store the generated certificate in an S3 bucket for reuse. This is because there's a rate limit of 5 certificates for the same domain name per week. If a certificate already exists, this function will get those artifacts and reuse them when assigning the certificate to OpenVPN Access Server.

Option	Required	Description
-d --domain-name	:heavy_check_mark:	The FQDN to be used for certificate registration
-e --email	:heavy_check_mark:	The email to use for certificate registration
-b --bucket	:heavy_check_mark:	The S3 Bucket to store/obtain certificate artifacts
-r --region	:heavy_check_mark:	The AWS region for the S3 SDK client to use

setup-pihole

Versioning

Versioning follows semantic versioning. semver is installed to help with this.

To create a beta release:

npm run semver -- 0.0.1 -i prerelease --preid beta