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
Example to run the OpenVPN script:
npx openvpn-access-server-scripts setup-openvpn -i 1.0.0.1 -d domain.foo-bar.com -e foo@bar.com -b foo-bar-bucket -r ap-southeast-1 -u user -p 123@abcExample to run the PiHole script:
npx openvpn-access-server-scripts setup-pihole -r ap-southeast-1 -p abc!@123Available Functions
setup-openvpn
This function:
- sets up open vpn with a default client user
- optionally sets up open vpn with an upstream dns server (if
-i, --ipis defined) - 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 |
|---|---|---|
| -i --ip | The private ip address of the upstream dns ec2 instance | |
| -d --domain-name | The FQDN to be used for certificate registration | |
| -e --email | The email to use for certificate registration | |
| -b --bucket | The S3 Bucket to store/obtain certificate artifacts | |
| -r --region | The AWS region for the S3 SDK client to use | |
| -u --user-name | The default vpn client username | |
| -p --user-password | The default vpn client password (special characters need to be escaped before they are passed here) |
setup-pihole
Installs Pi Hole as a DNS server for Ad Blocking and sets up Unbound to serve as a recursive DNS service. Also install some additional tooling to enhance Pi Hole functionality.
| Option | Required | Description |
|---|---|---|
| -r --region | The AWS region for the S3 SDK client to use | |
| -p --password | The pi hole web interface password (special characters need to be escaped before they are passed here) |
Publishing
A note about versions:
Versioning follows semantic versioning.
semver is installed to help with this.
To create a beta release:
npm run publish:betaTo create a patch release:
npm run publish