Loading...

Last updated: Jun 18 2018

Area: Episerver CMS Applies to versions: 10 and higher
Other versions:

Configuring personalization

This topic describes how to configure settings for personalization features when using visitor groups.

Providing access for editors to visitor groups

To access Visitor Groups in the global menu, you must be a member of the CmsAdmins or VisitorGroupAdmins access groups, otherwise you are prompted to a login page. If you want editors to add, edit, and delete visitor groups, you can provide access by adding them to VisitorGroupAdmins (CmsAdmins and CmsEditors are already defined in the configuration). The following example shows how to configure access for editors with the virtualRoles element in the <episerver.framework> section in the web.config file:

<virtualRoles replacePrincipal="true">
  <providers>
      ...
      <add name="VisitorGroupAdmins" 
           type="EPiServer.Security.MappedRole, EPiServer" roles="WebEditors" mode="Any" />
  </providers>
</virtualRoles>

Enabling a Geolocation provider

As of version 11.4.0 of the Episerver CMS Visual Studio Extensions, new CMS projects will no longer be created with a Geolocation provider configured. The Geolocation provider that has been shipped with CMS will also be removed in a future release as the MaxMind GeoLite database it depends on has been deprecated.

You can enable geographic location based visitor groups by configuring a Geolocation provider service. Episerver supplies a provider for the free GeoLite2 database from MaxMind through an optional NuGet package named EPiServer.Personalization.MaxMindGeolocation. The  GeoLite2 Geolocation database can be downloaded from MaxMind’s website. New versions of this database are released every month as the information is continuously updated.

The provider requires both the IP lookup database (.mmdb) and the accompanying locations database (.csv) to be able to serve an updated list of locations. The location of these files must be specified in your configuration such as:

<geolocation defaultProvider="maxmind2">
    <providers>
        <add name="maxmind2" 
             type="EPiServer.Personalization.MaxMindGeolocationProvider, EPiServer.Personalization.MaxMindGeolocation" 
             databaseFileName="path\to\GeoLite2-City.mmdb" 
             locationsFileName="path\to\GeoLite2-City-Locations-en.csv" />
    </providers>
</geolocation>

Alternatively you can configure the provider in the ConfigureContainer method of an initialization module that implements the IConfigurableModule interface.

public void ConfigureContainer(ServiceConfigurationContext context)
{
    context.Services.AddMaxMindGeolocationProvider("path\to\GeoLite2-City.mmdb", "path\to\GeoLite2-City-Locations-en.csv");
}

Note that Continent and Country names are localized using the usual localization in CMS while Regions are loaded directly from the Locations file.

Utilizing geographic location provided by a CDN

Episerver CMS also provides an option for retrieving Geolocation from the current request, when provided from the CDN in the form of a request header. This option is only used in cases where no dedicated Geolocation provider is configured and only supports Continent and Country locations. See Content Delivery Network (CDN) Configuration for additional information on how to enable this option.

Support for retrieving location from request headers was added to version 11.9.0 of EPiServer.Framework.AspNet.


Do you have feedback on this documentation? Send an email to documentation@episerver.com. For development-related questions and discussions, refer to our Forums on https://world.episerver.com/forum/