mmgeoip Module

The following modules must be loaded before this module:

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

You can select which GeoIP library to use by setting the GEOIP environment variable, before compiling the module, to one of the following values:

IMPORTANT: If the selected library is not installed the module won't compile.

NOTE: If GEOIP env is not set, the module will try to find which GeoIP library is installed, prioritizing libmaxminddb.

Path to either a GeoLite or GeoIP City database file.

Mandatory parameter.

...
modparam("mmgeoip", "mmgeoip_city_db_path",
  "/usr/share/GeoIP/GeoLiteCity.dat")
...
		

Databse memory caching options. The following options are available:

Default value for this parameter is MMAP_CACHE.

NOTE: If libmaxminddb is used, this parameter will be ignored as the library only supports loading the database into mmap allocated memory.

...
modparam("mmgeoip", "cache_type","MEM_CACHE_CHECK")
...
		

Looks up information specified by field associated with the IP address src. The resulting data is loaded in reverse order into the dst AVP.

Parameters:

When using the GeoIP2 library, each token from the list given in the fields parameter can be provided as a path to a specific key in the data structure associated with an IP. Thus, the token format is 'key_name.key_name[.key_name]*'. If a key's value is an array, instead of a subkey name, an index should be provided in order to select the appropriate value.

Example tokens: 'country.names.en', 'continent.names.en ', 'subdivisions.0.iso_code'. For more details about the available fields in the database and the key names that should be used to retrieve them, check the MaxMind GeoIP2 documentation.

This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE,ERROR_ROUTE, and LOCAL_ROUTE.

...
if(mmg_lookup("lon:lat",$si,$avp(lat_lon))) {
  xlog("L_INFO","Source IP latitude:$(avp(lat_lon)[0])\n");
  xlog("L_INFO","Source IP longitude:$(avp(lat_lon)[1])\n");
};
...
# fields format only supported for GeoIP2
if(mmg_lookup("continent.names.en:country.iso_code,",$si,$avp(geodata))) {
  xlog("L_INFO","Source IP country code:$(avp(geodata)[0])\n");
  xlog("L_INFO","Source IP continent:$(avp(geodata)[1])\n");
};
...