Changes

From SME Server
Jump to navigationJump to search

GeoIP (view source)

Revision as of 15:47, 29 January 2020

7,065 bytes added ,  15:47, 29 January 2020
→‎Db compatibility with other softwares
Line 1: Line 1:  
{{Languages}}
 
{{Languages}}
 
=== Maintainer ===
 
=== Maintainer ===
 +
[[User:ReetP|john crisp]]
 +
 
[mailto:stephdl@de-labrusse.fr stephdl] Stéphane de Labrusse AKA [[User:stephdl|Stephdl]]<br />
 
[mailto:stephdl@de-labrusse.fr stephdl] Stéphane de Labrusse AKA [[User:stephdl|Stephdl]]<br />
 
=== Version ===
 
=== Version ===
−
{{ #smeversion: smeserver-geoip }}
+
{{#smeversion: smeserver-geoip }}
 +
 
 +
{{Warning box|From MAXMIND site :
 +
"Due to upcoming data privacy regulations, we are making significant changes to how you access free GeoLite2 databases starting December 30, 2019. Learn more on our blog." https://blog.maxmind.com/2019/12/18/significant-changes-to-accessing-and-using-geolite2-databases/
 +
 
 +
Quote
 +
Starting December 30, 2019, we will be requiring users of our GeoLite2 databases to register for a MaxMind account and obtain a license key in order to download GeoLite2 databases. We will continue to offer the GeoLite2 databases without charge, and with the ability to redistribute with proper attribution and in compliance with privacy regulations. In addition, we are introducing a new end-user license agreement to govern your use of the GeoLite2 databases. Previously, GeoLite2 databases were accessible for download to the public on our developer website and were licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
 +
 
 +
Starting December 30, 2019, downloads will no longer be served from our public GeoLite2 page, from geolite.maxmind.com/download/geoip/database/*, or from any other public URL.
 +
End Quote
 +
 
 +
See the section below [[GeoIP#Installation_and_Updating_of_geoip_v2_db|Installation of V2 db ]] for steps on how to migrate to the new download mechanism.}}
    
===Description===
 
===Description===
Line 11: Line 24:  
{{Note box|Maxmind have removed support for their legacy v1 DBs and an update to v2 DBs is required. Please see the bugtracker link to bug #9033 below for more information }}
 
{{Note box|Maxmind have removed support for their legacy v1 DBs and an update to v2 DBs is required. Please see the bugtracker link to bug #9033 below for more information }}
    +
=== Installation of legacy geoip v1 db ===
 +
 +
those are still available for few time only for back compatibility purpose and to avoid a yum update mess, or if you do not trust third party repo, but be aware thos db are not updated anymore since April 2018 and were already only 80% accurate then.
 +
yum install smeserver-geoip --enablerepo=smecontribs
 +
config set UnsavedChanges no
 +
signal-event geoip-update
 +
 +
==== update of geoip v1 db ====
 +
if you have smeserver-geoip-1.1.2-7 already installed,  this will keep you on the legacy version, only change new plugin comaptible with v1 and removal of cron update.
 +
yum update --enablerepo=smecontribs
 +
 +
===Installation and Updating of geoip v2 db===
 +
 +
{{Note box| GeoIP2 will ONLY work on x64 CPU}}
 +
 +
Sign up for a MaxMind account (no purchase required) https://dev.maxmind.com/geoip/geoip2/geolite2/
 +
 +
Important - Note your login details and in particular your AccountID and LicenseKey
 +
 +
Go to Services My Licence key and generate a licence key, carefully note the key details, multiple keys may be created.
 +
 +
The following config property keys and values will be used to set the geoip config db for ongoing updates see below
 +
AccountID #######
 +
LicenseKey xxxxxxxxxxxxxxx
 +
 
Because the databases have been updated new perl modules are required to support GeoIP v2. The core modules have a large number of dependencies and we have decided that it is not practical for the Koozali team to maintain them all.
 
Because the databases have been updated new perl modules are required to support GeoIP v2. The core modules have a large number of dependencies and we have decided that it is not practical for the Koozali team to maintain them all.
    
As a result you will now need the OpenFusion repo to install smeserver-geoip We will be syncing their mirror in due course to speed up installs and updates.
 
As a result you will now need the OpenFusion repo to install smeserver-geoip We will be syncing their mirror in due course to speed up installs and updates.
 +
yum  --enablerepo=smeaddons install smeserver-extrarepositories-openfusion
 +
signal-event yum-modify
 +
config set UnsavedChanges no
   −
yum  --enablerepo=smeaddons install smeserver-extrarepositories-openfusion
+
====Updating to v2 with v1 DBs installed====
 +
If you have the v1 DBs package smeserver-geoip-1.1.2-7 already installed and do not wish to update to v2 DBs you may perform updates safely, after making sure your smeserver-extrarepositories-openfusion is the latest, the following:
 +
 
 +
To carry out an install or update of the new v2 DBs you are required to firstly remove the exclude statement from the openfusion repo db
 +
db yum_repositories delprop openfusion Exclude
 
  signal-event yum-modify
 
  signal-event yum-modify
 +
You may then go ahead with the following to either install or update a v2 DB package
 +
yum install smeserver-geoip2 --enablerepo=smecontribs,openfusion
 +
yum update --enablerepo=smecontribs,openfusion
 
  config set UnsavedChanges no
 
  config set UnsavedChanges no
   −
The openfusion repo now includes a number of packages as includes and Excludes, this is to prevent inadvertent system updates occurring resulting in unstable or inaccessible systems. These can be seen here:
+
A configuration db for geoip has been created as part of the install
 +
# config show geoip
 +
geoip=service
 +
    status=enabled
   −
  db yum_repositories show openfusion
+
Now add Maxmind AccountID and LicenseKey properties and keys to the geoip db config
 +
 
 +
db configuration setprop geoip LicenseKey "YOUR LIC KEY" AccountID "YOUR ACCT ID"
 +
 
 +
====Fresh Installation of geoip v2 DBs====
 +
To carry out an install or update of the new v2 DBs you are required to firstly remove the exclude statement from the openfusion repo db
 +
  db yum_repositories delprop openfusion Exclude
 +
signal-event yum-modify
 +
 
 +
You may then go ahead with the following to either install or update a v2 DB package
 +
 
 +
yum install smeserver-geoip2 --enablerepo=smecontribs,openfusion
 +
config set UnsavedChanges no
 +
 
 +
A configuration db for geoip has been created as part of the install
 +
# config show geoip
 +
geoip=service
 +
    status=enabled
   −
====Updating v1 version====
+
Now add Maxmind AccountID and LicenseKey properties and keys to the geoip db config
−
If you have the v1 DBs package smeserver-geoip-1.1.2-7 installed you may update safely with the either of the following
  −
yum update smeserver-geoip --enablerepo=smecontribs,openfusion (preferred method)
  −
yum update --enablerepo=smecontribs,openfusion 
     −
If you do not want to update you will need to follow something like this:
+
db configuration setprop geoip LicenseKey "YOUR LIC KEY" AccountID "YOUR ACCT ID"
   −
db yum_repositories setprop smecontribs Exclude smeserver-geoip
+
==== I installed the beta versions of smeserver-geoip v2 ====
−
signal-even yum-modify
+
if you installed smeserver-geoip-1.2-1, smeserver-geoip-1.2-2, smeserver-geoip-1.2-3, then you have already a v2, but you still need to do as you were with legacy  version and want to upgrade to v2. Otherwise you will not have the db updated anymore
   −
===Installation/Update v2 DBs===
  −
To carry out an install or update of the new v2 DBs you are required to firstly remove the exclude statement from the openfusion repo db
   
  db yum_repositories delprop openfusion Exclude
 
  db yum_repositories delprop openfusion Exclude
 +
signal-event yum-modify
 +
You may then go ahead with the following to either install or update a v2 DB package
 +
yum install smeserver-geoip2 --enablerepo=smecontribs,openfusion
 +
yum update --enablerepo=smecontribs,openfusion
 +
config set UnsavedChanges no
 +
 +
A configuration db for geoip has been created as part of the install
 +
# config show geoip
 +
geoip=service
 +
    status=enabled
   −
You may then go ahead with the following to either install or update a v2 DB package
+
Now add Maxmind AccountID and LicenseKey properties and keys to the geoip db config. To use the update feature, you need to register for a free Maxmind accoutn and register for a accoutn id and key : https://www.maxmind.com/en/account/login Register and get to "My License Key".    Generating a new license key will not disable existing keys. You can have a maximum of 25 active license keys at one time.
   −
  yum install smeserver-geoip --enablerepo=smecontribs,openfusion
+
  db configuration setprop geoip LicenseKey "YOUR LIC KEY" AccountID "YOUR ACCT ID"
−
yum update smeserver-geoip --enablerepo=smecontribs,openfusion (preferred method)
  −
yum update --enablerepo=smecontribs,openfusion
     −
then
+
==== Update the db ====
 +
(only working for geoip2 from 2019/01/03)
 
  signal-event geoip-update
 
  signal-event geoip-update
   Line 53: Line 125:     
This contrib adds a template to /etc/crontab to automatically update the database once a month. It's set to do so at midnight on the 5th of each month. If you have a paid subscription through the maintainer of this database (http://dev.maxmind.com/geoip/geoipupdate/) you can update more often. If you do want to update more often, you will have to create a custom template to handle the change. In addition, you will be supplied login credentials that have to be inserted into the file /etc/GeoIP.conf for the update to complete. The file is not templated so it will survive reboots. Use your favorite text editor to insert the information into this file.
 
This contrib adds a template to /etc/crontab to automatically update the database once a month. It's set to do so at midnight on the 5th of each month. If you have a paid subscription through the maintainer of this database (http://dev.maxmind.com/geoip/geoipupdate/) you can update more often. If you do want to update more often, you will have to create a custom template to handle the change. In addition, you will be supplied login credentials that have to be inserted into the file /etc/GeoIP.conf for the update to complete. The file is not templated so it will survive reboots. Use your favorite text editor to insert the information into this file.
 +
 +
==== More info on openfusion repo config ====
 +
 +
The openfusion repo now includes a number of packages as includes and Excludes, this is to prevent inadvertent system updates occurring when updating the old v1 DB package resulting in unstable or inaccessible systems, this is all they are for. These can be seen here:
 +
db yum_repositories show openfusion
    
==Testing==
 
==Testing==
 +
 +
{{Note box| These tests use the V1 DB which will be increasingly out of date.}}
    
Now that the package and database are installed, we can test it (refer to Country Code list at end of page as required).  
 
Now that the package and database are installed, we can test it (refer to Country Code list at end of page as required).  
Line 414: Line 493:     
Users are advised to determine the effectiveness of the database for themselves.
 
Users are advised to determine the effectiveness of the database for themselves.
 +
 +
=== Db compatibility with other softwares ===
 +
Some software either use or depends on a geoip library, here is a table to help understand:
 +
{| class="wikitable sortable"
 +
!software
 +
!repo
 +
!Geoip 1 support
 +
!Geoip 2 support
 +
!notes on behaviour and default or settings to do
 +
|-
 +
|spamassassin
 +
|smeos
 +
|yes
 +
|3.4.2 or above
 +
|
 +
|-
 +
|smeserver-mailsats
 +
|smecontribs
 +
|yes
 +
|Yes with updates
 +
|Requires updated perl-IO-Socket-INET6 and check_badcountries plugin: https://bugs.contribs.org/show_bug.cgi?id=10523
 +
|-
 +
|qpsmtpd plugin / smeserver-geoip
 +
|smecontribs
 +
|yes
 +
|smeserver-geoip 1.2 and above
 +
|new bad_countries is a fork of qpsmtpd geoip plugin, default to v2 unless v2 is not available then failback on v1
 +
|-
 +
|proftpd
 +
|smeos
 +
|only
 +
|no
 +
|no support for v2 yet see https://github.com/proftpd/proftpd/issues/605
 +
|-
 +
|apache mod_geoip
 +
|smecontribs
 +
|yes
 +
|unknown
 +
|v 1.2.10 requires libGeoIP.so.1 and GeoIP: probably only v1 db supported up there
 +
|-
 +
|apache mod_maxminddb
 +
|
 +
|
 +
|yes
 +
|https://github.com/maxmind/mod_maxminddb available in smecontribs [[Mod maxminddb|smeserver-mod_maxminddb]]
 +
|-
 +
|opensips-mmgeoip
 +
|epel
 +
|
 +
|
 +
|unknown
 +
|-
 +
|php-pecl-geoip
 +
|epel
 +
|yes
 +
|no
 +
|depends on libGeoIP.so.1
 +
|-
 +
|php*-php-pecl-geoip
 +
|remi-safe
 +
|yes
 +
|no
 +
|depends on libGeoIP.so.1
 +
|-
 +
|php-maxminddb
 +
|remi
 +
|no
 +
|yes
 +
|need to test if installs with base php. mostly not...
 +
|-
 +
|php*-php-maxminddb
 +
|remi-safe
 +
|
 +
|yes
 +
|depends on libmaxminddb
 +
|-
 +
|lighttpd-mod_geoip
 +
|epel
 +
|yes
 +
|
 +
|depends on libGeoIP.so.1
 +
|-
 +
|nginx-mod-http-geoip
 +
|epel
 +
|yes
 +
|
 +
|depends on libGeoIP.so.1 ; found a source for geoip2  https://github.com/leev/ngx_http_geoip2_module
 +
|-
 +
|python-GeoIP
 +
|epel
 +
|yes
 +
|no
 +
|
 +
|-
 +
|python-geoip2 python2-maxminddb
 +
|
 +
|no
 +
|yes
 +
|not available on CentOS 6 but 7.
 +
|-
 +
|python-pygeoip
 +
|epel
 +
|yes
 +
|no
 +
|Pure Python GeoIP API
 +
|-
 +
|uwsgi-plugin-geoip
 +
|epel
 +
|
 +
|
 +
|unknown
 +
|-
 +
|perl-Geo-IP
 +
|smecontribs
 +
|only
 +
|no
 +
|libGeoIP.so.1
 +
|-
 +
|perl-GeoIP2
 +
|openfusion
 +
|no
 +
|yes
 +
|
 +
|-
 +
|perl-MaxMind-DB-*
 +
|openfusion
 +
|no
 +
|yes
 +
|
 +
|-
 +
|libmaxminddb
 +
|epel
 +
|
 +
|
 +
|1.1.1 needed for mmdblookup
 +
|-
 +
|mmdblookup
 +
|
 +
|
 +
|
 +
|provided by libmaxminddb-devel (see https://bugzilla.redhat.com/show_bug.cgi?id=1663670)
 +
|}
 +
you might want to use legacy db updated with recent Maxmind geoilite2, see: https://www.miyuru.lk/geoiplegacy
 +
 
=== Bugs ===
 
=== Bugs ===
 
Please raise bugs under the SME-Contribs section in [http://bugs.contribs.org/enter_bug.cgi bugzilla]
 
Please raise bugs under the SME-Contribs section in [http://bugs.contribs.org/enter_bug.cgi bugzilla]
Line 425: Line 648:  
Only released version in smecontrib are listed here.
 
Only released version in smecontrib are listed here.
   −
{{ #smechangelog: smeserver-geoip}}
+
{{#smechangelog: smeserver-geoip}}
       
----
 
----
−
<noinclude>[[Category:Howto]]</noinclude>
+
<noinclude>
 +
[[Category:Howto]]
 +
</noinclude>
 
[[Category: Contrib]]
 
[[Category: Contrib]]
Unnilennium
Super Admin, Wiki & Docs Team, Bureaucrats, Interface administrators, Administrators
3,228

edits

Retrieved from "https://wiki.koozali.org/Special:MobileDiff/37806...38283"

Navigation menu