Skip to content

Commit 363cdd0

Browse files
committed
Improve proxy documentation
1 parent a5d1d3b commit 363cdd0

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

doc/FAQ.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -65,23 +65,29 @@ 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?
68+
## How do I securely access web services?
6969

7070
code-server is capable of proxying to any port using either a subdomain or a
71-
subpath.
71+
subpath which means you can securely access these services using code-server's
72+
built-in authentication.
7273

7374
### Sub-domains
7475

75-
Set up a wildcard certificate for your domain and a wildcard DNS entry (or you
76-
can configure each subdomain individually for the ports you expect to use).
76+
You will need a DNS entry that points to your server for each port you want to
77+
access. You can either set up a wildcard DNS entry for `*.<domain>` if your domain
78+
name registrar supports it or you can create one for every port you want to
79+
access (`3000.<domain>`, `8080.<domain>`, etc).
80+
81+
You should also set up TLS certificates for these subdomains, either using a
82+
wildcard certificate for `*.<domain>` or individual certificates for each port.
7783

7884
Start code-server with the `--proxy-domain` flag set to your domain.
7985

8086
```
81-
code-server --proxy-domain coder.com
87+
code-server --proxy-domain <domain>
8288
```
8389

84-
Now you can browse to `<port>.coder.com`. Note that this uses the host header so
90+
Now you can browse to `<port>.<domain>`. Note that this uses the host header so
8591
ensure your reverse proxy forwards that information if you are using one.
8692

8793
### Sub-paths

0 commit comments

Comments
 (0)