Skip to main content
Open app.vidoc.dev or your custom deployment URL. For an on-premises installation, use the web app URL from your admin. Select the tab for your deployment below; refer to Deployment options for the differences.
For a new self-hosted installation, start with Deployment process for image access, the technical runbook, and guidance from Vidoc. This quickstart starts after the application is available.
1

Sign in

Open app.vidoc.dev. Sign in with your email address (passwordless sign-in) or with Google. Your email address must be verified.
2

Create your organization

Type the name of your organization. You become the admin of the organization.
3

Tell us about you

Answer the questions about your role and your team.
4

Connect your source code platform

Select your platform. Vidoc shows a platform that is not available on Vidoc Cloud as disabled. Follow the steps for your platform:
  • GitHub: install the Vidoc GitHub App and select the repositories.
  • GitLab: add a bot access token.
For the platforms on each deployment, refer to Supported platforms.
5

Select repositories to scan

Select the repositories that Vidoc must review.
6

Choose a plan

If your organization has no subscription, click Enable auto-scan. Vidoc opens the checkout for the Pro plan. Scans do not start without a subscription. For the Enterprise plan, contact Vidoc. For plans and prices, refer to vidocsecurity.com.
7

Wait for the setup

Vidoc turns on PR reviews and indexes the repositories that you selected. Then Vidoc opens the Repositories page.
8

Open a pull request

Open a pull request (PR) in one of the selected repositories. Vidoc writes a summary comment on the PR. While the scan runs, the comment shows “Currently scanning commit …”. When the scan is complete, Vidoc edits the comment with the result.
Organizations on the Enterprise plan skip the onboarding steps. Connect your platform in Integrations and turn on PR reviews in Repositories.

Next steps

Pull request reviews

The summary comment, inline comments, and results.

Commands

Start a scan or ask a question from a PR comment (GitHub and GitLab).

Findings

Triage findings in the web app.

CLI

Scan from your terminal or CI.