解决code-server子域名代理端口重定向问题

在使用code-server时，通过子域名代理方式访问自定义应用时遇到了重定向问题。本文将详细分析问题原因并提供解决方案。

问题现象

用户在使用code-server的Docker容器时，配置了子域名代理功能，期望通过类似https://3000.example.com:12345/的URL访问运行在3000端口的PHP应用。然而实际访问时，系统却将请求重定向到了code-server主界面，而非预期的PHP应用。

环境配置

用户使用的是linuxserver/code-server:4.96.4镜像，主要配置如下：

1. 环境变量设置：

   • PROXY_DOMAIN=example.com
   • VSCODE_PROXY_URI=https://{{port}}.example.com:12345

2. 配置文件修改：

   • ~/.config/code-server/config.yaml中添加了proxy-domain: example.com

3. 端口映射：

   • 主端口3000映射到容器内的8443

问题分析

当用户启动PHP服务器后，code-server正确生成了代理URLhttps://3000.example.com:12345/，但访问时发生了意外的302重定向。有趣的是，通过https://example.com:12345/proxy/3000/这个替代URL仍然可以访问到PHP应用。

这表明code-server的子域名代理功能基本工作正常，但在处理包含端口的子域名时出现了路由判断错误。核心问题在于PROXY_DOMAIN环境变量的配置没有包含端口信息，导致系统无法正确匹配包含端口的请求。

解决方案

经过排查，发现只需简单修改PROXY_DOMAIN环境变量的配置即可解决问题：

将原来的：

PROXY_DOMAIN=example.com

修改为：

PROXY_DOMAIN=example.com:12345

这一修改使得code-server能够正确识别包含端口的子域名请求，从而将流量正确路由到目标应用而非code-server主界面。

技术原理

code-server的代理功能依赖于对请求Host头的匹配。当PROXY_DOMAIN不包含端口时，系统默认只匹配域名部分，忽略端口差异。添加端口信息后，系统会进行完整的Host头匹配，包括域名和端口，从而确保请求被正确路由。

最佳实践

1. 当使用非标准端口时，确保PROXY_DOMAIN包含完整的域名和端口信息
2. VSCODE_PROXY_URI中的端口应与实际访问端口一致
3. 检查config.yaml中的proxy-domain配置是否与环境变量一致
4. 对于Docker部署，确保端口映射关系正确

总结

通过这个案例可以看出，在使用code-server的代理功能时，配置细节非常重要。特别是当使用非标准端口时，必须确保所有相关配置中都包含完整的域名和端口信息，才能保证代理功能正常工作。这个小技巧可以帮助开发者避免不必要的调试时间，快速搭建基于子域名的开发环境代理。