Use community extensions for MongoDB hosting

⭐ Community Toolkit

The Aspire Community Toolkit MongoDB hosting extensions package provides extra functionality to the Aspire.Hosting.MongoDB hosting package.

This package provides the following features:

DbGate management UI
dbx management UI

Hosting integration

To get started with the Aspire Community Toolkit MongoDB hosting extensions, install the CommunityToolkit.Aspire.Hosting.MongoDB.Extensions NuGet package in the AppHost project.

aspire add communitytoolkit-mongodb-extensions

The Aspire CLI is interactive, be sure to select the appropriate search result when prompted:

Select an integration to add:

> communitytoolkit-mongodb-extensions (CommunityToolkit.Aspire.Hosting.MongoDB.Extensions)
> Other results listed as selectable options...

#:package CommunityToolkit.Aspire.Hosting.MongoDB.Extensions@*

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

For TypeScript AppHosts, add the Community Toolkit MongoDB extensions package to aspire.config.json:

{
  "packages": {
    "CommunityToolkit.Aspire.Hosting.MongoDB.Extensions": "*"
  }
}

Add management UI

DbGate management UI

To add the DbGate management UI, decorate the official MongoDBServerResource builder with WithDbGate / withDbGate:

C#
TypeScript

var builder = DistributedApplication.CreateBuilder(args);

var mongodb = builder.AddMongoDB("mongodb")
    .WithDbGate();

builder.AddProject<Projects.ExampleProject>("api")
    .WithReference(mongodb);

builder.Build().Run();

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

const builder = await createBuilder();

const mongodb = await builder.addMongoDB('mongodb');
await mongodb.withDbGate();

const api = await builder.addProject('api', '../Api/Api.csproj');
await api.withReference(mongodb);

await builder.build().run();

This adds a new DbGate resource to the AppHost which is available from the Aspire dashboard. DbGate is a comprehensive database management tool that provides a web-based interface for managing your MongoDB databases.

dbx management UI

dbx is a lightweight, web-based database client and an alternative management UI to DbGate and Adminer. Use WithDbx / withDbx to add a dbx child resource configured for the MongoDB server:

C#
TypeScript

var builder = DistributedApplication.CreateBuilder(args);

var mongodb = builder.AddMongoDB("mongodb")
    .WithDbx();

builder.Build().Run();

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

const builder = await createBuilder();

const mongodb = await builder.addMongoDB('mongodb');
await mongodb.withDbx({
  containerName: 'mongodb-dbx',
  imageTag: '0.5.33',
});

await builder.build().run();

The C# overload accepts an optional container configuration callback and containerName. The TypeScript binding accepts optional containerName and imageTag values.