For Administrators

Installation

There are several ways to require and install this extension. We recommend to get this extension via composer.

Via Composer

If your TYPO3 instance is running in composer mode, you can simply require the extension by running:

composer req leuchtfeuer/locate

Via Extension Manager

Open the extension manager module of your TYPO3 instance and select "Get Extensions" in the select menu above the upload button. There you can search for locate and simply install the extension. Please make sure you are using the latest version of the extension by updating the extension list before installing the locate extension.

Via ZIP File

You need to download the locate extension from the TYPO3 Extension Repository and upload the zip file to the extension manager of your TYPO3 instance and activate the extension afterwards.

Important

Please make sure to include all TypoScript files.

Important

For an more accurate IPv6 support, your PHP needs to support either gmp or bcmath. It also has to be compiled without the --disable-ipv6 option. The determination of IP addresses is also possible without these packages, but it is less precise.

Additional Packages

Static Info Tables

If you want to use the geo blocking feature for your pages, you need to to install the static info tables extension as well. It is enough to install just the basic version. Additional country-specific versions are not required by this extension. If you are using a composer setup you can execute following command:

composer req sjbr/static-info-tables

Detect Crawler

If you want to exclude bots such as the Google search bot from being assigned specific website versions, you must require the composer package jaybizzle/crawler-detect. This feature is only available in composer setups. If your TYPO3 is not running in composer mode, you have to provide this functions on your own.

composer req jaybizzle/crawler-detect

Updating the IP Database

We try to update the supplied IP database every quarter. For this update we provide a new patchlevel release of this extension. After this new version has been installed, you can update your local database via the Extension Manager module in your TYPO3 backend as shown below.

Update the provided IP database

You can update your local IP tables via the Extension Manager module.

Enabling this Extension

If you want to activate the language assignment, you have to add the following TypoScript line after you have installed locate and included the TypoScript. This function is disabled by default.

config.tx_locate = 1

If you do not want to activate the language assignment on every page, you can simply put the activation into a condition.

[page["uid"] == 1]
    config.tx_locate = 1
[end]

Logging

All critical errors will be logged into a dedicated logfile which is located in the TYPO3 log directory (e.g. var/logs) and contains the phrase locate in its name. If you want to increase the loglevel, you must overwrite the log configuration, for example like this:

$GLOBALS['TYPO3_CONF_VARS']['LOG']['Leuchtfeuer']['Locate'] = [
    'writerConfiguration' => [
        \TYPO3\CMS\Core\Log\LogLevel::DEBUG => [
            \TYPO3\CMS\Core\Log\Writer\FileWriter::class => [
                'logFileInfix' => 'locate',
            ],
        ],
    ],
];

For further configuration options and more examples take a look at the official TYPO3 documentation.