CORE SETUP

INSTALLATION GUIDE

Connect GitRabbit to your version control systems.

GitRabbit supports seamless integration with GitHub, GitLab, and Bitbucket. By default, it operates as an authorized app, listening to webhook events (like pull request creation or updates) and running isolated reviews in ephemeral environments.

Choose your platform below to begin the setup sequence.

Key_Capabilities

GitHub App

Install in one click via the GitHub Marketplace. Supports fine-grained permissions.

GitLab Integration

Integrate using self-hosted or SaaS GitLab using Project Webhooks and Access Tokens.

Secure Handshake

All communication is encrypted via TLS 1.3 with automated key rotation.

Self-Hosted Runners

Run analysis on your own infrastructure for maximum data isolation.

Setup_Sequence

GitHub Step 01

Access GitHub Marketplace

Navigate to the marketplace and look for the GitRabbit integration app.

GitHub Step 02

Configure Scope

Select either 'All repositories' or specify a list of repositories you wish to scan.

GitLab Step 01

Create Access Token

In GitLab, generate a Personal Access Token or Project Access Token with 'api' scope.

GitLab Step 02

Setup Webhook

Add a Webhook to your GitLab project pointing to the GitRabbit API endpoint with Merge Request events enabled.

Code_Example

Self-Hosted runner configuration (docker-compose.yml)

version: '3.8'
services:
  gitrabbit-runner:
    image: gitrabbit/runner:latest
    environment:
      - GITRABBIT_AGENT_KEY=gr_live_8f3a92c810d
      - REPO_SCOPE=github.com/my-org/*
      - MAX_CONCURRENT_JOBS=4
    restart: always

Pro_Tips

✦We recommend selecting specific repositories during initial installation to control review volume.
✦Ensure your CI environment has outbound access to api.gitrabbit.com if using self-hosted runners.
✦Check our Enterprise Security section for IP whitelisting instructions.

Quick Start Configuration