Files
vpngate/README.md
DG 7b4d98702e Add homebrew releaser (#44)
* Add homebrew releaser and tap

* Update README.md
2021-08-10 00:22:56 -04:00

91 lines
1.8 KiB
Markdown

# vpngate
This is a client for [vpngate.net](https://www.vpngate.net/).
![vpngate](https://user-images.githubusercontent.com/4519234/104145615-b6f9f880-5395-11eb-812c-c6597a7aed0f.gif)
This client fetches the list of available relay servers provided by vpngate.net.
You can check out your current IP address and region at https://nordvpn.com/what-is-my-ip/, or simply run the following command in a terminal:
```console
$ curl ipinfo.io
```
## Requirements
- [openvpn](https://github.com/OpenVPN/openvpn)
- macOS or Linux
## Install
### homebrew
vpngate can be installed with [homebrew](https://brew.sh/):
```sh
brew install openvpn
brew install davegallant/public/vpngate
```
### source
Ensure that [go](https://golang.org/doc/install) is installed.
```console
$ CGO_ENABLED=0 go get github.com/davegallant/vpngate
```
Ensure that the go bin path is discoverable:
```console
$ echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.profile
$ source ~/.profile
```
## Usage
### List available servers
```console
$ vpngate list
```
### Connect to a server
On macOS, `openvpn` may not be within your PATH. To fix this, run:
```console
$ export PATH=$(brew --prefix openvpn)/sbin:$PATH
```
The above command can also be added to a bash/zsh profile for future use.
Because openvpn creates a network interface, run the connect command with `sudo` or a user with escalated privileges.
```console
$ sudo vpngate connect
```
#### Random
If the country doesn't matter, a random server can be selected:
```console
$ sudo vpngate connect --random
```
#### Reconnect
To continually attempt to reconnect (this can be combined with `--random`):
```console
$ sudo vpngate connect --reconnect
```
## Notes
- I do not maintain any of the servers on vpngate.net (connect to these servers at your own discretion)
- Many of the listed servers claim to have a logging policy of 2 weeks