Qodo Single Tenant (GitHub)

Installation Guide

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

This guide helps you install and configure Qodo with GitHub. You can install Qodo on a single repository to start small or expand it across multiple organizations as needed.

Assuming your Qodo environment is already set up, configuring GitHub typically takes about 20 minutes. This includes creating access tokens, configuring the service, and setting up webhooks.

Once complete, Qodo processes pull requests and delivers actionable output—such as code reviews and insights—directly in your PRs. Setting up Qodo for GitHub brings automated pull request intelligence directly into your GitHub workflow.

Prerequisites

Before you begin, ensure you have:

• A Qodo single-tenant deployment You will receive your Qodo single-tenant URL from your Qodo Account Manager. It typically looks like: qodo-merge.yourcompanyname.st.qodo.ai

• System administrator access to your GitHub organization

Installation

Step 1: Navigate to the GitHub apps section

1. Login using an administrative account.

2. Click your profile picture → Your organizations.

1. Select your organization.

1. Click Settings.

1. Go to Developer settings → GitHub Apps.

1. Click New GitHub App.

Step 2: Create the GitHub App

1. Register a new GitHub App:

   • App name: Qodo

   • Homepage URL: http://qodo.ai

   

2. Configure the webhook

   • Select the Active checkbox.

   • Webhook URL: use the following format URL provided by Qodo:

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

   • Secret: Generate a random secret and add it here. Keep this webhook secret secure, as it will be required later when configuring the Qodo service. Use a strong value and any secret generation tool you prefer.

   • Select Enable SSL verification.

1. Set the following repository permissions:

Permission name	Description	Access
Workflows, workflow runs and artifacts	Access to GitHub Actions workflows, workflow runs, and related artifacts	Read-only
Checks	Checks on code	Read-only
Contents	Repository contents including commits, branches, downloads, releases, and merges	Read and write
Discussions	Discussions and related comments and labels	Read and write
Issues	Issues and related comments, assignees, labels, and milestones	Read and write
Pull requests	Pull requests and related comments, assignees, labels, milestones, and merges	Read and write

1. Subscribe to the following events:

1. In the Where can this GitHub App be installed? section, select Any account (If you have multiple organizations, this will avoid creating a separate application for each org).

1. Click Create GitHub App.

Step 3: Post creation actions

1. Make note of the App ID. You will need it later when configuring Qodo.

1. Generate a private key. You will need it later when configuring Qodo.

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

1. Use the Qodo Anteater logo:

Step 4: Install the App

1. Go to Your Organization -> Settings -> Developer Settings -> GitHub Apps:

1. Click on the Qodo App name.

1. Install the App on each of the relevant Orgs.

Step 5: App configuration

Select the repositories you want Qodo to run on.

1. In the organizational Settings menu, go to the GitHub Apps.

2. Click Configure on the Qodo app.

1. Under Repository Access select 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.

Once completed, wait for the Qodo team to confirm that 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 should automatically post a review comment or alternatively, add a comment with /improve to an existing PR.

3. Verify that Qodo 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.

Available commands

Once installed, you can use the following commands in pull request comments:

• /review – Perform a code review

• /improve – Suggest code improvements

• /describe – Generate a pull request description

• /ask – Ask questions about the code changes