[feat] add prometheus metrics for country
[getmyip.git] / README.rst
1 Geolocation
2 =======================
3 This is a simple geolocation service.
4
5 It provides the remote ip (via X-Forwarded-For header, if present), country code, city, and geographical coordinates.
6 Information is provided in plain text format, under ``/``, and in json, under ``/json``.
7
8 Prerequisites
9 -----------------------
10
11 You can use ``geoipupdate`` to download MaxMind's City database::
12
13     sudo apt install geoipupdate
14     sudo cp /usr/share/doc/geoipupdate/examples/GeoIP.conf.default /etc/GeoIP.conf
15     sudo geoipupdate -v
16
17 (note: this service now requires a license key)
18
19 Usage
20 -----------------------
21
22 -geodb <path>
23         path to the GeoLite2-City database (default is "/var/lib/GeoIP/GeoLite2-City.mmdb")
24 -port <port>
25         port where the service listens on (default is 9001)
26 -notls
27         disable TLS on the service
28 -server_crt string
29         path to the cert file for TLS
30 -server_key string
31         path to the key file for TLS
32