Settings
Instance administration
Instance admins manage accounts, all workspaces, instance settings, the GitHub App and health checks.
An instance is one CirCI installation. Instance admins run it: they manage every account and workspace, the server's settings and its health. This is separate from the workspace roles in Members and roles: an instance admin isn't automatically a member of any workspace, and sees a workspace's projects only if they belong to it.
Where to open it
Section titled “Where to open it”Instance admins have Instance admin in the account menu and an Instance entry in the sidebar. The hub lists three groups:
| Group | Page | What it holds |
|---|---|---|
| People | Accounts | Everyone who can sign in, and who runs the instance |
| Workspaces | All workspaces | Every workspace, new and deleted ones |
| Server | Instance settings, Health | Address, sign-in methods, mail, who can create workspaces; checks and background jobs |
The first account created during first-run setup becomes the first instance admin. See Sign in and set up.
Accounts
Section titled “Accounts”A searchable, paged list. Create account takes a Name, an Email, how they first sign in (Show a generated password or Email a sign-in code), an optional password, and Make them an instance admin. A generated password is shown once, in a dialog: pass it on yourself, because CirCI doesn't keep it readable.
Each account's actions menu offers:
- Change email: takes effect at once with no confirmation mail, so it works without mail and for a lost mailbox. They stay signed in.
- Reset password: signs them out everywhere and shows a new password once.
- Make instance admin or Remove instance admin. The last instance admin can't be removed.
- Sign out everywhere.
- Ban (with an optional reason and number of days; empty means no end) or Lift ban. Banning signs the person out at once; their reviews stay in each build's history.
The same actions exist in circi admin user on the server. See Admin CLI.
Workspaces
Section titled “Workspaces”Every workspace with its size, each opening its settings hub. New workspace asks for a Name and the Owner's email, which must already have an account; the owner invites the rest. Deleted workspaces are in a group of their own with the days left. When a workspace's owner deletes it, it's gone for everyone at once and deleted for good after 30 days. Until then an instance admin can Restore it or Delete permanently from its hub. See Workspace settings.
Instance settings
Section titled “Instance settings”Most of the page waits for Save changes, with Discard to revert. The single sign-on providers and the GitHub App apply from their own dialogs.
The page has sections for the dashboard address, sign-in methods, single sign-on providers, who can create workspaces, the mail server, the Slack app, storage and limits, and hosted sites. Instance settings lists each setting with its variable and default. Without mail, nobody gets sign-in codes or invitations by email.
GitHub App
Section titled “GitHub App”Create GitHub App, at the bottom of the page, sends you to GitHub with the App's name, address, permissions and events filled in; you confirm it there and install it. See GitHub and Instance settings.
Address changes
Section titled “Address changes”When the dashboard's address changes, instance admins see a banner and a Moving to … checklist on Health: old links redirect, but a few registrations outside CirCI (such as the GitHub App's webhook) still name the old address. The checklist can be dismissed and shown again.
Health
Section titled “Health”Run checks again runs the same checks as circi admin doctor, grouped as Services, Domains and cookies (best effort: it can only check hosts it knows) and a summary of Passing, Need a look and Failing. It also shows Background jobs (waiting, running, oldest waiting, retrying, failed) per queue, and the Setup code state: only needed on a fresh install, where the code is in the server log or from circi admin setup-code. See Scaling the worker.