Docs menu

fAI Remote Connection

Goal: Run a fAI server for your workspace.

Open fAI -> Manage Remote Connection. "Your fAI server runs fAI for this workspace, with a web app, an MCP server and an API. Choose its address and provision it. It deploys into your connected Azure subscription, or into Fathym’s shared cloud when none is connected."

Before you start

Nothing else is needed. A cloud connection and landing zone are not required; without a connected cloud the server goes to Fathym's shared cloud.

Provision

FieldWhat it is
Server addressFor example my-fai. "Lower-case letters, digits and hyphens, starting with a letter. It names the server’s URLs and cannot be changed once provisioned."

Provision fAI server starts it: "Provisioning started. The build and deploy run in the background." The window follows it in Latest deployment.

Once it is live

"Your fAI server is deployed. Redeploy rebuilds it from the pinned fAI source and replaces its three containers."

ButtonWhat it does
RedeployRebuilds the server: "Redeploy started. The build and deploy run in the background."
RemoveAsks first: "This queues the fAI server and its three containers for removal. The removal runs on your next Deploy." Queue removal confirms; Cancel backs out

After Queue removal: "Removal queued. It runs on your next Deploy." The server keeps running until then. The window has no start or stop control.

Save and Deploy

ActionWhen it takes effect
Provision fAI serverAt once, in the background
RedeployAt once, in the background
Queue removalOn the next Deploy

Rights

The window checks no access right of its own.

Azi and agents

The fAI server is set up by a person in this window; it is not proposed.

Messages you may see

WhenMessage
The address is missingAPISlug is required.
The address is not validIt must be lower-case letters, digits and hyphens, starting with a letter and ending with a letter or digit
The address is takenIt is already in use - choose another
A different address later"The fAI server already uses the address '(address)'. Remove it before choosing another."
Provisioning was refusedThe reason, or "The fAI server could not be provisioned."
Redeploy was refusedThe reason, or "The fAI server could not be redeployed."
Removal was refusedThe reason, or "The removal could not be queued."

Next steps

On this page