| Author: | Michael Bischof |
|---|---|
| Date: | 2015-05-04 |
| Version: | 1.1 |
| Manual section: | 3 |
import geoip;
Functions to handle country detection based on the client ip address.
- Prototype
config(STRING NAME, STRING VALUE)
- Return value
- NONE
- Description
Configures the geoip module. Supported options are:
file: Specify the database file default_name: The default country name returned if not found default_code: The default country code returned if not found
- Example
geoip.config("file", "/tmp/geoip.db");
- Prototype
country_name(STRING IP)
- Return value
- STRING
- Description
- Returns the detected country name by ip.
- Example
set resp.http.x-country-name = geoip.country_name(client.ip);
- Prototype
country_code(STRING IP)
- Return value
- STRING
- Description
- Returns the detected country code by ip.
- Example
set resp.http.x-country-code = geoip.country_code(client.ip);
The source tree is based on autotools to configure the building, and does also have the necessary bits in place to do functional unit tests using the varnishtest tool.
Usage:
./configure
Make targets:
- make - builds the vmod
- make install - installs your vmod in VMODDIR
- make check - runs the unit tests in
src/tests/*.vtc
In your VCL you could then use this vmod along the following lines:
import geoip;
sub vcl_deliver {
# This sets resp.http.x-country-name to the detected country name
set resp.http.x-country-name = geoip.country_name(client.ip);
}
This manual page was released as part of the varnish-vmod-geoip package. For further information about vmods in general check the vmod directory: https://www.varnish-cache.org/vmods
This document is licensed under the same license as the varnish-vmod-geoip project. See LICENSE for details.
- Copyright (c) 2014-2015 by Byteworks GmbH