Skip to content

Commit f5c8251

Browse files
coderabbit-amankcoderabbit-amank
committed
feat: added document under integration on integration with self hosted gitlab
1 parent 6d6435f commit f5c8251

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 walks you through integrating your own Self Managed GitLab with CodeRabbit.
26+
27+
To start the integration we need some information, this is required for first time to setup our CodeRabbit user and to create CodeRabbit application in your ___domain. Once this is set next time, You can directly login using 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 for your organization record in our database.
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 need the admin access token for setup.
44+
45+
#### **Generating Admin Personal Access token**
46+
47+
Gitlab provide an option to generate the personal access token to add a new user and setup application in the self managed instance. To generate the token, please follow the below process
48+
49+
1. Login to the instance. Make 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 One time, so you can set the minimum expiry time
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 scope `api`
57+
9. Select Create personal access token.
58+
10. Please copy this token, this will be visible at one time only
59+
60+
![Untitled](./images/admin-access-token.png)
61+
62+
### **Step 3: Paste the token and click submit**
63+
64+
- Once you submit the access token.
65+
- Sit, Relax. We will setup everything
66+
- And next time, when you visit. This will auto detect and you will be able to directly login.
67+
68+
![Untitled](./images/self-hosted-page.png)
69+
70+
- Further, Please refer to our Get Started Guide on how to use best of the 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)