The DFE console, where an operator sets up and runs a deployment.
It manages the deployment through the dfe-engine API alone, never past it to the infrastructure. Observe embeds dfe-hyperdx, which the browser loads from its own URL, and the console sends its own telemetry to an OTLP endpoint when OTEL_EXPORTER_OTLP_ENDPOINT is set.
- Sources and their ingest rules, defined in one place.
- Schemas and meta schemas, transforms, field maps and the library they draw on.
- Detection rules and hunts.
- An Observe view for searching and charting the data.
- Platform and admin settings, and a first-run setup flow.
corepack enable # yarn 4, node >= 24
yarn install
yarn dev # turbo dev - app on http://localhost:3000On a system-installed node (/usr/bin/node) corepack enable fails with
EACCES on its symlink. Either corepack enable --install-directory ~/.local/bin (any writable directory on your PATH), or prefix each command
with corepack -- corepack yarn install -- which needs no enable. A yarn 1
already on your PATH is the wrong yarn for this lockfile.
Point it at an engine with NEXT_PUBLIC_API_URL (defaults suit local dev).
Full environment reference: docs/local-development.md.
A Turborepo/yarn-workspaces monorepo with one shipped app and four packages:
| Workspace | What it is |
|---|---|
apps/dfe-core-ui |
the Next.js app - the only artifact shipped (standalone container) |
packages/dfe-engine-types |
vendored engine OpenAPI spec + generated TypeScript types |
packages/dfe-icons |
SVG -> React icon codegen + storybook |
packages/dev-logger |
small shared logging helper |
packages/typescript-config |
shared tsconfigs |
| Doc | Covers |
|---|---|
| docs/architecture.md | app + package map, route groups, where dfe-ui sits in the DFE stack |
| docs/console-and-the-flow.md | the four menu groups, and how a source page draws the engine's flow resolver |
| docs/engine-api-client.md | the typed engine API client + spec re-vendor procedure |
| docs/authentication.md | local and OIDC sign-in, session renewal, sign-out and redirects |
| docs/observe-embed.md | the embedded dfe-hyperdx explore surface |
| docs/build-and-deploy.md | standalone build, container, publish |
| docs/local-development.md | toolchain, env vars, tests, storybook |
The suite's published docs are at https://dfe.docs.hyperi.io, and this repository's pages at https://dfe.docs.hyperi.io/dfe-ui/.
How to work in this repo, the commands that prove a change and what tends to bite are in CONTRIBUTING.md. A question that is not a bug goes in a new issue.
Open bugs: this repo | whole DFE suite
BUSL-1.1, see LICENSE.