Skip to content

feat: add --disable-* options #5

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.

Sign up for GitHub

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 5 commits into from
Apr 14, 2025
Merged

feat: add --disable-* options #5

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6067463
feat: add all disable options
DanielleMaywood Apr 10, 2025
267eeeb
chore: remove ai fluff comment
DanielleMaywood Apr 14, 2025
f33c545
chore: capitalize GitHub
DanielleMaywood Apr 14, 2025
0eda689
chore: use array instead of string
DanielleMaywood Apr 14, 2025
360e865
chore: slight rewrite on install script and tests
DanielleMaywood Apr 14, 2025
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
7 changes: 7 additions & 0 deletions src/code-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ VS Code in the browser
| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| auth | The type of authentication to use. When 'password' is selected, code-server will auto-generate a password. 'none' disables authentication entirely. | string | password |
| disableFileDownloads | Disable file downloads from Code. When enabled, users will not be able to download files from the editor. | boolean | false |
| disableFileUploads | Disable file uploads to Code. When enabled, users will not be able to upload files to the editor. | boolean | false |
| disableGettingStartedOverride | Disable the coder/coder override in the Help: Getting Started page. | boolean | false |
| disableProxy | Disable domain and path proxy routes. | boolean | false |
| disableTelemetry | Disable telemetry reporting. | boolean | false |
| disableUpdateCheck | Disable update check. Without this flag, code-server checks every 6 hours against the latest github release and notifies once a week when updates are available. | boolean | false |
| disableWorkspaceTrust | Disable Workspace Trust feature. This only affects the current session. | boolean | false |
| 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 |
Expand Down
35 changes: 35 additions & 0 deletions src/code-server/devcontainer-feature.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,41 @@
"default": "password",
"description": "The type of authentication to use. When 'password' is selected, code-server will auto-generate a password. 'none' disables authentication entirely."
},
"disableFileDownloads": {
"type": "boolean",
"default": false,
"description": "Disable file downloads from Code. When enabled, users will not be able to download files from the editor."
},
"disableFileUploads": {
"type": "boolean",
"default": false,
"description": "Disable file uploads to Code. When enabled, users will not be able to upload files to the editor."
},
"disableGettingStartedOverride": {
"type": "boolean",
"default": false,
"description": "Disable the coder/coder override in the Help: Getting Started page."
},
"disableProxy": {
"type": "boolean",
"default": false,
"description": "Disable domain and path proxy routes."
},
"disableTelemetry": {
"type": "boolean",
"default": false,
"description": "Disable telemetry reporting."
},
"disableUpdateCheck": {
"type": "boolean",
"default": false,
"description": "Disable update check. Without this flag, code-server checks every 6 hours against the latest github release and notifies once a week when updates are available."
},
"disableWorkspaceTrust": {
"type": "boolean",
"default": false,
"description": "Disable Workspace Trust feature. This only affects the current session."
},
"extensions": {
"type": "string",
"default": "",
Expand Down
32 changes: 31 additions & 1 deletion src/code-server/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,42 @@ if [[ -n $WORKSPACE ]]; then
CODE_SERVER_WORKSPACE="$WORKSPACE"
fi

DISABLE_FLAGS=""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions: using arrays would be slightly cleaner.

args=()
args+=(--disable-file-downloads)
args+=(--disable-file-uploads)

# ...

cmd "${args[*]}"

(Note the use of * vs @ due to how we're creating the entry point, so this does not make it shell-safe when there are spaces in any inputs.)

Copy link
Member

@mafredri mafredri Apr 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, a way to make it shell safe would be:

cat > /usr/local/bin/code-server-entrypoint <<EOF
$(declare -p args)
cmd "\${args[@]}"
EOF

😄

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we do that second approach do we lose the ability to test the entrypoint for containing certain flags?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both approaches I outlined should be fine for the test. But in the latter you can't test coder-server.*--flag, but you can test "--flag" individually.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I understand the second approach more now, I'm happy to do that one 👍


if [[ "$DISABLEFILEDOWNLOADS" == "true" ]]; then
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haha, couldn't they have _'d these? 😅

DISABLE_FLAGS="$DISABLE_FLAGS --disable-file-downloads"
fi

if [[ "$DISABLEFILEUPLOADS" == "true" ]]; then
DISABLE_FLAGS="$DISABLE_FLAGS --disable-file-uploads"
fi

if [[ "$DISABLEGETTINGSTARTEDOVERRIDE" == "true" ]]; then
DISABLE_FLAGS="$DISABLE_FLAGS --disable-getting-started-override"
fi

if [[ "$DISABLEPROXY" == "true" ]]; then
DISABLE_FLAGS="$DISABLE_FLAGS --disable-proxy"
fi

if [[ "$DISABLETELEMETRY" == "true" ]]; then
DISABLE_FLAGS="$DISABLE_FLAGS --disable-telemetry"
fi

if [[ "$DISABLEUPDATECHECK" == "true" ]]; then
DISABLE_FLAGS="$DISABLE_FLAGS --disable-update-check"
fi

if [[ "$DISABLEWORKSPACETRUST" == "true" ]]; then
DISABLE_FLAGS="$DISABLE_FLAGS --disable-workspace-trust"
fi

cat > /usr/local/bin/code-server-entrypoint \
<< EOF
#!/usr/bin/env bash
set -e

su $_REMOTE_USER -c 'code-server --auth "$AUTH" --bind-addr "$HOST:$PORT" "$CODE_SERVER_WORKSPACE"'
su $_REMOTE_USER -c 'code-server --auth "$AUTH" --bind-addr "$HOST:$PORT" $DISABLE_FLAGS "$CODE_SERVER_WORKSPACE"'
EOF

chmod +x /usr/local/bin/code-server-entrypoint
15 changes: 15 additions & 0 deletions test/code-server/code-server-disable-file-downloads.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash
set -e

# Optional: Import test library bundled with the devcontainer CLI
source dev-container-features-test-lib

# Feature-specific tests
check "code-server version" code-server --version
check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
check "code-server listening" lsof -i "@127.0.0.1:8080"

check "code-server disable-file-downloads" grep $'\'code-server.* --disable-file-downloads .*' < /usr/local/bin/code-server-entrypoint

# Report results
reportResults
15 changes: 15 additions & 0 deletions test/code-server/code-server-disable-file-uploads.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash
set -e

# Optional: Import test library bundled with the devcontainer CLI
source dev-container-features-test-lib

# Feature-specific tests
check "code-server version" code-server --version
check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
check "code-server listening" lsof -i "@127.0.0.1:8080"

check "code-server disable-file-uploads" grep $'\'code-server.* --disable-file-uploads .*' < /usr/local/bin/code-server-entrypoint

# Report results
reportResults
15 changes: 15 additions & 0 deletions test/code-server/code-server-disable-getting-started-override.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash
set -e

# Optional: Import test library bundled with the devcontainer CLI
source dev-container-features-test-lib

# Feature-specific tests
check "code-server version" code-server --version
check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
check "code-server listening" lsof -i "@127.0.0.1:8080"

check "code-server disable-getting-started-override" grep $'\'code-server.* --disable-getting-started-override .*' < /usr/local/bin/code-server-entrypoint

# Report results
reportResults
22 changes: 22 additions & 0 deletions test/code-server/code-server-disable-multiple-options.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/bin/bash
set -e

# Optional: Import test library bundled with the devcontainer CLI
source dev-container-features-test-lib

# Feature-specific tests
check "code-server version" code-server --version
check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
check "code-server listening" lsof -i "@127.0.0.1:8080"

# Check for all three flags we enabled in this scenario
check "code-server disable-file-downloads" grep $'\'code-server.* --disable-file-downloads .*' < /usr/local/bin/code-server-entrypoint
check "code-server disable-file-uploads" grep $'\'code-server.* --disable-file-uploads .*' < /usr/local/bin/code-server-entrypoint
check "code-server disable-getting-started-override" grep $'\'code-server.* --disable-getting-started-override .*' < /usr/local/bin/code-server-entrypoint
check "code-server disable-proxy" grep $'\'code-server.* --disable-proxy .*' < /usr/local/bin/code-server-entrypoint
check "code-server disable-telemetry" grep $'\'code-server.* --disable-telemetry .*' < /usr/local/bin/code-server-entrypoint
check "code-server disable-update-check" grep $'\'code-server.* --disable-update-check .*' < /usr/local/bin/code-server-entrypoint
check "code-server disable-workspace-trust" grep $'\'code-server.* --disable-workspace-trust .*' < /usr/local/bin/code-server-entrypoint

# Report results
reportResults
15 changes: 15 additions & 0 deletions test/code-server/code-server-disable-proxy.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash
set -e

# Optional: Import test library bundled with the devcontainer CLI
source dev-container-features-test-lib

# Feature-specific tests
check "code-server version" code-server --version
check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
check "code-server listening" lsof -i "@127.0.0.1:8080"

check "code-server disable-proxy" grep $'\'code-server.* --disable-proxy .*' < /usr/local/bin/code-server-entrypoint

# Report results
reportResults
15 changes: 15 additions & 0 deletions test/code-server/code-server-disable-telemetry.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash
set -e

# Optional: Import test library bundled with the devcontainer CLI
source dev-container-features-test-lib

# Feature-specific tests
check "code-server version" code-server --version
check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
check "code-server listening" lsof -i "@127.0.0.1:8080"

check "code-server disable-telemetry" grep $'\'code-server.* --disable-telemetry .*' < /usr/local/bin/code-server-entrypoint

# Report results
reportResults
15 changes: 15 additions & 0 deletions test/code-server/code-server-disable-update-check.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash
set -e

# Optional: Import test library bundled with the devcontainer CLI
source dev-container-features-test-lib

# Feature-specific tests
check "code-server version" code-server --version
check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
check "code-server listening" lsof -i "@127.0.0.1:8080"

check "code-server disable-update-check" grep $'\'code-server.* --disable-update-check .*' < /usr/local/bin/code-server-entrypoint

# Report results
reportResults
15 changes: 15 additions & 0 deletions test/code-server/code-server-disable-workspace-trust.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash
set -e

# Optional: Import test library bundled with the devcontainer CLI
source dev-container-features-test-lib

# Feature-specific tests
check "code-server version" code-server --version
check "code-server running" pgrep -f 'code-server/lib/node.*/code-server'
check "code-server listening" lsof -i "@127.0.0.1:8080"

check "code-server disable-workspace-trust" grep $'\'code-server.* --disable-workspace-trust .*' < /usr/local/bin/code-server-entrypoint

# Report results
reportResults
70 changes: 70 additions & 0 deletions test/code-server/scenarios.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,75 @@
"auth": "password"
}
}
},
"code-server-disable-file-downloads": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"code-server": {
"disableFileDownloads": true
}
}
},
"code-server-disable-file-uploads": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"code-server": {
"disableFileUploads": true
}
}
},
"code-server-disable-getting-started-override": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"code-server": {
"disableGettingStartedOverride": true
}
}
},
"code-server-disable-proxy": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"code-server": {
"disableProxy": true
}
}
},
"code-server-disable-telemetry": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"code-server": {
"disableTelemetry": true
}
}
},
"code-server-disable-update-check": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"code-server": {
"disableUpdateCheck": true
}
}
},
"code-server-disable-workspace-trust": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"code-server": {
"disableWorkspaceTrust": true
}
}
},
"code-server-disable-multiple-options": {
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"code-server": {
"disableFileDownloads": true,
"disableFileUploads": true,
"disableGettingStartedOverride": true,
"disableProxy": true,
"disableTelemetry": true,
"disableUpdateCheck": true,
"disableWorkspaceTrust": true
}
}
}
}