mirror of
https://github.com/davegallant/vpngate.git
synced 2025-08-06 08:43:40 +00:00
92 lines
2.1 KiB
Markdown
92 lines
2.1 KiB
Markdown
# vpngate
|
|
|
|
This is a client for [vpngate.net](https://www.vpngate.net/).
|
|
|
|
|
|
|
|
This client fetches the list of available relay servers provided by vpngate.net, and allows you to filter and connect to a server of your liking.
|
|
|
|
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:
|
|
|
|
```shell
|
|
curl ipinfo.io
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- [openvpn](https://github.com/OpenVPN/openvpn)
|
|
- macOS or Linux
|
|
|
|
## Install
|
|
|
|
The simplest method of installation is using homebrew. You can also build from source.
|
|
|
|
### from homebrew
|
|
|
|
vpngate can be installed with [homebrew](https://brew.sh/) (ensure that xcode is installed before installing homebrew by running `xcode-select --install`).
|
|
|
|
```shell
|
|
|
|
brew install openvpn davegallant/public/vpngate
|
|
```
|
|
|
|
### from source
|
|
|
|
Ensure that [go](https://golang.org/doc/install) is installed.
|
|
|
|
```shell
|
|
CGO_ENABLED=0 go get github.com/davegallant/vpngate
|
|
```
|
|
|
|
Ensure that the go bin path is discoverable:
|
|
|
|
```shell
|
|
echo 'export PATH=$PATH:$HOME/go/bin' >> ~/.profile
|
|
source ~/.profile
|
|
```
|
|
|
|
## Usage
|
|
|
|
### List available servers
|
|
|
|
```shell
|
|
vpngate list
|
|
```
|
|
|
|
### Connect to a server
|
|
|
|
On macOS, `openvpn` may not be within your PATH. To fix this, run:
|
|
|
|
```shell
|
|
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.
|
|
|
|
```shell
|
|
sudo vpngate connect
|
|
```
|
|
|
|
#### Random
|
|
|
|
If the country doesn't matter, a random server can be selected:
|
|
|
|
```shell
|
|
sudo vpngate connect --random
|
|
```
|
|
|
|
#### Reconnect
|
|
|
|
To continually attempt to reconnect (this can be combined with `--random`):
|
|
|
|
```shell
|
|
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
|