first
This commit is contained in:
BIN
doc/_content/introduction/_media/img.png
Normal file
BIN
doc/_content/introduction/_media/img.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 180 KiB |
BIN
doc/_content/introduction/_media/img_1.png
Normal file
BIN
doc/_content/introduction/_media/img_1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 178 KiB |
BIN
doc/_content/introduction/_media/img_2.png
Normal file
BIN
doc/_content/introduction/_media/img_2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 202 KiB |
124
doc/_content/introduction/compile.md
Normal file
124
doc/_content/introduction/compile.md
Normal file
@@ -0,0 +1,124 @@
|
||||
<!-- 编译 -->
|
||||
|
||||
# 编译
|
||||
|
||||
WVP-PRO不只是实现了国标28181的协议，本身也是一个完整的视频平台。所以对于新手来说，你可能需要一些耐心来完成。遇到问题不要焦躁，你可以
|
||||
|
||||
1. 百度
|
||||
2. 加入星球体提问；[知识星球](https://t.zsxq.com/0d8VAD3Dm)
|
||||
3. 向作者发送邮件648540858@qq.com,寻求技术支持（有偿）；
|
||||
|
||||
WVP-PRO使用Spring boot开发，maven管理依赖。对于熟悉spring开发的朋友是很容易进行编译部署以及运行的。
|
||||
下面将提供一种通用方法方便大家运行项目。
|
||||
|
||||
## 1 服务介绍
|
||||
|
||||
| 服务 | 作用 | 是否必须 |
|
||||
|------------|------------------------------------------|------|
|
||||
| WVP-PRO | 实现国标28181的信令以及视频平台相关的功能 | 是 |
|
||||
| ZLMediaKit | 为WVP-PRO提供国标28181的媒体部分的实现，以及各种视频流格式的分发支持 | 是 |
|
||||
|
||||
## 2 安装依赖
|
||||
|
||||
| 依赖 | 版本 | 用途 | 开发环境需要 | 生产环境需要 |
|
||||
|--------|-------|-------------|--------|--------|
|
||||
| jdk | >=1.8 | 运行与编译java代码 | 是 | 是 |
|
||||
| maven | >=3.3 | 管理java代码依赖 | 否 | 否 |
|
||||
| git | | 下载/更新/提交代码 | 否 | 否 |
|
||||
| nodejs | | 编译于运行前端文件 | 否 | 否 |
|
||||
| npm | | 管理前端文件依赖 | 否 | 否 |
|
||||
|
||||
如果你是一个新手，建议你使用linux或者macOS平台。windows不推荐。
|
||||
|
||||
ubuntu环境，以ubuntu 18为例：
|
||||
|
||||
``` bash
|
||||
apt-get install -y openjdk-11-jre git maven nodejs npm
|
||||
```
|
||||
|
||||
centos环境,以centos 8为例：
|
||||
|
||||
```bash
|
||||
yum install -y java-1.8.0-openjdk.x86_64 git maven nodejs npm
|
||||
```
|
||||
|
||||
window环境，以windows10为例：
|
||||
|
||||
```bash
|
||||
这里不细说了，百度或者谷歌一搜一大把，基本都是下一步下一步，然后配置环境变量。
|
||||
```
|
||||
|
||||
## 3 安装mysql以及redis
|
||||
|
||||
这里依然是参考网上教程，自行安装吧。
|
||||
|
||||
## 4 编译ZLMediaKit
|
||||
|
||||
参考ZLMediaKit[WIKI](https://github.com/ZLMediaKit/ZLMediaKit/wiki)
|
||||
，如果需要使用语音对讲功能，请参考[zlm启用webrtc编译指南](https://github.com/ZLMediaKit/ZLMediaKit/wiki/zlm%E5%90%AF%E7%94%A8webrtc%E7%BC%96%E8%AF%91%E6%8C%87%E5%8D%97)
|
||||
，开启zlm的webrtc功能。截取一下关键步骤：
|
||||
|
||||
```bash
|
||||
# 国内用户推荐从同步镜像网站gitee下载
|
||||
git clone --depth 1 https://gitee.com/xia-chu/ZLMediaKit
|
||||
cd ZLMediaKit
|
||||
# 千万不要忘记执行这句命令
|
||||
git submodule update --init
|
||||
```
|
||||
|
||||
## 5 编译WVP-PRO
|
||||
|
||||
### 5.1 可以通过git克隆，也可以在项目下载点击下载
|
||||
|
||||
|
||||
|
||||
从gitee克隆
|
||||
|
||||
```bash
|
||||
git clone https://gitee.com/pan648540858/wvp-GB28181-pro.git
|
||||
```
|
||||
|
||||
从github克隆
|
||||
|
||||
```bash
|
||||
git clone https://github.com/648540858/wvp-GB28181-pro.git
|
||||
```
|
||||
|
||||
### 5.2 编译前端页面
|
||||
|
||||
```shell script
|
||||
cd wvp-GB28181-pro/web/
|
||||
npm --registry=https://registry.npmmirror.com install
|
||||
npm run build:prod
|
||||
```
|
||||
|
||||
编译如果报错, 一般都是网络问题, 导致的依赖包下载失败
|
||||
编译完成后在src/main/resources下出现static目录
|
||||
**编译完成一般是这个样子，中间没有报红的错误信息**
|
||||
|
||||
|
||||
### 5.3 生成可执行jar
|
||||
|
||||
```bash
|
||||
cd wvp-GB28181-pro
|
||||
mvn package
|
||||
```
|
||||
|
||||
### 5.4 生成war
|
||||
|
||||
```bash
|
||||
cd wvp-GB28181-pro
|
||||
mvn package -P war
|
||||
```
|
||||
|
||||
编译如果报错, 一般都是网络问题, 导致的依赖包下载失败
|
||||
编译完成后在target目录下出现 `wvp-pro-VERSION.jar` 和 `wvp-pro-VERSION.war` 文件。
|
||||
接下来[配置服务](./_content/introduction/config.md)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
166
doc/_content/introduction/config.md
Normal file
166
doc/_content/introduction/config.md
Normal file
@@ -0,0 +1,166 @@
|
||||
<!-- 配置 -->
|
||||
|
||||
# 配置
|
||||
|
||||
对于首次测试或者新手同学，我建议在局域网测试，并且关闭服务器与客户机的防火墙测试。建议部署在linux进行测试。
|
||||
|
||||
```plantuml
|
||||
@startuml
|
||||
"WVP-PRO" -> "ZLMediaKit": RESTful 接口
|
||||
"WVP-PRO" <-- "ZLMediaKit": Web Hook 接口
|
||||
@enduml
|
||||
```
|
||||
|
||||
WVP-PRO通过调用ZLMediaKit的RESTful接口实现对ZLMediaKit行为的控制; ZLMediaKit通过Web Hook 接口把消息通知WVP-PRO。通过这种方式，实现了两者的互通。
|
||||
对于最简单的配置，你不需要修改ZLMediaKit的任何默认配置。你只需要在WVP-PRO中配置的ZLMediaKit信息即可
|
||||
|
||||
## 1 WVP配置文件位置
|
||||
|
||||
基于spring boot的开发方式，配置文件的加载是很灵活的。默认在src/main/resources/application.yml，部分配置项是可选，你不需要全部配置在配置文件中，
|
||||
完全的配置说明可以参看"src/main/resources/配置详情.yml"。
|
||||
|
||||
### 1.1 默认加载配置文件方式
|
||||
|
||||
使用maven打包后的target里，已经存在了配置文件，默认加载配置文件为application.yml，查看内容发现其中spring.profiles.active配置的内容，将入配置的值为dev，那么具体加载的配置文件就是application-dev.yml，如果配置的值找不到对应的配置文件，修改值为dev。
|
||||
|
||||
```shell
|
||||
cd wvp-GB28181-pro/target
|
||||
java -jar wvp-pro-*.jar
|
||||
```
|
||||
|
||||
## 2 配置WVP-PRO
|
||||
|
||||
wvp支持多种数据库，包括Mysql，Postgresql，金仓等，配置任选一种即可。
|
||||
|
||||
### 2.1 数据库配置
|
||||
|
||||
#### 2.1.1 初始化数据库
|
||||
|
||||
首先使用创建数据库，然后使用sql/初始化.sql初始化数据库，如果是从旧版升级上来的，使用升级sql更新。
|
||||
|
||||
#### 2.1.2 Mysql数据库配置
|
||||
|
||||
数据库名称以wvp为例
|
||||
|
||||
```yaml
|
||||
spring:
|
||||
datasource:
|
||||
type: com.zaxxer.hikari.HikariDataSource
|
||||
driver-class-name: com.mysql.cj.jdbc.Driver
|
||||
url: jdbc:mysql://127.0.0.1:3306/wvp?useUnicode=true&characterEncoding=UTF8&rewriteBatchedStatements=true&serverTimezone=PRC&useSSL=false&allowMultiQueries=true
|
||||
username: root
|
||||
password: root123
|
||||
```
|
||||
|
||||
#### 2.1.3 Postgresql数据库配置
|
||||
|
||||
数据库名称以wvp为例
|
||||
|
||||
```yaml
|
||||
spring:
|
||||
datasource:
|
||||
type: com.zaxxer.hikari.HikariDataSource
|
||||
driver-class-name: org.postgresql.Driver
|
||||
url: jdbc:postgresql://127.0.0.1:3306/wvp?useUnicode=true&characterEncoding=UTF8&rewriteBatchedStatements=true&serverTimezone=PRC&useSSL=false&allowMultiQueries=true&allowPublicKeyRetrieval=true
|
||||
username: root
|
||||
password: 12345678
|
||||
|
||||
pagehelper:
|
||||
helper-dialect: postgresql
|
||||
```
|
||||
|
||||
#### 2.1.4 金仓数据库配置
|
||||
|
||||
数据库名称以wvp为例
|
||||
|
||||
```yaml
|
||||
spring:
|
||||
datasource:
|
||||
type: com.zaxxer.hikari.HikariDataSource
|
||||
driver-class-name: com.kingbase8.Driver
|
||||
url: jdbc:kingbase8://127.0.0.1:3306/wvp?useUnicode=true&characterEncoding=utf8
|
||||
username: root
|
||||
password: 12345678
|
||||
|
||||
|
||||
pagehelper:
|
||||
helper-dialect: postgresql
|
||||
```
|
||||
|
||||
### 2.2 Redis数据库配置
|
||||
|
||||
配置wvp中的redis连接信息，建议wvp自己单独使用一个db。
|
||||
|
||||
### 2.3 配置服务启动端口（可直接使用默认配置）
|
||||
|
||||
```yaml
|
||||
# [可选] WVP监听的HTTP端口, 网页和接口调用都是这个端口
|
||||
server:
|
||||
port: 18080
|
||||
```
|
||||
|
||||
### 2.4 配置28181相关信息（可直接使用默认配置）
|
||||
|
||||
```yaml
|
||||
# 作为28181服务器的配置
|
||||
sip:
|
||||
# [可选] 28181服务监听的端口
|
||||
port: 5060
|
||||
# 根据国标6.1.2中规定，domain宜采用ID统一编码的前十位编码。国标附录D中定义前8位为中心编码（由省级、市级、区级、基层编号组成，参照GB/T 2260-2007）
|
||||
# 后两位为行业编码，定义参照附录D.3
|
||||
# 3701020049标识山东济南历下区 信息行业接入
|
||||
# [可选]
|
||||
domain: 3402000000
|
||||
# [可选]
|
||||
id: 34020000002000000001
|
||||
# [可选] 默认设备认证密码，后续扩展使用设备单独密码, 移除密码将不进行校验
|
||||
password: 12345678
|
||||
```
|
||||
|
||||
### 2.5 配置ZLMediaKit连接信息
|
||||
|
||||
```yaml
|
||||
#zlm 默认服务器配置
|
||||
media:
|
||||
id: zlmediakit-local
|
||||
# [必须修改] zlm服务器的内网IP
|
||||
ip: 172.19.128.50
|
||||
# [可选] 有公网IP就配置公网IP, 不可用域名
|
||||
wan_ip:
|
||||
# [必须修改] zlm服务器的http.port
|
||||
http-port: 9092
|
||||
# [可选] zlm服务器访问WVP所使用的IP, 默认使用127.0.0.1，zlm和wvp没有部署在同一台服务器时必须配置
|
||||
hook-ip: 172.19.128.50
|
||||
# [必选选] zlm服务器的hook.admin_params=secret
|
||||
secret: TWSYFgYJOQWB4ftgeYut8DW4wbs7pQnj
|
||||
# 启用多端口模式, 多端口模式使用端口区分每路流，兼容性更好。 单端口使用流的ssrc区分， 点播超时建议使用多端口测试
|
||||
rtp:
|
||||
# [可选] 是否启用多端口模式, 开启后会在portRange范围内选择端口用于媒体流传输
|
||||
enable: true
|
||||
# [可选] 在此范围内选择端口用于媒体流传输, 必须提前在zlm上配置该属性，不然自动配置此属性可能不成功
|
||||
port-range: 30000,35000 # 端口范围
|
||||
# [可选] 国标级联在此范围内选择端口发送媒体流,
|
||||
send-port-range: 40000,40300 # 端口范围
|
||||
```
|
||||
|
||||
### 2.4 策略配置
|
||||
|
||||
```yaml
|
||||
# [根据业务需求配置]
|
||||
user-settings:
|
||||
# 点播/录像回放 等待超时时间,单位：毫秒
|
||||
play-timeout: 180000
|
||||
# [可选] 自动点播， 使用固定流地址进行播放时，如果未点播则自动进行点播, 需要rtp.enable=true
|
||||
auto-apply-play: true
|
||||
# 推流直播是否录制
|
||||
record-push-live: true
|
||||
# 国标是否录制
|
||||
record-sip: true
|
||||
# 国标点播 按需拉流, true：有人观看拉流，无人观看释放， false：拉起后不自动释放
|
||||
stream-on-demand: true
|
||||
```
|
||||
|
||||
更多完整的配置信息参考"src/main/resources/配置详情.yml"文件，需要那个配置项，复制到正在使用的配置文件中对应的文件即可。
|
||||
|
||||
如果配置信息无误，你可以启动zlm，再启动wvp来测试了，启动成功的话，你可以在wvp的日志下看到zlm已连接的提示。
|
||||
接下来[部署到服务器](./_content/introduction/deployment.md)， 如果你只是本地运行直接在本地运行即可。
|
||||
51
doc/_content/introduction/deployment.md
Normal file
51
doc/_content/introduction/deployment.md
Normal file
@@ -0,0 +1,51 @@
|
||||
<!-- 部署 -->
|
||||
|
||||
# 部署
|
||||
|
||||
**请仔细阅读以下内容**
|
||||
|
||||
1. WVP-PRO与ZLM支持分开部署;
|
||||
2. 需要开放的端口
|
||||
| 服务 | 端口 | 类型 | 必选 |
|
||||
|-----|:-------------------------|-------------|-------|
|
||||
| wvp | server.port | tcp | 是 |
|
||||
| wvp | sip.port | udp and tcp | 是 |
|
||||
| zlm | http.port | tcp | 是 |
|
||||
| zlm | http.sslport | tcp | 否 |
|
||||
| zlm | rtmp.port | tcp | 否 |
|
||||
| zlm | rtmp.sslport | tcp | 否 |
|
||||
| zlm | rtsp.port | udp and tcp | 否 |
|
||||
| zlm | rtsp.sslport | udp and tcp | 否 |
|
||||
| zlm | rtp_proxy.port | udp and tcp | 单端口开放 |
|
||||
| zlm | rtp.port-range(在wvp中配置) | udp and tcp | 多端口开放 |
|
||||
|
||||
3. 测试环境部署建议所有服务部署在一台主机，关闭防火墙，减少因网络出现问题的可能;
|
||||
4. 生产环境按需开放端口，但是建议修改默认端口，尤其是5060端口，易受到攻击;
|
||||
5. zlm使用docker部署的情况，请使用host模式，或者端口映射一致，比如映射5060,应将外部端口也映射为5060端口;
|
||||
6. zlm与wvp会保持高频率的通信，所以不要去将wvp与zlm分属在两个网络，比如wvp在内网，zlm却在公网的情况。
|
||||
7. 启动服务，以linux为例
|
||||
**启动WVP-PRO**
|
||||
|
||||
```shell
|
||||
nohup java -jar wvp-pro-*.jar &
|
||||
```
|
||||
|
||||
**war包：**
|
||||
下载Tomcat后将war包放入webapps中，启动Tomcat以解压war包，停止Tomcat后，删除ROOT目录以及war包，将解压后的war包目录重命名为ROOT，将配置文件中的Server.port配置为与Tomcat端口一致
|
||||
然后启动Tomcat。
|
||||
**启动ZLM**
|
||||
|
||||
```shell
|
||||
nohup ./MediaServer -d -m 3 &
|
||||
```
|
||||
|
||||
### 前后端分离部署
|
||||
|
||||
前端基于 [vue-admin-template](https://github.com/PanJiaChen/vue-admin-template/blob/master/README-zh.md) 构建， 参考这儿即可。
|
||||
|
||||
### 默认账号和密码
|
||||
|
||||
部署完毕后，可以通过访问 ip加端口的方式访问 WVP ，WVP的默认登录账号和密码均为 admin。
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user