Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kakkoyun/terraform-openvpn
You can have your pay as you go personal VPN in minutes! And you can destroy your environment whenever you want!
https://github.com/kakkoyun/terraform-openvpn
docker hack16 infrastructure-as-code meltwater openvpn openvpn-server terraform
Last synced: about 1 month ago
JSON representation
You can have your pay as you go personal VPN in minutes! And you can destroy your environment whenever you want!
- Host: GitHub
- URL: https://github.com/kakkoyun/terraform-openvpn
- Owner: kakkoyun
- License: gpl-3.0
- Created: 2018-03-02T10:53:38.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-04T14:42:35.000Z (almost 7 years ago)
- Last Synced: 2025-01-03T11:38:42.596Z (about 1 month ago)
- Topics: docker, hack16, infrastructure-as-code, meltwater, openvpn, openvpn-server, terraform
- Language: HCL
- Homepage:
- Size: 58.6 KB
- Stars: 18
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Terraform OpenVPN
Terraform declarations for Single node OpenVPN infrastructure.
You can have your pay as you go personal VPN in minutes! And you can destroy your environment whenever you want!
[](https://asciinema.org/a/I7rlhVKvHjf4KuNWYjCzpc0ir?autoplay=1)
### Prerequisites
`Terraform v0.11.3`
Check your version.
```
$ terraform -v
```
### Installing
Install `Terraform`, you can use [brew](https://brew.sh/) if you're on Mac OS X.
```
$ brew install terraform
```
## Usage
Make sure you provided AWS credentials to your environment.
You can simply export:
```Bash
export AWS_ACCESS_KEY_ID=(your access key id)
export AWS_SECRET_ACCESS_KEY=(your secret access key)
```
Or, you can use something like [awsudo](https://github.com/makethunder/awsudo) if you are using multiple accounts in your system:
```Bash
$ awsudo -u personal env | grep AWS
AWS_ACCESS_KEY_ID=''
AWS_SECRET_ACCESS_KEY=''
```
To provision remote machine, `Terraform` needs to access that machine, for that you have to add your SSH key to your local `ssh-agent`, so `Terraform` can find:
```Bash
$ ssd-add # Adds default ssh key
$ ssd-add ~/.ssh/my-jada-jada-key # Adds a specific ssh key
```
Then plan your changes:
```Bash
$ terraform plan
```
If everything is ok, you should see something like:
If everything looks good, you can apply your plan, it will take couple of minutes:
```Bash
$ terraform apply
```
If everything is ok, you should see something like:
Booom! You did it!
### Client Setup
Use generated file with an OpenVPN client. In OS X, you can install one with `brew`.
```Bash
$ brew install openvpn
```
Then,
```Bash
$ sudo openvpn --config awesome-personal-vpn.ovpn
$ sudo openvpn --config awesome-personal-vpn.ovpn --deaemon # as daemon
$ sudo -b openvpn --config awesome-personal-vpn.ovpn # run in background
```
If you want a GUI client, you can use [Tunnelblick](https://openvpn.net/index.php/access-server/docs/admin-guides/183-how-to-connect-to-access-server-from-a-mac.html) for Mac OS X, with Tunnelblick is installed, just go to your console:
```Bash
$ open awesome-personal-vpn.ovpn
```
### Available Parameters
If you want to configure your VPN, you can pass following parameters.
```Bash
$ terraform apply \
-var "aws_region=JADA" \
-var "ssh_remote_user=JADA"
-var "ssh_public_key_path=JADA" \
-var "vpn_data=JADA" \
-var "vpn_port=1234" \
-var "vpn_client_name=JADA"
```
Your VPN is ready! Have fun!
## Built With
* [OpenVPN](https://openvpn.net/)
* [Terraform](https://www.terraform.io/)
* [Docker](https://www.docker.com/)
* [Docker OpenVPN Image](https://hub.docker.com/r/kylemanna/openvpn/)
Special thanks to [@kylemanna](https://github.com/kylemanna) for [docker-openvpn](https://github.com/kylemanna/docker-openvpn)
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kakkoyun/terraform-openvpn/tags).
## Authors
* **Kemal Akkoyun** - *Initial work* - [kakkoyun](https://github.com/kakkoyun)
See also the list of [contributors](https://github.com/kakkoyun/terraform-openvpn/contributors) who participated in this project.
## License
This project is licensed under the GNU General Public License v3.0 - see the [LICENCE](LICENCE) file for details