Skip to content

A modern and elegant dashboard for network traffic visualization and analysis.

docs(.env.example): clarify WS port config and document new tuning vars

luolei82c58d43de92
diff --git a/.env.example b/.env.example
index 3e495f3..d14a944 100644
--- a/.env.example
+++ b/.env.example
@@ -21,12 +21,17 @@ WEB_EXTERNAL_PORT=3000
API_EXTERNAL_PORT=3001
# WebSocket 端口(可选)- 实时数据推送
-# 如需通过域名使用 WS,可在 Nginx 配置 /ws 代理并设置 WS_URL
+# 直连部署:设置 WS_EXTERNAL_PORT 即可,前端会在运行时读取它直连
+# ws://<页面host>:<WS_EXTERNAL_PORT>(端口需在 docker 映射中对外暴露)。
+# 反代/域名部署:在 Nginx 配置 /ws 升级代理,并设置 NEXT_PUBLIC_WS_URL,
+# 例如 NEXT_PUBLIC_WS_URL=wss://your-domain/ws (也支持以 / 开头的路径)。
WS_EXTERNAL_PORT=3002
# 说明:
# 只有当你需要“直连 API/WS”时才需要改这些外部端口。
# 一般不需要修改容器内部端口(WEB_PORT/API_PORT/COLLECTOR_WS_PORT)。
+# 注意:NEXT_PUBLIC_WS_PORT 是构建期变量,对预构建镜像在运行时无效,
+# 请使用 WS_EXTERNAL_PORT(运行时生效)或 NEXT_PUBLIC_WS_URL。
# -----------------------------------------------------------------------------
# 安全配置
@@ -55,6 +60,12 @@ WS_EXTERNAL_PORT=3002
# API_PORT=3001
# COLLECTOR_WS_PORT=3002
+# 采集器 WebSocket 心跳看门狗(检测静默断开的网关连接,见 #74)
+# WS_HEARTBEAT_INTERVAL_MS=10000 # ping + 活跃检测间隔
+# WS_HEARTBEAT_TIMEOUT_MS=30000 # 静默超过该时长则强制重连
+# 采集器重连退避上限(指数退避 + 抖动,避免重连风暴)
+# WS_MAX_RECONNECT_INTERVAL_MS=60000
+
# 数据库路径
# DB_PATH=/app/data/stats.db