Setting up Sitecore IP Geolocation

Last updated Friday, August 31, 2018 in Sitecore Experience Platform for Developer

The Sitecore IP Geolocation service provides information about the location and owner of an IP address beyond that provided by a reverse DNS lookup. IP Geolocation information includes the country, state, city, and the registered company name of every visitor.

You can use IP Geolocation lookups to create conditional renderings or personalization rules that show different content based on the visitor's location.

This topic describes:

System requirements for Sitecore 8.0

The Sitecore IP Geolocation Service component is a separate package in Sitecore 8.0. It supports all Sitecore 8.0 versions from Sitecore 8.0 rev. 141212 and later. The module has been tested specifically with Sitecore 8.0 rev. 150223 (Update-2) and Sitecore 8.0 rev. 150427 (Update-3).

We recommend that you update your Sitecore installation to the latest version.

Activate the Sitecore IP Geolocation service

To activate the Sitecore IP Geolocation Service on Sitecore XP *, you must subscribe to the Sitecore IP Geolocation service in the App Center. The Sitecore IP Geolocation service is now free of charge and with unlimited lookups per month.

Note

Your IP Geolocation service subscription is connected to your unique Sitecore License ID. This means that if you update your license ID (for example, when you use a new license.xml), you must reactivate your IP Geolocation subscription.

Install the Sitecore IP Geolocation service for Sitecore 8.0

Installing Sitecore IP Geolocation Service consists of two basic steps:

  1. Subscribe to the Sitecore IP Geolocation Service
  2. Install and enable the package. To ensure you have the right package, go to dev.sitecore.net.

Note

Your IP Geolocation service subscription is connected to your unique Sitecore License ID. This means that if you update your license ID (for example, when you use a new license.xml), you must reactivate your IP Geolocation subscription.

Subscribe to the Sitecore IP Geolocation Service

  1. On the Sitecore Launchpad, click App Center.

    Cloud_IPGeolocation_Launchpad_screenshot

  2. In the Sitecore App Center, click Sitecore IP Geolocation Service.

    Cloud_IPGeolocation_SitecoreAppCenter_screenshot

  3. Click Continue to proceed with your sign-up and to see a summary of your subscription.

    Cloud_IPGeolocation_PricePlan_screenshot

  4. Click Confirm to view the Terms of Service.

    Cloud_IPGeolocation_PurchaseConfirmation_screenshot

  5. Select the I accept the terms and conditions check box and click Continue to complete your subscription.

    Cloud_IPGeolocation_SitecoreIPGeolocationTermsOfService_screenshot

Now your subscription is complete.

Cloud_IPGeolocation_SubscriptionComplete_screenshot

Note

After activating your subscription, the system may take some time to update your license information. When this information is updated, the Sitecore IP Geolocation Service will automatically carry out geolocation lookups.

Install and enable the Sitecore IP Geolocation Service

After purchasing the Sitecore IP Geolocation Service from the Sitecore App Center, you can install the Sitecore IP Geolocation component on your Sitecore instance:

  1. Go to https://dev.sitecore.net/Downloads.aspx, and download the Sitecore IP Geolocation Service Client 1.2 package.
  2. On the Sitecore Launchpad, click Control Panel, and in the Administration section, click Install a package and then use the wizard to install the package and accept the license.
  3. Upload the package using the Upload Wizard.

    Important

    You must select the Overwrite all files checkbox.

  4. Open the CES folder /inetpub/wwwroot/yourinstancename/Website/App_Config/Include/CES/

    Note

    Make sure you change yourinstancename to the actual name of your instance.

  5. To enable the configuration files, remove .disable from the end of the file names.

    Enable the following files:

    • Sitecore.CES.config
    • Sitecore.CES.GeoIp.config
    • Sitecore.CES.GeoIP.LegacyLocation.config

Upgrade your Sitecore IP Geolocation Service

If you have the initial version of the Sitecore IP Geolocation client 1.2 rev. 150429 installed, you can use the following steps to upgrade to the Sitecore IP Geolocation Service Client 1.2 rev. 150602 (Update-1).

  1. On https://dev.sitecore.net/Downloads.aspx, download Sitecore IP Geolocation Service Client 1.2 rev. 150602.
  2. Follow steps 2–5 in the previous section.

Configuration file changes

If you have made any changes to your configuration files, you should:

  • Back up your configuration files.
  • Install the update package and overwrite the existing configuration files.
  • Reapply your configuration file changes in the new version of your configuration files.

Firewall configuration

It is common to set up a firewall between your content management and content delivery servers. To ensure that the Sitecore IP Geolocation service works correctly in every scenario, you must configure your firewall settings to allow requests to the service.

Add a firewall rule to allow HTTPS protocol for:

  • geoIp-ces.cloud.sitecore.net
  • Discovery-ces.cloud.sitecore.net

Using a proxy server

To ensure that requests that come from a reverse proxy server to your Sitecore instance are tracked as the valid IP addresses of a client, and not as the IP addresses of a proxy:

  • In Sitecore.Analytics.Tracking.config file, change the value of the Analytics.ForwardedRequestHttpHeader setting to X-Forwarded-For.

Send feedback about the documentation to docsite@sitecore.net.