A modern and elegant dashboard for network traffic visualization and analysis.
# =============================================================================
# Neko Master 环境配置文件
# =============================================================================
# 使用方法:
# 1. 复制本文件为 .env: cp .env.example .env
# 2. 修改下方的端口号(如果默认端口被占用)
# 3. 启动服务: docker compose up -d
# =============================================================================
# -----------------------------------------------------------------------------
# 端口配置(一般只需要改这里)
# -----------------------------------------------------------------------------
# 如果启动时提示 "端口已被占用",请修改以下三个端口为其他值
# 例如:改为 8080, 8081, 8082
# Web UI 访问端口 - 浏览器访问的地址 http://localhost:WEB_EXTERNAL_PORT
WEB_EXTERNAL_PORT=3000
# API 端口(可选)- 仅直连/调试时需要
# 若仅通过 Nginx 反代 Web,前端会走 /api,无需对外开放 3001
API_EXTERNAL_PORT=3001
# WebSocket 端口(可选)- 实时数据推送
# 直连部署:设置 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。
# -----------------------------------------------------------------------------
# 安全配置
# -----------------------------------------------------------------------------
# Cookie 签名密钥(生产环境必填,建议 32 位以上随机字符串)
# 可使用 openssl rand -hex 32 生成
# COOKIE_SECRET=
# 跨源访问白名单(逗号分隔的 Origin 列表)
# 默认(不设置)拒绝一切跨源请求——同源部署(默认 Docker 形态,前端与 API 同源)无需设置。
# 仅当仪表盘与 collector 部署在不同源(不同域名/端口)时才需要设置,
# 例如:CORS_ORIGIN=https://dashboard.example.com,https://admin.example.com
# 设置后这些源的跨源请求将被允许携带凭证。
# CORS_ORIGIN=
# 网关 API 使用 HTTPS 且证书为自签(Surge http-api-tls、mihomo external-controller-tls)时,
# 设为 1 仅对网关请求跳过证书校验(不影响 GeoIP / ClickHouse 等其他出站请求)。
# 仅在可信局域网内使用;启用后启动时会打印警告。
# BACKEND_TLS_INSECURE=1
# -----------------------------------------------------------------------------
# IP 地理查询配置(可选)
# -----------------------------------------------------------------------------
# 可选值:online / local
# online: 使用线上接口(默认)
# local: 使用本地 MMDB 文件查询
# GEOIP_LOOKUP_PROVIDER=online
# 线上 IP 查询接口地址(仅支持与默认 ipinfo.my 响应结构兼容的服务)
# 非兼容接口可能导致查询失败或字段为空
# GEOIP_ONLINE_API_URL=https://api.ipinfo.es/ipinfo
# -----------------------------------------------------------------------------
# 高级配置(一般不需要修改)
# -----------------------------------------------------------------------------
# 内部端口(容器内使用,除非你知道自己在做什么,否则不要改)
# WEB_PORT=3000
# API_PORT=3001
# COLLECTOR_WS_PORT=3002
# 采集器日志级别:error / warn / info / debug(大小写不敏感,默认 info)
# console.error 始终输出,不受日志级别影响
# LOG_LEVEL=info
# Agent 判定离线的心跳超时,后端列表/健康检查/手动测试共用(毫秒,最小 15000;默认 30 秒心跳 × 3,容忍上报延迟)
# 设置在采集器进程的环境中
# AGENT_HEARTBEAT_TIMEOUT_MS=90000
# 采集器 WebSocket 心跳看门狗(检测静默断开的网关连接,见 #74)
# WS_HEARTBEAT_INTERVAL_MS=10000 # ping + 活跃检测间隔
# WS_HEARTBEAT_TIMEOUT_MS=30000 # 静默超过该时长则强制重连
# 采集器重连退避上限(指数退避 + 抖动,避免重连风暴)
# WS_MAX_RECONNECT_INTERVAL_MS=60000
# WebSocket 推送背压阈值:出站缓冲超过该字节数的慢客户端跳过本轮推送
# WS_MAX_BUFFERED_BYTES=4194304
# 规则链路图 DAG 源数据行数上限(按流量取 Top-N)
# RULE_CHAIN_FLOW_MAX_ROWS=2000
# 数据库路径
# DB_PATH=/app/data/stats.db
# 运行环境
# NODE_ENV=production
# -----------------------------------------------------------------------------
# 演示模式配置
# -----------------------------------------------------------------------------
# 设置为 true 启用演示模式(禁止修改后端配置、认证设置和数据操作)
# 用于将在线站点转换为演示站点供公众访问
# SHOWCASE_SITE_MODE=false
# =============================================================================
# 配置完成后,请使用以下命令启动:
# docker compose up -d
#
# 然后访问: http://localhost:WEB_EXTERNAL_PORT
# 例如: http://localhost:3000
# =============================================================================