Getting started
Sign in and set up
The first-run setup page, then signing in.
A new install asks you to create its first account, and everyone after that signs in.
First-run setup
Section titled “First-run setup”On a fresh install the dashboard shows Set up CirCI, a guided flow in four steps. CirCI has no self sign-up, so this is how the first account comes to exist. A stranger can't claim a fresh install: step 1 asks for a setup code that only someone with access to the server can read.
- Account. Enter the setup code (from
docker compose logs circi, ordocker compose exec circi circi admin setup-code), then your name, email and a password of at least 12 characters. This account is an instance admin. - Workspace. A name and an address (the slug in URLs, for example
acme). You are its owner. - Storage. The flow checks that the server can write to storage and lets you re-run the check. You can continue with warnings and come back to them under Instance › Health.
- Project. Name your first project. The flow shows its CI token once: copy it now.
Signing in
Section titled “Signing in”The sign-in page offers the methods your instance allows.
- Email and password. At least 12 characters.
- Email code. With SMTP configured, people with an account can get a 6-digit code by email. A code works once, expires after 10 minutes and locks after 5 wrong attempts. Requests are limited to 5 per address per 15 minutes. An address without an account gets the same answer and no mail.
- Single sign-on. A button for each configured provider (GitHub, Google, GitLab or any OpenID Connect provider), and "Sign in through your workspace" when a workspace has connected its own provider.
Signing in through a provider doesn't create an account unless the person was invited, or the provider is trusted for email and the address is on a verified workspace domain. See Members and roles and Workspace settings. Every method, limit and rule is in Authentication.
Adding people
Section titled “Adding people”Owners and admins invite people by email from the workspace's members page. Someone without an account creates one by signing in with an emailed code. Without SMTP, add accounts from the command line:
docker compose exec circi circi admin user create --email you@acme.io --name "You"docker compose exec circi circi admin member add --org acme --email you@acme.io --role memberNext: Create a project.