Skip to content

Improve clarity in guide and fix typo in FAQ #1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
10 changes: 6 additions & 4 deletions doc/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down