SkeyeVSS国标视频平台项目安装使用说明

1. 服务资源本项目为Skeyevss Community Edition (go-vss)包含后端服务、前端管理后台、国标信令与流媒体联动能力。项目源码地址https://github.com/openskeye/go-vss试用安装包下载 | SMS | 试用安装包下载 | 在线演示1.1 代码与配置资源项目源码当前仓库根目录默认环境变量模板.env.local.default服务配置文件目录etc/Docker 编排docker-compose.yml开发生成脚本scripts/dev/1.2 主要运行组件基础依赖MySQL / Redis / etcd业务服务DB RPC / VSS / Backend API / Cron / Web Proxy媒体服务SkeyesMS独立进程2. 服务架构核心调用关系如下前端通过Web Proxy访问后端接口与静态资源。Backend API负责业务 API调用DB RPC与VSS。VSS负责 GB28181/ONVIF/RTSP 等协议处理并与SkeyesMS协同完成收流、转发与播放。Cron负责定时任务与录像计划。MySQL/Redis/etcd提供数据存储、缓存与服务发现。3. 服务说明3.1 环境准备Go 1.23.xNode.js前端开发需要Docker Docker Compose容器部署需要可选本地 MySQL / Redis / etcd非 Docker 运行3.2 关键配置文件环境变量.env.local可由.env.local.default复制VSS 配置etc/.vss.yamlDB RPC 配置etc/.db-rpc.yamlBackend API 配置etc/.backend-api.yamlWeb 代理配置etc/.web-sev.yamlCron 配置etc/.cron.yaml3.3 默认端口基于.env.local.defaultMySQL11001Redis11002etcd(Client)11003Web Proxy11004Media Server(HTTP)11005VSS(SIP)11008Cron11009DB RPC11010Backend API11011Guard11012VSS HTTP11013VSS SSE11014VSS Cascade SIP11015VSS WS110184. 服务运行4.1 Linux / macOS 本地开发运行第一步准备环境变量在项目根目录执行cp.env.local.default .env.local至少确认以下参数SKEYEVSS_INTERNAL_IPSKEYEVSS_EXTERNAL_IPSKEYEVSS_DATABASE_TYPEsqlite或mysqlSKEYEVSS_*_PORT系列端口是否冲突SKEYEVSS_VSS_SIP_ID/SKEYEVSS_VSS_SIP_DOMAIN/SKEYEVSS_VSS_SIP_PASSWORD第二步启动基础依赖若使用本地依赖先启动 MySQL / Redis / etcd。若使用 SQLite可不启动 MySQL并将SKEYEVSS_DATABASE_TYPEsqlite。第三步按顺序启动服务在项目根目录分别启动go run core/app/sev/db/main.go-env.env.local-fetc/.db-rpc.yaml go run core/app/sev/vss/main.go-env.env.local-fetc/.vss.yaml go run core/app/sev/backend/main.go-env.env.local-fetc/.backend-api.yaml go run core/app/sev/cron/main.go-env.env.local-fetc/.cron.yaml go run core/app/sev/web/main.go-env.env.local-fetc/.web-sev.yaml -web-static-dir前端构建目录SkeyesMS需单独启动按照其配置文件与运行参数启动。4.2 Windows 运行说明Windows 与 Linux/macOS 运行顺序一致建议先配置.env.local启动基础依赖MySQL/Redis/etcd 或 SQLite 模式依次启动db - vss - backend - cron - web确认防火墙放行 SIP/RTP/HTTP 相关端口4.3 Docker Compose 运行使用 Docker 方式时准备.env.prod.d或 compose 使用的 env 文件校验SKEYEVSS_SEV_VOLUMES_DIR、端口、镜像地址配置启动示例docker-compose--profilecore--profileconf up-ddocker-compose.yml中服务已定义依赖关系包含mysql/redis/etcd/skeyesms/dbrpc/vss/backendapi/cron/webproxy。5. 配置设备接入GB28181设备接入前重点确认 VSS SIP 参数来自.env.local与etc/.vss.yamlSIP HostSKEYEVSS_INTERNAL_IP或公网场景配置对应地址SIP 端口SKEYEVSS_VSS_PORT默认11008SIP IDSKEYEVSS_VSS_SIP_IDSIP 域SKEYEVSS_VSS_SIP_DOMAIN设备统一接入密码SKEYEVSS_VSS_SIP_PASSWORD是否启用密码校验SKEYEVSS_VSS_SIP_USE_PASSWORD公网部署场景可按需开启SKEYEVSS_VSS_USE_EXTERNAL_IPSKEYEVSS_VSS_SIP_USE_EXTERNAL_WANSKEYEVSS_EXTERNAL_IP6. 平台使用6.1 管理平台默认入口开发环境http://部署服务器IP:11004默认管理员账号来自.env.local.default用户名admin密码1111116.2 接口文档建议入口http://部署服务器IP:11004/apidoc通用 API 约定与请求体说明见source/doc/api/common.md6.3 视频能力项目支持设备直播、录像回放、云台控制、语音对讲等能力前端通过 Web 代理与后端交互后端通过 VSS 媒体服务完成流控制和播放链路。7. 统一编码规则为保证 GB28181 编码一致性项目约定了国标 ID 前缀变量见.env.local.default平台前缀SKEYEVSS_GEN_PLATFORM_UNIQUEID目录前缀SKEYEVSS_GEN_DIR_UNIQUEIDNVR 前缀SKEYEVSS_GEN_NVR_UNIQUEID摄像机前缀SKEYEVSS_GEN_CAMERA_UNIQUEID建议统一采用 20 位国标编码。同一部署内保持前缀唯一避免设备、通道、目录编码冲突。在多级级联场景中按组织或区域规划编码段避免跨域重复。8. 服务器硬件配置建议以下为生产环境建议按并发规模调整CPU2 核及以上内存4GB 及以上磁盘SSD录像与日志分盘更优网络公网场景建议固定公网 IP录像、高并发转发场景建议独立部署媒体服务并提升CPU 核数与网络带宽磁盘写入吞吐RTP/RTC 端口段与防火墙策略9. 常见问题排查服务启动失败先检查.env.local与etc/.xxx.yaml的变量是否可解析。DB RPC 连不上确认 etcd 已启动SKEYEVSS_ETCD_HOST/PORT正确。设备注册失败核对 SIP ID/域/密码、SIP 端口、防火墙策略。无法播放确认SkeyesMS已启动且 VSS 通知地址可访问。页面打不开确认webproxy已启动、-web-static-dir指向正确前端构建目录。