From f2c46c0e0de40f1872b39c71af7cf0586fbb005b Mon Sep 17 00:00:00 2001
From: n-i-x <440158+n-i-x@users.noreply.github.com>
Date: Tue, 19 May 2020 23:12:42 -0400
Subject: [PATCH] Add --proxy-domain documentation
---
README.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/README.md b/README.md
index 614f006..79a0827 100644
--- a/README.md
+++ b/README.md
@@ -81,6 +81,7 @@ docker create \
-e TZ=Europe/London \
-e PASSWORD=password `#optional` \
-e SUDO_PASSWORD=password `#optional` \
+ -e PROXY_DOMAIN=code-server.my.domain `#optional` \
-p 8443:8443 \
-v /path/to/appdata/config:/config \
--restart unless-stopped \
@@ -105,6 +106,7 @@ services:
- TZ=Europe/London
- PASSWORD=password #optional
- SUDO_PASSWORD=password #optional
+ - PROXY_DOMAIN=code-server.my.domain #optional
volumes:
- /path/to/appdata/config:/config
ports:
@@ -124,6 +126,7 @@ Container images are configured using parameters passed at runtime (such as thos
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London |
| `-e PASSWORD=password` | Optional web gui password, if not provided, there will be no auth. |
| `-e SUDO_PASSWORD=password` | If this optional variable is set, user will have sudo access in the code-server terminal with the specified password. |
+| `-e PROXY_DOMAIN=code-server.my.domain` | If this optional variable is set, this domain will be proxied for subdomain proxying. See [Documentation](https://github.com/cdr/code-server/blob/master/doc/FAQ.md#sub-domains) |
| `-v /config` | Contains all relevant configuration files. |
## Environment variables from files (Docker secrets)