Etherpad-Lite 2.x版本在Nginx反向代理下的WebSocket连接问题解析

问题背景

近期有用户报告在Etherpad-Lite 2.1.0版本中，当部署在Nginx反向代理后方时，出现了WebSocket连接失败的问题。具体表现为浏览器控制台出现400错误，主要影响/socket.io路径的wss连接。该问题在从1.x版本升级到2.x版本的环境中尤为常见。

技术分析

WebSocket是现代实时协作应用的核心技术，Etherpad-Lite依赖它来实现多用户实时编辑。在反向代理环境下，WebSocket连接需要特殊的代理配置才能正常工作。

在Nginx配置中，关键需要处理以下几点：

1. HTTP协议升级头(Upgrade header)
2. 连接类型转换(Connection header)
3. 代理缓冲设置
4. 路径重写规则

典型配置问题

许多用户在升级到2.x版本后遇到了配置兼容性问题，主要表现在：

1. 路径重写规则不完善，特别是当Etherpad部署在子路径(如/pad/)时
2. WebSocket特定的头信息传递不完整
3. 代理缓冲未正确关闭
4. 协议版本指定不明确

解决方案

对于Nginx反向代理配置，推荐以下最佳实践：

1. 明确区分普通HTTP请求和WebSocket请求的处理

2. 确保完整的头信息传递：

   proxy_set_header Upgrade $http_upgrade;
   proxy_set_header Connection "upgrade";
   proxy_set_header Host $host;
   proxy_set_header X-Real-IP $remote_addr;
   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
   proxy_set_header X-Forwarded-Proto $scheme;
   

3. 对于子路径部署的情况，需要额外的重写规则：

   location ^~ /pad/ {
       rewrite /pad/(.*) /$1 break;
       proxy_pass http://backend;
   }
   

4. 强制关闭代理缓冲：

   proxy_buffering off;
   

版本兼容性说明

Etherpad-Lite 2.1.1版本已针对WebSocket连接问题进行了多项修复，特别是：

1. 改进了socket.io的兼容性处理
2. 优化了反向代理环境下的连接建立过程
3. 增强了错误处理机制

建议所有从1.x版本升级的用户直接采用2.1.1或更高版本，可以避免大多数反向代理环境下的连接问题。

配置验证建议

部署后可通过以下方式验证配置是否正确：

1. 检查浏览器开发者工具中的WebSocket连接状态
2. 查看Nginx错误日志中的相关条目
3. 使用curl测试协议升级过程
4. 验证各子路径的访问情况

总结

Etherpad-Lite作为实时协作工具，对WebSocket连接的稳定性要求极高。在反向代理环境下，正确的Nginx配置是保证服务正常工作的关键。随着2.x版本的发布，虽然带来了一些配置上的变化，但通过遵循上述建议，用户可以构建出稳定可靠的部署方案。