Caddy x IPInfo

> This project does not affiliate with Caddy nor IPInfo. It only extends Caddy with custom code to integrate the free databases provided by IPInfo into Caddy. Logo Copyright belongs to the corresponding project. # Caddy IPInfo free Easy country and ASN lookup by IP with the free IPInfo database. > This module is still in development. Breaking changes will likely come. No stability checks yet. ## Example ``` { # Required as a third-party handler order ipinfo_free first # Configure module ipinfo_free_config { url https://ipinfo.io/data/free/country.mmdb?token=magicduck cron "10 16 * * *" path /tmp/caddy_ipinfo } } :8080 { ipinfo_free "{http.request.uri.query.ip}" header Content-Type text/plain respond < This is equal to the version above but replaces your existing binary with the new one including the package. Caddy has a feature to add packages to your current installation by running the following command: ```bash caddy add-package github.com/oltdaniel/caddy-ipinfo-free ``` ### DIY Route Build a custom binary of the latest caddy release with this module enabled. ```bash CADDY_VERSION=latest xcaddy build --with github.com/oltdaniel/caddy-ipinfo-free ./caddy run ``` ## Directives ### `ipinfo_free_config` (global) #### Examples ``` ipinfo_free_config https://ipinfo.io/data/free/country.mmdb?token=magicduck ipinfo_free_config { url https://ipinfo.io/data/free/country.mmdb?token=magicduck cron "10 16 * * *" path /tmp/caddy_ipinfo } ``` #### Values | Name | Values | Description | |-|-|-| | `url` | valid ipinfo free database url | This url can be easily found in the [Dashboard](https://ipinfo.io/account/data-downloads) of IPInfo after creating an account. Simply choose a database of your choice in the MMDB format and paste the url here. | | `cron` | valid crontab notation

Default: `10 16 * * *` | Customize how often you want to check for a new database. The official time is published by IPInfo in their FAQ [here](https://ipinfo.io/faq/article/141-when-do-the-updates-happen). Timezone is UTC. | | `path` | valid path to store the database

Default: [`os.TempDir()`](https://pkg.go.dev/os#TempDir) with directory `caddy_ipinfo_free` | This will be the path where the databases are stored after download. As there are different kinds of databases, we only accept a path and not a specific filename. Each database will be stored here by their corresponding names from the configured url.

If the configured path does not exist, the directories will be created. If not path is given, a temporary directory will be created in the systems temporary directory with the name `caddy_ipinfo_free`. | ### `ipinfo_free` (handler) #### Examples ``` ipinfo_free ipinfo_free 1 ipinfo_free on ipinfo_free true ipinfo_free enabled ipinfo_free forwarded ipinfo_free trusted ipinfo_free "{http.request.uri.query.ip}" ``` | Values | Description | |-|-| | `disabled`, `false`, `off`, `0` | Explicit disabling of looking up ip information. | | `enabled`, `true`, `on`, `1`, `strict`, empty | The remote address of the request will be used to lookup the ip information. | | `forwarded` | Use the IP set in the `X-Forwarded-For` Header if present, else it will fallback to the remote address of the request. | | `trusted` | Same as `forwarded` but it will make sure that the ip from which the request comes is listed as a trusted proxy in the current caddy environment. | | any value that is an IPv4 or IPv6 | The mode field supportes the [Caddy placeholders ](https://caddyserver.com/docs/json/apps/http/#docs) which allows you to fully customize the IP that is used for lookup.

**NOTE**: If the value maps to an empty string, the remote address of the client will be used as a fallback. | ## Placeholder Variables | Variable | Example | |-|-| | `ipinfo_free.ip` | `1.1.1.1` | | `ipinfo_free.country` | `AU` | | `ipinfo_free.country_name` | `Australia` | | `ipinfo_free.continent` | `OC` | | `ipinfo_free.continent_name`| `Oceania` | | `ipinfo_free.asn` | `AS13335` | | `ipinfo_free.as_name` | `Cloudflare, Inc.` | | `ipinfo_free.as_domain` | `cloudflare.com` | ## Advanced Examples > Just replace the body of the server from the Caddyfile example on top. ### Change Response for Countries This is a simple example on how the response can be changed for certain countries. ``` ipinfo_free header Content-Type text/plain @dach expression ({ipinfo_free.country} in ["DE", "CH", "AT"]) respond @dach "Hallo Besucher aus der DACH-Region!" respond "Hello visistor from {ipinfo_free.country_name}" ``` ### Simple GeoIP API Simply query with `http://localhost:8080/?ip=IP`. ``` ipinfo_free "{http.request.uri.query.ip}" header Content-Type text/plain respond <IP address data powered by IPinfo