VibeMQ.Server.WebUI 1.8.0

dotnet add package VibeMQ.Server.WebUI --version 1.8.0
                    
NuGet\Install-Package VibeMQ.Server.WebUI -Version 1.8.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="VibeMQ.Server.WebUI" Version="1.8.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="VibeMQ.Server.WebUI" Version="1.8.0" />
                    
Directory.Packages.props
<PackageReference Include="VibeMQ.Server.WebUI" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add VibeMQ.Server.WebUI --version 1.8.0
                    
#r "nuget: VibeMQ.Server.WebUI, 1.8.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package VibeMQ.Server.WebUI@1.8.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=VibeMQ.Server.WebUI&version=1.8.0
                    
Install as a Cake Addin
#tool nuget:?package=VibeMQ.Server.WebUI&version=1.8.0
                    
Install as a Cake Tool

VibeMQ.Server.WebUI

Optional Web dashboard for the VibeMQ broker. Serves a Vue 3 SPA and REST API for health, metrics, and queues on a separate HTTP port (default 12925).

Quick start

var broker = BrokerBuilder.Create()
    .UsePort(2925)
    .UseLoggerFactory(loggerFactory)
    .Build();

await broker.RunWithWebUIAsync(); // Web UI on http://localhost:12925/

With options:

await broker.RunWithWebUIAsync(new WebUIOptions {
    Port = 12925,
    Enabled = true,
    PathPrefix = "/",
}, cancellationToken);

Or run the Web UI server manually:

var webUi = new WebUIServer(broker, new WebUIOptions { Port = 12925 }, logger);
webUi.Start();
await broker.RunAsync(cancellationToken);
await webUi.DisposeAsync();

API endpoints

Method Path Description
GET /api/health Broker health (connections, queues, in-flight, memory)
GET /api/metrics Full metrics snapshot (counters, gauges, latency, uptime)
GET /api/queues List of queue names
GET /api/queues/{name} Single queue metadata (message count, subscribers, etc.)

All JSON responses use snake_case property names.

Building the frontend

The dashboard UI is a Vue 3 + Vite SPA. The frontend is built automatically when you build the .NET project: an MSBuild target runs npm install and npm run build in App/ before the main build, and the contents of App/dist/ are embedded into the assembly.

The build is incremental: changing any file under App/src/ (or App/index.html, Vite config, or package*.json) will trigger a rebuild of the Web UI project and rerun the frontend build as needed.

To skip the frontend build (e.g. in CI where Node.js is not installed, and you rely on pre-built assets):

dotnet build -p:SkipFrontendBuild=true

If dist/ is missing and the frontend build was skipped, the project still builds but the UI returns a 503 with instructions.

Requirements

  • .NET 8.0 or later
  • VibeMQ.Server (and transitively VibeMQ.Core)

No ASP.NET Core or Node.js at runtime; Node/npm only for building the frontend.

Product 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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.8.0 108 4/6/2026
1.7.1 114 3/14/2026
1.7.0 102 3/4/2026
1.6.1 110 2/27/2026
1.6.0 102 2/27/2026