Module geolocator

Source
Expand description

Geolocation service

This global module can be used to provide geolocation information to blocks that support it.

ipapi.co is the default geolocator service.

§Configuration

§ipapi.co Options

KeyValuesRequiredDefault
geolocatoripapiYesNone

§Ip2Location.io Options

KeyValuesRequiredDefault
geolocatorip2locationYesNone
api_keyYour Ip2Location.io API key.NoNone

An api key is not required to get back basic information from ip2location.io. However, to get more additional information, an api key is required. See pricing for more information.

The api_key option can be omitted from configuration, in which case it can be provided in the environment variable IP2LOCATION_API_KEY

§Examples

Use the default geolocator service:

[geolocator]
geolocator = "ipapi"

Use Ip2Location.io

[geolocator]
geolocator = "ip2location"
api_key = "XXX"

Structs§

Geolocator
IPAddressInfo

Enums§

GeolocatorBackend