XperienceCommunity.Sustainability 2.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package XperienceCommunity.Sustainability --version 2.0.0
                    


                    

                
NuGet\Install-Package XperienceCommunity.Sustainability -Version 2.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="XperienceCommunity.Sustainability" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="XperienceCommunity.Sustainability" Version="2.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="XperienceCommunity.Sustainability" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add XperienceCommunity.Sustainability --version 2.0.0
                    


                    

                
#r "nuget: XperienceCommunity.Sustainability, 2.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package XperienceCommunity.Sustainability@2.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=XperienceCommunity.Sustainability&version=2.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=XperienceCommunity.Sustainability&version=2.0.0
                    


                            Install as a Cake Tool

Xperience Community: Sustainability

Description

A community-driven open-source package that brings sustainability insights and audits to Xperience by Kentico, inspired by the brilliant work of the Umbraco Community Sustainability Team, and the Umbraco.Community.Sustainability package. 🌿

For more details about this package, check out Bringing Sustainability Insights to Xperience by Kentico which provides more background information around the package and its origin.

Screenshots

Once installed, a new tab appears for each page in your web channels. The Sustainability tab allows content editors and marketers to see and benchmark page weight and carbon emissions, which is then converted to a carbon rating for individual pages.

<a href="/src/images/Sustainability Report - Page Tab.png"> <img src="/src/images/Sustainability Report - Page Tab.png" width="800" alt="Sustainability Tab for pages in Xperience by Kentico"> </a>

Library Version Matrix

Xperience Version Library Version
>= 30.4.2 1.0.0

Dependencies

Package Installation

Add the package to your application using the .NET CLI

dotnet add package XperienceCommunity.Sustainability

Quick Start

  1. Install NuGet package above.

  2. Register the Sustainability services using builder.Services.AddXperienceCommunitySustainability():

    // Program.cs

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddKentico();

// ...

builder.Services.AddXperienceCommunitySustainability(builder.Configuration);

Configuration

The package can be configured using the Sustainability section in your appsettings.json file.

{
  "Sustainability": {
    "PlaywrightBrowserPath": "/custom/path/to/playwright/browsers"
  }
}

Configuration Options

Option Description Default
PlaywrightBrowserPath Custom path where Playwright browsers should be installed. Only used when hosting on UNC paths (network shares) - ignored for standard hosting scenarios. null

Note: This setting is only relevant for UNC hosting (network shares starting with \\). For standard hosting, browsers are automatically installed in the App_Data/playwright directory and this setting is ignored. When hosting on UNC paths, you must configure this setting or the Sustainability functionality will not work (the error will be logged in the Kentico event log, but the website will still start successfully).

Contributing

Feel free to submit issues or pull requests to the repository, this is a community package and everyone is welcome to support.

License

Distributed under the MIT License. See LICENSE.md for more information.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.0 349 7/25/2025
1.2.1 171 5/19/2025
1.2.0 153 5/19/2025
1.1.0 236 5/15/2025
1.0.0 235 5/14/2025