README

Easily redirect visitors to a Craft site based on their country of origin

Requirements

This plugin requires Craft CMS 3.0.0-beta.23 or later.

Installation

To install the plugin, follow these instructions.

Open your terminal and go to your Craft project:
```
 cd /path/to/project
```

Then tell Composer to load the plugin:

 composer require superbig/craft-countryredirect

In the Control Panel, go to Settings → Plugins and click the “Install” button for Country Redirect. Alternatively, run the command ./craft install/plugin country-redirect

Country Redirect Overview

@TODO

Using the plugin

Before you start using the plugin, you have to do 3 things:

Download a updated country database database from MaxMind through the plugin settings
Copy the configuration file config.php as country-redirect.php into the Craft config directory, usually config/
Modify the configuration file to match preferences, and make sure you setup the countryMap setting to match your site handles.
Add your MaxMind.com License Key obtained from the MaxMind.com account area.

Configuration

<?php
return [
    '*' => [
        /*
         * Enable for all users
         */
        //'enabled'             => true,
        /*
         * Or specifically logged in/anon users
         */
        'enabled'             => [
            'loggedIn'  => true,
            'anonymous' => true,
        ],

        /*
         * MaxMind.com License Key
         */
        'licenseKey' => null,

        /*
         * Enable logging
         */
        'enableLogging'          => true,

        /*
         * Don't redirect bots/crawlers like GoogleBot, Bing etc.
         */
        'ignoreBots'          => true,

        /*
        * Add any special URL patterns you want to ignore when deciding to redirect
        * This option accepts either exact matches (note the = prefix):
        * '=/shop',
        * or regex patterns:
        * '^\/global\//'
        */
        'ignoreUrlPatterns' => [
            // Matches '/shop' exactly
            '=/shop',

            // Matches uri that starts with '/global/'
            '/^\/global\//',

            // Matches a range of sitemap urls like '/sitemap.xml', '/no/sitemap.xml', '/sitemap_portfolio_1.xml', etc.
            '/^\/(no\/|en\/)*sitemap([\s\S])*\.xml$/',
        ],

        /*
         * Cookie name
         */
        'cookieName'          => 'countryRedirect',

        /*
         * The URL parameter that let a user manually select which locale they want to see
         */
        'overrideLocaleParam' => 'selected-locale',

        /*
         * The URL parameter that indicates that a user was redirect
         */
        'redirectedParam' => 'redirected',

        /*
        * The value of query params
        */
        'queryParamsValue' => '1',

        /*
         * Map a countrys two-letter ISO code to a Craft Site Handle, and/or define a catch-all with a * asterix
         * Here is a list of ISO country codes: http://www.nationsonline.org/oneworld/country_code_list.htm
         * Example:
         * 'countryMap'       => [
         *   'FR' => 'frenchSite',
         *   'DK' => 'danishSite',
         *   // You can also send visitors to an arbitrary URL
         *   'DE' => 'http://google.de',
         *   '*' => 'default',
         * ]
         *
         * If you within a country have different regional languages, you can map the different languages to sites by their Site Handle.
         * Take Switzerland, with German, French, Italian and Romansh, as an example:
         *
         * 'countryMap'       => [
         *   'CH' => [
         *     'fr' => 'frenchSite',
         *     'de' => 'germanSite',
         *   ],
         *   '*' => 'default',
         * ]
         *
         * This works by checking the Accept-Language header of the browser.
         *
         */
        'countryMap'          => [ ],

        /*
         * If you want to show a banner that prompts visitors to their matching site handle instead of redirecting them,
         * you can define these here.
         *
         * The key here is the Craft Site Handle, not the country code. The variables {countryName} and {url} will
         * be replaced.
         *
         * 'banners' => [
         *   'frenchSite' => 'It looks like your visiting from {countryName}. Do you <a href="{url}">want to visited the international site?</a>'
         * ],
         */
        'banners'             => [ ],

        /*
         * Override the detected IP - useful for testing, or when no IP address can be detected
         */
        'overrideIp'          => null,
    ],
];

For a list of the ISO country codes, check out this overview

Navigation

<h1>Select country</h1>

{% set titles = {
    'default': 'Go to our US site',
    'dutchSite': 'Go to our Dutch site',
    'foreignSiteBranch': 'Go to our Danish site',
} %}
<nav class="nav">
    <ul>
        {% for link in craft.countryRedirect.getLinks() %}
            <li>{{link.getLink({ title: titles[link.getId()] })}}</li>
        {% endfor %}
    </ul>
</nav>

Banner prompts

If you want to show a banner that prompts visitors to their matching locale instead of redirecting them, you can define the text for each locale with the banners setting.

You can then access the text like this:

{% set banner = craft.countryRedirect.getBanner() %}
{% if banner %}
    <div class="banner">
        <p>{{ banner.getText() }}</p>
    </div>
{% endif %}

Testing

You can test it by using a free VPN account from TunnelBear

Database

Geolocation data provided by MaxMind

Accuracy

According to MaxMind, their databases is 99.8% accurate on a country level.

Brought to you by Superbig

superbig / craft-countryredirect

Maintainers

Details