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

Commit 37a10df

Browse files
author
Luke Hinds
authored
Update docs (#3)
* Update docs * Spelling mistake
1 parent 37caebb commit 37a10df

File tree

5 files changed

+23
-37
lines changed

5 files changed

+23
-37
lines changed

public/help/continue-setup.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,9 @@ For auto completion, you can add the following to your settings.json file:
9595
You can now start using Continue as before, but with the added benefit
9696
extra privacy and control over your data.
9797

98-
![Continue Window](./images/continue-two.png)
98+
![Continue Window](./images/continue-two.png)
99+
100+
## Support
101+
102+
Any issuess , please ask for support on the Continue [CodeGate Discussions](https://github.com/stacklok/codegate/discussions/categories/continue) page.
103+

public/help/copilot-setup.md

Lines changed: 13 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

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

5-
65
---
76

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

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

23-
> **Why is this needed?**
24-
> The CodeGate CA allows your machine to securely intercept and modify traffic between GitHub CoPilot and your IDE.
25-
> **Don’t worry!** The decrypted traffic stays on your local machine and never leaves.
26-
27-
28-
#### 🍎 **For MacOS Users**
29-
30-
Run the following command in your terminal to install the CA:
31-
32-
```bash
33-
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain codegate_volume/certs/ca.crt
34-
```
35-
36-
#### 🖥️ For Windows Users
37-
38-
Use this PowerShell command:
39-
40-
```Powershell
41-
Import-Certificate -FilePath "certs\\ca.crt" -CertStoreLocation Cert:\\LocalMachine\\Root
42-
```
43-
44-
#### 🐧 For Linux Users
45-
46-
Run these commands to install the CA:
47-
48-
```bash
49-
sudo cp certs/ca.crt /usr/local/share/ca-certificates/codegate.crt
50-
sudo update-ca-certificates
51-
```
52-
53-
Note: You might need to restart your IDE after adding the certicates
22+
See the [Certificates Page](/certificates) for a full details.
5423

5524
### Configure CoPilot Settings to Use CodeGate
5625

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

7342
> **_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".
7443

75-
### Start Coding with the Privacy Protections and Security of CodeGate in place
44+
### Verify it works
45+
46+
In the bottom right section of VScode you will see a small CoPilot avatar. It
47+
should look like the following:
48+
49+
![Picture of CoPilot Success, no exclamation mark](./images/copilot-success.png)
50+
51+
If there is any sort of failure, you will see the following:
52+
53+
![Picture of CoPilot Failure, has an exclamation mark](./images/copilot-fail.png)
7654

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

79-
Go forth and build something amazing! 🚀✨

public/help/images/copilot-fail.png

5.13 KB
Loading
5.08 KB
Loading

src/components/Certificates.tsx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,10 @@ export function Certificates() {
9191
"Add the certificate to the System keychain",
9292
"Double-click the imported certificate",
9393
"Expand the \"Trust\" section",
94-
"Set \"When using this certificate\" to \"Always Trust\""
94+
"Set \"When using this certificate\" to \"Custom Settings\"",
95+
"Set \"Secure Sockets Layer\" to \"Always Trust\"",
96+
"Set \"X.509 Basic Policy\" to \"Always Trust\"",
97+
"Alternatively, you can run `sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain codegate_ca.crt`",
9598
],
9699
remove: [
97100
"Open Keychain Access",

0 commit comments

Comments
 (0)