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

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 CLI

Aspire CLI — 添加 CommunityToolkit.Aspire.Hosting.MongoDB.Extensions 包

aspire add communitytoolkit-mongodb-extensions

Aspire CLI 是交互式的；按提示选择合适的搜索结果：

Aspire CLI — 输出示例

Select an integration to add:

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

注意

如果只有一个结果，会自动选择。仍需确认版本。

apphost.cs (C# file-based app)

C# — AppHost.cs

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

PackageReference (*.csproj)

XML — 添加 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:

aspire.config.json

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

Add management UI

DbGate management UI

To add the DbGate management UI to your MongoDB resource, call the WithDbGate method on the MongoDBResourceBuilder instance:

C#

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

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

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

builder.Build().Run();

TypeScript

TypeScript — apphost.mts

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.

See also

• DbGate documentation
• MongoDB hosting integration
• Connect to MongoDB
• Aspire Community Toolkit
• Aspire integrations overview
• Aspire GitHub repo