Noderax Documentation
Read the current documentation tree for self-hosted install, operations, API reference, architecture, and release notes.
Noderax Documentation
Noderax is a workspace-aware infrastructure control plane composed of a Next.js operator surface, a NestJS orchestration API, a Go agent runtime, and an installer-managed release layer for self-hosted control planes.
This site is the canonical long-form documentation set for:
- operators running nodes and tasks
- platform admins managing installer-managed deployments
- developers integrating with the API or contributing to the repos
Start Here
Learn the core nouns, repo boundaries, and the shortest path for each role.
Self-Hosted
Install the platform, finish `/setup`, understand TLS, runtime promotion, and control-plane updates.
Operations
Add nodes, verify metrics and events, open terminals, and operate the split Updates Center.
API Reference
Read the auth and realtime model, then drill into generated endpoint pages from the local OpenAPI snapshot.
Read this docs tree by goal
- Start Here: learn the core nouns, product surfaces, and fastest path for each role.
- Self-Hosted: install the platform, finish
/setup, understand HA runtime promotion, and operate TLS and control-plane updates. - Operations: add nodes, watch metrics, work with terminals, root access, tasks, notifications, and the split updates center.
- API Reference: read the operational API guides, then drill into generated endpoint reference pages from the checked-in OpenAPI snapshot.
- Architecture: understand how the web app, API, agent, and platform bundle fit together.
- Changelog: track the current
1.0.0line and howreleaseIddifferentiates control-plane builds.
The platform line stays on 1.0.0. Control-plane update detection is driven by
immutable releaseId, not by a changing semantic version string.
Read by persona
Start with Add node and bootstrap, then move to Metrics, events, diagnostics, and notifications and Terminals.
Start with Fresh install, then First-run setup, Runtime model, and Control-plane updates.
Start with API overview, Realtime model, and Monorepo map.
Core entry points
- Public docs:
https://docs.noderax.net - Self-hosted install:
curl -fsSL https://cdn.noderax.net/noderax-platform/install.sh | sudo bash - Setup UI:
https://your-domain/setup - Runtime dashboard:
https://your-domain/login
Source of truth
The docs on this site are authored from the current product behavior. Repo READMEs stay useful as quick references, but they are no longer the primary public documentation surface after the docs site launches.