Set up Umami in the AppHost

このコンテンツはまだ日本語訳がありません。

⭐ Community Toolkit

This article describes the Aspire Community Toolkit hosting integration for Umami. Use its AppHost APIs to run an Umami container and configure its PostgreSQL backend.

If you’re new to the integration, start with Get started with the Umami integration.

Installation

Install the 📦 CommunityToolkit.Aspire.Hosting.Umami package in your AppHost:

aspire add communitytoolkit-umami

Aspire CLI は対話的です。求められたら適切な結果を選択してください:

Select an integration to add:

> communitytoolkit-umami (CommunityToolkit.Aspire.Hosting.Umami)
> Other results listed as selectable options...

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

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

Add an Umami resource

Add a PostgreSQL database, then pass it to WithPostgreSQL to configure Umami’s storage backend:

TypeScript
C#

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

const builder = await createBuilder();

const postgres = await builder.addPostgres('postgres');
const database = await postgres.addDatabase('umami-db');

const umami = await builder.addUmami('umami');
await umami.withPostgreSQL(database);

await builder.build().run();

var builder = DistributedApplication.CreateBuilder(args);

var postgres = builder.AddPostgres("postgres");
var database = postgres.AddDatabase("umami-db");

var umami = builder.AddUmami("umami")
    .WithPostgreSQL(database);

// After adding all resources, run the app...
builder.Build().Run();

AddUmami accepts the resource name, an optional secret parameter, and an optional host port. If you omit the secret, the integration creates a secret parameter for Umami. If you omit the port, Aspire assigns the HTTP endpoint’s host port.

The Umami container listens on port 3000. The integration uses the umamisoftware/umami:3.4 image and configures its APP_SECRET environment variable from the secret parameter.

Configure the PostgreSQL backend

Pass a PostgreSQL database resource to WithPostgreSQL. The integration waits for that database and sets Umami’s DATABASE_URL using the PostgreSQL resource’s username, password, host, port, and database name. Umami requires a database backend; the README for this integration identifies PostgreSQL as the supported backend.

Use a custom secret and port

Pass a secret parameter and a host port to AddUmami when you need to supply Umami’s APP_SECRET or reserve a specific host port:

TypeScript
C#

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

const builder = await createBuilder();

const umamiSecret = await builder.addParameter('umami-secret', {
  secret: true,
});
const postgres = await builder.addPostgres('postgres');
const database = await postgres.addDatabase('umami-db');

const umami = await builder.addUmami('umami', {
  secret: umamiSecret,
  port: 31300,
});
await umami.withPostgreSQL(database);

await builder.build().run();

var builder = DistributedApplication.CreateBuilder(args);

var umamiSecret = builder.AddParameter("umami-secret", secret: true);
var postgres = builder.AddPostgres("postgres");
var database = postgres.AddDatabase("umami-db");

var umami = builder.AddUmami("umami", secret: umamiSecret, port: 31300)
    .WithPostgreSQL(database);

// After adding all resources, run the app...
builder.Build().Run();

The port argument sets the host port for Umami’s HTTP endpoint. The container’s target port remains 3000.

Hosting integration health checks

The integration configures an HTTP health check that requests Umami’s /api/heartbeat endpoint. Aspire reports the resource as healthy after the endpoint responds successfully.

AppHost API

The integration exports the following AppHost API:

AddUmamiaddUmami adds an Umami resource. Its optional secret parameter supplies the APP_SECRET parameter, and its optional port parameter sets the host port.
WithPostgreSQLwithPostgreSQL configures the supplied PostgreSQL database resource as Umami’s storage backend.
UmamiResource.PrimaryEndpoint exposes the resource’s HTTP endpoint.
UmamiResource.SecretParameter exposes the parameter used for APP_SECRET.