Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dan-v/dosxvpn
Easily deploy your own personal VPN server with DNS adblocking running on DigitalOcean
https://github.com/dan-v/dosxvpn
adblock adblocking-dns android cli digitalocean go golang iphone ipsec osx personal strongswan vpn webapp
Last synced: 3 months ago
JSON representation
Easily deploy your own personal VPN server with DNS adblocking running on DigitalOcean
- Host: GitHub
- URL: https://github.com/dan-v/dosxvpn
- Owner: dan-v
- License: unlicense
- Archived: true
- Created: 2017-04-08T19:09:10.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-01-30T22:10:49.000Z (almost 4 years ago)
- Last Synced: 2024-06-20T02:11:04.969Z (5 months ago)
- Topics: adblock, adblocking-dns, android, cli, digitalocean, go, golang, iphone, ipsec, osx, personal, strongswan, vpn, webapp
- Language: Go
- Homepage:
- Size: 5.64 MB
- Stars: 306
- Watchers: 17
- Forks: 41
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This repository is no longer maintained.
dosxvpn
Easily deploy your own personal VPN server with DNS adblocking running on DigitalOcean.
---
## Key Features
* Personal IPsec-based VPN ([strongSwan](https://strongswan.org/)).
* Ad blocking DNS setup by default ([Pi-hole](https://pi-hole.net/)).
* Generates profiles for sharing VPN with OSX/iPhone and Android.
* No additional software required for OSX/iPhone - uses native VPN client.
* Simple Web or CLI installation methods.
* Automated OS and VPN software updates.
* Dual stack IPv4/IPv6 enabled.
## Web Installer (OSX)
1. Download the latest pre-built app from the [GitHub Releases](https://github.com/dan-v/dosxvpn/releases) page. Note: only OSX 10.12+ is supported.
2. Open the app and run through the web based installation wizard to setup a new VPN.
## CLI Usage (OSX)
1. Download the latest pre-built cli from the [GitHub Releases](https://github.com/dan-v/dosxvpn/releases) page. Note: only OSX 10.12+ is supported.
2. Make the binary executable
```sh
chmod +x dosxvpn
```
3. Create an API token (https://cloud.digitalocean.com/settings/api/tokens) and export it
```sh
export DIGITALOCEAN_ACCESS_TOKEN=
```
4. See help for all options
```sh
./dosxvpn -h
```
### CLI Examples
* Deploy a new VPN droplet and configure OSX VPN
```sh
./dosxvpn deploy --region sfo2 --auto-configure
```
* List dosxvpn VPN droplets
```sh
./dosxvpn ls
```
* Remove dosxvpn VPN droplet and OSX VPN profile
```sh
./dosxvpn rm --name --remove-profile
```
## FAQ
1. Should I use dosxvpn? That's up to you. Use at your own risk.
2. Why is this better than using public VPN provider XYZ? While most VPN providers will provide a secure connection to their endpoints, you may not be interested in putting blind faith in their claims that they will not log or track your activity online.
3. How is this different than [algo](https://github.com/trailofbits/algo)?
1) Installation - is simple and has no additional system dependencies.
2) Updates: dosxvpn handles updates of both the OS and VPN. This means any critical security updates or bug fixes will automatically be applied for you.
4. How much does this cost? This launches a 512MB DigitalOcean droplet that costs $5/month currently.
5. What is the bandwidth limit? The 512MB DigitalOcean droplet has a 1TB bandwidth limit. This does not appear to be strictly enforced.
6. Where does dosxvpn store VPN configuration files? You can find all deployed VPN configuration files in your ~/.dosxvpn directory.
7. How do I SSH into the deployed droplet? Assuming you had public SSH keys uploaded to your DigitalOcean account when the VPN was deployed, all of those keys should be authorized for access. You can SSH using any of those keys: `ssh -i core@`. If you had no SSH keys uploaded to your DigitalOcean account, then a temporary key was autogenerated for you and you will need to redeploy if you want SSH access.
8. What is the password to login to Pi-hole? The password is `dosxvpn`.
9. Are you going to support other VPS providers? Not right now.
10. Will this make me completely anonymous? No, absolutely not. All of your traffic is going through a VPS which could be traced back to your account. You can also be tracked still with [browser fingerprinting](https://panopticlick.eff.org/), etc. Your [IP address may still leak](https://ipleak.net/) due to WebRTC, Flash, etc.
11. How do I uninstall this thing on OSX? You can uninstall through the Web interface, which will also remove the running droplet in your DigitalOcean account. Alternatively go to System Preferences->Network, click on dosxvpn-* and click the '-' button in the bottom left to delete the VPN. Don't forget to also remove the droplet that is deployed in your DigitalOcean account.
# Powered By
* [strongSwan](https://strongswan.org/) - IPsec-based VPN software
* [CoreOS](https://coreos.com/) - used for running containers and automatic OS updates capabilities
* [Pi-hole](https://pi-hole.net/) - used for DNS adblocking
* [Platypus](http://www.sveinbjorn.org/platypus) - used to build the native OSX app
* [godo](https://github.com/digitalocean/godo) - DigitalOcean Go API client
# Acknowledgements
* [trailofbits/algo](https://github.com/trailofbits/algo) - strongSwan configuration is borrowed from this project
* [jbowens/dochaincore](https://github.com/jbowens/dochaincore) - web deployment code is borrowed from this project
* [vimagick/strongswan](https://github.com/vimagick/dockerfiles/tree/master/strongswan) - using a forked version of this docker image for VPN server
# Building Source
1. Install dependency [platypus cli](http://www.sveinbjorn.org/platypus)
```sh
brew install platypus
```
2. Fetch the project with `go get`:
```sh
go get github.com/dan-v/dosxvpn
cd $GOPATH/src/github.com/dan-v/dosxvpn
```
2. Run make to build
```sh
make
```