Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qodo.ai/llms.txt

Use this file to discover all available pages before exploring further.

This guide helps you install and configure Qodo on-premises with GitHub. You can install it for a single repository 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 a GitHub App, configuring webhooks, setting permissions, and installing the app. Once complete, Qodo processes pull requests and delivers actionable output such as code reviews and insights, directly in your PRs.

​
Prerequisites

Before you begin, ensure you have:
  • A Qodo on-premises deployment. You will receive your Qodo on-premises URL from your Qodo Account Manager. It typically looks like: qodo-merge.yourcompanyname.qodo.ai
  • System administrator access to your GitHub organization.

​
Installation

​
Step 1: Navigate to the GitHub Apps section

1
Log in to GitHub using an administrative account.
2
Click your profile picture → Your organizations.
GitHub profile picture menu with Your organizations option
3
Select your organization.
GitHub organizations list
4
Click Settings.
GitHub organization settings button
5
Go to Developer settings → GitHub Apps.
GitHub Developer settings with GitHub Apps menu item
6
Click New GitHub App.

​
Step 2: Create the GitHub App

1
Register a new GitHub App with the following settings:
  • App name: Qodo
  • Homepage URL: https://qodo.ai
GitHub App registration form with App name and Homepage URL fields
2
Configure the webhook:
  • Check the Active checkbox.
  • Webhook URL: https://qodo-merge.[yourcompanyname].qodo.ai/api/v1/github_webhooks
  • Secret: generate a strong random secret and save it — you will need it to configure the Qodo service.
  • Select Enable SSL verification.
GitHub App webhook configuration with URL, secret, and SSL verification fields
3
Set the following repository permissions:
PermissionAccess
ActionsRead-only
ChecksRead-only
ContentsRead and write
DiscussionsRead and write
IssuesRead and write
Pull requestsRead and write
4
Subscribe to the following events:
GitHub App event subscriptions page
5
Under Where can this GitHub App be installed?, choose Any account — this avoids creating a separate application per organization.
GitHub App installation scope selection showing Any account option
6
Click Create GitHub App.
GitHub Create GitHub App button

​
Step 3: Post-creation actions

1
Note the App ID — you will need it for Qodo configuration.
GitHub App details page showing App ID
2
Generate a private key — you will need it for Qodo configuration.
GitHub App private key generation section
3
Upload the Qodo logo to use on GitHub posts.
GitHub App logo upload field

​
Step 4: Install the app

1
Go to Your Organization → Settings → Developer Settings → GitHub Apps.
GitHub Developer Settings GitHub Apps page
2
Click the Qodo app name.
GitHub Apps list showing Qodo app
3
Click Install on each relevant organization.
GitHub App install page showing Install button

​
Step 5: Configure repository access

1
Go to Settings → Developer Settings → GitHub Apps in your organization.
2
Click Configure on the Qodo app.
GitHub Apps list with Configure button for Qodo app
3
Under Repository Access, choose Only select repositories and select the repositories to include.
GitHub App repository access section with Only select repositories option

​
Step 6: Configure your Qodo instance

Add the following details to your Qodo on-premises configuration: 
# GitHub App ID
app_id = <your-app-id>

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

# Private key (.pem file)

# Organization name(s) where the app is installed
The organization name is available in your organization’s settings in GitHub. You can provide multiple organizations if the app is installed in more than one.
For production environments, follow your organization’s secret management procedures to securely store these credentials.

​
Verify the installation

1
Open a new pull request in one of the configured repositories and confirm that Qodo is triggered automatically.
2
Add a comment using one of the supported commands:
  • /agentic_describe
  • /agentic_review
Qodo should respond with a review or PR summary directly on the pull request.

​
Troubleshooting

If Qodo is not responding:
  • Verify that the pull request is in a repository selected in the app settings.
  • Contact your Qodo Account Manager for assistance.

​
What’s next

View Using Qodo in PRs to learn about next steps and how to get the most out of Qodo.