Add README
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
2018-03-18 15:24:57 -08:00
parent a2fc7786f7
commit 7a68c28625
3 changed files with 23 additions and 2 deletions

8
LICENSE Normal file
View File

@@ -0,0 +1,8 @@
Copyright 2018 Ask Bjørn Hansen
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

15
README.md Normal file
View File

@@ -0,0 +1,15 @@
# geoipapi
This provides a small daemon intended to run within for example
a kubernetes to provide MaxMind GeoIP data to other services over
HTTP.
The available APIs are `/api/country?ip=192.0.2.1` returning the
country of the IP and `/api/json?ip=192.0.2.1` providing the maxmind
data in JSON format.
OpenTelemetry tracing is supported with the standard Traceparent http
header, and configuration through the standard environment variables.
(Work great with the opentelemetry collector operator).
There's a small Go API client in `client/geoipapi`.

2
go.mod
View File

@@ -2,8 +2,6 @@ module go.ntppool.org/geoipapi
go 1.23
toolchain go1.24rc1
require (
github.com/oschwald/geoip2-golang v1.11.0
go.ntppool.org/common v0.3.1