Skip to content

Commit e68d72c

Browse files
committed
Add documentation for proxying
1 parent 737a8f5 commit e68d72c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

doc/FAQ.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,26 @@ only to HTTP requests.
6565
You can use [Let's Encrypt](https://letsencrypt.org/) to get an SSL certificate
6666
for free.
6767

68+
## How do I access web services?
69+
code-server is capable of proxying to any port using either a subdomain or a
70+
subpath.
71+
72+
### Sub-domains
73+
Set up a wildcard certificate for your domain and a wildcard DNS entry (or you
74+
can configure each subdomain individually for the ports you expect to use).
75+
76+
Start code-server with the `--proxy-domain` flag set to your domain.
77+
78+
```
79+
code-server --proxy-domain coder.com
80+
```
81+
82+
Now you can browse to `<port>.coder.com`. Note that this uses the host header so
83+
ensure your reverse proxy forwards that information if you are using one.
84+
85+
### Sub-paths
86+
Just browse to `/proxy/<port>`.
87+
6888
## x86 releases?
6989

7090
node has dropped support for x86 and so we decided to as well. See

0 commit comments

Comments
 (0)