From 76d903014a3248a6c9d663d49cd200a65db21da7 Mon Sep 17 00:00:00 2001 From: Thomas Bell Date: Sat, 28 Mar 2020 13:48:56 -0400 Subject: [PATCH] docs --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 36696c0..a6d14a5 100644 --- a/README.md +++ b/README.md @@ -124,11 +124,13 @@ 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 SSL_CERT=/ssl/cert_file.crt` | If this optional variable is provided in conjunction with a key file the code-server run be served via HTTPS. | +| `-e SSL_KEY=/ssl/key_file.key` | If this optional variable is provided in conjunction with a cert file the code-server run be served via HTTPS. | | `-v /config` | Contains all relevant configuration files. | ## Environment variables from files (Docker secrets) -You can set any environment variable from a file by using a special prepend `FILE__`. +You can set any environment variable from a file by using a special prepend `FILE__`. As an example: @@ -155,9 +157,9 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel   ## Application Setup -Access the webui at `http://:8443`. -For github integration, drop your ssh key in to `/config/.ssh`. -Then open a terminal from the top menu and set your github username and email via the following commands +Access the webui at `http://:8443`. +For github integration, drop your ssh key in to `/config/.ssh`. +Then open a terminal from the top menu and set your github username and email via the following commands ``` git config --global user.name "username" git config --global user.email "email address"