Skip to content

add docs for extension with self-hosted #465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/guides/about-vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
6 changes: 2 additions & 4 deletions docs/guides/config-vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/install-vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +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)
29 changes: 29 additions & 0 deletions docs/guides/use-vscode-selfhosted.md
Original file line number Diff line number Diff line change
@@ -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)
Loading