From f9753ccbfc880883ec0762d5ef04352a6224771a Mon Sep 17 00:00:00 2001 From: Slatian Date: Mon, 27 Mar 2023 16:03:37 +0200 Subject: [PATCH] Added some documentation for the geolocation databses --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bcdcac4..17074cc 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,12 @@ The default templates should make use of everything exposed to the templating pa The templates are covered by the AGPL as well, please share them with your users if you modified them. +### GeoLite2 database + +For geolocation to work you need a MaxMind format database, for full functionality you need the GeoLite2-ASN and GeoLite2-City databses. Unfortunately you have to sign up with [MaxMind](https://maxmind.com) to obtain them. Once you have a license key there is a helper script in [contrib/maxmind-download.sh](contrib/maxmind-download.sh) that helps you with keeping the databse updated. + +Since v1.0 echoip-slatecave reloads the databses when it rececieves a `USR1` signal. + ## Security Considerations ### Information disclosure @@ -59,7 +65,7 @@ For a public service you should use a reverse proxy like Caddy, apache2 or nginx ### Denail of Service `echoip-slatecave` has some simle ratelimiting built in (see the `[ratelimit]` section in the configuration file) this should help you with too frequest automated requests causung high load. -The default configuration is pretty liberal so that the average human probably won't notice the rate limit, but a misbehavin bot will be limited to one request every 3 seconds after 15 requests. +The default configuration is pretty liberal so that the average human probably won't notice the rate limit, but a misbehavingig bot will be limited to one request every 3 seconds after 15 requests. ## License