wip: 更新文档

Author: cli

.env.default

@@ -1,10 +1,15 @@
-## 服务器IP, 网关等服务不设置IP的时候,默认会读取这个
-# 必填，当前服务器外网IP
-SERVER_IP_PUBLIC='' # 127.0.0.1
-# 必填, 当前服务器内网IP
-SERVER_IP_INTERNAL='' # 127.0.0.1
-# 服务器域名
+# 必填, 当前服务器公网IP, jtt808/video等服务不设置IP的时候,默认会读取这个
+SERVER_IP_PUBLIC='' # 58.82.168.181
+
+# 当前服务器内网IP, 目前没有人使用, 可以不填
+# JTT808_HOST/MYSQL_HOST等变量, 单机部署可以直接使用别名(eg: jtt808)，内网多服务器部署推荐内网IP, 公网部署使用公网IP
+SERVER_IP_INTERNAL=''
+
+# 必填, 服务器域名, 若没有域名, 则填写公网IP
 SERVER_HOSTNAME='' # livedvr.tripsdd.com
+
+# 必填, 证书文件的绝对路径, 排除.crt/.key后缀, nginx实际读取的是 ${SSL_CERTIFICATE}.crt 和 ${SSL_CERTIFICATE}.key 两个文件
+# 即使不使用https或者暂时没申请到证书, 也要配置该变量, 否则nginx会报错, 可以直接使用examples里面的假证书: /home/docker/examples/track/ssl/certificate
 SSL_CERTIFICATE='' # /home/docker-compose/ssl/livedvr_tripsdd_com
 
 # bus和track部署在同一台服务器上时, 需要通过域名区分两者
@@ -17,6 +22,8 @@ TRACK_SSL_CERTIFICATE=${SSL_CERTIFICATE}
 ## 前端配置
 WEB_PORT_HTTP=80
 WEB_PORT_HTTPS=443
+# 前端的公网URL
+# jtt808和maintain分开部署时, 必须填写这个变量
 WEB_BASE_URL='' # https://livedvr.tripsdd.com
 #---------------------------------------------
 
@@ -38,6 +45,7 @@ BUS_GATEWAY_VERSION=1.21.1
 BUS_GATEWAY_808_2019_VERSION=25.8.25
 BUS_GATEWAY_JSATL12_VERSION=23.1.21
 BUS_GATEWAY_CALCULATION_VERSION=1.17.0
+
 # track前端版本
 TRACK_WEB_VERSION=1.53.0
 # track前端文件复写目录, 该目录中的文件会在compose被up时被复制到track前端目录, 通常可以复写如下文件:
@@ -53,11 +61,11 @@ TRACK_JTT808_VERSION=1.18.0
 # ---------------------------------------------
 
 ## 视频服务器
-# 必填, 视频外网IP, APP客户端和设备连接
+# 必填, 视频公网IP, APP客户端和设备连接
 VIDEO_IP=${SERVER_IP_PUBLIC}
 # 必填
 VIDEO_HOSTNAME=${SERVER_HOSTNAME} # livedvr.tripsdd.com
-# 必填, 证书文件的绝对路径, 排除.crt/.key后缀, nginx使用的是 $VIDEO_SSL_CERTIFICATE.crt 和 $VIDEO_SSL_CERTIFICATE.key 两个文件
+# 必填
 VIDEO_SSL_CERTIFICATE=${SSL_CERTIFICATE} # /home/docker/video-nginx/ssl/livedvr_tripsdd_com
 
 # 终端-实时直播端口
@@ -84,9 +92,8 @@ VIDEO_PORT_HTTPS_5=9089
 
 ## 网关服务器
 # 必填, 后端和流媒体服务往网关服务器注册或者下发指令
-# 单机部署推荐别名jtt808，内网多服务器部署推荐内网IP, 外网部署使用外网IP
-JTT808_HOST='jtt808' # jtt808 | ${SERVER_IP_INTERNAL} | ${SERVER_IP_PUBLIC}
-JTT808_IP=${SERVER_IP_PUBLIC} # 默认使用服务器外网IP,设备使用
+JTT808_HOST='jtt808'
+JTT808_IP=${SERVER_IP_PUBLIC} # 默认使用服务器公网IP,设备使用
 JTT808_PORT=9011
 JTT808_PORT_HTTP=9012
 JTT808_PORT_FILE=9013
@@ -97,54 +104,55 @@ JTT808_PORT_FTP_PASSIVE=9041-9049
 #---------------------------------------------
 
 ## maintain
-MAINTAIN_HOST='maintain' # maintain | ${SERVER_IP_INTERNAL} | ${SERVER_IP_PUBLIC}
+MAINTAIN_HOST='maintain'
 MAINTAIN_PORT='8080'
 # TOKEN目录的绝对路径, 包含以下文件, 最新版服务器已经支持自动生成/下载这些文件:
 # - access/ras_key|ras_key.pub: 访问密钥的公私钥对
 # - refresh/ras_key|ras_key.pub: 刷新密钥的公私钥对
 # - ip2region.xdb: ip到区域的映射数据, 手动下载连接: https://raw.githubusercontent.com/lionsoul2014/ip2region/master/data/ip2region.xdb
 MAINTAIN_TOKEN_DIR=${DOCKER_COMPOSE_DIR}/token
 
