Etherpad-Lite升级至2.2.x版本时的WebSocket连接问题解决方案

在将Etherpad-Lite从2.0.3版本升级到2.2.x系列版本时，许多用户可能会遇到无法加载已有文档的问题。这个问题主要表现为客户端连接超时错误，核心原因是新版Etherpad对WebSocket通信机制的依赖增强，而传统的网络配置可能无法正确处理WebSocket连接。

问题现象

升级后访问文档时，浏览器控制台会出现"Reconnect timed out"错误，同时服务器日志显示WebSocket连接失败。典型错误包括：

• 客户端显示"Error: Reconnect timed out"
• 网络服务器(如Squid)返回400错误状态码
• 文档内容无法加载，仅显示错误提示页面

根本原因分析

Etherpad-Lite 2.2.x版本强化了实时协作功能，对WebSocket连接的稳定性要求更高。与旧版相比，新版在以下方面有显著变化：

1. 更严格的WebSocket握手协议
2. 增加了连接超时检测机制
3. 优化了数据同步流程

这些改进需要网络服务器正确支持WebSocket协议升级(Upgrade)和连接保持机制。

解决方案

1. Apache网络配置优化

对于使用Apache作为前端网络的用户，需要确保配置中包含WebSocket支持：

ProxyPreserveHost On
ProxyPass / http://127.0.0.1:9001/
ProxyPassReverse / http://127.0.0.1:9001/

# WebSocket支持配置
RewriteEngine On
RewriteCond %{HTTP:Upgrade} websocket [NC]
RewriteCond %{HTTP:Connection} upgrade [NC]
RewriteRule ^/?(.*) ws://127.0.0.1:9001/$1 [P,L]

关键配置说明：

• RewriteCond检测WebSocket升级头
• RewriteRule将HTTP连接升级为WebSocket(ws://)
• [P,L]标志表示网络处理并停止后续重写规则

2. 移除中间缓存层

如果部署架构中包含Squid等缓存网络，建议：

1. 暂时移除以验证是否为问题根源
2. 或确保Squid配置支持WebSocket协议
3. 检查缓存规则不会干扰实时数据流

3. 完整升级检查清单

为确保顺利升级，建议按以下步骤操作：

1. 备份现有数据和配置
2. 完全停止旧版服务
3. 安装新版依赖(pnpm install)
4. 测试直接访问(不通过网络)
5. 逐步添加网络层并验证
6. 监控网络连接状态

技术原理深入

WebSocket在Etherpad中的作用：

• 实现客户端与服务端的全双工通信
• 减少轮询带来的延迟和资源消耗
• 支持更高效的协同编辑操作

HTTP与WebSocket协议转换过程：

1. 客户端发起HTTP请求包含Upgrade头
2. 服务端响应101 Switching Protocols
3. 连接协议从HTTP升级为WebSocket
4. 保持持久连接进行实时数据传输

最佳实践建议

1. 生产环境建议：

   • 使用Nginx替代Apache，其对WebSocket支持更成熟
   • 配置独立的WebSocket连接健康检查
   • 实现连接失败自动恢复机制

2. 性能优化方向：

   • 调整WebSocket超时参数
   • 启用压缩减少数据传输量
   • 合理配置负载均衡策略

3. 安全注意事项：

   • 启用WSS(WebSocket Secure)加密
   • 配置合理的连接数限制
   • 实现Origin验证防止跨站劫持

通过以上配置和优化，可以确保Etherpad-Lite 2.2.x版本充分发挥其增强的实时协作能力，为用户提供更稳定流畅的文档编辑体验。