diff options
| author | kali kaneko (leap communications) <kali@leap.se> | 2021-02-25 21:41:50 +0100 |
|---|---|---|
| committer | kali kaneko (leap communications) <kali@leap.se> | 2021-02-25 21:41:50 +0100 |
| commit | c81b155a83908b8bec422fd2cc07866ff977106b (patch) | |
| tree | 229726243f6a4d4efb5a11fcf689a59a3dc1cf91 | |
| parent | ea2efe112b52e7f9ab3133c46bae1041a78cbd24 (diff) | |
[docs] explain tool name
| -rw-r--r-- | README.rst | 16 |
1 files changed, 12 insertions, 4 deletions
@@ -1,9 +1,17 @@ -Geolocation +Menshen ======================= -This is a simple geolocation service. -It provides the remote ip (via X-Forwarded-For header, if present), country code, city, and geographical coordinates. -Information is provided in plain text format, under ``/``, and in json, under ``/json``. +Menshen is a geolocation and gateway status service for LEAP VPN. + +In chinese folk religions, `menshen <https://en.wikipedia.org/wiki/Menshen>` +are guardians of doors and gates. + +The geolocation service provides the remote ip (via X-Forwarded-For header, if +present), country code, city, and geographical coordinates. Information is +provided in plain text format, under ``/``, and in json, under ``/json``. + +Menshen will also soon provide a "gateway health" service to help clients choose the +nearest, less congested gateway. This feature is currently undergoing heavy changes. Prerequisites ----------------------- |