A Varnish VMOD to query MaxMind GeoIP2 DB files
C M4 Makefile Perl Shell
Switch branches/tags
Nothing to show
Clone or download

README.md

libvmod-geoip2

Build Status

About

A Varnish master VMOD to query MaxMind GeoIP2 DB files.

For Varnish 4.1/5.x and 6.0 refer to the oldstable and master branches, respectively.

Requirements

To build this VMOD you will need:

  • make
  • a C compiler, e.g. GCC or clang
  • pkg-config
  • python-docutils or docutils in macOS [1]
  • Varnish master built from sources
  • libmaxminddb-dev in recent Debian/Ubuntu releases, maxminddb in macOS [1]. See also https://github.com/maxmind/libmaxminddb

If you are building from Git, you will also need:

  • autoconf
  • automake
  • libtool

You will also need to set PKG_CONFIG_PATH to the directory where varnishapi.pc is located before running autogen.sh and configure. For example:

export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig

Finally, to use it you will need one or more GeoIP2 or GeoLite2 binary databases. See https://dev.maxmind.com/.

Installation

From a tarball

To install this VMOD, run the following commands:

./configure
make
make check
sudo make install

The make check step is optional but it's good to know whether the tests are passing on your platform.

From the Git repository

To install from Git, clone this repository by running:

git clone --recursive https://github.com/fgsch/libvmod-geoip2

And then run ./autogen.sh followed by the instructions above for installing from a tarball.

Example

import geoip2;

sub vcl_init {
	new country = geoip2.geoip2("/path/to/GeoLite2-Country.mmdb");
}

sub vcl_recv {
	if (country.lookup("country/names/en", client.ip) != "Japan") {
		...
	}
}

More examples available at https://github.com/fgsch/libvmod-geoip2/wiki.

DB updates

To update the GeoIP2 DB, download the new file on the same filesystem as the old one and move it over. See also https://github.com/maxmind/geoipupdate.

License

This VMOD is licensed under BSD license. See LICENSE for details.

Note

  1. Using Homebrew, https://github.com/Homebrew/brew/.