Documentation

Admin backends

Everlock has three admin surfaces over one command engine:

  • backend-admin-ssh — the interactive console
  • backend-admin-http — the web dashboard and the OpenAPI-described HTTP API with Swagger UI
  • backend-admin-mcp — every command as an MCP tool, for AI assistants

What it is for

The admin backends are the operator control plane for Everlock.

Use them to:

  • enable or disable backends and frontends
  • create and configure service instances
  • manage users, groups, grants, API keys, and system state
  • inspect what the running Everlock instance is doing

Every command lives once in the shared everlock-admin-core engine with a typed input; each surface projects the same commands its own way — parsed command lines on SSH, POST /api/... operations over HTTP, JSON-schema tools over MCP. The same per-resource ACLs authorize all three.

Pages

How it fits in the system

The admin control plane is split by transport:

  • frontend-ssh routes PTY-style admin sessions into backend-admin-ssh
  • frontend-http serves the dashboard, the HTTP API, and the MCP endpoint on their pinned vhosts through the standard host dispatch

That keeps transport and service responsibilities separate:

  • SSH owns authentication, channels, PTY allocation, and session framing
  • HTTP owns host routing, TLS, cookies, and web responses; MCP rides it with Bearer API-key authentication (evapi_…)
  • the admin backends own the operator-facing commands and views