This repository has been archived on 2023-06-10. You can view files and clone it, but cannot push or open issues or pull requests.

33 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2022-03-06 17:09:40 +01:00
# mullvad-best-server
2022-03-06 17:46:55 +01:00
![Build](https://github.com/bastiandoetsch/mullvad-best-server/actions/workflows/go.yml/badge.svg)
2022-03-06 19:25:06 +01:00
Determines the mullvad.net server with the lowest latency.
2022-03-06 17:09:40 +01:00
## Installation
Download binary from releases for your platform and unpack.
## Usage
### Default usage
2022-03-06 17:09:40 +01:00
Execute `mullvad-best-server`. It outputs the code, e.g. `de05`. You can then connect to it with e.g. wireguard using the normal shell scripts.
2022-03-06 19:06:59 +01:00
### Command line parameters
```angular2html
Usage of dist/mullvad-best-server_darwin_amd64/mullvad-best-server:
-c string
Server country code, e.g. ch for Switzerland (default "ch")
-o string
Output format. 'json' outputs server json
-t string
Server type, e.g. wireguard (default "wireguard")
```
If you want the full server information, execute `mullvad-best-server -o json`. It returns the full json output of the server information.
2022-03-06 19:06:59 +01:00
The `-c` flag allows to give a country code. Else `ch` will be used.
2022-03-06 17:09:40 +01:00
## Background
2022-03-06 19:10:33 +01:00
The program uses `https://api.mullvad.net/www/relays/<SERVER_TYPE/` to get the current server list, pings the ones with the right country
2022-03-06 17:09:40 +01:00
and outputs the server with the lowest ping.