[sr-dev] git:master: geoip: extend docs after discussion with Francesco Castellano

Module: sip-router Branch: master Commit: b280f89b3ac4f97c3cad1487961509bae893f656 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b280f89… Author: Henning Westerholt &lt;henning.westerholt(a)1und1.de&gt; Committer: Henning Westerholt &lt;henning.westerholt(a)1und1.de&gt; Date: Mon May 16 15:48:53 2011 +0200 geoip: extend docs after discussion with Francesco Castellano --- modules/geoip/README | 8 ++++++++ modules/geoip/doc/geoip_admin.xml | 11 ++++++++++- 2 files changed, 18 insertions(+), 1 deletions(-) diff --git a/modules/geoip/README b/modules/geoip/README index 016d0d8..595b5df 100644 --- a/modules/geoip/README +++ b/modules/geoip/README @@ -82,6 +82,14 @@ Chapter 1. Admin Guide and its derivatives as libgeoip, and probably by other distributions as well. + Debian Linux squeeze includes already a database as dependency, but as + this contain the wrong data, it will not work correctly with the + module. More acurate, the module expect the GeoIP City Edition, and + will not work with the GeoIP Country Edition. In newer Debian Linux + releases the package geoip-database-contrib should contain the + necessary database. You can download the Lite edition of the DB from + here. + This module exports a new class of pseudo-variables - $gip(pvc=>key) - to enable access to the results of a query to the database. diff --git a/modules/geoip/doc/geoip_admin.xml b/modules/geoip/doc/geoip_admin.xml index b8c9f17..f1df9ca 100644 --- a/modules/geoip/doc/geoip_admin.xml +++ b/modules/geoip/doc/geoip_admin.xml @@ -28,7 +28,7 @@ </para> <para> This database itself can be obtained on a free or commercial basis - <ulink url="http://www.maxmind.com/app/ip-location">here</ulink>;here</ulink>. The + <ulink url="http://www.maxmind.com/app/ip-location">here</ulink>;here</ulink>. The library that interfaces with the Max Mind API, as well as scripts to automate downloading of the on-disk version of the open-source database is also packaged by the Debian Linux distribution and @@ -36,6 +36,15 @@ other distributions as well. </para> <para> + Debian Linux squeeze includes already a database as dependency, but as + this contain the wrong data, it will not work correctly with the module. + More acurate, the module expect the <emphasis>GeoIP City Edition</emphasis>, + and will not work with the <emphasis>GeoIP Country Edition</emphasis>. In + newer Debian Linux releases the package <emphasis>geoip-database-contrib</emphasis> + should contain the necessary database. You can download the Lite edition + of the DB from <ulink url="http://www.maxmind.com/app/geolitecity">here</ulink>;here</ulink>. + </para> + <para> This module exports a new class of pseudo-variables - $gip(pvc=&gt;key) - to enable access to the results of a query to the database.