CommunityToolkit.Aspire.Hosting.Zitadel
13.4.0
Prefix Reserved
See the version list below for details.
dotnet add package CommunityToolkit.Aspire.Hosting.Zitadel --version 13.4.0
NuGet\Install-Package CommunityToolkit.Aspire.Hosting.Zitadel -Version 13.4.0
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Zitadel" Version="13.4.0" />
<PackageVersion Include="CommunityToolkit.Aspire.Hosting.Zitadel" Version="13.4.0" />
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Zitadel" />
paket add CommunityToolkit.Aspire.Hosting.Zitadel --version 13.4.0
#r "nuget: CommunityToolkit.Aspire.Hosting.Zitadel, 13.4.0"
#:package CommunityToolkit.Aspire.Hosting.Zitadel@13.4.0
#addin nuget:?package=CommunityToolkit.Aspire.Hosting.Zitadel&version=13.4.0
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.Zitadel&version=13.4.0
CommunityToolkit.Aspire.Hosting.Zitadel library
Provides extension methods and resource definitions for an Aspire AppHost to configure Zitadel.
Getting Started
Install the package
In your AppHost project, install the package using the following command:
dotnet add package CommunityToolkit.Aspire.Hosting.Zitadel
Example usage
Then, in the Program.cs file of AppHost, define a Zitadel resource, then call AddZitadel:
builder.AddZitadel("zitadel");
Zitadel requires a Postgres database, you can add one with WithDatabase:
var database = builder.AddPostgres("postgres");
builder.AddZitadel("zitadel")
.WithDatabase(database);
You can also pass in a database rather than server (AddPostgres().AddDatabase()).
Configuring the External Domain
By default, Zitadel uses {name}.dev.localhost as the external domain, which works well for local development. For production deployments or custom scenarios, you can configure a custom external domain:
Option 1: Using the parameter
builder.AddZitadel("zitadel", externalDomain: "auth.example.com");
Option 2: Using the fluent API
builder.AddZitadel("zitadel")
.WithExternalDomain("auth.example.com");
Option 3: From configuration
var domain = builder.Configuration["Zitadel:ExternalDomain"];
builder.AddZitadel("zitadel", externalDomain: domain);
Why .dev.localhost?
.dev.localhost is a special top-level domain that:
- Automatically resolves to
127.0.0.1without requiring DNS configuration - Provides unique subdomains for each Zitadel instance (e.g.,
zitadel1.dev.localhost,zitadel2.dev.localhost) - Works reliably in local development and CI/CD environments
- Satisfies Zitadel's requirement for stable hostnames in OIDC/OAuth2 flows
For production deployments, replace this with your actual domain name using one of the configuration methods above.
Feedback & contributing
| 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. |
-
net10.0
- Aspire.Hosting (>= 13.4.0)
- Aspire.Hosting.PostgreSQL (>= 13.4.0)
-
net8.0
- Aspire.Hosting (>= 13.4.0)
- Aspire.Hosting.PostgreSQL (>= 13.4.0)
-
net9.0
- Aspire.Hosting (>= 13.4.0)
- Aspire.Hosting.PostgreSQL (>= 13.4.0)
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.4.1-beta.685 | 36 | 7/9/2026 |
| 13.4.1-beta.683 | 36 | 7/9/2026 |
| 13.4.1-beta.680 | 40 | 7/7/2026 |
| 13.4.1-beta.676 | 39 | 7/7/2026 |
| 13.4.1-beta.675 | 45 | 7/6/2026 |
| 13.4.1-beta.674 | 47 | 7/6/2026 |
| 13.4.0 | 142 | 6/2/2026 |
| 13.4.0-beta.671 | 52 | 7/3/2026 |
| 13.4.0-beta.654 | 61 | 6/18/2026 |
| 13.4.0-beta.651 | 65 | 6/17/2026 |
| 13.3.0 | 140 | 5/14/2026 |
| 13.2.1-beta.604 | 56 | 5/14/2026 |