ZitadelHostingExtensions Methods

AddZitadel(IDistributedApplicationBuilder, string, int?, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)

extension IResourceBuilder<ZitadelResource>

Adds a Zitadel container resource to the Hosting.IDistributedApplicationBuilder.

public static class ZitadelHostingExtensions
{
    public static IResourceBuilder<ZitadelResource> AddZitadel(
        this IDistributedApplicationBuilder builder,
        string name,
        int? port = null,
        IResourceBuilder<ParameterResource>? username = null,
        IResourceBuilder<ParameterResource>? password = null,
        IResourceBuilder<ParameterResource>? masterKey = null)
    {
        // ...
    }
}

ZitadelHostingExtensions.cs#L34-L138

Parameters

builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder to add the Zitadel container to.

name string The name of the resource. This name will be used as the connection string name when referenced in a dependency.

port int? optional The host port used when launching the container. If null a random port will be assigned

username IResourceBuilder<ParameterResource> optional An optional parameter to set a username for the admin account, if null will auto generate one.

password IResourceBuilder<ParameterResource> optional An optional parameter to set a password for the admin account, if null will auto generate one.

masterKey IResourceBuilder<ParameterResource> optional An optional parameter to set the masterkey, if null will auto generate one.

WithDatabase(IResourceBuilder<ZitadelResource>, IResourceBuilder<PostgresServerResource>, string?) extension IResourceBuilder<ZitadelResource>

Adds database support to the Zitadel resource.

public static class ZitadelHostingExtensions
{
    public static IResourceBuilder<ZitadelResource> WithDatabase(
        this IResourceBuilder<ZitadelResource> builder,
        IResourceBuilder<PostgresServerResource> server,
        string? databaseName = null)
    {
        // ...
    }
}

ZitadelHostingExtensions.cs#L154-L157

Parameters

builder IResourceBuilder<ZitadelResource> The Zitadel resource to add database support to.

server IResourceBuilder<PostgresServerResource> The Postgres server resource to use for the database.

databaseName string? optional An optional name for the database Zitadel will use, if left empty will default to "zitadel-db".

WithDatabase(IResourceBuilder<ZitadelResource>, IResourceBuilder<PostgresDatabaseResource>) extension IResourceBuilder<ZitadelResource>

Adds database support to the Zitadel resource.

public static class ZitadelHostingExtensions
{
    public static IResourceBuilder<ZitadelResource> WithDatabase(
        this IResourceBuilder<ZitadelResource> builder,
        IResourceBuilder<PostgresDatabaseResource> database)
    {
        // ...
    }
}

ZitadelHostingExtensions.cs#L168-L181

Parameters

builder IResourceBuilder<ZitadelResource> The Zitadel resource to add database support to.

database IResourceBuilder<PostgresDatabaseResource> The Postgres database resource to use for the database.

WithExternalDomain(IResourceBuilder<ZitadelResource>, string) extension IResourceBuilder<ZitadelResource>

Configures the external domain for the Zitadel resource. This overrides the default domain set in ZitadelHostingExtensions.AddZitadel.

public static class ZitadelHostingExtensions
{
    public static IResourceBuilder<ZitadelResource> WithExternalDomain(
        this IResourceBuilder<ZitadelResource> builder,
        string externalDomain)
    {
        // ...
    }
}

ZitadelHostingExtensions.cs#L197-L199

Parameters

builder IResourceBuilder<ZitadelResource> The Zitadel resource builder.

externalDomain string The external domain to use (e.g., "auth.example.com"). Cannot be null or empty.

Returns

IResourceBuilder<ZitadelResource> The resource builder for chaining.

Exceptions

ArgumentException Thrown if externalDomain is null or whitespace.