-## MYSQL, 必填
-MYSQL_HOST='mysql8' # mysql8 | ${SERVER_IP_INTERNAL} | ${SERVER_IP_PUBLIC}
+## MYSQL
+MYSQL_HOST='mysql8'
 MYSQL_PORT=3306
-MYSQL_USERNAME='root' #xxxxxxxx
-MYSQL_PASSWORD='' #xxxxxxxx
+MYSQL_USERNAME='root'
+MYSQL_PASSWORD='' # 必填
 
-## REDIS, 必填
-REDIS_HOST='redis' # redis | ${SERVER_IP_INTERNAL} | ${SERVER_IP_PUBLIC}
+## REDIS
+REDIS_HOST='redis'
 REDIS_PORT=6379
-REDIS_PASSWORD='' #xxxxxxxx
+REDIS_PASSWORD='' # 必填
 
-## MongoDB, jtt808必填
-MONGODB_HOST='mongodb' # mongodb | ${SERVER_IP_INTERNAL} | ${SERVER_IP_PUBLIC}
+## MongoDB
+MONGODB_HOST='mongodb'
 MONGODB_PORT=27017
 MONGODB_PORT_HTTP=15672
-MONGODB_USERNAME='root' # MONGODB
-MONGODB_PASSWORD='' # MONGODB
+MONGODB_USERNAME='root'
+MONGODB_PASSWORD='' # 必填
 
-## Rabbitmq, Rtp存储模式必填
-RABBITMQ_HOST='rabbitmq' # rabbitmq | ${SERVER_IP_INTERNAL} | ${SERVER_IP_PUBLIC}
+## Rabbitmq
+RABBITMQ_HOST='rabbitmq'
 RABBITMQ_PORT=5672
-RABBITMQ_USERNAME='admin' # admin
-RABBITMQ_PASSWORD='' # 123
+RABBITMQ_USERNAME='admin'
+RABBITMQ_PASSWORD='' # 必填
 
-## Minio, Rtp存储模式必填, 规避RTP-9000端口冲突
-MINIO_HOST='minio' # minio | ${SERVER_IP_INTERNAL} | ${SERVER_IP_PUBLIC}
+## Minio
+MINIO_HOST='minio'
 MINIO_PORT=8000
 MINIO_PORT_HTTP=8001
 MINIO_USER=minioadmin
-MINIO_PASSWORD='' # xxxxxxxxxxxxxxxx
+MINIO_PASSWORD='' # 必填
 # MINIO_ACCESSKEY/SECRETKEY, 默认使用帐号&密码, 也可以在minio的管理后台创建一组新的KEY
-MINIO_ACCESSKEY=${MINIO_USER} # xxxxxxxxxxxxxxxx
-MINIO_SECRETKEY=${MINIO_PASSWORD} # xxxxxxxxxxxxxxxxx
+MINIO_ACCESSKEY=${MINIO_USER}
+MINIO_SECRETKEY=${MINIO_PASSWORD}
 # MINIO ftp功能
 MINIO_FTP_PORT=8021
 MINIO_FTP_PASSIVE_PORT=8523-8529
 #---------------------------------------------
 
 ## 邮件
+# 默认使用transcodegroup的邮箱
 MAIL_HOST=smtp.transcodegroup.com
 MAIL_USERNAME=bus@transcodegroup.com
-# 需要去企业邮箱中创建密码
-MAIL_PASSWORD='' #xxxxxxxxxxxxxxxx
+# 必填, 需要去企业邮箱中创建密码
+MAIL_PASSWORD=''

README.md

@@ -19,6 +19,7 @@ git clone https://github.com/TranscodeGroup/docker.git /home/docker
 - [video-storage](./examples/video-storage/compose.yaml): RTP存储
 - [video-stream](./examples/video-stream/compose.yaml): RTP视频
 - [track](./examples/track/compose.yaml): Tracker V2单机部署
+- [bus](./examples/bus/compose.yaml): Bus单机部署
 - etc.
 
 ### 3. 配置`.env`
@@ -43,9 +44,14 @@ docker compose config > compose-stack.yaml
 
 在`/home/docker-compose/compose.yaml`文件中, `include`如下服务, 即可自动下载前端:
 
-- [compose.yaml](./web-downloader/compose.yml): 自动下载的基础配置
-- [compose.track.yaml](./web-downloader/compose.track.yml): 自动下载track的配置, 可选;
-- [compose.bus.yaml](./web-downloader/compose.bus.yml): 自动下载bus的配置, 可选;
+```yaml
+include:
+  # ...
+  - path:
+    - ../docker/web-downloader/compose.yml        # 自动下载的基础配置
+    - ../docker/web-downloader/compose.track.yml  # 自动下载track, 可选
+    - ../docker/web-downloader/compose.bus.yml    # 自动下载bus, 可选
+```
 
 #### 手动下载