添加文档

doc/_content/ability/auto_play.md

@@ -0,0 +1,2 @@
+<!-- 自动点播 -->
+# 自动点播

doc/_content/ability/cascade.md

@@ -0,0 +1,34 @@
+<!-- 国标级联的使用 -->
+# 国标级联的使用
+国标28181不同平台之间支持两种连接方式，平级和上下级，WVP目前支持向上级级联。
+## 1 接入平台
+### 1.1 wvp-pro
+#### 1.1.1 wvp-pro管理页面点击添加
+   ![cascade1](_media/cascade1.png)
+#### 1.1.2 填入wvp-pro上级平台信息
+   ![cascade1](_media/img_4.png)
+   ![cascade1](_media/img_5.png)
+#### 1.1.3 编辑wvp-pro上级设备信息，开启订阅
+   ![cascade1](_media/img_6.png)
+### 1.2 大华平台
+### 1.3 海康平台
+### 1.4 liveGBS
+#### 1.4.1. wvp-pro管理页面点击添加  
+   ![添加](_media/cascade1.png)
+#### 1.4.2. 填入liveGBS平台信息  
+   ![填入liveGBS平台信息1](_media/cascade2.png)
+   ![填入liveGBS平台信息2](_media/cascade3.png)
+#### 1.4.3. 编辑liveGBS设备信息，开启目录订阅  
+   ![cascade1](_media/cascade4.png)  
+#### 1.4.4. 编辑liveGBS设备信息，开启GPS订阅  
+   ![cascade1](_media/img_7.png)
+
+## 2 添加目录与通道
+1. 级联平台添加目录信息  
+   ![cascade1](_media/img_1.png)
+2. 为目录添加通道  
+   ![cascade1](_media/img_2.png)
+3. 设置默认流目录   
+如果需要后续自动生成的流信息都在某一个节点下，可以在对应节点右键设置为默认  
+   ![cascade1](_media/img_3.png)
+

doc/_content/ability/cascade2.md

@@ -0,0 +1,18 @@
+<!-- 国标级联的使用 -->
+# 国标级联的使用
+国标28181不同平台之间支持两种连接方式，平级和上下级，WVP目前支持向上级级联。
+## 添加上级平台
+在国标级联页面点击“添加”按钮，以推送到上级WVP为例子，参看[接入设备](./_content/ability/device.md)
+![cascade17](_media/img_17.png)
+点击保存可以在上级的国标通道列表看到新增加的设备；
+国标级联列表出现了级联的这个平台；同时状态显示为在线，如果状态为离线那么可能是你的服务信息配置有误或者网络不通。
+订阅信息列有三个图标，表示上级开启订阅，从左到右依次是：报警订阅，目录订阅，移动位置订阅。
+## 推送通道
+点击你要推送的平台的“选择通道”按钮。
+![cascade18](_media/img_18.png)
+- **页面结构**
+  - 左侧为目录结构  
+  选择未分配，则右侧显示待分配的通道，可以点击“添加按钮”，在弹窗中选择要放置的位置，保存后即可添加通道成功
+  选择其他的目录可以看到已经分配在这个目录下的通道，可以对其进行删除后重新在未分配中去分配。
+  - 右侧为数据展示以及操作  
+  国标通道栏内为来自其他国标设备/平台的通道；直播流通道为来自推流/拉流代理的通道。

doc/_content/ability/cloud_record.md

@@ -0,0 +1,8 @@
+<!-- 云端录像 -->
+# 云端录像
+云端录像是对录制在zlm服务下的录像文件的管理，录像的文件路径默认在ZLM/www/record下，使用云端录像功能必须部署wvp-pro-assist，主要通过调用wvp-pro-assist的接口完成各种功能。
+如果你需要24小时的录像，目前有一个这种方案，可以参考[7*24不间断录像](./_content/ability/continuous_recording.md)。
+1. 云段录像支持录像文件的查看，播放（可能因为编码的原因导致无法播放）；
+2. 支持录像的下载；
+3. 支持录像的合并下载；
+功能没有太多特殊的地方就不一一介绍了，大家自行体验吧。

doc/_content/ability/continuous_recording.md

