ProfessionalUwU/echoip-slatecave
1
0
Fork 0
mirror of https://codeberg.org/slatian/service.echoip-slatecave.git synced 2024-11-10 00:27:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added some documentation for the geolocation databses

Browse Source
This commit is contained in:
Slatian 2023-03-27 16:03:37 +02:00
parent a9512d7d4d
commit f9753ccbfc
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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. 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 ## Security Considerations
### Information disclosure ### Information disclosure
@ -59,7 +65,7 @@ For a public service you should use a reverse proxy like Caddy, apache2 or nginx
### Denail of Service ### 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. `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 ## License