Set up LavinMQ in the Aspire AppHost

⭐ Community Toolkit

This article is the AppHost API reference for the 📦 CommunityToolkit.Aspire.Hosting.LavinMQ package. Start with Get started with LavinMQ and Aspire for the integration workflow, or see Connect Aspire apps to LavinMQ for client examples.

Installation

C#

Terminal

aspire add CommunityToolkit.Aspire.Hosting.LavinMQ

Or add the package manually:

AppHost.cs

#:package CommunityToolkit.Aspire.Hosting.LavinMQ@*

AppHost.csproj

<PackageReference Include="CommunityToolkit.Aspire.Hosting.LavinMQ" Version="*" />

TypeScript

Terminal

aspire add CommunityToolkit.Aspire.Hosting.LavinMQ

This adds the package to aspire.config.json. After aspire restore, .aspire/modules/aspire.mjs includes addLavinMQ, the persistence APIs, and the exported endpoint properties.

Learn more about aspire add and aspire restore.

Add a LavinMQ resource

C#

AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var lavinmq = builder.AddLavinMQ("lavinmq");

builder.AddProject<Projects.Worker>("worker")
    .WithReference(lavinmq);

builder.Build().Run();

TypeScript

apphost.mts

import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const lavinmq = await builder.addLavinMQ('lavinmq');

await builder
  .addNodeApp('worker', './worker', 'index.js')
  .withReference(lavinmq);

await builder.build().run();

The integration runs docker.io/cloudamqp/lavinmq:2.1.0. The AMQP endpoint uses container port 5672, and the management endpoint uses 15672. The default username and password are both guest.

Caution

The default guest credentials are intended for local development. Don’t expose the broker to untrusted networks with these credentials.

Configure host ports

Pass fixed host ports when another process needs stable endpoints:

C#

AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var lavinmq = builder.AddLavinMQ(
    "lavinmq",
    amqpPort: 5672,
    managementPort: 15672);

builder.Build().Run();

TypeScript

apphost.mts

import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const lavinmq = await builder.addLavinMQ('lavinmq', {
  amqpPort: 5672,
  managementPort: 15672,
});

await builder.build().run();

When you omit these parameters, the integration binds host ports 5672 and 15672. Pass alternative values when either port is already occupied.

Persist data in a volume

WithDataVolume and withDataVolume require a volume name and mount it at /var/lib/lavinmq:

C#

AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var lavinmq = builder.AddLavinMQ("lavinmq")
    .WithDataVolume("lavinmq-data");

builder.Build().Run();

TypeScript

apphost.mts

import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const lavinmq = await builder.addLavinMQ('lavinmq');
await lavinmq.withDataVolume('lavinmq-data');

await builder.build().run();

Persist data in a bind mount

Use a bind mount when you need direct access to broker files on the host:

C#

AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var lavinmq = builder.AddLavinMQ("lavinmq")
    .WithDataBindMount(@"C:\LavinMQ\Data");

builder.Build().Run();

TypeScript

apphost.mts

import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const lavinmq = await builder.addLavinMQ('lavinmq');
await lavinmq.withDataBindMount('./lavinmq-data');

await builder.build().run();

Both persistence methods accept an optional isReadOnly value. A read-only mount isn’t suitable for a broker that needs to write data.

Use endpoint properties

The resource exports its AMQP endpoint and connection expressions for use in custom AppHost expressions:

C#

AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

var lavinmq = builder.AddLavinMQ("lavinmq");
var primaryEndpoint = lavinmq.Resource.PrimaryEndpoint;
var host = lavinmq.Resource.Host;
var port = lavinmq.Resource.Port;
var uri = lavinmq.Resource.UriExpression;
var connectionString = lavinmq.Resource.ConnectionStringExpression;

builder.Build().Run();

TypeScript

apphost.mts

import { createBuilder } from './.aspire/modules/aspire.mjs';

const builder = await createBuilder();

const lavinmq = await builder.addLavinMQ('lavinmq');
const primaryEndpoint = await lavinmq.primaryEndpoint();
const host = await lavinmq.host();
const port = await lavinmq.port();
const uri = await lavinmq.uriExpression();
const connectionString = await lavinmq.connectionStringExpression();

await builder.build().run();

Management UI

The management endpoint is added automatically. Open the management HTTP endpoint from the Aspire dashboard, then sign in with the broker credentials.

Hosting integration health checks

The hosting integration registers a RabbitMQ-compatible health check against the AMQP endpoint. The dashboard reports the resource healthy after a client connection succeeds.

See also

• Connect Aspire apps to LavinMQ
• LavinMQ documentation
• Persist data using volumes
• 📦 CommunityToolkit.Aspire.Hosting.LavinMQ