diff options
Diffstat (limited to 'README.rst')
| -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 ----------------------- |