Appearance

Frequently Asked Questions (FAQ) ​

Find quick solutions to common issues. Use the categories below to jump to a specific section.

Quick Navigation ​

🔑 Account & Access ​

How do I get the Repository UID (RepoUID)? ​

The RepoUID is a unique identifier required for CLI scans.

  • Method 1: Open your repository in the browser; the UID is the string at the end of the URL.
  • Method 2: Go to Repository Dashboard > Three Dots (...) > More Information.
  • Detailed Guide →

How do I generate an Access Token (EAT)? ​

  1. Log in to your instance.
  2. Navigate to User Settings > Access Tokens.
  3. Click Generate Token. Note: Copy it immediately; it will not be shown again.

What permissions does my access token need? ​

For CLI scans and API access, your token needs:

  • Repository Access: Read permissions for target repositories
  • Scan Permissions: Ability to create and upload scan results
  • Project Access: View access to projects containing your repositories

🐳 Installation & Deployment ​

What are the minimum system requirements? ​

For standard use, we recommend:

  • CPU: 4 Cores (8 recommended for large repos)
  • RAM: 16GB minimum (32GB for enterprise workloads)
  • Storage: SSD with at least 50GB free space
  • Full Requirements Guide →

How do I handle self-signed SSL certificates? ​

If your Git server uses a self-signed certificate, you must mount your .crt file to the container:

bash
--volume /path/to/cert.crt:/opt/gamma/certs/cert.crt

How do I backup my data before upgrading? ​

Always create backups before any upgrade:

  1. Database backup: docker exec -t embold_db_1 pg_dump -U postgres postgres > backup.sql
  2. File backup: tar -czf backup.tar.gz /home/user/BrowserStackCodeQuality/gamma_data

🔍 Analysis & Scans ​

Where can I download the CLI Scanner? ​

The CLI tool is essential for remote and pipeline-based scans.

How do I download the Repository Configuration? ​

  1. Open your Repository Dashboard.
  2. Click the Three Dots (...) in the top right.
  3. Select Download Repository Configuration.
  4. Place this repository-configuration.json at your repo root.

How do I exclude specific folders (e.g., node_modules)? ​

Add the paths to the excludes array in your repository-configuration.json:

json
{
  "excludes": [
    "**/node_modules/**", 
    "**/test/**", 
    "**/vendor/**",
    "**/build/**",
    "**/*.min.js"
  ]
}

My scan is running out of memory. How do I fix this? ​

Large codebases need more RAM allocation:

How long should a scan take? ​

Typical scan times:

  • Small repos (<100k LoC): 2-5 minutes
  • Medium repos (100k-1M LoC): 10-30 minutes
  • Large repos (>1M LoC): 1-3 hours
  • Delta scans: <10 seconds regardless of size

🤖 SCM & Workflows ​

How do I enable Pull Request analysis? ​

  1. Go to Repositories > [Your Repo] > Edit
  2. Toggle Enable Pull Request Analysis
  3. Webhooks are created automatically if your VCA has permissions

Why aren't my PRs being scanned? ​

Check these common issues:

  • Webhook exists: Verify webhook is created in your SCM settings
  • Token permissions: Ensure VCA token has webhook and PR comment rights
  • Server accessibility: Your SCM must reach your BrowserStack Code Quality server URL
  • Troubleshooting Guide →

What's the difference between Commit and PR workflows? ​

  • Commit Workflow: Enterprise-only, scans every commit (GitHub/Bitbucket)
  • PR Workflow: All licenses, scans pull requests (GitHub/GitLab/Bitbucket/Azure)
  • Workflow Comparison →

🛠️ Troubleshooting ​

Why am I getting a 401 Unauthorized error? ​

Your Access Token is either missing, expired, or doesn't have the correct permissions:

  1. Check if EMBOLD_TOKEN environment variable is set: echo $EMBOLD_TOKEN
  2. Regenerate a new token in User Settings > Access Tokens
  3. Verify token has repository access permissions

What does a 422 Unprocessable Entity error mean? ​

This usually occurs during webhook setup:

  • Server accessibility: Ensure your BrowserStack Code Quality server URL is reachable from your SCM
  • Duplicate webhooks: Check if webhook already exists for this repository
  • URL format: Verify webhook URL ends with /api/views/repositories/webhooks

My Docker container won't start. What should I check? ​

Common startup issues:

  1. Port conflicts: Ensure port 3089 is available: netstat -tlnp | grep 3089
  2. Memory limits: Verify sufficient RAM allocated to Docker
  3. Volume permissions: Check file ownership: chown -R 1001:1001 gamma_data/
  4. Database connectivity: Ensure database container is healthy

How do I check the application logs? ​

Use these commands to diagnose issues:

bash
# View recent logs
docker logs BrowserStackCodeQuality --tail 50

# Follow live logs
docker logs -f BrowserStackCodeQuality

# Search for errors
docker logs BrowserStackCodeQuality 2>&1 | grep -i error

My scan completed but I don't see results. Why? ​

Possible causes:

  • Analysis in progress: Check Development History for scan status
  • No issues found: Verify scan actually analyzed files (check logs)
  • Permission issues: Ensure user has view access to repository results
  • Delta scan limitations: New repositories need full scan first

Need More Help? ​

Can't find your answer? Try these resources:

Copyright © 2025 BrowserStack