Management UI

Enterprise

Enable the Management UI

A browser-based console hosted by your application (default port 9021). It reads the engine in-process; it does not need the REST API.

builder.Services.AddNetlyDB();
builder.Services.AddNetlyDBManagementUI(webappPort: 9021, apiPort: 9020, launchBrowser: false);

// First start: an "admin" account is created and its generated password is written to the log once.
// Or set it yourself: options.Security.ManagementUiInitialAdminPassword

What it shows

Query

Run filter queries, see the query plan, and reuse recent queries.

Collections

Create and delete collections; export and import them as JSON.

Data explorer

Browse documents; browse file collections in a folder tree, upload files, filter by tags, preview images and video.

Indexes

Create and drop indexes; see each index's lifecycle state and why an index is degraded.

Search

Full-text search, and vector search by text, by a similar document or by a raw vector.

Snapshots

See snapshot timings; save and load snapshots per collection.

Diagnostics

Engine state and degradation scope, recovery and snapshot reports, mutation lookup by id.

Metrics and Logs

Live metric values and the event log.

Nodes

Cluster peers: role, online state, replication backlog and bootstrap state, per-collection counts.

Settings

Users, and the active license with each Enterprise feature shown as enabled or locked.

Chat

Shown when the MCP server is enabled: ask questions about your data through a language model that uses the MCP tools. Requires an OpenAI API key.

The UI changes data where an operator would expect it to (collections, files, indexes, imports, snapshots, users), but it offers no repair actions: it surfaces diagnostics and leaves recovery decisions to the engine and the operator.

Security

• Sign-in is required. On first start an admin account is created and its generated password is written to the log once; set Security.ManagementUiInitialAdminPassword to choose it instead. Passwords need at least 12 characters and mixed character classes.
• The UI binds to localhost. Reach it from elsewhere only through a reverse proxy you secure.
• Stored files are previewed conservatively: only PNG, JPEG, GIF and WebP images and common audio and video types are displayed in the browser. Every other file - HTML, SVG, XML and scripts included - is shown as escaped text or downloaded, never opened. Text previews show at most 64 KiB, and files over 1 MiB are not previewed.

Things to know

• Image previews and thumbnails are unavailable when the UI runs in an arm64 process, including macOS on Apple silicon. Files can still be downloaded.
• The UI needs additional third-party packages in your application; see Packages.