DocsUse
The web console
The browser UI served by the API at /console/: health, indexing, search, the graph explorer and impact analysis, and with the Enterprise Edition, people, organisations and the audit log.
Open it
bbm-atlas console # opens http://localhost:8000/console/ in your browserThe console is part of the API: wherever BBM-Atlas runs, it is at /console/, and / leads there. It holds no data of its own and fetches everything from the API, with your key when the server requires one. BBM_ATLAS_CONSOLE_ENABLED=false turns it off.
The pages
| Page | What it shows |
|---|---|
| Overview | Each store's readiness, the version and storage, repository and job counts, feature flags, compression savings, and how to connect an AI assistant to this server |
| Repositories | Index a path (in the background, with its progress), re-index, delete; each repository's languages, counts and age |
| Index jobs | Every job, newest first, with its step, progress and outcome; cancel one |
| Search | How a question was understood and planned, then each hit's score, sources, file and snippet |
| Graph explorer | A neighbourhood of the knowledge graph: pan, zoom, expand a node in place, centre on it |
| Impact analysis | What a change affects, one column per hop, with the tests that cover it |
Every page keeps its inputs in the address, so a search, a graph or an impact report can be bookmarked and shared, and results link to each other. The theme is dark by default, with a light one, or it follows your system.
Your API key
When the server requires keys, the API key button in the header asks for yours. It is sent as X-API-Key with every request and kept for this tab only, unless you choose to remember it on this device. Test checks a key before saving it.
With the Enterprise Edition's single sign-on, the same dialog also offers Sign in with SSO and, with SAML, Sign in with SAML (both labels can be changed). The console then works with your account's session.
Enterprise pages
With an Enterprise licence, an Enterprise section joins the sidebar. Each page shows only to the roles allowed to use it:
- People - add users and service accounts, set their roles, disable them, and issue and revoke their keys.
- Organisations - see them, and create one if you administer the whole deployment.
- Audit log - filter it by period, action, outcome and organisation, and verify its chain.
- My account - who you are signed in as, your roles and permissions, and your own API keys.
A new key's token is shown once, with a copy button. See People, roles and keys.