From 25ea76ebc9aa4161bc4742233a9762033b662406 Mon Sep 17 00:00:00 2001 From: Anmol Sethi Date: Tue, 19 May 2020 13:46:19 -0400 Subject: [PATCH] Improve clarity in guide and fix typo in FAQ --- doc/FAQ.md | 2 +- doc/guide.md | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/FAQ.md b/doc/FAQ.md index d56b4138..f9988509 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -108,7 +108,7 @@ only to HTTP requests. You can use [Let's Encrypt](https://letsencrypt.org/) to get an SSL certificate for free. -Again, Please follow [./guide.md](./guide.md) for our recommendations on setting up and using code-server. +Again, please follow [./guide.md](./guide.md) for our recommendations on setting up and using code-server. ## How do I securely access web services? diff --git a/doc/guide.md b/doc/guide.md index 8cc05e0c..ef1d6e0b 100644 --- a/doc/guide.md +++ b/doc/guide.md @@ -94,11 +94,13 @@ systemctl --user enable --now code-server **Never**, **ever** expose `code-server` directly to the internet without some form of authentication and encryption as someone can completely takeover your machine with the terminal. -There are several approaches to securely operating and exposing code-server. - By default, code-server will enable password authentication which will -require you to copy the password from the code-server config file to login. You -can also set a custom password with `$PASSWORD`. +require you to copy the password from the code-server config file to login. Since it +cannot use TLS by default, it will listen on `localhost` to avoid exposing itself +to the world. This is fine for testing but will not work if you want to access `code-server` +from a different machine. + +There are several approaches to securely operating and exposing code-server. **tip**: You can list the full set of code-server options with `code-server --help`