Skip to content

docs: update documentation #4

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
Apr 11, 2025
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
11 changes: 6 additions & 5 deletions src/code-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@ VS Code in the browser

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| version | - | string | - |
| host | - | string | 127.0.0.1 |
| port | - | string | 8080 |
| args | - | string | - |
| extensions | - | string | - |
| auth | The type of authentication to use. When 'password' is selected, code-server will auto-generate a password. 'none' disables authentication entirely. | string | password |
| extensions | Comma-separated list of VS Code extensions to install. Format: 'publisher.extension[@version]' (e.g., 'ms-python.python,ms-azuretools.vscode-docker'). | string | - |
| 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 |
| port | The port to bind to for the code-server. | string | 8080 |
| version | The version of code-server to install. If empty, installs the latest version. | string | - |
| workspace | Path to the workspace or folder to open on startup. Can be a directory or a .code-workspace file. | string | - |



Expand Down
34 changes: 18 additions & 16 deletions src/code-server/devcontainer-feature.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,36 @@
"version": "1.0.0",
"description": "VS Code in the browser",
"options": {
"version": {
"auth": {
"type": "string",
"default": ""
"enum": ["password", "none"],
"default": "password",
"description": "The type of authentication to use. When 'password' is selected, code-server will auto-generate a password. 'none' disables authentication entirely."
},
"host": {
"extensions": {
"type": "string",
"default": "127.0.0.1"
"default": "",
"description": "Comma-separated list of VS Code extensions to install. Format: 'publisher.extension[@version]' (e.g., 'ms-python.python,ms-azuretools.vscode-docker')."
},
"port": {
"host": {
"type": "string",
"default": "8080"
"default": "127.0.0.1",
"description": "The address to bind to for the code-server. Use '0.0.0.0' to listen on all interfaces."
},
"args": {
"port": {
"type": "string",
"default": ""
"default": "8080",
"description": "The port to bind to for the code-server."
},
"extensions": {
"version": {
"type": "string",
"default": ""
"default": "",
"description": "The version of code-server to install. If empty, installs the latest version."
},
"workspace": {
"type": "string",
"default": ""
},
"auth": {
"type": "string",
"enum": ["password", "none"],
"default": "password"
"default": "",
"description": "Path to the workspace or folder to open on startup. Can be a directory or a .code-workspace file."
}
},
"entrypoint": "/usr/local/bin/code-server-entrypoint",
Expand Down