Documentation Home

Module Installation

Note: Before configuring this module, please ensure that you have completed the Broadleaf Geolocation API Configuration.

Steps to enable this module in your custom Broadleaf Commerce project

Steps

Step 1 Pull this dependency into your core/pom.xml:

<dependency>
    <groupId>org.broadleafcommerce</groupId>
    <artifactId>broadleaf-free-geo-ip</artifactId>
</dependency>

This assumes that you are using the Broadleaf BOM that pins all version information. If not, you will need to also add a <version> qualifier

System Property Configuration

First, be sure that you have set geolocation.api.enabled to true either through your common-shared.properties file or using the System Properties section of the admin interface.

To specify that this module's Geolocation API implementation should be used, you will need to override the geolocation.api system property with the following value: blFreeGeoIpAPI.