Skip to content

Commit 6409b43

Browse files
docs: update documentation
1 parent cc090bf commit 6409b43

File tree

2 files changed

+24
-21
lines changed

2 files changed

+24
-21
lines changed

src/code-server/README.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ VS Code in the browser
1515

1616
| Options Id | Description | Type | Default Value |
1717
|-----|-----|-----|-----|
18-
| version | - | string | - |
19-
| host | - | string | 127.0.0.1 |
20-
| port | - | string | 8080 |
21-
| args | - | string | - |
22-
| extensions | - | string | - |
18+
| auth | The type of authentication to use. When 'password' is selected, code-server will auto-generate a password. 'none' disables authentication entirely. | string | password |
19+
| extensions | Comma-separated list of VS Code extensions to install. Format: 'publisher.extension[@version]' (e.g., 'ms-python.python,ms-azuretools.vscode-docker'). | string | - |
20+
| host | The address to bind to for the code-server. Use '0.0.0.0' to listen on all interfaces. | string | 127.0.0.1 |
21+
| port | The port to bind to for the code-server. | string | 8080 |
22+
| version | The version of code-server to install. If empty, installs the latest version. | string | - |
23+
| workspace | Path to the workspace or folder to open on startup. Can be a directory or a .code-workspace file. | string | - |
2324

2425

2526

src/code-server/devcontainer-feature.json

+18-16
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,36 @@
44
"version": "1.0.0",
55
"description": "VS Code in the browser",
66
"options": {
7-
"version": {
7+
"auth": {
88
"type": "string",
9-
"default": ""
9+
"enum": ["password", "none"],
10+
"default": "password",
11+
"description": "The type of authentication to use. When 'password' is selected, code-server will auto-generate a password. 'none' disables authentication entirely."
1012
},
11-
"host": {
13+
"extensions": {
1214
"type": "string",
13-
"default": "127.0.0.1"
15+
"default": "",
16+
"description": "Comma-separated list of VS Code extensions to install. Format: 'publisher.extension[@version]' (e.g., 'ms-python.python,ms-azuretools.vscode-docker')."
1417
},
15-
"port": {
18+
"host": {
1619
"type": "string",
17-
"default": "8080"
20+
"default": "127.0.0.1",
21+
"description": "The address to bind to for the code-server. Use '0.0.0.0' to listen on all interfaces."
1822
},
19-
"args": {
23+
"port": {
2024
"type": "string",
21-
"default": ""
25+
"default": "8080",
26+
"description": "The port to bind to for the code-server."
2227
},
23-
"extensions": {
28+
"version": {
2429
"type": "string",
25-
"default": ""
30+
"default": "",
31+
"description": "The version of code-server to install. If empty, installs the latest version."
2632
},
2733
"workspace": {
28-
"type": "string",
29-
"default": ""
30-
},
31-
"auth": {
3234
"type": "string",
33-
"enum": ["password", "none"],
34-
"default": "password"
35+
"default": "",
36+
"description": "Path to the workspace or folder to open on startup. Can be a directory or a .code-workspace file."
3537
}
3638
},
3739
"entrypoint": "/usr/local/bin/code-server-entrypoint",

0 commit comments

Comments
 (0)