terminal42/contao-geoip2-country

Detect country of visitor and protect elements in Contao using MaxMind GeoIP2 database

Fund package maintenance!
terminal42
Other

Installs: 178

Dependents: 1

Suggesters: 3

Security: 0

Stars: 4

Watchers: 3

Forks: 0

Open Issues: 0

Type:contao-bundle

1.2.5 2021-07-02 10:29 UTC

This package is auto-updated.

Last update: 2021-12-02 11:32:05 UTC


README

This Contao extension finds the country from the client IP. The website can then be customized based on this information.

This extension requires the MaxMind GeoIP2 database, either the GeoIP2 Country or GeoLite2 Country database. Be aware that you might need a commercial license of this product depending on your use case!

Features

  1. Limit content based on the user country
    By default, visibility for pages, articles, content elements and front end modules can be set for the country. For each content, you can either show only to or hide it from a list of countries.

  2. Symfony HTTP Reverse Proxy
    Integrated support for the Symfony HTTP Reverse Proxy allows a page to be cached for each country by using Vary headers. Without a supported reverse proxy, responses with country-specific content are automatically set to Cache-Control: private.

    This will be automatically configured for you in a Contao Managed Edition.

  3. Default country for members
    The detected country is set as the default country for new members, so the registration front end module already has the country pre-selected.

  4. Support for terminal42/contao-countryselect
    If the countryselect form field is added to a form, the default option is automatically set to the visitors country.

Installation

Choose the installation method that matches your workflow!

Installation via Contao Manager

Search for terminal42/contao-geoip2-country in the Contao Manager and add it to your installation. Finally, update the packages.

Manual installation

Add a composer dependency for this bundle. Therefore, change in the project root and run the following:

composer require terminal42/contao-geoip2-country

Depending on your environment, the command can differ, i.e. starting with php composer.phar … if you do not have composer installed globally.

Then, update the database via the contao:migrate command or the Contao install tool.

HTTP Reverse Proxy

If you do not use the Contao Managed Edition, you can manually register the CacheHeaderSubscriber when using the Symfony Reverse Proxy including friendsofsymfony/http-cache.

Configuration

MaxMind GeoIP2 database

Install the binary MMDB file and configure its path in the GEOIP2_DATABASE environment variable (e.g. through your .env/.env.local file).

Bundle configuration

Default configuration:

terminal42_geoip2_country:
    database_path: %env(GEOIP2_DATABASE)%
    fallback_country: XX
    dca_tables: [tl_content, tl_article, tl_module, tl_page]
  • database_path: Path to the MMDB file. Defaults to the GEOIP2_DATABASE environment variable. Be aware that this setting does not apply to the HTTP Reverse Proxy!

  • fallback_country: The default country if a visitors IP cannot be detected (e.g. applies to localhost as well). XX is the United Nations standard for unknown country, but by entering a valid ISO 3166-1 alpha-2 code unknown visitors will see a specific content.

  • dca_tables: configures which elements allow the country restrictions. Changing this will add the DCA fields to the given table(s), but for any but the default tables you will need to implement your own visibility checks!

Updating the MaxMind GeoIP2 database

Detecting the country from IP requires an up-to-date information source, as IPs change all the time. We recommend to use MaxMind's Automatic Update Support to keep your database up-to-date.

Thanks!

Thanks to Burki & Scherer AG (@Tsarma) for the original implementation and supporting the development.

License

This bundle is released under the MIT