Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.5 KB

README.md

File metadata and controls

51 lines (37 loc) · 1.5 KB
Raw

Geolix Adapter: MMDB2

MMDB2 adapter for Geolix.

Package Setup

To use the Geolix MMDB2 Adapter with your projects, edit your mix.exs file and add the required dependencies:

defp deps do
  [
    # ...
    {:geolix_adapter_mmdb2, "~> 0.6.0"},
    # ...
  ]
end

An appropriate version of :geolix is automatically selected by the adapter's dependency tree.

Adapter Configuration

To start using the adapter with a compatible database you need to add the required configuration entry to your :geolix configuration:

config :geolix,
  databases: [
    %{
      id: :geolite2_city,
      adapter: Geolix.Adapter.MMDB2,
      source: "/absolute/path/to/GeoLite2-City.mmdb"
    },
    %{
      id: :geolite2_country,
      adapter: Geolix.Adapter.MMDB2,
      source: "/absolute/path/to/GeoLite2-Country.mmdb"
    }
  ]

For more configuration details and options please refer to the inline documentation of the Geolix.Adapter.MMDB2 module.

Benchmark

A (minimal) benchmark script is included. Please refer to the Mixfile or mix help output for the name.

License

Apache License, Version 2.0

License information about the supported MaxMind GeoIP2 Country, MaxMind GeoIP2 City and MaxMind GeoLite2 databases can be found on their respective sites.