Nextended.Aspire.Hosting.AspireUI
10.1.65
Prefix Reserved
dotnet add package Nextended.Aspire.Hosting.AspireUI --version 10.1.65
NuGet\Install-Package Nextended.Aspire.Hosting.AspireUI -Version 10.1.65
<PackageReference Include="Nextended.Aspire.Hosting.AspireUI" Version="10.1.65" />
<PackageVersion Include="Nextended.Aspire.Hosting.AspireUI" Version="10.1.65" />
<PackageReference Include="Nextended.Aspire.Hosting.AspireUI" />
paket add Nextended.Aspire.Hosting.AspireUI --version 10.1.65
#r "nuget: Nextended.Aspire.Hosting.AspireUI, 10.1.65"
#:package Nextended.Aspire.Hosting.AspireUI@10.1.65
#addin nuget:?package=Nextended.Aspire.Hosting.AspireUI&version=10.1.65
#tool nuget:?package=Nextended.Aspire.Hosting.AspireUI&version=10.1.65
![]()
Nextended.Aspire.Hosting.AspireUI
AspireUI — the visual AppHost builder — as a resource inside your own Aspire stack, with an optional pre-seeded admin user and a starter stack built from your project paths.
Runs AspireUI as an Aspire resource.
📖 Documentation: English · Deutsch | 🧪 Runnable sample: AspireUI.AppHost
Run AspireUI — the visual .NET Aspire AppHost builder — as a resource inside your own Aspire stack.
var builder = DistributedApplication.CreateBuilder(args);
builder.AddAspireUI()
.WithAdminUser("admin", "change-me-please")
.WithSeedStack("My App", builder.AppHostDirectory);
builder.Build().Run();
This adds the ghcr.io/fgilde/aspireui container with:
- an HTTP endpoint for the web UI,
- the host Docker socket mounted, so stacks you build in AspireUI can run,
- a named volume for AspireUI's data (stacks, settings, users).
API
The container
| Call | Effect |
|---|---|
AddAspireUI(name = "aspireui", port?, image?, tag?) |
Add the AspireUI container. |
.WithDataBindMount(hostPath) |
Keep AspireUI's data in a host folder instead of a named volume. |
.WithoutDockerSocket() |
Run without the host's docker socket: builds and remote deploys still work, hosting on this machine does not. |
.WithDockerHost(dockerHost) |
Point AspireUI's docker client somewhere else (DOCKER_HOST); implies WithoutDockerSocket(). |
.WithSourceMount(hostPath, containerPath?) |
Bind-mount source into the container so a seeded stack can also run there. |
Accounts and tokens
| Call | Effect |
|---|---|
.WithAdminUser(username, password) |
Seed the admin on first run (idempotent; password stored hashed). Also accepts an Aspire ParameterResource. |
.WithUser(username, password, permissions?, viewModes?, mustChangePassword?) |
Create an account. permissions is a preset from AspireUIPermissions or a comma-separated list of ids. Also accepts a ParameterResource password. |
.WithUsers(params AspireUIUser[]) |
Create several accounts at once, admins included. |
.WithAppUser(username, password) |
An account that installs, configures and browses files — no builder. |
.WithViewer(username, password) |
An account that may look and change nothing. |
.WithApiToken(name, username, token) |
A bearer token for automation, with a value you already know. Also accepts a ParameterResource. |
Deploy targets
| Call | Effect |
|---|---|
.WithSshTarget(name, host, user, port, keyFile?, key?, passphrase?, publicHost?, isDefault?) |
Another machine's docker daemon over SSH. keyFile is mounted read-only, never put in an environment variable. |
.WithDockerTcpTarget(name, host, port, caFile?, certFile?, keyFile?, publicHost?, isDefault?) |
A docker daemon over TCP with mTLS; the three certificates are mounted read-only. |
.WithKubernetesTarget(name, context?, kubeconfigFile?, namespace?, expose?, ingressHost?, storageClass?, isDefault?) |
A Kubernetes cluster, deployed with Helm. |
Apps and stacks
| Call | Effect |
|---|---|
.WithApps(params catalogIds) |
Install apps from AspireUI's own catalog by id (vaultwarden, gitea, …). |
.WithApp(catalogId, name?, deploy?) |
Install one catalog app under a name of your choosing. |
.WithAppSource(name, url) |
Register an app manifest url as a store source. |
.WithSeedStack(name, params projectPaths) |
Seed a stack with one AddProject node per path. |
.WithProjectStack(name, params projects) |
Same, from the ProjectResources in this AppHost — and their folders are mounted so the stack can also run. |
.WithSeedFromDirectory(hostPath, name?, mode?, deploy?) |
Import a folder as a stack: manifest, compose file or AppHost, whichever it holds. Mounted read-only, imported as a copy. |
.WithSeedFromCompose(hostPath, name?, deploy?) |
Import a single docker-compose file as a stack. |
.WithSeedFromGit(url, branch?, subdir?, name?, mode?, deploy?) |
Clone a repository inside the container and import it. |
.WithSeedFile(hostPath) |
Mount a seed document (or a folder with aspireui.seed.json) and point AspireUI at it. |
.WithAutoDeploy(deploy = true) |
Deploy the seeded stacks and apps once hosting is up. |
Settings
| Call | Effect |
|---|---|
.WithAssistant(endpoint, model, apiKey?, label?) |
The assistant's backend: an OpenAI-compatible url. Also takes a ReferenceExpression for an endpoint only known at start, and an Aspire ParameterResource for the key. |
.WithAssistant(server, model, apiKey?, apiPath?, endpointName?, label?) |
A model server in this stack — Ollama, LocalAI, vLLM, llama.cpp. AspireUI waits for it and talks to it over the container network. |
.WithOllamaAssistant(ollama, model = "llama3.2") / .WithLocalAiAssistant(localAi, model) |
The same, named for the two servers people reach for first. |
.WithCliAssistant(tool, model?) |
An agent CLI on the AspireUI host (claude, gemini, ollama, llm, codex). Answers questions; cannot call tools. |
.WithAi(baseUrl, model, apiKey?) / .WithAi(backend, model, …) |
The older name for the first two. |
.WithPublicHost(host) |
The host name app urls are built from. |
.WithNginxProxyManager(baseUrl, email, password, forwardHost?) |
Let a hosted app be given a domain and a certificate from its own menu. Also takes an NPM resource in the same stack. |
.WithNotifications(webhookUrl?, telegramToken?, telegramChat?) |
Where a deployment that came up, went down or started failing is reported. |
.WithBackupSchedule(intervalHours = 24, retain = 7) |
Back up every hosted app's volumes on a schedule. |
.WithHostedDashboards(browserToken?) |
Host an Aspire dashboard next to every deployed app. |
.WithSingleSignOn(authority, clientId, clientSecret?, label?, …) |
Sign-in through an OpenID Connect provider. Only the authority and client id are needed — the endpoints come from the provider's discovery document. The secret also takes an Aspire ParameterResource. |
.WithS3Backups(bucket, accessKey, secretKey, endpoint?, region?, pathStyle?) |
Copy every backup to an S3-compatible bucket. |
.WithWebDavBackups(baseUrl, user, password) |
Copy every backup to a WebDAV share. |
.WithSshBackups(host, user, path, keyFile?, port?) |
Copy every backup to a directory on another machine over scp; the key file is mounted read-only. |
.WithRetrieveApi(apiKey?) |
GET /api/retrieve/apps lists the hosted apps and running stacks as [{ name, kind, healthy, urls }]. Anonymous without a key; with one (a string or an Aspire ParameterResource) callers send it as X-Api-Key. Each app or stack can be hidden from its menu. |
.WithRetrieveApiHidden(params names) |
Apps and stacks of these names start out hidden from the retrieve API; they can be shown again from their menu. |
.WithAuditRetention(days) |
How long the activity log keeps an entry (0 = keep everything). |
.WithSettings(s => { … }) |
Every setting under AspireUI's own settings, typed: public host, bundled dashboards, proxy, notifications, backup schedule, import limits, activity-log retention and the assistant's backend. Anything left null is not sent. |
.WithSetting(key, parameter) |
One setting whose value is a secret, from an Aspire ParameterResource. |
.WithSetting(key, value) |
Any AspireUI setting by key. |
.WithForcedSettings(force = true) |
Apply those settings on every start instead of only filling in what is empty. |
Everything is idempotent by name: restarting with the same AppHost changes nothing, adding one
entry adds exactly that one, and anything changed in the UI stays changed. WithAdminUser is the
one exception — like AspireUI's own first-run seed, it is skipped once any account exists.
var builder = DistributedApplication.CreateBuilder(args);
var opsPassword = builder.AddParameter("ops-password", secret: true);
builder.AddAspireUI()
.WithAdminUser("admin", "change-me-please")
.WithUser("ops", opsPassword, AspireUIPermissions.Operator)
.WithViewer("guest", "guest-password-1")
.WithApiToken("pipeline", "ops", builder.AddParameter("ci-token", secret: true))
.WithSshTarget("nas", "nas.local", "deploy", keyFile: "./keys/id_ed25519")
.WithApps("vaultwarden", "gitea")
.WithSeedFromDirectory("./seed/edge", "Edge")
.WithOllamaAssistant(ollama, "llama3.2")
.WithAutoDeploy();
builder.Build().Run();
The Docker-socket mount gives the container control over the host Docker daemon — run it only on a trusted host. Passwords and tokens belong in Aspire parameters, and key material in the files the target methods mount, so neither ends up in the manifest.
Supported frameworks
net8.0net9.0net10.0
Dependencies
- Aspire.Hosting.AppHost
The Nextended family
The other 18 packages in the suite:
Core libraries
- Nextended.Core — Foundation library — extension methods, custom types (Money, Date, BaseId, SuperType), class mapping, deep clone, encryption, hashing and the code-generation attributes.
- Nextended.Cache — Expression-based caching — automatic cache keys from method expressions, CacheProvider with condition-based invalidation, thread-safe AddOrGetExisting.
Data access
- Nextended.EF — Entity Framework Core extensions — graph loading (LoadGraphAsync, IncludeAll, MultiInclude), declarative include definitions, paging, dynamic sorting and bulk operations.
ASP.NET Core & web
- Nextended.Web — ASP.NET Core utilities — zero-config OData (AddODataAuto), composable IQueryable OData appliers, strongly typed controller URLs, streaming download helpers and a background executor that can replay a captured request.
- Nextended.ResponseFilters — Fluent, provider-agnostic pipeline that redacts, masks, rounds, truncates, hashes, prunes and restructures response DTOs before serialization — per request, per user, per permission.
- Nextended.ResponseFilters.AspNetCore — ASP.NET Core adapter for Nextended.ResponseFilters — registers the pipeline as a global IAsyncResultFilter and replays structural edits against the serialized JSON tree.
UI libraries
- Nextended.Blazor — Blazor helpers — IBrowserFile extensions (bytes, data URLs, downloads), a hierarchical model for browsing inside uploaded zip/tar/rar archives, MIME-type detection and component-parameter reflection.
- Nextended.UI — WPF and Windows desktop helpers — a global input-binding manager with hold/sequence matching, DirectInput and XInput gamepad readers, key-bind capture controls, converters, behaviours, markup extensions and runtime-defined PropertyGrid types.
Code generation & tooling
- Nextended.Imaging — Image processing — aspect-preserving resize, crop, colour replacement, brightness-based foreground picking, thumbnail generation, byte/data-URL conversion and MIME detection from magic bytes.
- Nextended.CodeGen — Roslyn source generator — DTOs and interfaces from your entities, strongly typed classes from JSON/XML, lookup tables from Excel, documentation from source files, and TypeScript declarations of your contracts.
.NET Aspire hosting
- Nextended.Aspire — Conditional AppHost builder extensions — WithReferenceIf / WaitForIf / WithExplicitStartIf, strongly typed environment variables from config objects, HTTPS dev-cert wiring, Docker guards, GitHub-source resources and npm app discovery.
- Nextended.Aspire.Hosting.Supabase — The complete Supabase stack — Postgres, Auth (GoTrue), REST, Realtime, Storage, Studio, Kong and Edge Functions — as one composable Aspire resource.
- Nextended.Aspire.Hosting.N8n — The n8n workflow-automation platform as an Aspire resource, with Postgres persistence, workflow import and a typed client for triggering workflows from .NET.
- Nextended.Aspire.Hosting.Grafana — Grafana, Prometheus, Loki, Tempo, Promtail, cAdvisor, postgres_exporter and the OpenTelemetry Collector as composable resources with auto-provisioned datasources.
- Nextended.Aspire.Hosting.WebDataStudio — WebDataStudio — a browser database studio for PostgreSQL, MySQL, SQL Server, SQLite, Oracle, DuckDB, ClickHouse, MongoDB and Redis — wired to the databases of your stack, with accounts and roles, an optional SQL assistant, and an MCP endpoint for AI agents.
- Nextended.Aspire.Hosting.AspireUI — AspireUI — the visual AppHost builder — as a resource inside your own Aspire stack, with an optional pre-seeded admin user and a starter stack built from your project paths. (this package)
- Nextended.Aspire.Hosting.LocalAI — Self-hosted, OpenAI-compatible multimodal AI — image generation, text-to-speech, speech-to-text and video — with gallery model management, GPU support and Open WebUI.
- Nextended.Aspire.Hosting.Php — Run PHP endpoints inside your Aspire stack — a docroot folder or a single router script served by PHP's built-in web server, with php.ini settings as fluent options.
- Nextended.Aspire.Hosting.DbTools — Database tools for an Aspire app host. The first: fill a database resource from a database that already exists — schema and data — from another resource in the stack or from a server it does not model. PostgreSQL, SQL Server, MySQL/MariaDB, MongoDB and Redis, each through its own engine's dump and restore tools.
Links
- 📦 NuGet package
- 📖 Documentation — English
- 📖 Dokumentation — Deutsch
- 🏠 Documentation portal
- 🧪 Runnable sample
- 🧑💻 Source code
- 🐛 Report an issue
License
MIT — see LICENSE.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- Aspire.Hosting.AppHost (>= 13.6.4)
-
net8.0
- Aspire.Hosting.AppHost (>= 13.6.4)
-
net9.0
- Aspire.Hosting.AppHost (>= 13.6.4)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Nextended.Aspire.Hosting.AspireUI:
| Package | Downloads |
|---|---|
|
Coworkee.Aspire
AddCoworkeeApp() for the Aspire app host: migrations, auth server, APIs, workers and web wired with Postgres (or SQL Server, SQLite), Redis, Mailpit, Elasticsearch and Keycloak. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 10.1.65 | 102 | 11/14/2026 |
| 10.1.64 | 88 | 11/13/2026 |
| 10.1.63 | 63 | 11/12/2026 |
| 10.1.62 | 52 | 11/12/2026 |
| 10.1.61 | 81 | 11/12/2026 |
| 10.1.60 | 48 | 11/12/2026 |
| 10.1.59 | 64 | 11/12/2026 |
| 10.1.58 | 76 | 11/11/2026 |
| 10.1.57 | 66 | 11/11/2026 |
| 10.1.56 | 72 | 11/11/2026 |
| 10.1.55 | 98 | 11/11/2026 |
| 10.1.54 | 70 | 11/11/2026 |
| 10.1.53 | 93 | 11/8/2026 |
| 10.1.52 | 94 | 11/6/2026 |
| 10.1.51 | 346 | 11/5/2026 |
| 10.1.50 | 154 | 10/30/2026 |
| 10.1.49 | 100 | 10/29/2026 |
| 10.1.48 | 492 | 10/27/2026 |
| 10.1.47 | 139 | 10/25/2026 |
| 10.1.46 | 115 | 10/16/2026 |
