Easily deploy your own personal VPN server with DNS adblocking running on DigitalOcean
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd * Add IPv6 support Nov 7, 2017
deploy Update to newly released upgraded droplet sizes, update dependencies Jan 19, 2018
doclient * Add IPv6 support Nov 7, 2017
genconfig * Add IPv6 support Nov 7, 2017
platypus New features, fixes, updates Oct 26, 2017
services Change tcp mss to avoid mtu problems Aug 7, 2018
sshclient * Add IPv6 support Nov 7, 2017
static New features, fixes, updates Oct 26, 2017
vendor Minor updates: Apr 7, 2018
vpn New features, fixes, updates Oct 26, 2017
web * Add IPv6 support Nov 7, 2017
.gitignore Switch from glide to dep for dependency management Jul 26, 2017
Gopkg.lock
Gopkg.toml Minor updates: Apr 7, 2018
LICENSE Initial commit of dosxvpn Apr 8, 2017
Makefile Update to newly released upgraded droplet sizes, update dependencies Jan 19, 2018
README.md Minor updates: Apr 7, 2018
dosxvpn.go New features, fixes, updates Oct 26, 2017

README.md

dosxvpn

Easily deploy your own personal VPN server with DNS adblocking running on DigitalOcean.


Key Features

  • Personal IPsec-based VPN (strongSwan).
  • Ad blocking DNS setup by default (Pi-hole).
  • 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 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 page. Note: only OSX 10.12+ is supported.
  2. Make the binary executable
chmod +x dosxvpn
  1. Create an API token (https://cloud.digitalocean.com/settings/api/tokens) and export it
export DIGITALOCEAN_ACCESS_TOKEN=<token>
  1. See help for all options
./dosxvpn -h

CLI Examples

  • Deploy a new VPN droplet and configure OSX VPN
    ./dosxvpn deploy --region sfo2 --auto-configure
  • List dosxvpn VPN droplets
    ./dosxvpn ls
  • Remove dosxvpn VPN droplet and OSX VPN profile
    ./dosxvpn rm --name <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?
    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 <ssh-private-key> core@<vpn-ip>. 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, etc. Your IP address may still leak 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 - IPsec-based VPN software
  • CoreOS - used for running containers and automatic OS updates capabilities
  • Pi-hole - used for DNS adblocking
  • Platypus - used to build the native OSX app
  • godo - DigitalOcean Go API client

Acknowledgements

Building Source

  1. Install dependency platypus cli
brew install platypus
  1. Fetch the project with go get:
go get github.com/dan-v/dosxvpn
cd $GOPATH/src/github.com/dan-v/dosxvpn
  1. Run make to build
make