Skip to content

docs: add port-forwarding #5979

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

Merged
merged 6 commits into from
Jan 27, 2023
Merged

docs: add port-forwarding #5979

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
985212d
docs: add port-forwarding
jsjoeio Jan 19, 2023
a637e75
fixup: formatting
jsjoeio Jan 19, 2023
b2e683c
Update docs/guide.md
jsjoeio Jan 20, 2023
077ad34
docs: clean up based on feedback
jsjoeio Jan 20, 2023
c10d0cb
docs: add relative paths paragraph
jsjoeio Jan 23, 2023
cdb2934
Remove dupe paragraph and fill paragraph
code-asher Jan 27, 2023
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
27 changes: 25 additions & 2 deletions docs/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- [Accessing web services](#accessing-web-services)
- [Using a subdomain](#using-a-subdomain)
- [Using a subpath](#using-a-subpath)
- [Using your own proxy](#using-your-own-proxy)
- [Stripping `/proxy/<port>` from the request path](#stripping-proxyport-from-the-request-path)
- [Proxying to create a React app](#proxying-to-create-a-react-app)
- [Proxying to a Vue app](#proxying-to-a-vue-app)
Expand Down Expand Up @@ -300,6 +301,11 @@ If you're working on web services and want to access them locally, code-server
can proxy to any port using either a subdomain or a subpath, allowing you to
securely access these services using code-server's built-in authentication.

By default, ports running on the same machine as code-server can be accessed at
{current_url}/proxy/{port}. For instance, if you have code-server running on
localhost:8080 and a Python server running on localhost:8000, you could access
it via http://localhost:8080/proxy/8000

### Using a subdomain

You will need a DNS entry that points to your server for each port you want to
Expand All @@ -316,12 +322,29 @@ To set your domain, start code-server with the `--proxy-domain` flag:
code-server --proxy-domain <domain>
```

Now you can browse to `<port>.<domain>`. Note that this uses the host header, so
For instance, if you have code-server exposed on `domain.tld` and a Python
server running on port 8080 of the same machine code-server is running on, you
could run code-server with `--proxy-domain domain.tld` and access the Python
server via `8080.domain.tld`.

Note that this uses the host header, so
ensure your reverse proxy (if you're using one) forwards that information.

### Using a subpath

Simply browse to `/proxy/<port>/`.
Simply browse to `/proxy/<port>/`. For instance, if you have code-server
exposed on `domain.tld` and a Python server running on port 8080 of the same
machine code-server is running on, you could access the Python server via
`domain.tld/proxy/8000`.

### Using your own proxy

You can make extensions and the ports panel use your own proxy by setting
`VSCODE_PROXY_URI`. For example if you set
`VSCODE_PROXY_URI=https://{{port}}.kyle.dev` when an application is detected
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

relative path like VSCODE_PROXY_URI=./proxy/{{port}} also work :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL! I'll add that. Thank you :)

running on port 3000 of the same machine code-server is running on the ports
panel will create a link to https://3000.kyle.dev instead of pointing to the
built-in subpath-based proxy.

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

Expand Down