You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 16, 2025. It is now read-only.
###**Step 3: Enter Admin Personal Access Token (First time only)**
29
+
If the self-managed GitLab instance is not found, we initiate the onboarding process, which can be either manual or automated.
30
30
31
-
If this is the first time you are signing up with your instance, we need an
32
-
admin access token for setting up the CodeRabbit.
31
+
###**Step 3: Onboarding Manual or Automated**
32
+
33
+
####1. Automated onboarding
34
+
33
35
34
36
####**Why do we need the Admin Access Token?**
35
37
36
38
Admin access token is required to set up a new CodeRabbit bot user within your
37
39
self-managed instance. The token is needed only once during the initial setup
38
-
process and is not stored in our database. Once the token is generated, you can
39
-
set its minimum expiration period.This is the standard approach used by other
40
-
products in this category.This is not automatically installing the CodeRabbit
40
+
process. Once the token is generated, you can set its minimum expiration period.
41
+
This is the standard approach used by other products in this category.
42
+
This is not automatically installing the CodeRabbit
41
43
app across all projects. You will add CodeRabbit manually on the projects you
42
44
wish, as the next step.
43
45
44
-
####**Generating Admin Personal Access token**
46
+
####2. Manual onboarding
47
+
48
+
For the manual onboarding process we need to create the[CodeRabbit user](#creating-coderabbit-user) and the[OAuth2 GitLab application](#creating-oauth2-application).
49
+
50
+
51
+
####**Creating CodeRabbit user**
52
+
This feature will work with any user from your organization, but we strongly suggest creating a
53
+
dedicated user called**CodeRabbitAI**. This ensures clarify about which user is used for our
54
+
application and allows for better fine-grained access control.
55
+
56
+
To create users in GitLab, log in with an instance admin account and follow the steps provided in the[GitLab documentation](https://docs.gitlab.com/ee/user/profile/account/create_accounts.html#create-users-in-admin-area).
57
+
After the user is created, you can retrieve the**User ID** from that user's profile and generate an[**access token**](#generating-personal-access-token).
58
+
The access token is used to post reviews on merge requests.
59
+
60
+
####**Creating OAuth2 application**
61
+
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.
62
+
63
+
Please follow the steps outlined in the[GitLab documentation](https://docs.gitlab.com/ee/integration/oauth_provider.html#create-an-instance-wide-application) for creating the application.
64
+
65
+
Requirements:
66
+
1. Scopes:`api read_user email`
67
+
2. Callback URL:`https://app.coderabbit.ai/login`
68
+
69
+
####**Generating Personal Access token**
45
70
46
71
GitLab offers an option to generate a personal access token for adding a new
47
72
user and setting up the application in the self-managed instance. To generate
48
73
the token, please follow the process outlined below:
49
74
50
-
1. Login to your self-hosted instance.Ensure sure you have admin rights.
75
+
1. Login to your self-hosted instance.For[automated onboarding](#1-automated-onboarding) ensure you have admin rights.
51
76
2. On the left sidebar, select your avatar.
52
77
3. Select Edit profile.
53
78
4. On the left sidebar, select Access Tokens.
@@ -56,15 +81,15 @@ the token, please follow the process outlined below:
56
81
setup, so the minimum expiry time is sufficient.
57
82
7. If you do not enter an expiry date, the expiry date is automatically set to
58
83
365 days later than the current date.
59
-
8. Make sure, you select thescope:`api`
84
+
8. Make sure, you select thescopes:`api user email`
60
85
9. Select Create personal access token.
61
86
10. Please note down this token as this will be visible one time only
62
87
63
88
64
89
65
-
###**Step 4: Paste thetoken and click submit**
90
+
###**Step 4: Paste thedetails and click submit**
66
91
67
-
- Submit theaccess token.
92
+
- Submit theform.
68
93
- We will handle the setup process for you.
69
94
- On subsequent visits, your setup will be automatically detected, allowing for
70
95
direct login.