Documentation

Connect

Connect the customer's git host, sign-in, chat channels and tools, in this order, and check each connection before you configure anything.

This stage connects CoRoid to the systems in the discovery document. Connect them in the order of this page. Each section links to the page that explains the connection.

Let the customer's own people enter tokens and keys where you can. A connection made with a consultant's personal token stops working when the consultant's access ends.

Git host

CoRoid cannot work without a git host. Connect it at Settings → Connections → Source control. See Connect your code.

  • GitHub with the CoRoid GitHub App. Use the App when you can. It grants access per repository and keeps working when the person who installed it leaves. It also sends the pull request events that CoRoid Quality Control and CoRoid Review need. A GitHub organization admin usually installs it, so plan that meeting early. See GitHub.
  • GitHub with a token. Use a token only when the customer cannot install the App. A token acts as the person who made it, so it must belong to an account that the customer owns. With a token, CoRoid does not check or review the pull requests that people open.
  • GitLab. GitLab is in private preview. You connect gitlab.com by signing in. A self-managed GitLab connects with an access token, over HTTPS, and CoRoid must reach it over the public internet. See GitLab.

Keep the customer's branch protection and required reviews on. CoRoid works inside them. See Branch protection.

Sign-in

  • Own accounts. Each person signs in with their own account. Each person turns on two-factor authentication in their profile.
  • Members and roles. Invite people in Settings → Members with the role from the discovery document. See Invite your team.
  • Single sign-on. SAML single sign-on, verified domains and directory sync (SCIM) are in Settings → Identity and access → Enterprise identity. They are part of Enterprise, which is in private preview. Before Require SSO for this organization can be turned on, the page asks for four things: an active SAML connection, a verified domain, a successful SSO test by the owner, and a way for the owner to recover access. See Identity and access.

Chat channels

A Slack or Telegram message can become a request for work. Each platform needs its bot in Settings → Connections → Channels → Platform bots. You turn the request source on later, in Configure. See Chat platforms.

Anyone who can post in a matching channel can file a request. Agree with the customer which channels CoRoid reads, and note them in the discovery document.

Tools

Connect only the tools that the discovery document names.

ToolWhat it doesWhere
Issue trackersBring existing Jira, Linear, Trello and GitHub issues into CoRoidIssue trackers
External MCP serversLet agents call the customer's own toolsSettings → Connections → External MCP. See External MCP servers
Review evidenceShow the results of the customer's scanners, previews and test runs on each pull requestA project's Settings → Integrations. See Review evidence providers
Service accountsLet the customer's own systems file requests through the work intake APISettings → Service accounts. See From your own systems
CoRoid's MCP serverLet the customer's assistants work with CoRoidSettings → Connections → CoRoid MCP server. See CoRoid as an MCP server
Provider keysUse the customer's own contracts with model providersSettings → Provider keys. See Provider keys

Done when

  • CoRoid lists the customer's repositories when you create a project.
  • Each person signs in with their own account, with two-factor authentication or the customer's SSO.
  • Each bot and each tool in the discovery document is connected.