Make geo database usage optional (#39)

Dockerfile

@@ -15,6 +15,8 @@ RUN --mount=type=cache,target=/go/pkg/mod/ apk --no-cache add make && make build
 
 FROM builder AS build-prod-app
 # hadolint ignore=DL3018
+RUN apk update && apk add --no-cache ca-certificates && update-ca-certificates
+# hadolint ignore=DL3018
 RUN --mount=type=cache,target=/go/pkg/mod/ apk --no-cache add make upx \
     && make build \
     && upx --best --lzma whatismyip

Makefile

@@ -50,9 +50,10 @@ endif
 
 docker-run: docker-build-dev
 	docker run --tty --interactive --rm \
-	-v ${PWD}/test/GeoIP2-City-Test.mmdb:/tmp/GeoIP2-City-Test.mmdb:ro \
-	-v ${PWD}/test/GeoLite2-ASN-Test.mmdb:/tmp/GeoLite2-ASN-Test.mmdb:ro -p 8080:8080 \
-	${DOCKER_URL}:${VERSION} \
-		-geoip2-city /tmp/GeoIP2-City-Test.mmdb \
-		-geoip2-asn /tmp/GeoLite2-ASN-Test.mmdb \
+		--publish 8080:8080 \
+		--volume ${PWD}/test/GeoIP2-City-Test.mmdb:/GeoIP2-City-Test.mmdb \
+		--volume ${PWD}/test/GeoLite2-ASN-Test.mmdb:/GeoLite2-ASN-Test.mmdb \
+		${DOCKER_URL}:${VERSION} \
+		-geoip2-city /GeoIP2-City-Test.mmdb \
+		-geoip2-asn /GeoLite2-ASN-Test.mmdb \
 		-trusted-header X-Real-IP

README.md

@@ -14,15 +14,17 @@
   - [Usage](#usage)
   - [Examples](#examples)
     - [Run a default TCP server](#run-a-default-tcp-server)
-    - [Run a TLS (HTTP/2) and enable What is my DNS](#run-a-tls-http2-and-enable-what-is-my-dns)
+    - [Run a default TCP server with geo information enabled](#run-a-default-tco-server-with-geo-information-enabled)
+    - [Run a TLS (HTTP/2) and enable "what is my DNS" with geo information](#run-a-tls-http2-and-enable-what-is-my-dns-with-geo-information)
     - [Run an HTTP/3 server](#run-an-http3-server)
     - [Run a default TCP server with a custom template and trust a pair of custom headers set by an upstream proxy](#run-a-default-tcp-server-with-a-custom-template-and-trust-a-pair-of-custom-headers-set-by-an-upstream-proxy)
   - [Download](#download)
   - [Docker](#docker)
     - [Run a container locally using test databases](#run-a-container-locally-using-test-databases)
     - [From Docker Hub](#from-docker-hub)
 
-> [!NOTE]  
+> [!NOTE]
+> Since version 3.0.0, geodb database is not mandatory, not adding the flags will disable the geo feature.
 > Since version 2.3.0, the application includes an optional client [DNS discovery](#dns-discovery)
 
 Just another "what is my IP address" service, including geolocation, TCP open port checking, and headers information. Written in go with high performance in mind,
@@ -124,42 +126,48 @@ Golang >= 1.22 is required.
 ```text
 Usage of whatismyip:
   -bind string
-        Listening address (see https://pkg.go.dev/net?#Listen) (default ":8080")
+      Listening address (see https://pkg.go.dev/net?#Listen) (default ":8080")
   -enable-http3
-        Enable HTTP/3 protocol. HTTP/3 requires --tls-bind set, as HTTP/3 starts as a TLS connection that then gets upgraded to UDP. The UDP port is the same as the one used for the TLS server.
+      Enable HTTP/3 protocol. HTTP/3 requires --tls-bind set, as HTTP/3 starts as a TLS connection that then gets upgraded to UDP. The UDP port is the same as the one used for the TLS server.
   -enable-secure-headers
-        Add sane security-related headers to every response
+      Add sane security-related headers to every response
   -geoip2-asn string
-        Path to GeoIP2 ASN database
+      Path to GeoIP2 ASN database. Enables ASN information. (--geoip2-city becomes mandatory)
   -geoip2-city string
-        Path to GeoIP2 city database
+      Path to GeoIP2 city database. Enables geo information (--geoip2-asn becomes mandatory)
   -resolver string
-        Path to the resolver configuration. It actually enables the resolver for DNS client discovery.
+      Path to the resolver configuration. It actually enables the resolver for DNS client discovery.
   -template string
-        Path to template file
+      Path to the template file
   -tls-bind string
-        Listening address for TLS (see https://pkg.go.dev/net?#Listen)
+      Listening address for TLS (see https://pkg.go.dev/net?#Listen)
   -tls-crt string
-        When using TLS, path to certificate file
+      When using TLS, path to certificate file
   -tls-key string
-        When using TLS, path to private key file
+      When using TLS, path to private key file
   -trusted-header string
-        Trusted request header for remote IP (e.g. X-Real-IP). When using this feature if -trusted-port-header is not set the client port is shown as 'unknown'
+      Trusted request header for remote IP (e.g. X-Real-IP). When using this feature if -trusted-port-header is not set the client port is shown as 'unknown'
   -trusted-port-header string
-        Trusted request header for remote client port (e.g. X-Real-Port). When this parameter is set -trusted-header becomes mandatory
+      Trusted request header for remote client port (e.g. X-Real-Port). When this parameter is set -trusted-header becomes mandatory
   -version
-        Output version information and exit
+      Output version information and exit
 ```
 
 ## Examples
 
 ### Run a default TCP server
 
+```bash
+./whatismyip
+```
+
+### Run a default TCP server with geo information enabled
+
 ```bash
 ./whatismyip -geoip2-city ./test/GeoIP2-City-Test.mmdb -geoip2-asn ./test/GeoLite2-ASN-Test.mmdb
 ```
 
-### Run a TLS (HTTP/2) and enable What is my DNS
+### Run a TLS (HTTP/2) and enable "what is my DNS" with geo information
 
 ```bash
 ./whatismyip -geoip2-city ./test/GeoIP2-City-Test.mmdb -geoip2-asn ./test/GeoLite2-ASN-Test.mmdb \

cmd/whatismyip.go

@@ -13,6 +13,7 @@ import (
 	"github.com/dcarrillo/whatismyip/internal/setting"
 	"github.com/dcarrillo/whatismyip/resolver"
 	"github.com/dcarrillo/whatismyip/server"
+	"github.com/dcarrillo/whatismyip/service"
 	"github.com/gin-contrib/secure"
 	"github.com/patrickmn/go-cache"
 
@@ -41,11 +42,20 @@ func main() {
 		engine.Use(router.GetDNSDiscoveryHandler(store, setting.App.Resolver.Domain, setting.App.Resolver.RedirectPort))
 	}
 
+	var geoSvc *service.Geo
+	if setting.App.GeodbPath.City != "" || setting.App.GeodbPath.ASN != "" {
+		var err error
+		geoSvc, err = service.NewGeo(context.Background(), setting.App.GeodbPath.City, setting.App.GeodbPath.ASN)
+		if err != nil {
+			panic(err)
+		}
+	}
+
 	router.SetupTemplate(engine)
-	router.Setup(engine)
+	router.Setup(engine, geoSvc)
 	servers = slices.Concat(servers, setupHTTPServers(context.Background(), engine.Handler()))
 
-	whatismyip := server.Setup(servers)
+	whatismyip := server.Setup(servers, geoSvc)
 	whatismyip.Run()
 }
 

go.mod

@@ -4,26 +4,28 @@ go 1.23
 
 require (
 	github.com/docker/docker v26.1.5+incompatible
-	github.com/gin-contrib/secure v1.1.0
+	github.com/gin-contrib/secure v1.1.1
 	github.com/gin-gonic/gin v1.10.0
 	github.com/google/uuid v1.6.0
 	github.com/miekg/dns v1.1.62
 	github.com/oschwald/maxminddb-golang v1.13.1
 	github.com/patrickmn/go-cache v2.1.0+incompatible
 	github.com/quic-go/quic-go v0.48.2
-	github.com/stretchr/testify v1.9.0
+	github.com/stretchr/testify v1.10.0
 	github.com/testcontainers/testcontainers-go v0.31.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
 	dario.cat/mergo v1.0.0 // indirect
 	github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
+	github.com/BurntSushi/toml v1.4.0 // indirect
 	github.com/Microsoft/go-winio v0.6.1 // indirect
 	github.com/Microsoft/hcsshim v0.11.4 // indirect
 	github.com/bytedance/sonic v1.12.6 // indirect
 	github.com/bytedance/sonic/loader v0.2.1 // indirect
 	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
+	github.com/chavacava/garif v0.1.0 // indirect
 	github.com/cloudwego/base64x v0.1.4 // indirect
 	github.com/cloudwego/iasm v0.2.0 // indirect
 	github.com/containerd/containerd v1.7.15 // indirect
@@ -33,9 +35,11 @@ require (
 	github.com/distribution/reference v0.5.0 // indirect
 	github.com/docker/go-connections v0.5.0 // indirect
 	github.com/docker/go-units v0.5.0 // indirect
+	github.com/fatih/color v1.18.0 // indirect
+	github.com/fatih/structtag v1.2.0 // indirect
 	github.com/felixge/httpsnoop v1.0.4 // indirect
 	github.com/gabriel-vasile/mimetype v1.4.7 // indirect
-	github.com/gin-contrib/sse v0.1.0 // indirect
+	github.com/gin-contrib/sse v1.0.0 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/go-ole/go-ole v1.2.6 // indirect
@@ -47,14 +51,20 @@ require (
 	github.com/gogo/protobuf v1.3.2 // indirect
 	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/google/pprof v0.0.0-20241210010833-40e02aabc2ad // indirect
+	github.com/hashicorp/go-version v1.7.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/klauspost/compress v1.16.0 // indirect
+	github.com/klauspost/compress v1.17.11 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.9 // indirect
 	github.com/kr/text v0.2.0 // indirect
 	github.com/leodido/go-urn v1.4.0 // indirect
 	github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 // indirect
 	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mattn/go-runewidth v0.0.16 // indirect
+	github.com/mgechev/dots v0.0.0-20210922191527-e955255bf517 // indirect
+	github.com/mgechev/revive v1.5.1 // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
 	github.com/moby/docker-image-spec v1.3.1 // indirect
 	github.com/moby/patternmatcher v0.6.0 // indirect
 	github.com/moby/sys/sequential v0.5.0 // indirect
@@ -63,17 +73,20 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/morikuni/aec v1.0.0 // indirect
-	github.com/onsi/ginkgo/v2 v2.22.0 // indirect
+	github.com/olekukonko/tablewriter v0.0.5 // indirect
+	github.com/onsi/ginkgo/v2 v2.22.2 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
 	github.com/opencontainers/image-spec v1.1.0 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.3 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/power-devops/perfstat v0.0.0-20210106213030-5aafc221ea8c // indirect
 	github.com/quic-go/qpack v0.5.1 // indirect
+	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/shirou/gopsutil/v3 v3.23.12 // indirect
 	github.com/shoenig/go-m1cpu v0.1.6 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/spf13/afero v1.11.0 // indirect
 	github.com/tklauser/go-sysconf v0.3.12 // indirect
 	github.com/tklauser/numcpus v0.6.1 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
@@ -96,5 +109,5 @@ require (
 	google.golang.org/genproto/googleapis/api v0.0.0-20231106174013-bbf56f31fb17 // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20231120223509-83a465c0220f // indirect
 	google.golang.org/grpc v1.59.0 // indirect
-	google.golang.org/protobuf v1.36.0 // indirect
+	google.golang.org/protobuf v1.36.1 // indirect
 )