Skip to content
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

Update guide.md: Reverse Proxying Server-Side Requests #7223

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update guide.md: Reverse Proxying Server-Side Requests #7223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions docs/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,18 @@ built-in subpath-based proxy.
Note: relative paths are also supported i.e.
`VSCODE_PROXY_URI=./proxy/{{port}}`

It may also be neccesary to reroute server side requests through your
reverse proxy as well. This is the preferred method described [here](https://coder.com/docs/code-server/FAQ#how-do-i-direct-server-side-requests-through-a-proxy)
as it will preserve the functionality desrcibed above. This can be done by
configuring the enviornment variable(s) `HTTP_PROXY` and/or `HTTPS_PROXY` to
the address or hostname of your reverse proxy.

This will also resolve hostnames, including within docker networks. For
example, if your reverse proxy is a Caddy container named `caddy`, on the
same docker network as `code-server`, you could set
`HTTPS_PROXY=https://caddy/` in the `enviornment:` block of the
`compose.yml`.

### Stripping `/proxy/<port>` from the request path

You may notice that the code-server proxy strips `/proxy/<port>` from the
Expand Down