@@ -0,0 +1,14 @@
+<!-- 7*24不间断录像 -->
+# 7*24不间断录像
+
+目前如果要实现不间断录像如果只是关闭无人观看停止推流是不够的，设备可能经历断网，重启，都会导致录像的中断，目前给大家提供一种可用的临时方案。   
+
+**原理：** wvp支持使用流地址自动点播，即你拿到一个流地址直接去播放，即使设备处于未点播状态，wvp会自动帮你点播；ZLM
+的拉流代理成功后会无限重试，只要流一恢复就可以拉起来，基于这两个原理。  
+**方案如下：**
+1. wvp的配置中user-settings->auto-apply-play设置为团true,开启自动点播；
+2. 点击你要录像的通道，点击播放页面左下角的“更多地址”，点击rtsp，此时复制了rtsp地址到剪贴板；
+3. 在拉流代理中添加一路流，地址填写你复制的地址，启用成功即可。  
+**前提：** 
+1. wvp使用多端口收流，不然你无法得到一个固定的流地址，也就无法实现自动点播。
+

doc/_content/ability/device.md

@@ -0,0 +1,36 @@
+<!-- 接入设备 -->
+# 接入设备
+设备接入主要是需要在设备上配置28181上级也就是WVP-PRO的信息，只有信息一致的情况才可以注册成功。设备注册成功后打开WVP->国标设备,可以看到新增加的设备；[设备使用](./_content/ability/device_use.md)，  
+主要有以下字段需要配置：  
+
+- sip->ip  
+本机IP，不要使用127.0.0.1/0.0.0.0, 除非你对项目及其熟悉    
+
+- sip->port  
+28181服务监听的端口  
+
+- sip->domain  
+domain宜采用ID统一编码的前十位编码。  
+
+- sip->id  
+28181服务ID
+
+- sip->password  
+28181服务密码    
+
+- 配置信息在如下位置  
+
+![_media/img_16.png](_media/img_16.png)
+***
+## 大华摄像头
+![_media/img_10.png](_media/img_10.png)
+## 大华NVR
+![_media/img_11.png](_media/img_11.png)
+## 艾科威视摄像头
+![_media/img_15.png](_media/img_15.png)
+## 水星摄像头
+![_media/img_12.png](_media/img_12.png)
+## 海康摄像头
+![_media/img_9.png](_media/img_9.png)
+
+[设备使用](_content/ability/device_use.md)

doc/_content/ability/device_use.md

@@ -0,0 +1,35 @@
+<!-- 设备使用 -->
+# 设备使用  
+### 更新设备通道  
+  点击列表末尾的“刷新”按钮，可以看到一个圆形进度条，等进度结束提示成功后即可更新完成，如果通道数量有变化你可以看点击左上角的![刷新](_media/img_14.png)即可看到通道数量的变化；如果通道数量仍未0,那么可能时对方尚未推送通道给你。
+### 查看设备通道  
+  点击列表末尾的“通道”按钮，
+### 查看设备定位  
+  点击列表末尾的“定位”按钮，即可跳转到地图页面看到设备的位置
+### 编辑设备在WVP中一些功能
+点击列表末尾的“编辑”按钮，即可在打开的弹窗中对设备功能进行修改
+- 设备名称  
+  如何未能从设备里读取到设备名称或者需要自己重命名，那么可以修改此选项。
+- 字符集  
+  修改读取设备数据时使用的字符集，默认为GB2312,但是GB2312收录的汉字不全，所以有时候回遇到乱码，可以修改为UTF-8来解决。
+- 地理坐标系  
+  展示此设备定位信息时使用的设用什么坐标系来解析经纬度，一般不用修改，如果遇到定位不准，可以修改尝试修改此选项解决。 
+- 目录结构  
+  展示设备的通道信息时，使用设备作为树形结构的依据，国标28181定义了两种树形结构，详情查看[国标28181的树形结构](./_content/theory/channel_tree.md)；
+- 目录订阅  
+  填写订阅周期即可对设备开启目录订阅，设备如果支持目录订阅那么设备在通道信息发生变化时就会通知WVP哪些通道发生了那些变化，包括通道增加/删除/更新/上线/下线/视频丢失/故障。0为取消订阅。
+  一般NVR和平台对接可以开启此选项，直接接摄像机开启此选项意义不大。
+- 移动位置订阅  
+  对设备开启移动位置订阅，设备如果支持目录订阅那么设备位置发生变化时会通知到WVP,一般执法记录仪可以开启此选项，对固定位置的设备意义不大。
+- SSRC校验  
+  为了解决部分设备出现的串流问题，可以打开此选项。ZLM会严格按照给定的ssrc处理视频流。部分设备流信息不标准，开启可能导致无法点播。
+### 删除设备  
+  可以删除WVP中的设备信息，如果设备28181配置未更改，那么设备在下一次注册后仍然会注册上来。
+### 点播视频  
+  进入通道列表后，点击列表末尾的“播放”按钮，稍等即可弹出播放页面
+### 设备录像  
+  进入通道列表后，点击列表末尾的“设备录像”按钮，也可以在播放页面点击录像查询进入录像查看页面，选择要查看的日期即可对录像进行播放和下载。
+### 云台控制  
+  可以对支持云台功能的设备进行上下左右的转动以及拉近拉远的操作。
+### 获取视频的播放器地址  
+  视频点播成功后在实时视频页面，点击“更多地址”可以看到所有的播放地址，地址是否可以播放与你是否完整编译启用zlm功能有关，更与网络有关。

