--- title: "GeoIP Lookup" description: "Geo-reference TenXObjects via their ipAddress value" source: "https://github.com/log-10x/modules/tree/main/pipelines/run/modules/initialize/geoIP/module.yaml" icon: "material/globe-model" --- Enriche TenXObjects by geo-referencing [ipAddress](https://doc.log10x.com/api/js/#TenXObject+ipAddress "An array of string values of IPV4 parsed from the object's text.") values via [GeoIP DB](https://doc.log10x.com/api/js/#TenXLookup.loadGeoIPDB) lookup. Database files [reload](https://doc.log10x.com/run/reload/ "Monitor changes to configuration and symbol files") on disk changes and can [sync](https://doc.log10x.com/config/github/) from GitHub. On Kubernetes, deliver them via [ConfigMap](https://doc.log10x.com/config/k8s/) (the `@kubernetes` macro writes via temp + atomic rename, which reloads; plain volume-mounted ConfigMaps do not). Resolves IP addresses to: Continent, Country, Subdivision, City, Postal, Latitude, Longitude. ## :material-wrench-outline: Config Files To configure the GeoIP lookup module, [:material-cog: Edit](https://doc.log10x.com/config/app/#module-config "Learn how to edit app and module configurations") these files. Below is the default configuration from: [geoIP/config.yaml](https://github.dev/log-10x/config/blob/main/pipelines/run/initialize/geoIP/config.yaml "geoIP/config.yaml"){target="\_blank"}.

Edit Online

```yaml # 🔟❎ 'run' GeoIP lookup configuration # The GeoIP lookup geo-references TenXObjects based on their ipAddress field value. # To learn more see https://doc.log10x.com/api/js/#TenXObject+ipAddress # Set the 10x pipeline to 'run' tenx: run # =============================== Dependencies ================================ include: run/modules/initialize/geoIP # =============================== GeoIP Options =============================== geoIP: # 'file' specifies the MaxMind GeoIP DB (.mmdb) file to load. # To learn more see https://doc.log10x.com/api/js/#TenXLookup.loadGeoIPDB file: data/run/lookup/geo.mmdb # 'countryField' specifies the field name for country geo-reference data. # Defaults to "country". Set to "" to disable country enrichment. countryField: country # Uncomment the following fields to enable additional geo-reference data as needed: # continentField: continent # subdivisionField: subdivision # cityField: city # postalField: postal # latitudeField: latitude # longitudeField: longitude ``` ## :material-menu: Options Specify the options below to [configure](/config "configure") the GeoIP lookup: |Name|Description| |---|---| |[geoIPFile](#geoipfile "MaxMind GeoIP file (.mmdb)")|MaxMind GeoIP file (.mmdb)| |[geoIPContinentField](#geoipcontinentfield "Field name for continent geo-reference")|Field name for continent geo-reference| |[geoIPCountryField](#geoipcountryfield "Field name for country geo-reference")|Field name for country geo-reference| |[geoIPSubdivisionField](#geoipsubdivisionfield "Field name for subdivision geo-reference")|Field name for subdivision geo-reference| |[geoIPCityField](#geoipcityfield "Field name for city geo-reference")|Field name for city geo-reference| |[geoIPPostalField](#geoippostalfield "Field name for postal code geo-reference")|Field name for postal code geo-reference| |[geoIPLatitudeField](#geoiplatitudefield "Field name for latitude geo-reference")|Field name for latitude geo-reference| |[geoIPLongitudeField](#geoiplongitudefield "Field name for longitude geo-reference")|Field name for longitude geo-reference| ### :material-menu-right-outline:**`geoIPFile`** MaxMind GeoIP file (.mmdb). |Type|Required| |---|---| |File|✔| The [MaxMind](https://www.maxmind.com/en/geoip2-databases){target="\_blank"} GeoIP DB file (.mmdb) to load. To learn more, see [loadGeoIPDB](https://doc.log10x.com/api/js/#TenXLookup.loadGeoIPDB). ### :material-menu-right-outline:**`geoIPContinentField`** Field name for continent geo-reference. |Type|Default| |---|---| |String|continent| Specifies the field name to store the continent geo-reference data (e.g., "my\_continent"). Defaults to "continent". Set to "" to disable continent enrichment. ### :material-menu-right-outline:**`geoIPCountryField`** Field name for country geo-reference. |Type|Default| |---|---| |String|country| Specifies the field name to store the country geo-reference data (e.g., "my\_country"). Defaults to "country". Set to "" to disable country enrichment. ### :material-menu-right-outline:**`geoIPSubdivisionField`** Field name for subdivision geo-reference. |Type|Default| |---|---| |String|subdivision| Specifies the field name to store the subdivision (state/region) geo-reference data (e.g., "my\_region"). Defaults to "subdivision". Set to "" to disable subdivision enrichment. ### :material-menu-right-outline:**`geoIPCityField`** Field name for city geo-reference. |Type|Default| |---|---| |String|city| Specifies the field name to store the city geo-reference data (e.g., "my\_city"). Defaults to "city". Set to "" to disable city enrichment. ### :material-menu-right-outline:**`geoIPPostalField`** Field name for postal code geo-reference. |Type|Default| |---|---| |String|postal| Specifies the field name to store the postal code geo-reference data (e.g., "my\_postal"). Defaults to "postal". Set to "" to disable postal code enrichment. ### :material-menu-right-outline:**`geoIPLatitudeField`** Field name for latitude geo-reference. |Type|Default| |---|---| |String|latitude| Specifies the field name to store the latitude geo-reference data (e.g., "my\_latitude"). Defaults to "latitude". Set to "" to disable latitude enrichment. ### :material-menu-right-outline:**`geoIPLongitudeField`** Field name for longitude geo-reference. |Type|Default| |---|---| |String|longitude| Specifies the field name to store the longitude geo-reference data (e.g., "my\_longitude"). Defaults to "longitude". Set to "" to disable longitude enrichment.
:material-github: This module is defined in [geoIP/module.yaml](https://github.com/log-10x/modules/tree/main/pipelines/run/modules/initialize/geoIP/module.yaml "geoIP/module.yaml"){target="\_blank"}.