Hi! š We are doing a big documentation refresh. Help us improve - what's missing or could be better? Let us know! Join the Discord channel or simply send an email!
Learn how to integrate CodeRabbit with your self-managed GitLab instance through automated or manual onboarding, including OAuth setup, user configuration, and webhook installation.
Version RequirementsCodeRabbit supports GitLab 16.x and above. Version 15.x may experience unexpected issues such as review comments not being posted or the sign-up process not working at all. We recommend upgrading your GitLab instance to obtain the intended experience.
To integrate your self-managed GitLab with CodeRabbit, we require specific information for the initial setup within your domain. Once this setup is complete, you can log in directly using the OAuth2 flow.
Enter the URL of your self-managed GitLab instance and click Submit. Weāll check our database for an existing record of your organization and start the login process if found.If your self-managed GitLab instance is not found, weāll initiate the onboarding process.
3
Choose onboarding method
You can choose between automated or manual onboarding based on your security
preferences and administrative access.
Why do we need the Admin Access Token?The admin access token is required to set up a new CodeRabbit bot user within your self-managed instance. The token is needed only once during the initial setup process. Once generated, you can set its minimum expiration period. This is the standard approach used by other products in this category.Note: This does not automatically install the CodeRabbit app across all projects. You will add CodeRabbit manually to the projects you wish to integrate.
This feature will work with any user from your organization, but we strongly recommend creating a dedicated user called CodeRabbitAI. This ensures clarity about which user is used for our application and allows for better fine-grained access control.
1
Create the user
Log in with an instance admin account and follow the steps provided in the
GitLab
documentation
to create a new user.
2
Retrieve user information
After the user is created, retrieve the User ID from that userās profile.
3
Generate access token
Generate an access token for this
user. The access token is used to post reviews on merge requests.
Recommendations for the CodeRabbit user: - Use āCodeRabbitAIā as the
username for easy identification - Use the CodeRabbit
logo as the profile picture for easy
recognition - Ensure the user has appropriate permissions for the repositories
you want to integrate
If you prefer, you can create a Group Access Token which will create a
dedicated user on your behalf. For more information, see Group Access
Token.
For self-managed GitLab, we recommend creating an instance-wide application unless you want the reviews to be limited to a single group or user.Follow the steps outlined in the GitLab documentation for creating the application.