Installation
Step 1: Connect GitHub
- Go to your project in the Vidoc dashboard
- Navigate to Settings → Integrations
- Click “Connect GitHub”
- You’ll be redirected to GitHub to authorize the Vidoc app
Step 2: Authorize Access
On the GitHub authorization page:- Review the permissions requested
- Select which organizations to grant access
- Click “Authorize”
Vidoc requires read access to your code and write access to pull request comments.
Step 3: Select Repositories
After authorization:- Return to Vidoc
- Click “Add Repository”
- Select repositories from the list
- Choose which branches to scan
Permissions Explained
| Permission | Purpose |
|---|---|
| Read: Code | Scan your source code for vulnerabilities |
| Read: Pull requests | Detect new PRs to scan |
| Write: Pull requests | Post security findings as comments |
| Read: Metadata | Access repository information |
Repository Settings
After adding a repository, configure scanning behavior:Default Branch
The branch scanned for baseline security posture. Usuallymain or master.
Auto Scan
Enable to automatically scan:- New pull requests
- Pushes to the default branch
PR Comments
Configure how Vidoc reports findings in pull requests:- Inline comments - Comments on specific lines of code
- Summary comment - Overview of all findings in the PR
Multiple Organizations
To scan repositories from multiple GitHub organizations:- Go to Settings → Integrations
- Click “Add Organization”
- Authorize Vidoc for the new organization
- Select repositories to add
Troubleshooting
”Repository not appearing in list”
- Check that Vidoc is authorized for the repository’s organization
- Go to GitHub → Settings → Applications → Vidoc
- Click “Configure” and add the missing repository
”Scans not triggering”
- Verify Auto Scan is enabled for the repository
- Check webhook delivery in GitHub repository settings
- See Troubleshooting for more solutions
Revoking Access
To disconnect GitHub:- Go to Vidoc Settings → Integrations
- Click “Disconnect” next to GitHub
- Optionally, revoke access in GitHub Settings → Applications

