HomepageBlogCommunityGet Started

Qodo Single Tenant - Github

Installation Guide

Qodo can be integrated with all versions of Github. Enterprise, Cloud & Cloud Enterprise.

This guide will help you install and configure Qodo with Github. You can install it for a single repository or expand it across multiple Orgs as needed.

Assuming your Qodo environment is setup, expect configuring Github to take about 20 minutes, including creating tokens, configuring the service, and setting up web hooks.

Once complete, Qodo will process pull requests and deliver actionable output—such as code reviews and insights—directly to your PRs. Setting up Qodo for Github brings automated PR intelligence to your github installation.

Prerequisites

Before you begin, ensure you have:

  1. A Qodo Single Tenant Deployment

  2. Receive your Qodo Single Tenant URL from your Qodo Account Manager. It will look like qodo-merge.yourcompanyname.st.qodo.ai

  3. System administrator access to your Github Org

Installation Steps

Step 1: Navigate to the GitHub apps section

  • Login using an administrative account

  • Click your profile picture → Your organizations

  • Select your organization (click on the org name)

  • Click “Settings”

  • Go to Developer settings → GitHub Apps

  • Click “New GitHub App”

Step 2: Create the GitHub App

  • Register a new Github App:

  • Configure the webhook

    • Check the “Active” checkbox.

    • Webhook URL: use the following format (URL to be provided to you by Qodo):

      • https://qodo-merge.[yourcompanyname].st.qodo.ai/api/v1/github_webhook

    • Secret: generate a random secret and add it here. Keep the webhook secret safe, it will be needed to configure the Qodo service. Choose a strong secret (it can be anything). You can use any secret generation tool you prefer.

    • Select “Enable SSL verification”

  • Set the following Repository permissions:

Permission Name
Description
Access

Actions

Workflows, workflow runs and artifacts

Read-only

Checks

Checks on code

Read-only

Contents

Repository contents commits. branches, downloads, releases and merges

Read and write

Discussions

Discussions and rleated comments and labels

Read and write

Issues

Issues and related commens, assignees, labels and milestones

Read and write

Pull requests

Pull requests and related comments, assignees, labels, milestones and merges

Read and write

  • Subscribe to the following events:

  • In the “Where can this GitHub App be installed?” section:

    • Choose “Any account” (If you have multiple organizations, this will avoid creating a separate application for each org).

  • Finally, click “Create GitHub App”

Step 3: Post creation actions

  • Write down the App ID, it will be needed for Qodo Merge configuration

  • Generate a private key, it will be needed for Qodo Merge configuration

  • Upload a logo that will be used on Qodo GitHub posts on issues and PRs.

  • Use the Qodo Anteater logo:

Step 4: Install the App

  • Go to Your Organization -> Settings -> Developer Settings -> Github Apps:

  • Click on the Qodo App name

  • Install the App on each of the relevant Orgs

Step 5: App Configuration

Select the repositories you wish to include for Qodo Merge.

  • Go to the GitHub Apps section in your organization’s Settings menu:

    • Click “Configure” on the Qodo app

  • Under Repository Access choose “Only select repositories” and select the repositories that you wish to include:

Step 6: Send Github App Details to Qodo

Provide Qodo account contact the following details to configure your Qodo instance with the following settings:

Production Note: For production environments, follow your organization's secret management procedures to securely store these credentials.

# Github App ID
AppID = 3

# Shared secret for webhook verification 
webhook_secret = "your-webhook-secret-here"

# Private key (.pem file)

# Organization IDs (the name of the organization where the application is installed)

The organization ID is available in the organization settings in Github. You can provide multiple organizations if you have installed Qodo several times.

Well Done. Now wait for the Qodo Team to confirm Server configuration is complete.

Verification

After confirmation from the Qodo team, you can proceed to testing the installation

Run a Test PR

  1. Open a new pull request in one of your integrated repositories

  2. Qodo Merge should automatically post a review comment

  3. Alternatively, add a comment with /improve to an existing PR

  4. Verify that Qodo Merge responds with code suggestions

Troubleshooting

If Qodo Merge isn't responding:

  • Verify that you are raising the PR in a repo that was selected in the App settings

  • Contact Qodo team and provide the installation ID of the App.

Once installed, you can use Qodo Merge commands in PR comments:

  • /review - Perform a code review

  • /improve - Suggest code improvements

  • /describe - Generate a PR description

  • /ask - Ask questions about the code changes

PreviousGitHubNextGitHub Enterprise

Last updated