ZitadelHostingExtensions Methods

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

extensionIResourceBuilder<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

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder to add the Zitadel container to.

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

portint?optionalThe host port used when launching the container. If null a random port will be assigned

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

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

masterKeyIResourceBuilder<ParameterResource>optionalAn optional parameter to set the masterkey, if null will auto generate one.

WithDatabase(IResourceBuilder<ZitadelResource>, IResourceBuilder<PostgresServerResource>, string?)extensionIResourceBuilder<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

builderIResourceBuilder<ZitadelResource>The Zitadel resource to add database support to.

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

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

WithDatabase(IResourceBuilder<ZitadelResource>, IResourceBuilder<PostgresDatabaseResource>)extensionIResourceBuilder<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

builderIResourceBuilder<ZitadelResource>The Zitadel resource to add database support to.

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

WithExternalDomain(IResourceBuilder<ZitadelResource>, string)extensionIResourceBuilder<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

builderIResourceBuilder<ZitadelResource>The Zitadel resource builder.

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

Returns

IResourceBuilder<ZitadelResource>The resource builder for chaining.

Exceptions

ArgumentExceptionThrown if externalDomain is null or whitespace.