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 your GitLab instance. You can install Qodo on a single project to start small or expand it across multiple projects as needed. Assuming your Qodo environment is already set up, configuring GitLab typically takes about 20 minutes. This includes creating access tokens, configuring the service, and setting up webhooks. Once complete, Qodo processes merge requests and delivers actionable output such as code reviews and insights, directly in your MRs.

​
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.st.qodo.ai
  • System administrator access. Required if you want to set up Qodo at the group level.

​
Installation (group level)

​
Step 1: Generate a token

1
Navigate to the Groups section in GitLab and select the group where you want to set up Qodo.
GitLab groups list showing group with Owner role
2
Within the selected group, go to Group settings → Access tokens.
GitLab group settings sidebar with Access Tokens menu item
3
Configure the access token with the following settings:
  • Name: Any name will suffice
  • Expiration date: Choose an appropriate period
    • For a proof of value (PoV): 1–2 months
    • For a customer setup: 1 year
  • Role: At least Developer
  • Scopes: Select only the api scope
GitLab group access token form with name, expiry, role, and api scope fields
Copy and save the bearer token immediately — you will not be able to view it again.
GitLab group access token created showing token value to copy and save

​
Step 2: Create a shared webhook secret

Select a strong secret value (it can be any string). You can use any secret generation tool you prefer.

​
Step 3: Create a group webhook

1
Within the selected group, navigate to Group settings → Webhooks.
GitLab group settings Webhooks page with webhook list
2
Select Add new webhook.
GitLab group webhooks empty state with Add new webhook button
3
Configure the webhook with the following settings:
  • Name: Choose an appropriate name (no specific requirement)
  • Description: Free text
  • URL: Use the Qodo on-premises URL provided by your Qodo Account Manager (for example: https://qodo-merge.yourcompanyname.st.qodo.ai/webhook)
  • Secret token: The shared secret you created in Step 2
  • Triggers: Select Comments and Merge request events
GitLab group webhook form with URL, secret token, and description fields
GitLab webhook trigger events with Comments and Merge request events enabled

​
Verify the installation

1
Open a new merge request in one of the projects within the selected group where Qodo was configured.
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 merge request.

​
Troubleshooting

If Qodo is not responding:
  • Verify that the merge request is opened in a repository that is included in the configured group or project scope.
  • Contact the Qodo team for assistance.

​
Installation (project level)

If you want to limit Qodo to a specific GitLab project (repository), follow the same steps outlined above, but perform them at the project level instead of the group level. You can repeat this process for multiple projects. Note that each project must use a unique webhook secret.

​
What’s next

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