# CommunityToolkit.Aspire.Hosting.Listmonk

- Module: `CommunityToolkit.Aspire.Hosting.Listmonk`
- Version: `13.5.0`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/tree/4ff8268fbd97ddd23cb73dc8eff9cc92718156d1)
- Functions: `16`
- Types: `1`

## Types

- [ListmonkResource](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/listmonkresource.md) -- `handle` - 20 members -- A resource that represents a listmonk instance.

## Functions

- [addListmonk](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/addlistmonk.md) -- `method` -- Adds a listmonk container resource to the application model. The default image is and the tag is .
- [withAdminCredentials](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withadmincredentials.md) -- `method` -- Configures the first-run listmonk Super Admin credentials.
- [withAdminPassword](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withadminpassword.md) -- `method` -- Configures the first-run listmonk Super Admin password.
- [withAdminUser](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withadminuser.md) -- `method` -- Configures the first-run listmonk Super Admin username.
- [withAppAddress](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withappaddress.md) -- `method` -- Configures the listmonk web server address.
- [withDatabaseMaxIdleConnections](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withdatabasemaxidleconnections.md) -- `method` -- Configures the maximum number of idle PostgreSQL connections.
- [withDatabaseMaxLifetime](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withdatabasemaxlifetime.md) -- `method` -- Configures the maximum lifetime for PostgreSQL connections.
- [withDatabaseMaxOpenConnections](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withdatabasemaxopenconnections.md) -- `method` -- Configures the maximum number of open PostgreSQL connections.
- [withDatabaseParameters](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withdatabaseparameters.md) -- `method` -- Configures additional PostgreSQL DSN parameters.
- [withDatabaseSslMode](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withdatabasesslmode.md) -- `method` -- Configures the PostgreSQL SSL mode used by listmonk.
- [withGroupId](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withgroupid.md) -- `method` -- Configures the group ID used by the listmonk container entrypoint.
- [withReference](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withreference.md) -- `method` -- References a `PostgresDatabaseResource` as the PostgreSQL database for the listmonk resource.
- [withTimeZone](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withtimezone.md) -- `method` -- Configures the time zone used by the listmonk container.
- [withUploadsBindMount](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withuploadsbindmount.md) -- `method` -- Adds a bind mount for listmonk media uploads.
- [withUploadsVolume](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withuploadsvolume.md) -- `method` -- Adds a named volume for listmonk media uploads.
- [withUserId](/reference/api/typescript/communitytoolkit.aspire.hosting.listmonk/withuserid.md) -- `method` -- Configures the user ID used by the listmonk container entrypoint.