Skip to content

Commit cb72128

Browse files
committed
doc/FAQ: Document proxy environment variables
1 parent ae902b9 commit cb72128

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

doc/FAQ.md

+25
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
- [Isn't an install script piped into sh insecure?](#isnt-an-install-script-piped-into-sh-insecure)
2828
- [How do I make my keyboard shortcuts work?](#how-do-i-make-my-keyboard-shortcuts-work)
2929
- [Differences compared to Theia?](#differences-compared-to-theia)
30+
- [`$HTTP_PROXY`, `$HTTPS_PROXY`, `$NO_PROXY`](#http_proxy-https_proxy-no_proxy)
3031
- [Enterprise](#enterprise)
3132

3233
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -338,6 +339,30 @@ You can't just use your VS Code config in Theia like you can with code-server.
338339
To summarize, code-server is a patched fork of VS Code to run in the browser whereas
339340
Theia takes some parts of VS Code but is an entirely different editor.
340341

342+
## `$HTTP_PROXY`, `$HTTPS_PROXY`, `$NO_PROXY`
343+
344+
code-server supports the standard environment variables to allow directing
345+
server side requests through a proxy.
346+
347+
```sh
348+
export HTTP_PROXY=https://134.8.5.4
349+
export HTTPS_PROXY=https://134.8.5.4
350+
# Now all of code-server's server side requests will go through
351+
# https://134.8.5.4 first.
352+
code-server
353+
```
354+
355+
- See [proxy-from-env](https://www.npmjs.com/package/proxy-from-env#environment-variables)
356+
for a detailed reference on the various environment variables and their syntax.
357+
- code-server only uses the `http` and `https` protocols.
358+
- See [proxy-agent](https://www.npmjs.com/package/proxy-agent) for the various supported
359+
proxy protocols.
360+
361+
**note**: Only server side requests will be proxied! This includes fetching extensions,
362+
requests made from extensions etc. To proxy requests from your browser you need to
363+
configure your browser separately. Browser requests would cover exploring the extension
364+
marketplace.
365+
341366
## Enterprise
342367

343368
Visit [our enterprise page](https://coder.com) for more information about our

0 commit comments

Comments
 (0)