doc/_content/ability/gis.md

@@ -0,0 +1,37 @@
+<!-- 电子地图 -->
+# 电子地图
+WVP提供了简单的电子地图用于设备的定位以及移动设备的轨迹信息，电子地图基于开源的地图引擎openlayers开发。
+### 查看设备定位
+1. 可以在设备列表点击“定位”按钮,自动跳转到电子地图页面； 
+2. 在电子地图页面在设备上右键点击“定位”获取设备/平台下的所有通道位置。
+3. 单击通道信息可以定位到具体的通道 
+
+
+### 查询设备轨迹
+查询轨迹需要提前配置save-position-history选项开启轨迹信息的保存，目前WVP此处未支持分库分表，对于大数据量的轨迹信息无法胜任，有需求请自行二次开发或者定制开发。
+在电子地图页面在设备上右键点击“查询轨迹”获取设备轨迹信息。
+
+PS： 目前的底图仅用用作演示和学习，商用情况请自行购买授权使用。
+
+### 更换底图以及底图配置
+目前WVP支持使用了更换底图，配置文件在web_src/static/js/mapConfig.js，请修改后重新编译前端文件。
+```javascript
+window.mapParam = {
+  // 开启/关闭地图功能
+  enable: true,
+  // 坐标系 GCJ-02 WGS-84,
+  coordinateSystem: "GCJ-02",
+  // 地图瓦片地址
+  tilesUrl: "http://webrd0{1-4}.is.autonavi.com/appmaptile?x={x}&y={y}&z={z}&lang=zh_cn&size=1&scale=1&style=8",
+  // 瓦片大小
+  tileSize: 256,
+  // 默认层级
+  zoom:10,
+  // 默认地图中心点
+  center:[116.41020, 39.915119],
+  // 地图最大层级
+  maxZoom:18,
+  // 地图最小层级
+  minZoom: 3
+}
+```

doc/_content/ability/node_manger.md

@@ -0,0 +1,9 @@
+<!-- 节点管理 -->
+# 节点管理
+WVP支持单个WVP多个ZLM的方案来扩展WVP的视频并发能力，并发点播是因为带宽和性能的原因，单个ZLM节点能支持的路数有限，所以WVP增加了ZLM集群来扩展并发并且保证ZLM的高可用。
+## 默认节点
+WVP中为了保证功能的完整性，ZLM节点至少要有一个默认节点，这个节点不是在管理页面添加的，而是在WVP的配置文件中配置的，这个节点不可在页面删除。每次启动会自动从配置文件中读取配置写入数据库备用。
+## 新增节点
+启动你要添加的zlm节点，然后点击“添加节点”按钮输入zlm的ip， http端口，SECRET。点击测试测试完成则开始对节点进行详细的设置，如果你的zlm是使用docker启动的，可能存在zlm使用的端口与宿主机端口不一致的情况，需要在这里一一配置。
+## wvp使用多个节点的原理
+wvp会把连接的节点统一记录在redis中，并记录zlm的负载情况，当新的请求到来时，会取出负载最低的那个zlm进行使用。以此保证节点负载均衡。

doc/_content/ability/online_doc.md

@@ -0,0 +1,2 @@
+<!-- 在线文档 -->
+# 在线文档

doc/_content/ability/proxy.md

