mirror of
https://github.com/davegallant/vpngate.git
synced 2025-08-05 16:23:40 +00:00
119 lines
3.0 KiB
Markdown
119 lines
3.0 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://ipinfo.io/json>, or run the following:
|
|
|
|
```shell
|
|
curl ipinfo.io
|
|
```
|
|
|
|
## Requirements
|
|
|
|
- OpenVPN
|
|
- macOS, Linux, or Windows
|
|
|
|
## Install
|
|
|
|
You can install vpngate in a few different ways, and it will differ slightly depending on your OS.
|
|
|
|
### Homebrew (macOS and linux)
|
|
|
|
vpngate can be installed with [homebrew](https://brew.sh/) (if on macOS, ensure that xcode is installed before installing homebrew by running `xcode-select --install`).
|
|
|
|
```shell
|
|
brew install openvpn davegallant/public/vpngate
|
|
```
|
|
|
|
### Windows
|
|
|
|
On Windows, install OpenVPN from the [official website](https://openvpn.net/community-downloads/).
|
|
|
|
As there is no installer at the moment, you will need to download and extract the Windows release from the relevant Github release.
|
|
|
|
Once the release is extracted, open Command Prompt *as Administrator*, and run vpngate.exe from the location where it was extracted.
|
|
|
|
<img width="278" alt="image" src="https://github.com/user-attachments/assets/fb47270d-82bb-4790-833a-377b874c8104">
|
|
|
|
<img width="565" alt="image" src="https://github.com/user-attachments/assets/42287904-6c00-48d1-bff3-9757cf250519">
|
|
|
|
### Build 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
|
|
|
|
> If on macOS, you may need to add openvpn to your PATH (if you installed it with brew): `export PATH=$(brew --prefix openvpn)/sbin:$PATH`
|
|
|
|
### List available servers
|
|
|
|
```shell
|
|
vpngate list
|
|
```
|
|
|
|
### Connect to a server
|
|
|
|
Because openvpn creates a network interface, run the connect command with `sudo` or a user with escalated privileges.
|
|
|
|
```shell
|
|
sudo vpngate connect
|
|
```
|
|
|
|
#### Reconnect
|
|
|
|
To continually attempt to reconnect (this can be combined with `--random`):
|
|
|
|
```shell
|
|
sudo vpngate connect --reconnect
|
|
```
|
|
|
|
#### Random
|
|
|
|
If the country doesn't matter, a random server can be selected:
|
|
|
|
```shell
|
|
sudo vpngate connect --random
|
|
```
|
|
|
|
#### Proxy
|
|
|
|
In some cases, anonymity is necessary to populate the list of available VPN servers.
|
|
|
|
A proxy is a way to bypass restrictions and in some cases, internet censorship.
|
|
|
|
##### HTTP/HTTPS
|
|
|
|
Use the specified HTTP/HTTPS proxy to fetch the server list.
|
|
|
|
```shell
|
|
sudo vpngate connect --proxy "http://localhost:8080"
|
|
```
|
|
|
|
##### SOCKS5
|
|
|
|
Use the specified SOCKS5 proxy to fetch the server list.
|
|
|
|
```shell
|
|
sudo vpngate connect --socks5 "127.0.0.1:1080"
|
|
```
|
|
|
|
## 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
|