Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thejandroman/vagrant-openvpn
Create an OpenVPN server on a VPS using vagrant.
https://github.com/thejandroman/vagrant-openvpn
amazon-lightsail digitalocean openvpn vagrant
Last synced: 2 months ago
JSON representation
Create an OpenVPN server on a VPS using vagrant.
- Host: GitHub
- URL: https://github.com/thejandroman/vagrant-openvpn
- Owner: thejandroman
- Created: 2015-08-20T17:33:52.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-05-29T14:07:11.000Z (over 5 years ago)
- Last Synced: 2024-10-16T00:17:28.356Z (2 months ago)
- Topics: amazon-lightsail, digitalocean, openvpn, vagrant
- Language: Shell
- Homepage:
- Size: 64.5 KB
- Stars: 10
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: contributing.json
Awesome Lists containing this project
README
[](https://travis-ci.org/thejandroman/vagrant-openvpn)
# Introduction
This project is meant to quickly spin up an optimally configured
OpenVPN server with downloadable, sane client configs. It performs the
following functions:
1. This vagrantfile spins up an Ubuntu 16.04 x86 server in a user
selected cloud provider.
1. It then configures the server using ssh provisioners to serve as
an OpenVPN server.
1. Finally it creates an ovpn client config file for easy importing
into any OpenVPN client.
## Supported Cloud Providers
- [Digital Ocean](https://www.digitalocean.com/)
- [Amazon Lightsail](https://amazonlightsail.com/)
# Prerequisites
1. Install [vagrant](https://www.vagrantup.com/downloads.html)
1. Install vagrant plugins
- [vagrant-rsync-back](https://github.com/smerrill/vagrant-rsync-back) Used
to sync the client ovpn and cert files back to the host from the
droplet.
```sh
vagrant plugin install vagrant-rsync-back
```
- [vagrant-digitalocean](https://github.com/devopsgroup-io/vagrant-digitalocean) Only
required if using the DigitalOcean cloud provider.
```sh
vagrant plugin install vagrant-digitalocean
```
- [vagrant-lightsail](https://github.com/thejandroman/vagrant-lightsail) Only
required if using the Amazon Lightsail cloud provider.
```sh
vagrant plugin install vagrant-lightsail
```
1. Create an account with a supported cloud provider and acquire credentials.
- [Digital Ocean](https://cloud.digitalocean.com/registrations/new)
After creating an account, a
[Personal Access Token](https://cloud.digitalocean.com/settings/api/tokens)
is required.
- [Amazon Lightsail](https://amazonlightsail.com)
After creating an account, a set of
[Access Keys](https://console.aws.amazon.com/iam/home?#/security_credential)
is required.
# Configuration
All configuration options are stored in the file `config.yaml`. Each
config option has an accompanying comment. Modify the `config.yaml`
file as needed for user specific cases. The only required options are
the cloud provider authentication tokens or keys. Only one cloud
provider needs to be configured.
# Basic Usage
```sh
vagrant up
vagrant rsync-back
```
1. The server is created and configured with the `vagrant up` command.
1. Using the `vagrant rsync-back` command will retrieve the generated
client configs. These configs and certs can then be found in the
`./client-configs` directory on the local host.
# Using with an OpenVPN client
Once the `client.ovpn` file has been acquired by either of the
mechanisms described above it can be imported into most OpenVPN client
softwares. A short, incomplete list follows:
## Windows
* [OpenVPN](https://openvpn.net/index.php/open-source/downloads.html)
## Mac
* [Tunnelblick](https://tunnelblick.net/)
# Troubleshooting
* After a vagrant destroy be sure to delete the contents of the
`./client-configs` directory before running vagrant up again.
## Digital Ocean
* When doing a vagrant up occasionally the command will hang. Though
there could be several reasons for this the most likely is that a
`vagrant` ssh key-pair already exists in your DigitalOcean
account. You can either delete the offending key from your
DigitalOcean account as described
[here](https://github.com/smdahlen/vagrant-digitalocean/issues/144#issuecomment-105165756)
or you can edit the `provider.ssh_key_name` variable from the
`Vagrantfile`.