Administration guide
The administration guide is for the people who run an Apiome installation — super-admins and operators. Using Apiome inside a workspace (members, roles, API keys, tenants) is in the user guide; the command line has its own CLI guide.
Start with Operating Apiome — the services, the environment reference and the runbooks for deploying, backing up and triaging.
The admin console at /admin is where operators manage the whole installation:
signing in and the overview, Users,
Tenants, Licenses, Feature flags,
Sign-in providers and Property templates.
The tools — the Data browser and Migrations — work on a workspace's data directly.
These screens predate the Hive redesign, so they look unlike the rest of Apiome; every page carries a note saying so, and the redesign is tracked in #5272.
To serve this site yourself, see Host the documentation site; to change it, see Contribute to the docs.
Operating Apiome
Runbooks, environment reference and the Docker Compose stack for operators.
The admin console
Sign in to the installation-wide admin console and find your way around it.
Users
Approve signups, create accounts, assign licenses and disable or delete users.
Tenants in the admin console
Create, rename, disable and delete any tenant, and manage its members and administrators.
Licenses
Define license plans, their seat limits and features, and assign them to people.
Feature flags
Define feature flags and packages, switch them off, and grant them to one person.
Sign-in providers
Configure GitHub, Microsoft, Google, Okta and other OAuth sign-in from the admin console.
Property templates
Manage the reusable property definitions offered across every tenant.
Data browser
Browse, search, insert and restore data records stored against a version's class schemas.
Migrations
Map a class's records from one schema version to the next, and preview them.
Host the documentation site
Run this documentation site from the apiome-docs Docker image.
Contribute to the docs
Run the site, write a page, add a screenshot, and pass the docs gate.