Lantern.Umbraco 1.0.2

Lantern for Umbraco

Inject the Lantern bug-tracking widget into every frontend page of your Umbraco site — no template changes required. Configure your embed key right from the Umbraco backoffice.

Features

• 🔑 Backoffice settings — paste your Lantern embed key in the Settings → Lantern dashboard
• ⚡ Automatic injection — the <script> tag is inserted before </body> on all public HTML pages via ASP.NET Core middleware
• 🛡️ Backoffice excluded — /umbraco routes are always skipped
• 📋 Config fallback — set Lantern:EmbedKey in appsettings.json as a static fallback (database value takes precedence)
• 🎛️ Path exclusions — optionally exclude specific path prefixes from injection
• 🏷️ Header badge — a subtle status indicator in the backoffice toolbar

Requirements

Installation

NuGet Package Manager

dotnet add package Lantern.Umbraco

Package Manager Console

Install-Package Lantern.Umbraco

No additional Program.cs or Startup.cs changes are needed — the composer handles everything automatically.

Configuration

Option 1: Backoffice (recommended)

1. Log into the Umbraco backoffice
2. Navigate to Settings → Lantern
3. Paste your embed key from lanternhq.app → Settings → Widget
4. Click Save embed key

Done — the widget is live on your site immediately.

Option 2: appsettings.json

Add the following to your appsettings.json (or environment-specific variant):

{
  "Lantern": {
    "EmbedKey": "your-embed-key-here"
  }
}

The backoffice-stored value always takes precedence over this configuration value.

Full configuration options

{
  "Lantern": {
    "EmbedKey": "your-embed-key-here",
    "Enabled": true,
    "ExcludedPaths": [
      "/health",
      "/robots.txt",
      "/sitemap.xml",
      "/api"
    ]
  }
}

How it works

The package registers an ASP.NET Core middleware (LanternWidgetMiddleware) that:

1. Buffers HTML responses (responses with Content-Type: text/html)
2. Finds the last </body> tag in the response
3. Injects <script src="https://lanternhq.app/api/widget/script" data-key="..." defer></script> immediately before it
4. Streams the modified response back to the client

Non-HTML responses (JSON, images, CSS, etc.), backoffice routes (/umbraco), and any configured ExcludedPaths are always passed through unmodified.

Management API

The package exposes a management API used by the backoffice dashboard. You can call it directly if needed:

Get settings

GET /umbraco/management/api/v1/lantern/settings
Authorization: Umbraco backoffice session

Response:

{
  "embedKey": "ltrn_live_abc123",
  "enabled": true,
  "isStoredInDatabase": true,
  "scriptTagPreview": "<script src=\"https://lanternhq.app/api/widget/script\" data-key=\"ltrn_live_abc123\" defer></script>"
}

Save settings

POST /umbraco/management/api/v1/lantern/settings
Content-Type: application/json
Authorization: Umbraco backoffice session

{
  "embedKey": "ltrn_live_abc123"
}

Building from source

git clone https://github.com/lanternhqapp/lantern-umbraco.git
cd lantern-umbraco
dotnet build

Create the NuGet package

dotnet pack src/Lantern.Umbraco/Lantern.Umbraco.csproj \
  --configuration Release \
  --output ./artifacts

Publish to NuGet.org

dotnet nuget push ./artifacts/Lantern.Umbraco.1.0.0.nupkg \
  --api-key YOUR_NUGET_API_KEY \
  --source https://api.nuget.org/v3/index.json

Our Umbraco submission

When submitting to the Our Umbraco package repository:

1. Build the NuGet package (see above)
2. Navigate to our.umbraco.com/member/profile/packages
3. Fill in:
   • Package name: Lantern
   • NuGet package ID: Lantern.Umbraco
   • Compatible Umbraco versions: 17+
   • Category: Website Utilities
   • Tags: bug-tracking, widget, monitoring, feedback

License

MIT — see LICENSE for details.