Connect your stack

Connect a repository

Connect GitHub, GitLab, or Bitbucket repositories to a Veriom workspace, or upload a repository as a ZIP file.

This page is for a workspace admin who wants Veriom to audit code. Veriom reads code from GitHub through its GitHub App, from GitLab and Bitbucket through a sign-in or a read-only token, or from a ZIP file you upload.

Before you start

  • You have the Admin or Owner role in the workspace. A Developer can upload ZIP files but cannot connect providers.
  • You are signed in to Veriom in your browser.

Connect GitHub

  1. In Veriom, open Integrations and select the Repositories tab.
  2. Click Add repositories. If the workspace already has a GitHub account, click Connect another GitHub account to add a second one.
  3. GitHub opens. Choose the account or organization, choose All repositories or Only select repositories, and install the App.
  4. GitHub sends you back to Veriom. Choose the repositories to add to the workspace.

The authorization link works once and expires after 10 minutes. If it expires, start again from step 2.

Veriom starts a first audit for each repository you add, then audits it on every push to its default branch.

GitHub permissions

FeatureGitHub App permissions it needs
AuditsMetadata: read, Contents: read
Pull request checksPull requests: read, Checks: write
Fix pull requests (remediation)Contents: write, Pull requests: write
Keyless CI setup pull requestContents: write, Workflows: write, Pull requests: write

Veriom never asks for organization administration.

Connect GitLab or Bitbucket

  1. Open Integrations, select the Repositories tab, and find Repository providers.
  2. Click Connect GitLab.com or Connect Bitbucket Cloud.
  3. For Bitbucket, enter your Bitbucket Workspace and click Continue to Bitbucket.
  4. Approve the access on GitLab or Bitbucket.
ProviderAccess Veriom asks forWhy
GitLab.comapi, read_repositoryapi lets Veriom create the project webhook that reports pushes and merge requests
Bitbucket CloudAccount: read, Repositories: read, Webhooks: read and writeWebhooks report pushes and pull requests

Veriom turns on up to 10 of the most recently active repositories, within your plan's repository limit. It schedules them and starts a first audit for each. To audit another repository, open Repository inventory and click Add to scope on it.

Use a token instead

Use a token for self-managed GitLab, or when you do not want to sign in through OAuth.

  1. In Repository providers, click Use a token.
  2. Choose the Provider, and enter a Connection name.
  3. For self-managed GitLab, set Provider API URL to your GitLab address. It defaults to https://gitlab.com.
  4. Paste a Read-only access token:
    • GitLab: a token with read_api and read_repository;
    • Bitbucket: a repository access token with repository read permission.
  5. Click Connect provider.

Upload a ZIP file

Use this when Veriom cannot reach your repository host.

  1. Open Integrations, select the Repositories tab, and find Repository ZIP sources.
  2. Click Upload ZIP and choose the file.

Veriom checks the archive, then audits it.

LimitValue
File type.zip only
Upload size1 GB
Unpacked size5 GB
Files in the archive250,000
Kept for30 days

Archives with symbolic links, absolute paths, or .. in a path are refused.

If something goes wrong

What Veriom saysFix
This one-time authorization expired or was already used.Start the connection again
The GitHub App is missing a required permission.Open the App's settings in GitHub, accept the requested permissions, then retry
The GitHub installation was cancelled.Retry, or skip GitHub for now and upload a ZIP
This workspace is already connected to a different GitHub account.Choose another workspace, or manage the existing connection
No repositories are available to this GitHub account.In GitHub, give the App access to at least one repository
This GitHub account is already connected to another Veriom account.Sign in to that Veriom account, or use another GitHub account

See Troubleshooting for more codes.

Was this guide useful?

Your response stays in this browser unless you open a GitHub issue.
View source