CommunityToolkit.Aspire.Hosting.Listmonk 13.4.1-beta.706

Prefix Reserved
This is a prerelease version of CommunityToolkit.Aspire.Hosting.Listmonk.
dotnet add package CommunityToolkit.Aspire.Hosting.Listmonk --version 13.4.1-beta.706
                    
NuGet\Install-Package CommunityToolkit.Aspire.Hosting.Listmonk -Version 13.4.1-beta.706
                    
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.Listmonk" Version="13.4.1-beta.706" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CommunityToolkit.Aspire.Hosting.Listmonk" Version="13.4.1-beta.706" />
                    
Directory.Packages.props
<PackageReference Include="CommunityToolkit.Aspire.Hosting.Listmonk" />
                    
Project file
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.Listmonk --version 13.4.1-beta.706
                    
#r "nuget: CommunityToolkit.Aspire.Hosting.Listmonk, 13.4.1-beta.706"
                    
#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.Listmonk@13.4.1-beta.706
                    
#: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.Listmonk&version=13.4.1-beta.706&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=CommunityToolkit.Aspire.Hosting.Listmonk&version=13.4.1-beta.706&prerelease
                    
Install as a Cake Tool

listmonk hosting integration

Use this integration to model, configure, and orchestrate a listmonk newsletter and mailing list manager in an Aspire AppHost. The integration runs listmonk in a container and configures it to use a PostgreSQL database resource.

Getting started

Install the package in your AppHost project:

aspire add CommunityToolkit.Aspire.Hosting.Listmonk

Usage example

var builder = DistributedApplication.CreateBuilder(args);

var adminPassword = builder.AddParameter("listmonk-admin-password", secret: true);
var database = builder.AddPostgres("postgres")
    .AddDatabase("listmonkdb");

var listmonk = builder.AddListmonk("listmonk")
    .WithReference(database)
    .WithAdminCredentials("admin", adminPassword)
    .WithTimeZone("Etc/UTC")
    .WithUploadsVolume();

builder.AddProject<Projects.Api>("api")
    .WithReference(listmonk);

builder.Build().Run();

Connection Properties

The ListmonkResource exposes the following connection properties:

Name Format
Host The listmonk host name
Port The listmonk HTTP port
Uri http://{host}:{port}

Connection properties become environment variables when referenced, for example LISTMONK_URI.

Configuration

The integration exposes listmonk's container configuration environment variables as fluent methods:

Method Environment variable
WithAppAddress LISTMONK_app__address
WithReference LISTMONK_db__host, LISTMONK_db__port, LISTMONK_db__user, LISTMONK_db__password, LISTMONK_db__database, LISTMONK_db__ssl_mode
WithDatabaseSslMode LISTMONK_db__ssl_mode
WithDatabaseMaxOpenConnections LISTMONK_db__max_open
WithDatabaseMaxIdleConnections LISTMONK_db__max_idle
WithDatabaseMaxLifetime LISTMONK_db__max_lifetime
WithDatabaseParameters LISTMONK_db__params
WithTimeZone TZ
WithAdminUser, WithAdminPassword, WithAdminCredentials LISTMONK_ADMIN_USER, LISTMONK_ADMIN_PASSWORD
WithUserId, WithGroupId PUID, PGID

The admin credentials are only used by listmonk during first database setup. listmonk's container entrypoint also supports LISTMONK_*_FILE variables for Docker or Podman secret files. Prefer Aspire parameters for secrets in AppHost code; if a deployment requires file-based secret paths, configure those specific variables with Aspire's generic WithEnvironment API.

Additional documentation

See the listmonk documentation for listmonk configuration, administration, and operation.

Feedback & contributing

https://github.com/CommunityToolkit/Aspire

Product 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.

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.706 28 8/6/2026
13.4.1-beta.704 33 8/5/2026
13.4.1-beta.701 35 8/4/2026
13.4.1-beta.700 47 8/2/2026
13.4.1-beta.696 44 8/1/2026
13.4.1-beta.687 52 7/27/2026