Skip to main content
Vidoc connects to GitHub through a GitHub App. You do not give a token to Vidoc. On GitHub, Vidoc can:
  • Review each pull request (PR) and write a summary comment and inline comments.
  • Resolve its own comment threads when a later scan shows that the issue is fixed.
  • Read commands and questions that mention @vidoc in PR comments.
  • Record feedback from replies and 👍/👎 reactions on its comments.
  • Show a check run with a Run Vidoc button, when status reporting is on.
For a comparison with other platforms, refer to Supported platforms.

​
Requirements

  • Your repositories are on github.com. Vidoc does not support GitHub Enterprise Server.
  • You install the Vidoc GitHub App, vidoc-agent, on your GitHub account or organization. If you are not an owner of the GitHub organization, an owner must approve the installation.
  • You have the Admin role in Vidoc.

​
Connect GitHub

You must have the Admin role in Vidoc.
1

Open the Integrations page

In the web app, open the account menu and select Integrations. On the GitHub card, click Connect. If GitHub is already connected, click the card, then click Add connection.
On Vidoc Cloud, the onboarding flow shows the same steps when you create your organization.
2

Sign in with GitHub

In Connect to GitHub (step 1 of 3), click Continue with GitHub. Sign in to GitHub in the window that opens and authorize Vidoc. If you signed in to GitHub before, Vidoc skips this step.
3

Install the Vidoc GitHub App

In Install Vidoc App (step 2 of 3), click Install GitHub App. On GitHub, select the account or organization. Select the repositories that the app can access, then complete the installation.
GitHub app installation step
If you are not an owner of the GitHub organization, GitHub sends an install request to the organization owners. Vidoc shows Waiting for Approval. When an owner approves the request, Vidoc connects the installation. Click Check Status to update the page.
4

Import repositories

In Import GitHub repositories, select the repositories to add to the current project. Click Import selected repositories.
If a GitHub installation exists but it is not linked to your organization, the GitHub page shows it under Detected installations. Click Claim to link it.

​
Import more repositories later

  1. Open Integrations > GitHub.
  2. Open the actions menu of the GitHub account and select Import repositories.
The list shows only the repositories that the app can access. To add a repository to the list, change the repository access of the app on GitHub first. In GitHub, open the organization Settings > GitHub Apps, select the Vidoc app, and click Configure. Add the repository in Repository access.

​
Turn on PR reviews for repositories

Open Repositories in the web app. Each repository has a PR reviews toggle. You must have the Developer role or higher to change it.
  • On Vidoc Cloud, Vidoc turns on PR reviews automatically for the repositories that you import. On self-hosted installations, turn on the toggle for each repository.
  • When PR reviews turn on, Vidoc indexes the default branch of the repository. On the Enterprise plan and on self-hosted installations, Vidoc then runs a first full scan of the default branch. Refer to Scan types.
  • You do not create a webhook. The GitHub App sends the PR events to Vidoc.
  • Vidoc then reviews each new PR and each new commit on a PR.
On Vidoc Cloud, indexing and PR reviews start only when your organization has an active plan. The Repositories page shows a message when repositories wait for plan activation.
The PR comments toggle is in the actions menu of each repository. When it is off, Vidoc still scans PRs, but it does not write to GitHub. For all repository controls, refer to Repositories.

​
GitHub specifics

​
Update credentials

There is no token to rotate. The GitHub App gets short-lived tokens from GitHub for each operation. To change which repositories Vidoc can access, change the repository access of the Vidoc app in your GitHub organization settings.

​
Troubleshooting