mirror of https://github.com/coder/code-server.git
docs: make --link docs separate entry
link to --link docs from README to separate docs entry
This commit is contained in:
parent
73380379da
commit
8c70dfa387
|
@ -53,20 +53,9 @@ code-server.
|
||||||
We also have an in-depth [setup and
|
We also have an in-depth [setup and
|
||||||
configuration](https://coder.com/docs/code-server/v3.11.0/guide) guide.
|
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
|
To add TLS and authentication out of the box, use [code-server --link](https://coder.com/docs/code-server/v3.11.0/link).
|
||||||
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
|
|
||||||
```
|
|
||||||
|
|
||||||
## Questions?
|
## Questions?
|
||||||
|
|
||||||
|
|
|
@ -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
|
||||||
|
```
|
|
@ -32,6 +32,11 @@
|
||||||
"icon": "<svg viewBox=\"0 0 16 16\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4 6H2v14c0 1.1.9 2 2 2h14v-2H4V6zm16-4H8c-1.1 0-2 .9-2 2v12c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2zm0 10l-2.5-1.5L15 12V4h5v8z\"></path></svg>",
|
"icon": "<svg viewBox=\"0 0 16 16\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4 6H2v14c0 1.1.9 2 2 2h14v-2H4V6zm16-4H8c-1.1 0-2 .9-2 2v12c0 1.1.9 2 2 2h12c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2zm0 10l-2.5-1.5L15 12V4h5v8z\"></path></svg>",
|
||||||
"path": "./guide.md",
|
"path": "./guide.md",
|
||||||
"children": [
|
"children": [
|
||||||
|
{
|
||||||
|
"title": "--link",
|
||||||
|
"description": "How to run code-server --link",
|
||||||
|
"path": "./link.md"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"title": "iPad",
|
"title": "iPad",
|
||||||
"description": "How to access your code-server installation using an iPad.",
|
"description": "How to access your code-server installation using an iPad.",
|
||||||
|
|
Loading…
Reference in New Issue