版本：4.0.0

Streaming服务的布署和维护

安装包和许可文件

流媒体服务交付时，将提供一个安装包文件和一个许可文件。

安装包文件为streaming-release-x.x.x.zip(其中x.x.x为版本号)压缩包文件。压缩包内包含以下文件：

文件名	说明
`config/application.yml`	配置文件1
`config/config.json`	配置文件2
`config/trusted-clients.json`	信任客户端表数据文件
`start.sh`	程序启动脚本文件
`streaming.service`	`Streaming`服务的`systemd`服务单元文件
`streaming-x.x.x.jar`	流媒体服务Jar包（其中`x.x.x`为版本号）

许可文件为streaming-cert.json，此文件另行交付。

程序的安装

本文假设：

操作系统为Ubuntu Server 20.04，并已经完成一般性操作系统环境的准备
域名为：n11.gratour.info，按下文配置时，应改为实际的域名
操作系统用户名为：streaming，按下文配置时，应改为实际的用户名
Java使用JDK版本，安装在/opt/jdk-11

程序端口规划

Streaming服务需要在以下端口监听（均为TCP协议），部分只在本机内内部使用，部分需要开放内网访问，部分需要开放外网访问。对于需要外网访问的端口，本文假设外网端口和内网端口一致。

默认端口号	本机内部监听	内网访问需求	外网访问需求	用途
1973	Y			本地数据库端口（内部使用）
2000		Y	Y	流媒体服务API接口端口及HLS发布端口(https)
2001	Y	Y		流媒体服务API服务对接端口(https)，供集成应用或 `Micro-GNSS`服务使用
2002			Y	终端JT/T 1078端口(实时，2013)
2003			Y	终端JT/T 1078端口(回放，2013)
2004			Y	终端JT/T 1078端口(实时，2019)
2005			Y	终端JT/T 1078端口(回放，2019)
2006		Y	Y	FLV-HTTPS 发布端口（https）
2007		Y	Y	FLV-HTTP 发布端口（实时）
2008		Y	Y	FLV-HTTP 发布端口（回放）
2009		Y	Y	FLV-Websocket 发布端口 (wss)

目录规划

/opt/strm-fs目录：用于Streaming服务和Micro-GNSS服务存储服务端音视频转储文件、附件等文件
/opt/strm目录：用于安装Streaming服务
/opt/certs目录：用于存放域名的SSL证书文件，此目录应可为服务执行用户（本文假设为streaming）读取

创建这两个目录并将目录属主改为规划的运行用户（本文假设为streaming）：

sudo mkdir /opt/strm
sudo chown streaming:streaming /opt/strm
sudo mkdir /opt/strm-fs
sudo chown streaming:streaming /opt/strm-fs

安装 Streaming 服务程序

解压压缩包文件到/opt/streaming目录：

unzip streaming-release-x.x.x.zip -d /opt/strm

修改/opt/strm/start.sh文件中的JAVA_HOME变量的赋值(下图第一个黄色荧光部分) ，使之符合实际Java的安装路径（此处安装的是JDK版），并将最后一行的命令行的jar文件路径改为实际的文件路径( 下图第二个黄色荧光部分)：

#!/bin/bash
export JAVA_HOME=/opt/jdk-11
export JRE_HOME=${JAVA_HOME}/jre
export CLASSPATH=.:${JAVA_HOME}/lib:${JRE_HOME}/lib
export PATH=${JAVA_HOME}/bin:$PATH
java -Djava.net.preferIPv4Stack=true -jar /opt/strm/streaming-3.4.1.jar

为/opt/strm/start.sh添加可执行属性：

chmod +x start.sh

修改/opt/strm/streaming.service文件中的WorkingDirectory属性，使之符合Streaming服务实际的安装目录；修改User属性为执行服务的用户的用户名；修改ExecStart属性中的黄色荧光部分，改为start.sh文件的实际路径：

[Unit]
Description=GT Streaming Service
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
WorkingDirectory=/opt/streaming
Restart=always
RestartSec=5
User=streaming
ExecStart=/bin/bash /opt/streaming/start.sh

[Install]
WantedBy=multi-user.target

将/opt/strm/streaming.service复制到/etc/systemd/system目录下，并激活(enable)服务（但先不要启动，因为后面还有一些配置要完成）：

sudo cp /opt/strm/streaming.service /etc/systemd/system/
sudo systemctl enable streaming

将域名的JKS格式的SSL证书文件复制到某个streaming用户可读取的目录，这里假设为/opt/certs目录
修改/opt/strm/config/application.yml文件：
- 修改server.port属性的值为流媒体服务API接口端口的端口号；
- 修改server.private-port属性的值为内部接口端口的端口号；
- 修改server.ssl.key-store属性的值设为域名SSL证书文件的文件路径；
- 修改server.ssl.key-store-password属性的值为证书文件的密码；
- 修改server.ssl.key-alias属性的值为密钥别名。

