From 8c70dfa387742a622c5ad31c915d4503cf8413b3 Mon Sep 17 00:00:00 2001 From: Ashley McClelland Date: Wed, 4 Aug 2021 20:52:57 -0700 Subject: [PATCH] docs: make --link docs separate entry link to --link docs from README to separate docs entry --- docs/README.md | 15 ++------------- docs/link.md | 9 +++++++++ docs/manifest.json | 5 +++++ 3 files changed, 16 insertions(+), 13 deletions(-) create mode 100644 docs/link.md diff --git a/docs/README.md b/docs/README.md index 05b6466d..53248f6c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -53,20 +53,9 @@ code-server. We also have an in-depth [setup and configuration](https://coder.com/docs/code-server/v3.11.0/guide) guide. -### code-server --link +## TLS and authentication (beta) -We're working on a cloud platform that makes deploying and managing code-server -easier. Consider running code-server with the beta flag `--link` if you don't -want to worry about: - -- TLS -- Authentication -- Port forwarding - -```bash -$ code-server --link -Proxying code-server, you can access your IDE at https://example.cdr.co -``` +To add TLS and authentication out of the box, use [code-server --link](https://coder.com/docs/code-server/v3.11.0/link). ## Questions? diff --git a/docs/link.md b/docs/link.md new file mode 100644 index 00000000..4675550e --- /dev/null +++ b/docs/link.md @@ -0,0 +1,9 @@ +# code-server --link + +Run code-server with the beta flag `--link` and you'll get TLS, authentication, and a dedicated URL +for accessing your IDE out of the box. + +```shell-session +$ code-server --link +Proxying code-server, you can access your IDE at https://example.cdr.co +``` diff --git a/docs/manifest.json b/docs/manifest.json index a6cf2ccc..7250fe57 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -32,6 +32,11 @@ "icon": "", "path": "./guide.md", "children": [ + { + "title": "--link", + "description": "How to run code-server --link", + "path": "./link.md" + }, { "title": "iPad", "description": "How to access your code-server installation using an iPad.",