Administration guide
The administration guide is for the people who run an Apiome Suite installation — the operators who deploy the studio beside an Apiome installation, keep its sign-in paired with the main app, and decide which workspaces are entitled to which surfaces. Using the Suite inside a workspace is the user guide; the open-source product's own operations — the admin console, sign-in providers, migrations and hosting — are in the Apiome administration guide.
The Suite is two services next to Apiome:
| Service | What it is | Page |
|---|---|---|
The studio (designer) | The Next.js app that serves every Suite surface: the Designer workspace, Authoring, Scribe, Slate and the hosted-plan pages. Published as the apiome-suite image. | Deploy the studio |
| Spire | The FastAPI service behind Scribe and Slate: documentation content, coverage, the LLM gateway, sites and builds. Its tables live in the authoring schema of the Apiome database. | Run Spire |
Both talk to the Apiome installation they extend — apiome-rest for projects, versions, classes and paths, and the main app for sign-in — so an installation is three origins that must agree on a few secrets. Start with Deploy the studio, then Authentication for the pairing rules, and Licensing for what each plan and flag unlocks.
To serve this site yourself, see Host the documentation site; to change it, see Contribute to the docs.
Deploy the studio
Build and run the apiome-suite image beside an Apiome installation.
Environment reference
Every variable the studio and Spire read, with its purpose and default.
Run Spire
Start the authoring service, apply its migrations and connect an LLM provider.
Authentication
One sign-in across the main app and the studio, and the service bearer.
Licensing
Plans, limits and the feature flags that unlock each Suite surface.
Release process
The gates a release candidate passes, and the checklist to record them.
Host the documentation site
Build and serve this site's Docker image at docs.suite.apiome.dev.
Contribute to the docs
Run the site, write a page, and pass the docs gate.