Install a local platform with Builder and verify that onboarding has finished before using its Dataplane. This path is for a machine that will run platform services. To connect a workstation to an existing tenant, use Developer workstation setup instead.
See Platform sizing and environments for the distinction between installation topology, environments and production capacity.
Prerequisites
- A supported Docker installation with its engine running and permission to run containers.
- Node.js and the Builder CLI installed according to your team's version baseline.
- An approved local installation identity and administrator account details.
- Access to the required images and any credentials or licence needed by the selected installation.
Use a compatible Builder, Controller and Dataplane version set supplied by your platform operator. A command appearing in CLI help does not prove that an older Controller supports its readiness contract. Record versions before diagnosing a setup failure.
Where it lives
Builder runs the setup from your terminal. Platform containers run on the local Docker host; Builder's user configuration records the selected controller and installation settings.
Workspace onboarding is a different operation. aifabrix onboarding prepares coding work on a managed host; aifabrix setup installs or updates the local platform. Do not run platform installation merely because a workspace login failed.
How to set
- Confirm the tools and inspect the existing installation:
node --version
aifabrix --version
docker info
aifabrix status
- For a new local installation, start the guided installer:
aifabrix setup
Review the proposed installation and platform mode. Supply administrator details through the supported prompt and follow your organization's credential policy. Do not copy real passwords into shared examples, issue reports or command transcripts.
-
Let setup start the Controller and follow its onboarding progress. Readiness includes completion of both baseline Dimensions and baseline Business Roles. A healthy container alone is not the completion signal, and setup must not be treated as successful while either projection remains incomplete.
-
Follow the printed authentication and platform-ready instructions. Use the controller address reported for this installation instead of guessing an address from another host's developer number or topology.
-
For a later image refresh on an existing installation, use the supported update mode:
aifabrix setup --mode update-images
Read its output and confirm readiness again. This mode requires existing infrastructure; it is not a substitute for first-time setup.
Defaults and examples
| Choice | Meaning |
|---|---|
| Guided setup | Inspect and choose the appropriate installation action |
| Update images | Refresh an existing installation through the normal startup path |
| Dimension ABAC omitted | Preserve its saved selection, or use the default off |
| Reported controller address | Use the actual installation's endpoint for login |
Choose enforcement deliberately with Enable and verify Dimension ABAC. A platform mode and a licensed workload environment are different choices; selecting a topology does not grant additional environment entitlement.
Validate
aifabrix status
aifabrix auth status
Open the reported controller portal, complete any remaining activation steps, and confirm the intended environment is usable. Record the installed versions, readiness result, controller address and environment. Keep credentials out of retained evidence.
If setup stops on onboarding readiness, retain its named failure and correct the Controller's reported step. If image retrieval fails, resolve registry access. If authentication fails after readiness, verify the selected controller and account. Retry the affected operation after correcting its prerequisite instead of assuming that a complete reinstall is required.
Common mistakes
| Mistake | Correction |
|---|---|
| Container health used as onboarding proof | Require both catalog projections to complete |
| Update mode used on an empty host | Use guided first-time setup |
| Workspace login failure triggers platform installation | Check managed workspace configuration first |
| Reinstall or volume deletion used as routine retry | Preserve data and diagnose the reported failure |
Limits
This guide covers bounded local setup and verification, not production certification or a complete multi-environment rollout. Confirm compatibility and licence availability for your installed versions. Local provisioning, Azure provisioning and managed coding workspaces have different prerequisites. Do not infer that additional environments are isolated or ready solely because installation completed.