Skip to content

Settings

Workspace settings

A workspace's name and address, defaults for its projects, sign-in methods and email domains, integrations, storage and deletion.

A workspace is your organization in CirCI: its members, projects, integrations and defaults. Workspace settings are where owners and admins shape them.

  • Settings in the workspace menu (the workspace's name at the top of the sidebar). Owners and admins land on General, other members on Members, and instance admins on the workspace's hub.
  • gthens from anywhere.
  • CommandK, then the page's name, for example "Members" or "Storage".

The hub groups the pages, each with a summary on the right:

Group Page For
Workspace General, Members, projects General and projects: owners and admins. Members: everyone in the workspace
Access Sign-in and domains Owners and admins
Connections Integrations Owners and admins
Data Storage and retention Owners and admins

A member who isn't an owner or admin sees only Members and projects, and is redirected to Members from the others. Someone outside the workspace sees "You're not a member of this workspace". See Members and roles for the roles.

Details saves as soon as you change it:

CirCI
The General page of workspace settings for Acme. Details has the picture, Display name and URL slug. Below are Merge gate defaults with Flaky-only changes block merging turned on and the projects that inherit or set their own, then Triage defaults.
General for the Acme workspace. Each default shows which projects inherit it and which set their own.
  • The picture: Change picture uploads one, and it can be removed ("Picture saved", "Picture removed").
  • Display name.
  • URL slug: where the workspace lives in CirCI. Changing it breaks existing links, including bookmarks and the links in existing pull request comments; new builds post the new address.

A name or slug field shows a check mark when it differs from what is saved, and you confirm it there.

Flaky-only changes block merging: when the only changes in a pull request are to flaky screenshots, the check still waits for review. On by default; turned off, the check passes. Every project follows this unless its own settings override it, and the page lists how many follow it and which override, linking to those projects. See Triage and flaky screenshots.

Assign new triage items to whoever is on triage: items nobody has go to the person on the project's weekly rotation, and move to the next person at the handover. Projects can override it. See Review requests and rules.

These two are defaults that change how people work, so Save changes applies them ("Defaults saved"), and Discard reverts.

Delete workspace is for owners only. Its projects, builds, screenshots and settings disappear for everyone at once, and are deleted for good after 30 days. In that time an instance admin can restore it. You type the workspace's slug to confirm. An instance admin finds a deleted workspace in the instance's workspace list and opens its hub, which shows the days left, Restore and Delete permanently (deletes everything now, after a confirmation, and can't be undone). See Instance administration.

A list of every project in the workspace, each opening that project's settings. See Project settings.

People can open this workspace only if they sign in with a method you turn on here. Each method is a checkbox:

Method Notes
Password Email and password
Email code A 6-digit code and link mailed to the address. Disabled with "Not set up on this instance" when the server has no mail
Single sign-on Your own OpenID Connect provider, below
GitHub, Google Shown only when the instance offers them. GitHub also covers joining by invitation or verified domain

A method the instance doesn't allow can't be turned on here: an instance admin sets the outer limit, and a workspace can only narrow it. The server keeps at least one method usable by an owner, so you can't lock everyone out. Because turning a method off can lock people out, the changes wait for Save ("Sign-in methods saved"), with Discard.

The Single sign-on row connects the workspace's own OpenID Connect provider. Configure opens a dialog with Issuer address, Client ID and Client secret. Once connected, the row shows the issuer and the redirect address to register at your provider, with Remove. Only owners and admins see this row.

People sign in from the sign-in page by entering the workspace's slug, and join as members. Their session opens this workspace only, and an address that already has an account elsewhere is refused. Removing the provider stops them opening the workspace, but their accounts stay until you remove them as members.

Add a domain such as example.com to let people join without an invitation. Add the DNS TXT record the page shows, then choose Check now. Once a domain is verified, anyone who signs in with an emailed code on an address at that domain joins the workspace as a member. Removing a domain stops this; members who already joined stay. The DNS record, who can verify a domain and when people join are in Authentication.

Git hosts (GitHub, GitLab, Bitbucket), Slack, Linear, Jira and Figma are connected here, then mapped to projects. Each is covered in its own page: see Integrations.

Storage used shows the workspace's total with a row per kind of file and By project. Identical files are stored once, across builds and projects, so the parts add up to more than the total.

Retention sets the Default for new projects, in days. Existing projects keep their own setting, changed in their General page. It saves with Save and Discard. The page also states what is never deleted (the newest approved build on the default branch for each build name, which is the baseline, and any hosted site version a live branch link serves) and that a file nothing refers to is deleted 24 hours later, after CirCI checks again that no new upload claimed it. See Retention and garbage collection.