mirror of
https://github.com/davegallant/vpngate.git
synced 2025-08-06 00:33:40 +00:00
Add initial prototype (#1)
* Add survey library to select server * Add speedtest * Add --random flag to connect * Add list command * Cache server list * Tail the openvpn logs so that it appears in vpngate logs * Add goreleaser action * Add golangci-lint action
This commit is contained in:
56
README.md
56
README.md
@@ -0,0 +1,56 @@
|
||||
# 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. Once connected to a relay server, speed tests kick off to determine latency, upload speed and download speed.
|
||||
|
||||

|
||||
|
||||
Once connected, you can check out your IP address: https://nordvpn.com/what-is-my-ip/
|
||||
|
||||
## Requirements
|
||||
|
||||
- [openvpn](https://github.com/OpenVPN/openvpn)
|
||||
- macOS or Linux (might work on Windows)
|
||||
|
||||
## Install
|
||||
|
||||
```sh
|
||||
go get github.com/davegallant/vpngate
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### List Available VPNs
|
||||
|
||||
```sh
|
||||
$ vpngate list
|
||||
```
|
||||
|
||||
### Connect to a VPN
|
||||
|
||||
Because openvpn creates a network interface, run the connect command with `sudo` or a user with escalated privileges.
|
||||
|
||||
```sh
|
||||
$ sudo vpngate connect
|
||||
```
|
||||
|
||||
#### Random
|
||||
|
||||
If the country doesn't matter, a random VPN can be selected:
|
||||
|
||||
```sh
|
||||
$ sudo vpngate connect --random
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- I do not maintain any of the VPN servers on vpngate.net. Connect to these VPN servers at your own discretion
|
||||
- Many of the listed servers claim to have a logging policy of 2 weeks
|
||||
|
||||
|
||||
## Todo
|
||||
|
||||
- Allow for servers to be cycled periodically (--cycle)
|
||||
|
Reference in New Issue
Block a user