CommunityToolkit.Aspire.Hosting.Keycloak.Extensions 13.0.0-beta.438

Prefix Reserved
This is a prerelease version of CommunityToolkit.Aspire.Hosting.Keycloak.Extensions.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package CommunityToolkit.Aspire.Hosting.Keycloak.Extensions --version 13.0.0-beta.438
                    
NuGet\Install-Package CommunityToolkit.Aspire.Hosting.Keycloak.Extensions -Version 13.0.0-beta.438
                    
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="CommunityToolkit.Aspire.Hosting.Keycloak.Extensions" Version="13.0.0-beta.438" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CommunityToolkit.Aspire.Hosting.Keycloak.Extensions" Version="13.0.0-beta.438" />
                    
Directory.Packages.props
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Keycloak.Extensions" />
                    
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 CommunityToolkit.Aspire.Hosting.Keycloak.Extensions --version 13.0.0-beta.438
                    
#r "nuget: CommunityToolkit.Aspire.Hosting.Keycloak.Extensions, 13.0.0-beta.438"
                    
#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 CommunityToolkit.Aspire.Hosting.Keycloak.Extensions@13.0.0-beta.438
                    
#: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=CommunityToolkit.Aspire.Hosting.Keycloak.Extensions&version=13.0.0-beta.438&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.Keycloak.Extensions&version=13.0.0-beta.438&prerelease
                    
Install as a Cake Tool

Keycloak Hosting Extensions for .NET Aspire

Overview

This package provides .NET Aspire hosting extensions for integrating Keycloak with your AppHost. It includes a PostgreSQL integration that works with resources created via Aspire.Hosting.Postgres.AddPostgres() and Aspire.Hosting.Keycloak.AddKeycloak(), and automatically configures the required environment variables for Keycloak database connectivity.


Features

  • Configure Keycloak to use PostgreSQL.
  • Automatically sets environment variables:
    • KC_DB
    • KC_DB_URL
    • KC_DB_USERNAME
    • KC_DB_PASSWORD
  • Supports XA transactions via KC_TRANSACTION_XA_ENABLED.
  • Integrates with ParameterResource for secure user/password injection.
  • Falls back to default credentials (postgres / postgres) if no parameters are provided.
  • Fluent extension methods on the hosting model.

Usage (AppHost)

var postgres = builder.AddPostgres("pg");
var db = postgres.AddDatabase("keycloakdb");

// Using explicit username/password parameters
var user = builder.AddParameter("keycloak-user");
var pass = builder.AddParameter("keycloak-pass");

var keycloak = builder.AddKeycloak("kc")
    .WithPostgres(db, user, pass);

// Or rely on server parameters or default postgres/postgres
var keycloak2 = builder.AddKeycloak("kc2")
    .WithPostgres(db, xaEnabled: true);

Keycloak will be configured with:

  • KC_DB=postgres
  • KC_DB_URL=jdbc:postgresql://<host>:<port>/keycloakdb
  • KC_DB_USERNAME=<user>
  • KC_DB_PASSWORD=<pass>
  • KC_TRANSACTION_XA_ENABLED=true (when set)

Notes

  • Extension methods are in the Aspire.Hosting namespace for discoverability in AppHost projects.
  • If you add custom resource types, place them under Aspire.Hosting.ApplicationModel.
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 is compatible.  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
13.0.0-preview.1.251125-0315 55 11/25/2025
13.0.0-beta.462 33 11/25/2025
13.0.0-beta.456 42 11/23/2025
13.0.0-beta.454 48 11/23/2025
13.0.0-beta.453 68 11/22/2025
13.0.0-beta.450 74 11/22/2025
13.0.0-beta.448 67 11/22/2025
13.0.0-beta.444 330 11/17/2025
13.0.0-beta.443 247 11/17/2025
13.0.0-beta.440 82 11/15/2025
13.0.0-beta.439 222 11/12/2025
13.0.0-beta.438 216 11/12/2025
13.0.0-beta.436 221 11/12/2025
13.0.0-beta.435 224 11/11/2025
13.0.0-beta.433 146 11/10/2025
13.0.0-beta.432 140 11/10/2025
13.0.0-beta.431 132 11/6/2025
13.0.0-beta.430 129 11/6/2025
9.9.0-preview.1.251103-2303 145 11/3/2025
9.9.0-beta.427 146 11/3/2025
9.8.1-beta.426 140 11/3/2025
9.8.1-beta.424 133 10/28/2025