summaryrefslogtreecommitdiff
path: root/README.rst
blob: d9780191dc4fa1ba0edc3924a0d2da657eed046e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
Geolocation
=======================
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``.

Prerequisites
-----------------------

You can use ``geoipupdate`` to download MaxMind's City database::

    sudo apt install geoipupdate
    sudo cp /usr/share/doc/geoipupdate/examples/GeoIP.conf.default /etc/GeoIP.conf
    sudo geoipupdate -v

(note: this service now requires a license key)

Usage
-----------------------

-geodb <path>
	path to the GeoLite2-City database (default is "/var/lib/GeoIP/GeoLite2-City.mmdb")
-port <port>
	port where the service listens on (default is 9001)
-notls
	disable TLS on the service
-server_crt string
	path to the cert file for TLS
-server_key string
	path to the key file for TLS