server:
  port: 2000
  private-port: 2001
  ssl:
    key-store-type: JKS
    key-store: "/opt/certs/xxx.jks"
    key-store-password: "xxxxxx"
    key-alias: alias-key
    enabled: true

将许可文件streaming-cert.json文件复制到/opt/strm/config目录下（不要修改此文件的内容）
根据下表说明，按实际情况和/或需要修改/opt/strm/config/config.json文件：

文件的初始内容大致如下：

{
  "instanceId": "strm.1",
  "db": {
    "dataPath": "/opt/strm/data",
    "listenPort": 1973,
    "user": "sa",
    "pwd": "",
    "strmLogCleanupCron": "0 0 1 * * *",
    "strmStatCron": "0 40 1 * * *"
  },
  "externalAddr": "n11.gratour.info",
  "endPoint": {
    "port2013": {
      "livePort": 2002,
      "replayPort": 2003
    },
    "port2019": {
      "livePort": 2004,
      "replayPort": 2005,
      "autoDetectProto": true
    }
  },
  "publisher": {
    "livePort": 2006,
    "liveHttpPort": 2007,
    "replayHttpPort": 2008,
    "websocketPort": 2009,
    "hls": {
      "tmpDir": "/opt/strm-fs/hls",
      "fragmentIntv": 1,
      "fragmentCount": 10
    }
  },
  "storage": {
    "storePath": "/opt/strm-fs/strm",
    "cleanup": {
      "enabled": true,
      "cron": "0 0 2 * * *",
      "keepDays": 7
    }
  },
  "options": {}
}

文件中的各属性说明如下：

属性名	数据类型	修改说明
`instanceId`	字符串	实例ID；可分配任意要可见ASCII字符；如果整个系统中（即使不在同一台机器上）有多个`Streaming`服务实例，则应分配不同的ID给每个实例
`db.dataPath`	字符串	本地数据存储文件目录；一般为`Streaming`服务的安装目录下的`data`子目录；必须为服务执行用户可读写的目录；如果目录不存在，则服务在启动时将创建该目录
`db.listenPort`	整数	本地数据库的服务监听端口，内部使用，只要不与操作系统中的其它服务的端口号冲突即可
`db.user`	字符串	本地数据库用户名，默认为`sa`，不要修改
`db.pwd`	字符串	本地数据库密码，默认为空字符串，不要修改
`db.strmLogCleanupCron`	字符串	执行流媒体日志记录自动清理的 Spring CRON 调度时间表达式，服务将依照此表达式定义的时间执行周期性的日志记录清理工作
`db.codeStrmLogCleanupCron`	字符串	执行流媒体码流日志记录自动清理的 Spring CRON 调度时间表达式，服务将依照此表达式定义的时间执行周期性的日志记录清理工作
`db.strmStatCron`	字符串	执行流媒体活动统计的 Spring CRON 调度时间表达式，服务将依照此表达式定义的时间执行周期性的隔日统计工作
`externalAddr`	字符串	外部地址，应填写服务器的域名
`endPoint.port2013.livePort`	整数	JT/T 1078协议终端实时码流接收端口（短终端识别号）；此端口要求外网访问
`endPoint.port2013.replayPort`	整数	JT/T 1078协议终端回放码流接收端口（短终端识别号）；此端口要求外网访问
`endPoint.port2019.livePort`	整数	JT/T 1078协议终端实时码流接收端口（长终端识别号）；此端口要求外网访问
`endPoint.port2019.replayPort`	整数	JT/T 1078协议终端回放码流接收端口（长终端识别号）；此端口要求外网访问
`endPoint.port2019.audoDetectProto`	布尔值	JT/T 1078协议终端回放码流接收端口（长终端识别号）是否启用同时自动适应短终端识别号
`publisher.livePort`	整数	FLV-HTTPS实时播放端口；此端口要求外网访问，否则只能内网播放
`publisher.liveHttpPort`	整数	FLV-HTTP实时播放端口；此端口要求外网访问，否则只能内网播放，主要服务政府平台
`publisher.replayHttpPort`	整数	FLV-HTTP回放播放端口；此端口要求外网访问，否则只能内网播放，主要服务政府平台
`publisher.websocketPort`	整数	FLV-Websocket端口；此端口要求外网访问，否则只能内网播放
`publisher.hls.tmpDir`	字符串	音视频HLS转码的临时文件存储目录；可设置到`/opt/strm-fs`的`hls`子目录，或`/tmp/hls`，必须为服务执行用户可读写的目录；目录不存在时，服务将在启动时创建此目录
`storage.storePath`	字符串	服务端音视频转储文件存储目录；一般为`/opt/strm-fs`的`strm`子目录，必须为服务执行用户可读写的目录；目录不存在时，服务将在启动时创建此目录
`storage.cleanup.enabled`	布尔值	是否执行服务端音视频转储文件自动清理；一般应设为`true`
`storage.cleanup.cron`	字符串	服务端音视频转储文件自动清理 Spring CRON 调度时间表达式；请务必将自动清理工作安排在每天凌晨2点之后，在0点至2点之间执行统计可能导致统计不准确；服务将依照此表达式定义的时间执行周期性的音视频转储文件清理工作
`storage.cleanup.keepDays`	整数	执行服务端音视频转储文件自动清理时，保留的最近转储文件的天数；转储时间在此天数内的文件不会被清理掉；应大于0

