Follow the official GitHub guide for registering a GitHub app

• GitHub App name: You can make this whatever you want (ex. Sourcebot Review Agent)
• Homepage URL: You can make this whatever you want (ex. https://www.sourcebot.dev/)
• Webhook URL (IMPORTANT): You must set this to point to your Sourcebot deployment at /api/webhook (ex. https://sourcebot.aperture.com/api/webhook). Your Sourcebot deployment must be able to accept requests from GitHub (either github.com or your self-hosted enterprise server) for this to work. If you’re running Sourcebot locally, you can use smee to forward webhooks to your local deployment.
• Webook Secret: This can be any string (ex. generate a random string python -c "import secrets; print(secrets.token_hex(10))"). You’ll provide this to Sourcebot to be able to read webhook events from your app.
• Permissions
  • Pull requests: Read & Write
  • Issues: Read & Write
  • Contents: Read
• Events:
  • Pull request
  • Issue comment

Navigate to your new GitHub app’s page and press Install

Sourcebot requires the following environment variables to begin reviewing PRs through your new GitHub app:

• GITHUB_APP_ID: The client ID of your GitHub app. Can be found in your app settings
• GITHUB_APP_WEBHOOK_SECRET: The webhook secret you defined in your GitHub app. Can be found in your app settings
• GITHUB_APP_PRIVATE_KEY_PATH: The path to your app’s private key. If you’re running Sourcebot from a container, this is the path to this file from within your container (ex /data/review-agent-key.pem). You must copy the private key file into the directory you mount to Sourcebot (similar to the config file).

You can generate a private key file for your app in the app settings. You must copy this private key file into the directory that you mount to Sourcebot

• OPENAI_API_KEY: Your OpenAI API key
• REVIEW_AGENT_AUTO_REVIEW_ENABLED (default: false): If enabled, the review agent will automatically review any new or updated PR. If disabled, you must invoke it using the command defined by REVIEW_AGENT_REVIEW_COMMAND
• REVIEW_AGENT_REVIEW_COMMAND (default: review): The command that invokes the review agent (ex. /review) when a user comments on the PR. Don’t include the slash character in this value.

You can find an example docker compose file below.

• This docker compose file is placed in ~/sourcebot_review_agent_workspace, and I’m mounting that directory to Sourcebot
• The config and the app private key files are placed in this directory
• The paths to these files are given to Sourcebot relative to /data since that’s the directory in Sourcebot that I’m mounting to

services:
    sourcebot:
        image: ghcr.io/sourcebot-dev/sourcebot:latest
        pull_policy: always
        container_name: sourcebot
        ports:
            - "3000:3000"
        volumes:
            - "/Users/michael/sourcebot_review_agent_workspace:/data"
        environment:
            CONFIG_PATH: "/data/config.json"
            GITHUB_APP_ID: "my-github-app-id"
            GITHUB_APP_WEBHOOK_SECRET: "my-github-app-webhook-secret"
            GITHUB_APP_PRIVATE_KEY_PATH: "/data/review-agent-key.pem"
            OPENAI_API_KEY: "sk-proj-my-open-api-key"

Navigate to the agents page by pressing Agents in the Sourcebot nav menu. If you’ve configured your environment variables correctly you’ll see the following: