CommunityToolkit.Aspire.Hosting.Keycloak.Extensions
13.1.2-beta.516
Prefix Reserved
This is a prerelease version of CommunityToolkit.Aspire.Hosting.Keycloak.Extensions.
dotnet add package CommunityToolkit.Aspire.Hosting.Keycloak.Extensions --version 13.1.2-beta.516
NuGet\Install-Package CommunityToolkit.Aspire.Hosting.Keycloak.Extensions -Version 13.1.2-beta.516
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.1.2-beta.516" />
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.1.2-beta.516" />
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Keycloak.Extensions" />
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.1.2-beta.516
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CommunityToolkit.Aspire.Hosting.Keycloak.Extensions, 13.1.2-beta.516"
#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.1.2-beta.516
#: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.1.2-beta.516&prerelease
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.Keycloak.Extensions&version=13.1.2-beta.516&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Keycloak Hosting Extensions for Aspire
Overview
This package provides 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_DBKC_DB_URLKC_DB_USERNAMEKC_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=postgresKC_DB_URL=jdbc:postgresql://<host>:<port>/keycloakdbKC_DB_USERNAME=<user>KC_DB_PASSWORD=<pass>KC_TRANSACTION_XA_ENABLED=true(when set)
Notes
- Extension methods are in the
Aspire.Hostingnamespace for discoverability in AppHost projects. - If you add custom resource types, place them under
Aspire.Hosting.ApplicationModel.
| Product | Versions 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 is compatible. 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.
-
net10.0
- Aspire.Hosting (>= 13.1.0)
- Aspire.Hosting.Keycloak (>= 13.1.0-preview.1.25616.3)
- Aspire.Hosting.PostgreSQL (>= 13.1.0)
-
net8.0
- Aspire.Hosting (>= 13.1.0)
- Aspire.Hosting.Keycloak (>= 13.1.0-preview.1.25616.3)
- Aspire.Hosting.PostgreSQL (>= 13.1.0)
-
net9.0
- Aspire.Hosting (>= 13.1.0)
- Aspire.Hosting.Keycloak (>= 13.1.0-preview.1.25616.3)
- Aspire.Hosting.PostgreSQL (>= 13.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.