@@ -0,0 +1,24 @@
+<!-- 拉流代理 -->
+# 拉流代理
+不是所有的摄像机都支持国标或者推流的，但是这些设备可以得到一个视频播放地址，通常为rtsp协议，
+以大华为例：
+```text
+rtsp://{user}:{passwd}@{ipc_ip}:{rtsp_port}/cam/realmonitor?channel=1&subtype=0
+```
+可以得到这样一个流地址，可以直接用vlc进行播放，此时我们可以通过拉流代理功能将这个设备推送给其他国标平台了。
+流程如下：
+```plantuml
+@startuml
+"摄像机"  <- "ZLMediaKit": 1. 流去流信息到ZLM
+"ZLMediaKit"  -> "WVP-PRO": 2. 收到hook通知得到流信息
+"上级国标平台"  -> "WVP-PRO": 3. 点播这路视频
+"WVP-PRO" -> "ZLMediaKit": 4. 通知推流到上级国标平台
+@enduml
+```
+## 添加代理
+拉流代理支持两种方式：
+1. ZLM中直接代理流，支持RTSP/RTMP，不支持转码；
+2. 借助ffmpeg完成拉转，可以通过修改ffmpeg拉转参数完成转码。  
+点击页面的“添加代理”，安装提示操作即可，保存并启用成功后，可以在国标级联中[添加通道推送给上级平台](./_content/ability/cascade?id=_2-%e6%b7%bb%e5%8a%a0%e7%9b%ae%e5%bd%95%e4%b8%8e%e9%80%9a%e9%81%93)
+
+PS： ffmpeg默认模板不需修改，需要修改参数自行去ZLM配置文件中添加一个即可。

doc/_content/ability/push.md

@@ -0,0 +1,41 @@
+<!-- 推流列表 -->
+# 推流列表
+## 功能说明
+
+WVP支持三种图像输入方式，直播，[拉流代理](_content/ability/proxy.md)，[国标](_content/ability/device.md),直播设备接入流程如下
+```plantuml
+@startuml
+"直播设备"  -> "ZLMediaKit": 1. 发起推流
+"ZLMediaKit"  -> "WVP-PRO": 2. 收到hook通知得到流信息
+"上级国标平台"  -> "WVP-PRO": 3. 点播这路视频
+"WVP-PRO" -> "ZLMediaKit": 4. 通知推流到上级国标平台
+@enduml
+```
+1. 默认情况下WVP收到推流信息后，列表中出现这条推流信息，此时你可以点击“加入国标”按钮为此路推流配置名称以及国标编号，只有有国标编号的推流才可以添加到级联平台，保存成功后可以在国标级联中[添加通道推送给上级平台](_content/ability/cascade?id=_2-%e6%b7%bb%e5%8a%a0%e7%9b%ae%e5%bd%95%e4%b8%8e%e9%80%9a%e9%81%93)
+2. WVP也支持推流前导入大量通道直接推送给上级，点击“下载模板”按钮，根据示例修改模板后，点击“通道导入”按钮导入通道数据，保存成功后可以在国标级联中[添加通道推送给上级平台](_content/ability/cascade?id=_2-%e6%b7%bb%e5%8a%a0%e7%9b%ae%e5%bd%95%e4%b8%8e%e9%80%9a%e9%81%93)
+
+## 推拉流鉴权规则
+为了保护服务器的WVP默认开启推流鉴权（目前不支持关闭此功能）
+
+### 推流规则
+推流时需要携带推流鉴权的签名sign，sign=md5(pushKey),pushKey来自用户表，每个用户会有一个不同的pushKey.
+例如app=test，stream=live，pushKey=1000，ip=192.168.1.4, port=10554 那么推流地址为：
+```
+rtsp://192.168.1.4:10554/test/live?sign=a9b7ba70783b617e9998dc4dd82eb3c5
+```
+支持推流时自定义播放鉴权Id，参数名为callId，此时sign=md5(callId_pushKey)
+例如app=test，stream=live，pushKey=1000，callId=12345678, ip=192.168.1.4, port=10554 那么推流地址为：
+```
+rtsp://192.168.1.4:10554/test/live?callId=12345678&sign=c8e6e01dde2d60c66dcea8d2498ffef1
+```
+### 播放规则
+默认情况播放不需要鉴权，但是如果推流时携带了callId，那么播放时必须携带callId
+例如app=test，stream=live，无callId, ip=192.168.1.4, port=10554 那么播放地址为：
+```
+rtsp://192.168.1.4:10554/test/live
+```
+例如app=test，stream=live，callId=12345678, ip=192.168.1.4, port=10554 那么播放地址为：
+```
+rtsp://192.168.1.4:10554/test/live?callId=12345678
+```
+

doc/_content/ability/user.md

@@ -0,0 +1,2 @@
+<!-- 用户管理 -->
+# 用户管理