Skip to content
This repository was archived by the owner on Jul 8, 2025. It is now read-only.

Update docs #3

Merged
merged 2 commits into from
Dec 15, 2024
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
7 changes: 6 additions & 1 deletion public/help/continue-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,9 @@ For auto completion, you can add the following to your settings.json file:
You can now start using Continue as before, but with the added benefit
extra privacy and control over your data.

![Continue Window](./images/continue-two.png)
![Continue Window](./images/continue-two.png)

## Support

Any issuess , please ask for support on the Continue [CodeGate Discussions](https://github.com/stacklok/codegate/discussions/categories/continue) page.

48 changes: 13 additions & 35 deletions public/help/copilot-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

Welcome to the setup guide for configuring CoPilot integration with **CodeGate**.


---

## 📋 Prerequisites
Expand All @@ -20,37 +19,7 @@ Before you begin, make sure you have the following:

To enable CodeGate, you’ll need to install its Certificate Authority (CA) into your operating system’s trust store.

> **Why is this needed?**
> The CodeGate CA allows your machine to securely intercept and modify traffic between GitHub CoPilot and your IDE.
> ✨ **Don’t worry!** The decrypted traffic stays on your local machine and never leaves.


#### 🍎 **For MacOS Users**

Run the following command in your terminal to install the CA:

```bash
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain codegate_volume/certs/ca.crt
```

#### 🖥️ For Windows Users

Use this PowerShell command:

```Powershell
Import-Certificate -FilePath "certs\\ca.crt" -CertStoreLocation Cert:\\LocalMachine\\Root
```

#### 🐧 For Linux Users

Run these commands to install the CA:

```bash
sudo cp certs/ca.crt /usr/local/share/ca-certificates/codegate.crt
sudo update-ca-certificates
```

Note: You might need to restart your IDE after adding the certicates
See the [Certificates Page](/certificates) for a full details.

### Configure CoPilot Settings to Use CodeGate

Expand All @@ -72,8 +41,17 @@ settings (Ctrl+Shift+P) + "Preferences: Open User Settings (JSON)":

> **_NOTE:_** CoPilot may need a refresh after creating the proxy config. Restart VS-Code or open the command palate (Ctrl+Shift+P) and select "Developer: Reload Window".

### Start Coding with the Privacy Protections and Security of CodeGate in place
### Verify it works

In the bottom right section of VScode you will see a small CoPilot avatar. It
should look like the following:

![Picture of CoPilot Success, no exclamation mark](./images/copilot-success.png)

If there is any sort of failure, you will see the following:

![Picture of CoPilot Failure, has an exclamation mark](./images/copilot-fail.png)

That’s it—you’re all set!
If you experience a failure, click on the CoPilot avatar and select "Show Diagnostics"
, copy the text and post it to the CoPilot [CodeGate Discussions](https://github.com/stacklok/codegate/discussions/categories/copilot)

Go forth and build something amazing! 🚀✨
Binary file added public/help/images/copilot-fail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/help/images/copilot-success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion src/components/Certificates.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,10 @@ export function Certificates() {
"Add the certificate to the System keychain",
"Double-click the imported certificate",
"Expand the \"Trust\" section",
"Set \"When using this certificate\" to \"Always Trust\""
"Set \"When using this certificate\" to \"Custom Settings\"",
"Set \"Secure Sockets Layer\" to \"Always Trust\"",
"Set \"X.509 Basic Policy\" to \"Always Trust\"",
"Alternatively, you can run `sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain codegate_ca.crt`",
],
remove: [
"Open Keychain Access",
Expand Down