telize,6api

                           t  e  l  i  z  e
                       _______________________
                 ______\                     /_______
                \\     \\           ___     //      /
           __    \ ____  \   __    /   \   _____/\ / ____
       ___/  \____/  _//____/  \___\___/___\__   /__/  _//____
      \\__    ____  __/  __     __      ____    ____  __/  __///
        /      \_   |/    \_     /       \/     /_/   |/    \_
      \\\   ___/\___       /____/\_______/\   ___/\___       /
  <0(--- \__/ -h7- \______/   \       .    \__/ ---- \______/ --(0>
                       \      .\     /.      .
                        \      .\   //      /
                         \______\\ //______/ 
                                  Y

Description

Telize is a REST API built on Nginx and Lua allowing to get a visitor IP address and to query location information from any IP address. It outputs JSON-encoded IP geolocation data, and supports both JSON and JSONP.

Requirements

Nginx modules

Telize requires Nginx compiled with the following modules :

GeoIP (Optional HTTP modules : --with-http_geoip_module)
HttpRealipModule (Optional HTTP module : --with-http_realip_module)
HttpEchoModule (Third party module (ngx_echo) : http://wiki.nginx.org/HttpEchoModule)
HttpLuaModule (Third party module (ngx_lua) : http://wiki.nginx.org/HttpLuaModule)

If you are using Debian stable, the nginx-extras package have these modules compiled-in.

Lua modules

Telize requires the following Lua module :

Lua CJSON

Installing via LuaRocks :

luarocks install lua-cjson

GeoIP databases

Telize requires the free GeoLite databases : http://dev.maxmind.com/geoip/legacy/geolite/

For IPv4 support only :

mkdir -p /usr/share/GeoIP
cd /usr/share/GeoIP
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
wget http://download.maxmind.com/download/geoip/database/asnum/GeoIPASNum.dat.gz
gunzip *gz

For IPv4 and IPv6 support :

mkdir -p /usr/share/GeoIP
cd /usr/share/GeoIP
wget http://geolite.maxmind.com/download/geoip/database/GeoIPv6.dat.gz
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCityv6-beta/GeoLiteCityv6.dat.gz
wget http://download.maxmind.com/download/geoip/database/asnum/GeoIPASNumv6.dat.gz
gunzip *gz

Installation

Copy timezone.conf in the Nginx configuration files directory.

Edit nginx.conf to include timezone.conf and to add directives specifying the path to the GeoIP database files, within the http block.

For IPv4 support only :

http {

	...

	include        /etc/nginx/timezone.conf;

	geoip_country  /usr/share/GeoIP/GeoIP.dat;
	geoip_city     /usr/share/GeoIP/GeoLiteCity.dat;
	geoip_org      /usr/share/GeoIP/GeoIPASNum.dat;
}

For IPv4 and IPv6 support (requires at least Nginx 1.3.12) :

http {

	...

	include        /etc/nginx/timezone.conf;

	geoip_country  /usr/share/GeoIP/GeoIPv6.dat;
	geoip_city     /usr/share/GeoIP/GeoLiteCityv6.dat;
	geoip_org      /usr/share/GeoIP/GeoIPASNumv6.dat;
}

Then deploy the API configuration file telize to the appropriate location on your system, and reload Nginx configuration.