Skip to content

Commit b3dcd60

Browse files
guritfaqguritfaq
authored
Merge pull request #4 from coderabbitai/feature-self-hosted-gitlab
New Document on Self Hosted Gitlab Integration
2 parents 0857b26 + f8f5ee3 commit b3dcd60

File tree

6 files changed

+103
-32
lines changed

6 files changed

+103
-32
lines changed

‎docs/integrations/images/admin-access-token.png

491 KB
Loading

‎docs/integrations/images/enter-url.png

161 KB
Loading

‎docs/integrations/images/login-page.png

154 KB
Loading

‎docs/integrations/images/self-hosted-page.png

126 KB
Loading

‎docs/integrations/self-hosted-gitlab.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
title: CodeRabbit in Self Managed Gitlab
3+
description: Integrate CodeRabbit with your Self Managed Gitlab instance.
4+
sidebar_label: Self Managed Gitlab
5+
image: "/preview_meta.jpg"
6+
---
7+
8+
<head>
9+
<meta charSet="utf-8" />
10+
<meta name="title" content="CodeRabbit in Self Managed Gitlab" />
11+
<meta name="description" content="Integrate CodeRabbit in your own hosted Gitlab instance." />
12+
13+
<meta property="og:type" content="website" />
14+
<meta property="og:url" content="https://coderabbit.ai/" />
15+
<meta property="og:title" content="CodeRabbit in Self Managed Gitlab" />
16+
<meta property="og:description" content="CodeRabbit: AI-powered Code Reviews" />
17+
<meta property="og:image" content="/preview_meta.jpg" />
18+
19+
<meta name="twitter:image" content="https://coderabbit.ai/preview_meta.jpg" />
20+
<meta name="twitter:card" content="summary_large_image" />
21+
<meta name="twitter:title" content="CodeRabbit in Self Managed Gitlab" />
22+
<meta name="twitter:description" content="CodeRabbit: AI-powered Code Reviews" />
23+
</head>
24+
25+
This page guides you through the process of integrating your Self-Managed GitLab with CodeRabbit.
26+
27+
To initiate the integration, we require specific information. This is essential for the initial setup of our CodeRabbit user and the creation of the CodeRabbit application within your ___domain. Once this setup is complete, you can log in directly using the OAuth2 flow.
28+
29+
### **Step 1: Getting Started**
30+
31+
**Visit CodeRabbit:** Land on to our login page https://coderabbit.ai/login and select Self-Hosted Gitlab
32+
33+
![login-page](./images/login-page.png)
34+
35+
### Step 2: Enter your Self Managed Gitlab URL
36+
37+
On this page, you need to enter the URL of your self managed GitLab instance and click submit. Once, you submit, we will check our database for a record of your organization.
38+
39+
![Untitled](./images/enter-url.png)
40+
41+
### **Step 3: Enter Admin Personal Access Token (First time only)**
42+
43+
If this is the first time you are signing up with your instance, then we will need a admin access token for setting up the CodeRabbit bot.
44+
45+
#### **Generating Admin Personal Access token**
46+
47+
GitLab offers an option to generate a personal access token for adding a new user and setting up the application in the self-managed instance. To generate the token, please follow the process outlined below:
48+
49+
1. Login to your self-hosted instance. Ensure sure you have admin rights.
50+
2. On the left sidebar, select your avatar.
51+
3. Select Edit profile.
52+
4. On the left sidebar, select Access Tokens.
53+
5. Select Add new token.
54+
6. Enter a name and expiry date for the token. We need this for the initial setup, so the minimum expiry time is sufficient.
55+
7. If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
56+
8. Make sure, you select the scope: `api`
57+
9. Select Create personal access token.
58+
10. Please note down this token as this will be visible one time only
59+
60+
![Untitled](./images/admin-access-token.png)
61+
62+
### **Step 3: Paste the token and click submit**
63+
64+
- Submit the access token.
65+
- We will handle the setup process for you.
66+
- On subsequent visits, your setup will be automatically detected, allowing for direct login.
67+
68+
![Untitled](./images/self-hosted-page.png)
69+
70+
- Furthermore, please refer to our Get Started Guide to make the most of CodeRabbit. [here](../get-started/add-repo.md)

‎sidebars.ts

Lines changed: 33 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -11,38 +11,39 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
1111
Create as many sidebars as you want.
1212
*/
1313
const sidebars: SidebarsConfig = {
14-
docsSidebar: [
15-
"introduction/introduction",
16-
{
17-
type: "category",
18-
label: "About",
19-
collapsed: false,
20-
items: ["about/features", "about/pricing", "about/support"],
21-
},
22-
{
23-
type: "category",
24-
label: "Get Started",
25-
items: [
26-
"get-started/signup",
27-
"get-started/add-repo",
28-
// "get-started/customize-coderabbit",
29-
// "get-started/prompt-customization",
30-
"get-started/analytics",
31-
// "get-started/coderabbit-commands",
32-
,
33-
],
34-
},
35-
{
36-
type: "category",
37-
label: "Guides",
38-
items: [
39-
"guides/customize-coderabbit",
40-
"guides/prompt-customization",
41-
"guides/coderabbit-commands",
42-
],
43-
},
44-
"faq/faq",
45-
],
14+
docsSidebar: [
15+
"introduction/introduction",
16+
{
17+
type: "category",
18+
label: "About",
19+
collapsed: false,
20+
items: ["about/features", "about/pricing", "about/support"],
21+
},
22+
{
23+
type: "category",
24+
label: "Get Started",
25+
items: [
26+
"get-started/signup",
27+
"get-started/add-repo",
28+
// "get-started/customize-coderabbit",
29+
// "get-started/prompt-customization",
30+
"get-started/analytics",
31+
// "get-started/coderabbit-commands",
32+
,
33+
],
34+
},
35+
{
36+
type: "category",
37+
label: "Guides",
38+
items: ["guides/customize-coderabbit", "guides/prompt-customization", "guides/coderabbit-commands"],
39+
},
40+
{
41+
type: "category",
42+
label: "Integrations",
43+
items: ["integrations/self-hosted-gitlab"],
44+
},
45+
"faq/faq",
46+
],
4647
};
4748

4849
export default sidebars;

0 commit comments

Comments
 (0)