Umbraco.Community.Engage.LocationHeaders 0.1.1

Engage LocationHeaders

Engage - LocationHeaders is a lightweight package for Umbraco Engage that enriches analytics and segmentation data with location information extracted from HTTP headers.

The package is designed to work out-of-the-box on Umbraco Cloud, using location headers automatically injected by services like Cloudflare or Azure Front Door. This allows Engage to tap into geographic information such as country, region, and city, without the need for client-side geolocation or third-party services.

✨ Features

• 🔌 Plug-and-play for Umbraco Cloud – no setup required
• 🌍 Supports Cloudflare, Azure Front Door, and other CDNs that inject location headers
• ⚙️ Optional configuration for custom header names or alternative setups
• 📊 Enables location-based segmentation and analytics in Umbraco Engage

Installation

Add the package to an existing Umbraco website (v13+) from nuget:

dotnet add package Umbraco.Community.Engage.LocationHeaders

🛠️ Configuration (Optional)

By default, the package expects certain common header names. If your setup uses different headers, you can override the defaults using appsettings configuration:

"Engage": {
  "LocationHeaders": {
    "Country": "uc-ipcountry",
    "County": "CF-Region",
    "Province": "CF-Region",
    "City": "cf-ipcity"
  }
}

If your infrastructure uses custom headers, you can override the defaults in your appsettings.json file. Simply add an Engage:LocationHeaders section with keys like Country, County, Province, or City and map them to your custom header names.

🚀 Getting Started

Install the package via NuGet and deploy it to your Umbraco project. If you’re using a compatible CDN (like Cloudflare), the package will begin collecting location data immediately.

🧠 Use Cases

• Segment content based on visitor location
• Build region-specific personalizations
• Enhance analytics with geographic insights

📦 Package Compatibility

• Compatible with Umbraco 13.x
• Optimized for Umbraco Cloud
• Requires Umbraco Engage

Bring location awareness to your digital experiences with Engage - LocationHeaders – simple, configurable, and Umbraco Cloud-ready.

Contributing

Contributions to this package are most welcome! Please read the Contributing Guidelines.

🙌 Acknowledgements

Big thanks to the community members who inspired and supported this package:

• 💡 @TvGessel – for the original idea of using location headers to enrich Umbraco Engage with geolocation data.
• 🧰 @LottePitcher – for providing the excellent Umbraco Package Starter Kit, which this package is built upon.

This package wouldn’t exist without your contributions — thank you!