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
Copy file name to clipboardExpand all lines: docs/platforms/self-hosted-gitlab.md
+29-16
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,10 @@ To initiate the integration, we require specific information. This is essential
12
12
for the initial setup of CodeRabbit within your domain. Once this setup is
13
13
complete, you can log in directly using the OAuth2 flow.
14
14
15
-
CodeRabbit 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. While we won't block the integration, we recommend upgrading your GitLab instance to obtain the intended experience.
15
+
CodeRabbit supports GitLab `16.x` and above. Version `15.x` may experience
16
+
unexpected issues such as review comments not being posted or the sign-up
17
+
process not working at all. While we won't block the integration, we recommend
18
+
upgrading your GitLab instance to obtain the intended experience.
16
19
17
20
### **Step 1: Getting Started**
18
21
@@ -29,7 +32,8 @@ organization and if we find an existing one, we are starting the login process.
If the self-managed GitLab instance is not found, we initiate the onboarding process, which can be either manual or automated.
35
+
If the self-managed GitLab instance is not found, we initiate the onboarding
36
+
process, which can be either manual or automated.
33
37
34
38
### **Step 3: Onboarding Manual or Automated**
35
39
@@ -42,31 +46,39 @@ If the self-managed GitLab instance is not found, we initiate the onboarding pro
42
46
Admin access token is required to set up a new CodeRabbit bot user within your
43
47
self-managed instance. The token is needed only once during the initial setup
44
48
process. Once the token is generated, you can set its minimum expiration period.
45
-
This is the standard approach used by other products in this category.
46
-
This is not automatically installing the CodeRabbit
47
-
app across all projects. You will add CodeRabbit manually on the projects you
48
-
wish, as the next step.
49
+
This is the standard approach used by other products in this category. This is
50
+
not automatically installing the CodeRabbit app across all projects. You will
51
+
add CodeRabbit manually on the projects you wish, as the next step.
49
52
50
53
#### 2. Manual onboarding
51
54
52
-
For the manual onboarding process we need to create the [CodeRabbit user](#creating-coderabbit-user) and the [OAuth2 GitLab application](#creating-oauth2-application).
55
+
For the manual onboarding process we need to create the
56
+
[CodeRabbit user](#creating-coderabbit-user) and the
This feature will work with any user from your organization, but we strongly suggest creating a
58
-
dedicated user called **CodeRabbitAI**. This ensures clarify about which user is used for our
59
-
application and allows for better fine-grained access control.
62
+
This feature will work with any user from your organization, but we strongly
63
+
suggest creating a dedicated user called **CodeRabbitAI**. This ensures clarify
64
+
about which user is used for our application and allows for better fine-grained
65
+
access control.
60
66
61
-
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).
62
-
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).
67
+
To create users in GitLab, log in with an instance admin account and follow the
After the user is created, you can retrieve the **User ID** from that user's
71
+
profile and generate an [**access token**](#generating-personal-access-token).
63
72
The access token is used to post reviews on merge requests.
64
73
65
74
#### **Creating OAuth2 application**
66
75
67
-
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.
76
+
For self-managed GitLab, we recommend creating an instance-wide application
77
+
unless you want the reviews to be limited to a single group or user.
68
78
69
-
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.
0 commit comments