-
Notifications
You must be signed in to change notification settings - Fork 0
WebUI
Recollectium WebUI is the local browser control plane for Recollectium Core. It sits beside the CLI, API, and MCP surfaces and uses the same Core service contract, so you can inspect and manage a running Core from your browser.
Use the dedicated WebUI service commands:
recollectium webui serve
recollectium webui start
recollectium webui stop
recollectium webui restart
recollectium webui status-
recollectium webui serveruns the WebUI in the foreground for local development. -
recollectium webui startstarts the managed background WebUI service. -
recollectium webui stopstops the managed WebUI service. -
recollectium webui restartrestarts the managed WebUI service. -
recollectium webui statusreports whether the WebUI is running and shows the current endpoint.
The default bind address is 127.0.0.1:8766.
You can override the bind address with config or with serve flags:
recollectium webui serve --host 127.0.0.1 --port 8766The managed start, stop, restart, and status commands read the configured WebUI host and port from the active Recollectium config.
The WebUI is local-first, unauthenticated, and intended for localhost use.
- Default authentication: none.
- Default TLS: off.
- Recommended bind:
127.0.0.1.
Do not bind the WebUI to a non-local interface unless you also add private-network controls and understand that anyone who can reach the interface can access your local memory and service operations.
For the full service-level security model, see SECURITY.md.
The WebUI exposes the same major local control surfaces as Core:
- Memory CRUD, search, archive, and memory-space filtering.
- Workspace listing, aliasing, and resolution.
- Config get, set, unset, and validate.
- Service discovery plus API, MCP, and WebUI service controls.
- Embedding status, refresh, job list, and job cleanup.
- Dev tools, including seeded data reset, evaluation, and threshold optimization.
- Graph, diagnostics, and logs views.
The packaged front end lives in src/recollectium/webui_static/ and is exercised by the test suite, so WebUI changes should keep the static shell and the API contract in sync.
When Core adds a new user-facing feature or operation, the WebUI should gain matching support in the same release unless the change is explicitly documented as deferred.
FAQ
- Is Recollectium cloud-hosted?
- Does Recollectium encrypt the database?
- Does the API have authentication?
- Does the WebUI have authentication?
- Which embedding model does it use?
- Should agents search by type first?
- What is the difference between
dev serveandservice start api? - Can I run Core on one machine and an agent on another?
- Is the OpenCode plugin available?