From 53b0b430809d4610c9b8d9030b0ec7fa26275a0e Mon Sep 17 00:00:00 2001 From: Ankit Jena Date: Tue, 22 Jul 2025 10:26:33 +0530 Subject: [PATCH 1/2] add docs for extension with self-hosted --- docs/guides/about-vscode.md | 1 + docs/guides/config-vscode.md | 6 ++---- docs/guides/install-vscode.md | 2 ++ docs/guides/use-vscode-selfhosted.md | 29 ++++++++++++++++++++++++++++ 4 files changed, 34 insertions(+), 4 deletions(-) create mode 100644 docs/guides/use-vscode-selfhosted.md diff --git a/docs/guides/about-vscode.md b/docs/guides/about-vscode.md index 3e484ffe..ada6f06f 100644 --- a/docs/guides/about-vscode.md +++ b/docs/guides/about-vscode.md @@ -35,3 +35,4 @@ The extension makes only basic CodeRabbit review features available, with defaul - [Install the VSCode extension](/guides/install-vscode) - [Use the VSCode extension](/guides/use-vscode) +- [Use with Self-hosted CodeRabbit](/guides/use-vscode-selfhosted) diff --git a/docs/guides/config-vscode.md b/docs/guides/config-vscode.md index 41afc157..8bd0672a 100644 --- a/docs/guides/config-vscode.md +++ b/docs/guides/config-vscode.md @@ -60,11 +60,9 @@ The **Auto Review Mode** setting lets you control the behavior of the automatic For more information about this feature, see [Automatically review local commits](/guides/use-vscode#auto-reviews). -## Set a review timeout {#timeout} +## Use with self-hosted CodeRabbit {#self-hosted-coderabbit} -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`. - -To turn off timeouts, set this value to `0`. +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. ## What's next {#whats-next} diff --git a/docs/guides/install-vscode.md b/docs/guides/install-vscode.md index 03dfa98c..f4f37694 100644 --- a/docs/guides/install-vscode.md +++ b/docs/guides/install-vscode.md @@ -61,3 +61,5 @@ If you do install the extension this way, then you still need to connect your Co - [Use the VSCode extension](/guides/use-vscode) - [Configure the VSCode extension](/guides/config-vscode) + +- [Use with Self-hosted CodeRabbit](/guides/use-vscode-selfhosted) diff --git a/docs/guides/use-vscode-selfhosted.md b/docs/guides/use-vscode-selfhosted.md new file mode 100644 index 00000000..acba2a4c --- /dev/null +++ b/docs/guides/use-vscode-selfhosted.md @@ -0,0 +1,29 @@ +--- +title: Use the VSCode extension with self-hosted CodeRabbit +description: How to setup the VSCode extension with self-hosted CodeRabbit +--- + +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). + +## Prerequisites + +Your extension version should be greater than `0.12.1` + +## Connect your self-hosted instance{#connect-self-hosted-instance} + +To connect the VSCode extension to your self-hosted instance, follow these steps: + +1. Logout from the VSCode extension, if logged in to our managed offering. +2. Click on the "Self hosting CodeRabbit?" button, below the "Use CodeRabbit for free" button. +3. Enter your self-hosted instance URL. + 3.1. Make sure the instance URL is reachable within your network and websocket connections are allowed. +4. Select your git provider which you are using with your self-hosted CodeRabbit. (GitLab, Self-Hostd Gitlab, GitHub, GitHub Enterprise) +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. +6. You should be connected to your self-hosted instance and ready to use the VSCode extension. + + +## What's next {#whats-next} + +- [Use the VSCode extension](/guides/use-vscode) +- [Configure the VSCode extension](/guides/config-vscode) +- [Uninstall the VSCode extension](/guides/uninstall-vscode) From 0486dec5b8ca590c52bd56c68a49f9870b43a486 Mon Sep 17 00:00:00 2001 From: Ankit Jena Date: Tue, 22 Jul 2025 10:38:13 +0530 Subject: [PATCH 2/2] nit fix --- docs/guides/install-vscode.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/guides/install-vscode.md b/docs/guides/install-vscode.md index f4f37694..99e3b662 100644 --- a/docs/guides/install-vscode.md +++ b/docs/guides/install-vscode.md @@ -59,7 +59,5 @@ If you do install the extension this way, then you still need to connect your Co ## What's next - [Use the VSCode extension](/guides/use-vscode) - - [Configure the VSCode extension](/guides/config-vscode) - - [Use with Self-hosted CodeRabbit](/guides/use-vscode-selfhosted)