将/opt/strm/config/trusted-client.json文件中的clients[0].password 属性的值修改为一个随机密码（不要使用文件中已有密码），建议生成长度为12个或以上的字母数字字符组成的密码。Micro-GNSS 服务将使用此密码访问安全敏感的接口。

{
  "clients": [
    {
      "username": "gnss-1",
      "password": "Jc4xrpsIX2c2PGSm",
      "privs": [
        "config", "strm"
      ]
    }
  ]
}

根据前述端口需求，设置好防火墙和端口映射
启动服务

sudo systemctl start streaming

日常维护

服务的启动、停止、重启

启动Streaming服务可执行：

sudo systemctl start streaming

停止Streaming服务可执行：

sudo systemctl stop streaming

重启Streaming服务可执行：

sudo systemctl restart streaming

SSL证书更换

将jks的格式证书上传到服务器的某个目录
修改 config/application.yml 文件中的 server.ssl.key-store ，使之指向新的证书文件，修改server.ssl.key-store-password，改为新的证书密码
重启服务

日志文件

日志文件为服务安装目录（本文为opt/strm）下的log子目录下的strm.log文件。

Spring CRON 调度时间表达式

Spring CRON表达式类似于crontab表达式，但分为6个（crontab为5个，少了秒字段）以空格分隔的时间日期字段：

主要规则如下

字段可以设为星号(*)，表示从第一个到最后一个。对于日或周几字段，可以用问号(?)，表示的意义和星号(*)一样。
范围可以用连接号(-)连接两个数字表示；它表示的范围是包含的，即包含开始的数字，也包含结尾的数字；如：3-7，表示[3,4,5,6,7]，范围包含开始数字3，也包含结尾数字7。
在一个字段中，单个数字或一个范围或星号(*)后跟/n(其中n为具体数字)，可表示在触发后，在范围内再多次触发，间隔由n值指出。
在日字段中可以使用一个L字符，表示月的最后一天。如果L后面跟随一个负的偏量，即L-n(其中n为具体数字)，表示月的倒数n天。如果L后面跟随W字母，即LW，则表示月的最后一个工作日。
在周几字段中可以使用一个L字符，表示周的最后一天。如果在L前面加一个数字，表示月的最后一个周几。
日字段可以是nW(其中n为具体数字)，表示与n号最接近的工作日；如果当月n号刚好为工作日，则计算为n号；如果n不为1，n号那天为周六，则计算为n号的前一天（周五）；如果n为1，1号那天为周六，则计算为1号的下周一；如果n号那天为周日，则为n号的后一天（周一）。
周几字段可以指定为d#n（其中d, n为具体数字），表示月的第n个周d。

同时也支持以下宏：

@yearly (或 @annually)，表示每年1月1日零时
@monthly，表示每月1日零时
@weekly，表示每个周日的零时
@daily (或 @midnight)，表示每天的零时
@hourly，表示每个小时的0分0秒

表达式示例

表达式	说明
`0 0 * * * *`	每小时的0分0秒
`/10 * * * *`	每隔10秒
`0 0 8-10 * * *`	每天8点，9点，10点三个时刻
`0 0 6,19 * * *`	每天的6点和19点二个时刻
`0 0/30 8-10 * * *`	每天的8:00, 8:30, 9:00, 9:30, 10:00和10:30
`0 0 9-17 * * 1-5`	工作日的9点至17点的九个整点时刻
`0 0 0 25 12 ?`	每年12月25日零时
`0 0 0 L * *`	每个月的月末那天零时
`0 0 0 L-3 * *`	每个月的倒数第三天的零时
`0 0 0 1W * *`	每个月的第一个工作日的零时
`0 0 0 LW * *`	每个月的最后一个工作日的零时
`0 0 0 * * 5L`	每月最后一个周五的零时
`0 0 0 ? * 5#2`	每月第二个周五的零时

Streaming服务的布署和维护

安装包和许可文件​

程序的安装​

程序端口规划​

目录规划​

安装 Streaming 服务程序​

日常维护​

服务的启动、停止、重启​

SSL证书更换​

日志文件​

Spring CRON 调度时间表达式​

主要规则如下​

表达式示例​