From e68d72c4d6dbee4d1c72a928a5051bbd24099b7e Mon Sep 17 00:00:00 2001 From: Asher Date: Mon, 30 Mar 2020 18:59:29 -0500 Subject: [PATCH] Add documentation for proxying --- doc/FAQ.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/FAQ.md b/doc/FAQ.md index 0fd08732..8dbd12f0 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -65,6 +65,26 @@ only to HTTP requests. You can use [Let's Encrypt](https://letsencrypt.org/) to get an SSL certificate for free. +## How do I access web services? +code-server is capable of proxying to any port using either a subdomain or a +subpath. + +### Sub-domains +Set up a wildcard certificate for your domain and a wildcard DNS entry (or you +can configure each subdomain individually for the ports you expect to use). + +Start code-server with the `--proxy-domain` flag set to your domain. + +``` +code-server --proxy-domain coder.com +``` + +Now you can browse to `.coder.com`. Note that this uses the host header so +ensure your reverse proxy forwards that information if you are using one. + +### Sub-paths +Just browse to `/proxy/`. + ## x86 releases? node has dropped support for x86 and so we decided to as well. See -- GitLab