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

Commit 4c956e6

Browse files
authored
Fix cert instructions (#66)
* Update cert instructions for Linux * Clarify state of JetBrains support for Copilot
1 parent 8259a06 commit 4c956e6

2 files changed

Lines changed: 27 additions & 33 deletions

File tree

docs/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ CodeGate supports several development environments and AI providers.
3838
AI coding assistants / IDEs:
3939

4040
- **[GitHub Copilot](./integrations/copilot.mdx)** with Visual Studio Code
41-
(JetBrains coming soon!)
4241

4342
- **[Continue](./integrations/continue.mdx)** with Visual Studio Code and
4443
JetBrains IDEs

docs/integrations/copilot.mdx

Lines changed: 27 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,20 @@ import ThemedImage from '@theme/ThemedImage';
1212

1313
[GitHub Copilot](https://github.com/features/copilot) is an AI coding assistant
1414
developed by GitHub and OpenAI. The Copilot plugin works with Visual Studio Code
15-
(VS Code). Support for JetBrains is
16-
[coming soon](https://github.com/stacklok/codegate/issues/383).
15+
(VS Code) and JetBrains IDEs.
1716

1817
:::note
1918

19+
Currently, CodeGate only works with Copilot in VS Code. JetBrains IDEs do not
20+
support HTTPS proxy configurations. If you would like to use CodeGate with
21+
Copilot in JetBrains IDEs, please add a :+1: to
22+
[this issue](https://github.com/stacklok/codegate/issues/383) or let us know on
23+
[Discord](https://discord.gg/stacklok).
24+
25+
:::
26+
27+
:::info
28+
2029
This guide assumes you have an active subscription to GitHub Copilot and have
2130
installed the IDE extension.
2231

@@ -132,15 +141,14 @@ and prevent resource exhaustion.
132141
133142
</details>
134143
135-
### Install certificate from the UI
144+
### Install certificate from the dashboard
136145
137-
The easiest way to retrieve and install the CodeGate certificate is from the
138-
CodeGate web dashboard. Open the CodeGate dashboard in your browser:
139-
http://localhost:9090
146+
You can download the CodeGate CA certificate file from the CodeGate dashboard.
147+
Open the dashboard in your browser: http://localhost:9090
140148
141-
From the **Certificates** menu choose **Download**, then click the **Download
142-
Certificate** button. Follow the OS-specific instructions on the page to import
143-
the certificate to your trust store.
149+
From the **Certificates** menu choose **Download certificates**, then click the
150+
**Download certificate** button. Follow the OS-specific instructions on the page
151+
to import the certificate to your trust store.
144152
145153
### Install certificate from the CLI
146154
@@ -157,9 +165,11 @@ logs for errors.
157165
158166
<Tabs groupId="os">
159167
<TabItem value="macos" label="macOS" default>
168+
Run the following from a terminal:
169+
160170
```bash
161171
docker cp codegate:/app/codegate_volume/certs/ca.crt ./codegate.crt
162-
security add-trusted-cert -r trustRoot -k ~/Library/Keychains/login.keychain ./codegate.crt
172+
security add-trusted-cert -r trustRoot -p ssl -p basic -k ~/Library/Keychains/login.keychain ./codegate.crt
163173
```
164174
165175
Enter your password when prompted.
@@ -175,33 +185,24 @@ Import-Certificate -FilePath ".\codegate.crt" -CertStoreLocation Cert:\CurrentUs
175185
176186
</TabItem>
177187
<TabItem value="linux" label="Linux">
178-
Run the following commands from a terminal, depending on your distribution.
179-
180-
Ubuntu/Debian based distributions:
181-
182-
```bash
183-
docker cp codegate:/app/codegate_volume/certs/ca.crt ./codegate.crt
184-
sudo cp ./codegate.crt /usr/local/share/ca-certificates/codegate.crt
185-
sudo update-ca-certificates
186-
```
188+
Prerequisite: the `certutil` tool must be available on your system.
189+
- Ubuntu/Debian: `sudo apt install libnss3-tools`
190+
- RHEL/Fedora: `sudo dnf install nss-tools`
187191
188-
RHEL/Fedora and other Enterprise Linux distributions:
192+
Run the following from a terminal:
189193
190194
```bash
191195
docker cp codegate:/app/codegate_volume/certs/ca.crt ./codegate.crt
192-
sudo cp ./codegate.crt /etc/pki/ca-trust/source/anchors/codegate.pem
193-
sudo update-ca-trust
196+
certutil -d sql:$HOME/.pki/nssdb -A -t "C,," -n CodeGate-CA -i ./codegate.crt
194197
```
195198
196199
</TabItem>
197200
</Tabs>
198201
199-
## Configure your IDE to proxy traffic through CodeGate
202+
## Configure VS Code
200203
201-
Finally, configure your IDE to use CodeGate as an HTTP proxy.
204+
Finally, configure VS Code to use CodeGate as an HTTP proxy.
202205
203-
<Tabs groupId="ide">
204-
<TabItem value="vscode" label="VS Code" default>
205206
In VS Code, open the Command Palette (<kbd>⌘</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd>
206207
on macOS or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> on Windows/Linux) and
207208
search for the **Preferences: Open User Settings (JSON)** command.
@@ -227,12 +228,6 @@ Append the following settings to your configuration:
227228
}
228229
```
229230
230-
</TabItem>
231-
<TabItem value="jetbrains" label="JetBrains" default>
232-
Support for JetBrains is [coming soon](https://github.com/stacklok/codegate/issues/383).
233-
</TabItem>
234-
</Tabs>
235-
236231
## Verify configuration
237232
238233
To verify that you've successfully connected Copilot to CodeGate, open the

0 commit comments

Comments
 (0)