Pick the shortest useful path based on whether you are operating the platform, administering the control plane, or integrating as a developer.

Quickstart Paths

Choose the path that matches what you need to do right now.

Operator path

Use this path if you need to add nodes, inspect metrics, open terminals, or work with tasks and packages.

Sign into the control plane and join the correct workspace.

Add a node from the dashboard and collect the generated install command.

Run the node install command on the target machine and watch the install progress update in realtime.

After enrollment completes, verify metrics, heartbeat, diagnostics, and terminal access from the node detail views.

Use this path if you own the control plane itself.

Install the platform bundle with the public install command.

Open /setup and finish the bootstrap flow for database, Redis, mail, and admin credentials.

Confirm runtime promotion and verify api-a, api-b, web, and nginx.

Use the Control plane tab in the Updates Center to download and apply newer installer-managed releases when they become available.

Use this path if you are integrating with the API or contributing to the code.

Read the architecture pages for repo layout, API/web/agent boundaries, and the release pipeline.

Read the API overview pages for auth, workspace scoping, realtime, and update flows.

Browse the generated endpoint reference pages under API Reference.

If you need a current schema snapshot, run pnpm sync:openapi inside noderax-docs.