ListmonkBuilderExtensions Methods

AddListmonk(IDistributedApplicationBuilder, string, int?)extensionIResourceBuilder<ListmonkResource>

Adds a listmonk container resource to the application model. The default image is and the tag is .

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> AddListmonk(
        this IDistributedApplicationBuilder builder,
        string name,
        int? port = null)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L60-L71

Parameters

builderIDistributedApplicationBuilderThe Hosting.IDistributedApplicationBuilder.

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

portint?optionalThe host port for the listmonk HTTP endpoint. If null, Aspire will assign a random host port.

Returns

IResourceBuilder<ListmonkResource>A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

Add a listmonk container to the application model and reference it in a .NET project.

var builder = DistributedApplication.CreateBuilder(args);

var db = builder.AddPostgres("postgres")
  .AddDatabase("db");
var listmonk = builder.AddListmonk("listmonk")
  .WithReference(db);
var api = builder.AddProject<Projects.Api>("api")
  .WithReference(listmonk);

builder.Build().Run();

WithAdminCredentials(IResourceBuilder<ListmonkResource>, string, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<ListmonkResource>

Configures the first-run listmonk Super Admin credentials.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithAdminCredentials(
        this IResourceBuilder<ListmonkResource> builder,
        string username,
        IResourceBuilder<ParameterResource> password)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L248-L254

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

usernamestringThe value for LISTMONK_ADMIN_USER.

passwordIResourceBuilder<ParameterResource>The parameter resource used for LISTMONK_ADMIN_PASSWORD.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithAdminPassword(IResourceBuilder<ListmonkResource>, IResourceBuilder<ParameterResource>)extensionIResourceBuilder<ListmonkResource>

Configures the first-run listmonk Super Admin password.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithAdminPassword(
        this IResourceBuilder<ListmonkResource> builder,
        IResourceBuilder<ParameterResource> password)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L229-L232

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

passwordIResourceBuilder<ParameterResource>The parameter resource used for LISTMONK_ADMIN_PASSWORD.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithAdminUser(IResourceBuilder<ListmonkResource>, string)extensionIResourceBuilder<ListmonkResource>

Configures the first-run listmonk Super Admin username.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithAdminUser(
        this IResourceBuilder<ListmonkResource> builder,
        string username)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L214-L217

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

usernamestringThe value for LISTMONK_ADMIN_USER.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithAppAddress(IResourceBuilder<ListmonkResource>, string)extensionIResourceBuilder<ListmonkResource>

Configures the listmonk web server address.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithAppAddress(
        this IResourceBuilder<ListmonkResource> builder,
        string address)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L83-L86

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

addressstringThe address value for LISTMONK_app__address, for example 0.0.0.0:9000.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithDatabaseMaxIdleConnections(IResourceBuilder<ListmonkResource>, int)extensionIResourceBuilder<ListmonkResource>

Configures the maximum number of idle PostgreSQL connections.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithDatabaseMaxIdleConnections(
        this IResourceBuilder<ListmonkResource> builder,
        int maxIdle)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L154-L157

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

maxIdleintThe value for LISTMONK_db__max_idle.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithDatabaseMaxLifetime(IResourceBuilder<ListmonkResource>, string)extensionIResourceBuilder<ListmonkResource>

Configures the maximum lifetime for PostgreSQL connections.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithDatabaseMaxLifetime(
        this IResourceBuilder<ListmonkResource> builder,
        string maxLifetime)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L169-L172

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

maxLifetimestringThe duration value for LISTMONK_db__max_lifetime, for example 300s.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithDatabaseMaxOpenConnections(IResourceBuilder<ListmonkResource>, int)extensionIResourceBuilder<ListmonkResource>

Configures the maximum number of open PostgreSQL connections.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithDatabaseMaxOpenConnections(
        this IResourceBuilder<ListmonkResource> builder,
        int maxOpen)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L139-L142

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

maxOpenintThe value for LISTMONK_db__max_open.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithDatabaseParameters(IResourceBuilder<ListmonkResource>, string)extensionIResourceBuilder<ListmonkResource>

Configures additional PostgreSQL DSN parameters.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithDatabaseParameters(
        this IResourceBuilder<ListmonkResource> builder,
        string parameters)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L184-L187

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

parametersstringThe space-separated parameter string for LISTMONK_db__params.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithDatabaseSslMode(IResourceBuilder<ListmonkResource>, string)extensionIResourceBuilder<ListmonkResource>

Configures the PostgreSQL SSL mode used by listmonk.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithDatabaseSslMode(
        this IResourceBuilder<ListmonkResource> builder,
        string sslMode)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L124-L127

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

sslModestringThe PostgreSQL SSL mode value for LISTMONK_db__ssl_mode.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithGroupId(IResourceBuilder<ListmonkResource>, int)extensionIResourceBuilder<ListmonkResource>

Configures the group ID used by the listmonk container entrypoint.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithGroupId(
        this IResourceBuilder<ListmonkResource> builder,
        int groupId)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L281-L284

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

groupIdintThe value for PGID.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithReference(IResourceBuilder<ListmonkResource>, IResourceBuilder<PostgresDatabaseResource>)extensionIResourceBuilder<ListmonkResource>

References a ApplicationModel.PostgresDatabaseResource as the PostgreSQL database for the listmonk resource.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithReference(
        this IResourceBuilder<ListmonkResource> builder,
        IResourceBuilder<PostgresDatabaseResource> database)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L100-L112

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

databaseIResourceBuilder<PostgresDatabaseResource>The PostgreSQL database resource builder.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithTimeZone(IResourceBuilder<ListmonkResource>, string)extensionIResourceBuilder<ListmonkResource>

Configures the time zone used by the listmonk container.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithTimeZone(
        this IResourceBuilder<ListmonkResource> builder,
        string timeZone)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L199-L202

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

timeZonestringThe time zone value for TZ, for example Etc/UTC.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithUploadsBindMount(IResourceBuilder<ListmonkResource>, string)extensionIResourceBuilder<ListmonkResource>

Adds a bind mount for listmonk media uploads.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithUploadsBindMount(
        this IResourceBuilder<ListmonkResource> builder,
        string source)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L310-L313

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

sourcestringThe source directory on the host to mount into the container.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithUploadsVolume(IResourceBuilder<ListmonkResource>, string?)extensionIResourceBuilder<ListmonkResource>

Adds a named volume for listmonk media uploads.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithUploadsVolume(
        this IResourceBuilder<ListmonkResource> builder,
        string? name = null)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L296-L298

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

namestring?optionalThe name of the volume. Defaults to an auto-generated name based on the application and resource names.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.

WithUserId(IResourceBuilder<ListmonkResource>, int)extensionIResourceBuilder<ListmonkResource>

Configures the user ID used by the listmonk container entrypoint.

public static class ListmonkBuilderExtensions
{
    public static IResourceBuilder<ListmonkResource> WithUserId(
        this IResourceBuilder<ListmonkResource> builder,
        int userId)
    {
        // ...
    }
}

ListmonkBuilderExtensions.cs#L266-L269

Parameters

builderIResourceBuilder<ListmonkResource>The listmonk resource builder.

userIdintThe value for PUID.

Returns

IResourceBuilder<ListmonkResource>The ApplicationModel.IResourceBuilder`1.