Redpoint Interaction v7.x Documentation
Auto Light Dark
Auto Light Dark

Admin: Geolocation setup

Overview

RPI Realtime uses geolocation to find where a visitor is, so that Realtime decisions can use location, distance, geofence, and weather rules. RPI includes a built-in Azure Maps provider. You can also plug in your own geolocation provider, or a plugin that finds a visitor's location from their IP address.

Geolocation is off by default. When you turn it on, RPI Realtime needs an API key from your provider, stored as a secret.

Prerequisites

Value

Where to find it

Azure Maps API key

In the Azure portal, open your Azure Maps account and go to Settings > Authentication. Copy the Primary Key.

Custom provider details (optional)

If you use your own provider plugin, you need the plugin's assembly name, its fully qualified type name, and any settings it expects.

IP lookup plugin details (optional)

If you look up location from IP addresses, you need the same plugin details for your IP lookup plugin.

Finish setting up your provider account before you generate your overrides.

Store the API key

When enabled is true, RPI Realtime requires the secret key RealtimeAPI_Geolocation_APIKey. Add your provider's API key under that name, in a Kubernetes secret or your CSI secret store, whichever your deployment uses. Refer to Secrets management for additional information.

Configure geolocation

Adjust these values under realtimeapi to match your environment:

YAML
realtimeapi:
  geolocation:
    enabled: true
    provider: Azure
    weatherUnits: imperial
    coordsCacheTimespanMinutes: 10

Setting

Description

enabled

Turns geolocation on or off. Defaults to false. When it's false, RPI Realtime gets no geolocation settings and doesn't look for the API key secret.

provider

The geolocation provider. Defaults to Azure, which uses the built-in Azure Maps provider. Any other value means you're using a custom provider plugin.

weatherUnits

Units for weather data. Set it to metric for metric units. Any other value gives imperial units. Defaults to imperial.

coordsCacheTimespanMinutes

How long, in minutes, RPI Realtime reuses a visitor's coordinates before looking them up again. Defaults to 10.

pluginAssembly

The assembly name of a custom provider plugin. Leave it blank to use Azure Maps.

pluginType

The fully qualified type name of a custom provider plugin.

pluginSettings

Key/value settings passed to a custom provider plugin.

If you set provider to a custom value and the plugin can't be loaded, RPI Realtime uses Azure Maps instead and logs an error.

Look up location from IP addresses (optional)

RPI Realtime can find a visitor's location from their IP address. It doesn't include a native IP lookup provider, so you need a plugin for this. The lookup runs only when enableGeoIPLookup is true and both pluginAssembly and pluginType are set.

YAML
realtimeapi:
  geolocation:
    enabled: true
    ipLookup:
      enableGeoIPLookup: true
      coordsCacheTimespanMinutesIPLookup: 30
      pluginAssembly: <assembly name>
      pluginType: <fully qualified type>
      pluginSettings:
        - key: apiKey          
          value: <your key>

Setting

Description

enableGeoIPLookup

Turns IP-based lookup on or off. Defaults to false.

coordsCacheTimespanMinutesIPLookup

How long, in minutes, RPI Realtime reuses coordinates found by IP lookup before looking them up again. Defaults to 30.

pluginAssembly

The assembly name of the IP lookup plugin.

pluginType

The fully qualified type name of the IP lookup plugin.

pluginSettings

Key/value settings passed to the IP lookup plugin.

Generate your overrides

When you have the values above, go to the Helm Assistant Configure tab. Refer to Managing Helm chart updates for more information about adding values to your overrides.yaml. For a complete list of geolocation keys, see the Helm Assistant Reference tab.

Last updated: