Skip to content

docs fix for self-hosted extension #466

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.

Sign up for GitHub

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

docs fix for self-hosted extension #466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d88fea8
docs fix for self-hosted extension
Jul 22, 2025
04c45ff
change title
Jul 22, 2025
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
18 changes: 9 additions & 9 deletions docs/guides/use-vscode-selfhosted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---
title: Use the VSCode extension with self-hosted CodeRabbit
title: Use 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`
1. Your extension version should be greater than `0.12.1`.
2. Logout of the extension if previously logged in.

## 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.
1. Click on the "Self hosting CodeRabbit?" button, below the "Use CodeRabbit for free" button.
2. Enter your self-hosted instance URL when prompted.
- Make sure the instance URL is reachable within your network and websocket connections are allowed.
3. Select your git provider which you are using with your self-hosted CodeRabbit. (GitLab, Self-Hosted Gitlab, GitHub, GitHub Enterprise)
- If using GitHub or GitHub Enterprise, enter your [Github Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) when prompted.

You should be connected to your self-hosted instance and ready to use the VSCode extension.

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

Expand Down
1 change: 1 addition & 0 deletions sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ const sidebars: SidebarsConfig = {
"guides/about-vscode",
"guides/install-vscode",
"guides/use-vscode",
"guides/use-vscode-selfhosted",
"guides/config-vscode",
"guides/uninstall-vscode",
],
Expand Down