feat: add 'absProxyBasePath' option

DanielleMaywood · DanielleMaywood · commit 5a1700c5c9f0 · 2025-04-24T09:47:06.000Z
diff --git a/src/code-server/README.md b/src/code-server/README.md
@@ -15,6 +15,7 @@ VS Code in the browser
 
 | Options Id | Description | Type | Default Value |
 |-----|-----|-----|-----|
+| absProxyBasePath | The base path to prefix to all absproxy requests | string | - |
 | appName | The name to use in branding. Will be shown in titlebar and welcome message. | 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 |
 | cert | Path to certificate. A self signed certificate is generated if none is provided. | string | - |
diff --git a/src/code-server/devcontainer-feature.json b/src/code-server/devcontainer-feature.json
@@ -4,6 +4,11 @@
     "version": "1.0.0",
     "description": "VS Code in the browser",
     "options": {
+        "absProxyBasePath": {
+            "type": "string",
+            "default": "",
+            "description": "The base path to prefix to all absproxy requests"
+        },
         "appName": {
             "type": "string",
             "default": "",
diff --git a/src/code-server/install.sh b/src/code-server/install.sh
@@ -106,6 +106,10 @@ if [[ "$PROXYDOMAIN" ]]; then
     FLAGS+=(--proxy-domain "$PROXYDOMAIN")
 fi
 
+if [[ "$ABSPROXYBASEPATH" ]]; then
+    FLAGS+=(--abs-proxy-base-path "$ABSPROXYBASEPATH")
+fi
+
 cat > /usr/local/bin/code-server-entrypoint <<EOF
 #!/usr/bin/env bash
 set -e
diff --git a/test/code-server/code-server-abs-proxy-base-path.sh b/test/code-server/code-server-abs-proxy-base-path.sh
@@ -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 locale" grep '"--abs-proxy-base-path".*"/user/123/workspace"' < /usr/local/bin/code-server-entrypoint
+
+# Report results
+reportResults
diff --git a/test/code-server/scenarios.json b/test/code-server/scenarios.json
@@ -257,5 +257,13 @@
                 "githubAuthTokenFile": "/tmp/code-server-github-auth-token"
             }
         }
+    },
+    "code-server-abs-proxy-base-path": {
+        "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
+        "features": {
+            "code-server": {
+                "absProxyBasePath": "/user/123/workspace"
+            }
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -257,5 +257,13 @@`
`257`	`257`	`"githubAuthTokenFile": "/tmp/code-server-github-auth-token"`
`258`	`258`	`}`
`259`	`259`	`}`
	`260`	`+ },`
	`261`	`+ "code-server-abs-proxy-base-path": {`
	`262`	`+ "image": "mcr.microsoft.com/devcontainers/base:ubuntu",`
	`263`	`+ "features": {`
	`264`	`+ "code-server": {`
	`265`	`+ "absProxyBasePath": "/user/123/workspace"`
	`266`	`+ }`
	`267`	`+ }`
`260`	`268`	`}`
`261`	`269`	`}`