Skip to content

Commit 8a0881f

Browse files
ankitjenaAnkit Jena
andauthored
add docs for extension with self-hosted (#465)
* add docs for extension with self-hosted * nit fix --------- Co-authored-by: Ankit Jena <ankit@coderabbit.ai>
1 parent 2f756f3 commit 8a0881f

File tree

4 files changed

+33
-5
lines changed

4 files changed

+33
-5
lines changed

docs/guides/about-vscode.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,4 @@ The extension makes only basic CodeRabbit review features available, with defaul
3535

3636
- [Install the VSCode extension](/guides/install-vscode)
3737
- [Use the VSCode extension](/guides/use-vscode)
38+
- [Use with Self-hosted CodeRabbit](/guides/use-vscode-selfhosted)

docs/guides/config-vscode.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,9 @@ The **Auto Review Mode** setting lets you control the behavior of the automatic
6060

6161
For more information about this feature, see [Automatically review local commits](/guides/use-vscode#auto-reviews).
6262

63-
## Set a review timeout {#timeout}
63+
## Use with self-hosted CodeRabbit {#self-hosted-coderabbit}
6464

65-
The **Review Timeout** setting lets you specify how long the extension waits for a response from CodeRabbit remote servers before timing out a code review. The default value is `20`.
66-
67-
To turn off timeouts, set this value to `0`.
65+
This setting is only used when you're using a self-hosted instance of CodeRabbit. If you're using the CodeRabbit Cloud service, you don't need to configure this setting. You will need to login and logout of the extension after adding this value.
6866

6967
## What's next {#whats-next}
7068

docs/guides/install-vscode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ If you do install the extension this way, then you still need to connect your Co
5959
## What's next
6060

6161
- [Use the VSCode extension](/guides/use-vscode)
62-
6362
- [Configure the VSCode extension](/guides/config-vscode)
63+
- [Use with Self-hosted CodeRabbit](/guides/use-vscode-selfhosted)

docs/guides/use-vscode-selfhosted.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Use the VSCode extension with self-hosted CodeRabbit
3+
description: How to setup the VSCode extension with self-hosted CodeRabbit
4+
---
5+
6+
This page is about setting up the VSCode extension with self-hosted CodeRabbit. If you are instead using the managed offering, see [Install the VSCode extension](/guides/install-vscode).
7+
8+
## Prerequisites
9+
10+
Your extension version should be greater than `0.12.1`
11+
12+
## Connect your self-hosted instance{#connect-self-hosted-instance}
13+
14+
To connect the VSCode extension to your self-hosted instance, follow these steps:
15+
16+
1. Logout from the VSCode extension, if logged in to our managed offering.
17+
2. Click on the "Self hosting CodeRabbit?" button, below the "Use CodeRabbit for free" button.
18+
3. Enter your self-hosted instance URL.
19+
3.1. Make sure the instance URL is reachable within your network and websocket connections are allowed.
20+
4. Select your git provider which you are using with your self-hosted CodeRabbit. (GitLab, Self-Hostd Gitlab, GitHub, GitHub Enterprise)
21+
5. If using GitHub, enter your [Github Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) when asked.
22+
6. You should be connected to your self-hosted instance and ready to use the VSCode extension.
23+
24+
25+
## What's next {#whats-next}
26+
27+
- [Use the VSCode extension](/guides/use-vscode)
28+
- [Configure the VSCode extension](/guides/config-vscode)
29+
- [Uninstall the VSCode extension](/guides/uninstall-vscode)

0 commit comments

Comments
 (0)