Skip to content

Commit ce4c05a

Browse files
shimonenatoripcjs
authored andcommitted
docs: translate documentation and config files to English
1 parent 92401bd commit ce4c05a

File tree

16 files changed

+185
-186
lines changed

16 files changed

+185
-186
lines changed

.env.default

Lines changed: 72 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,109 +1,109 @@
1-
## ================================ 目录 ================================
1+
## ================================ Directory ================================
22

3-
# 数据目录, 用于存放日志/数据库/文件等
3+
# Data directory, used for storing logs/database/files, etc.
44
DATA_DIR=/data
5-
# docker仓库的目录, 不建议在compose文件中引用docker仓库的绝对路径, 建议使用configs替代: https://docs.docker.com/reference/compose-file/configs/
5+
# Docker repository directory. It is not recommended to reference the absolute path of the docker repository in the compose file. It is recommended to use configs instead: https://docs.docker.com/reference/compose-file/configs/
66
DOCKER_DIR=/home/docker
7-
# 实际配置项目配置目录
7+
# Project configuration directory
88
DOCKER_COMPOSE_DIR=/home/docker-compose
9-
# bus前端文件复写目录, 该目录中的文件会在compose被up时被复制到bus前端目录, 通常可以复写如下文件:
10-
# - _app.config.js: 前端配置文件
9+
# bus frontend file override directory. Files in this directory will be copied to the bus frontend directory when compose is up. Usually, the following files can be overridden:
10+
# - _app.config.js: Frontend configuration file
1111
BUS_WEB_OVERRIDE_DIR=${DOCKER_COMPOSE_DIR}/bus-override
12-
# track前端文件复写目录, 该目录中的文件会在compose被up时被复制到track前端目录, 通常可以复写如下文件:
13-
# - _app.config.js: 前端配置文件
14-
# - index-seo.html: 交给爬虫(搜索引擎/Line网页摘要等)读取的静态页面
15-
# - favicon.ico: ico图标
16-
# - favicon.png: png图标
17-
# - logo.png: 大图标
12+
# track frontend file override directory. Files in this directory will be copied to the track frontend directory when compose is up. Usually, the following files can be overridden:
13+
# - _app.config.js: Frontend configuration file
14+
# - index-seo.html: Static page for crawlers (search engine/Line web page abstract, etc.)
15+
# - favicon.ico: ico icon
16+
# - favicon.png: png icon
17+
# - logo.png: Large icon
1818
TRACK_WEB_OVERRIDE_DIR=${DOCKER_COMPOSE_DIR}/track-override
19-
# TOKEN目录的绝对路径, 包含以下文件, 最新版服务器已经支持自动生成/下载这些文件:
20-
# - access/ras_key|ras_key.pub: 访问密钥的公私钥对
21-
# - refresh/ras_key|ras_key.pub: 刷新密钥的公私钥对
22-
# - ip2region.xdb: ip到区域的映射数据, 手动下载连接: https://raw.githubusercontent.com/lionsoul2014/ip2region/master/data/ip2region.xdb
19+
# Absolute path of TOKEN directory, including the following files. The latest server version already supports automatic generation/download of these files:
20+
# - access/ras_key|ras_key.pub: Public/private key pair for access secret
21+
# - refresh/ras_key|ras_key.pub: Public/private key pair for refresh secret
22+
# - ip2region.xdb: ip to region mapping data, manual download link: https://raw.githubusercontent.com/lionsoul2014/ip2region/master/data/ip2region.xdb
2323
MAINTAIN_TOKEN_DIR=${DOCKER_COMPOSE_DIR}/token
24-
# jtt808可选功能目录, 可选包含的文件如下, 下载方式详见: https://github.com/TranscodeGroup/docker/blob/master/jtt808/README.md
25-
# - ffmpeg, ffprobe: FFmpeg的bin文件
26-
# - ifv2mp4/: 通力ifv转mp4工具目录
24+
# jtt808 optional feature directory, optionally including the following files, see download details: https://github.com/TranscodeGroup/docker/blob/master/jtt808/README.md
25+
# - ffmpeg, ffprobe: FFmpeg bin files
26+
# - ifv2mp4/: Tongli ifv to mp4 tool directory
2727
JTT808_OPT_DIR=${DOCKER_COMPOSE_DIR}/opt
2828

29-
## ================================ 服务器信息 ================================
29+
## ================================ Server Info ================================
3030

31-
# 必填, 当前服务器公网IP, jtt808/video等服务不设置IP的时候,默认会读取这个
31+
# Required, current server public IP. If jtt808/video and other services do not set IP, this will be read by default
3232
SERVER_IP_PUBLIC='' # 58.82.168.181
3333

34-
# 当前服务器内网IP, 目前没有人使用, 可以不填
35-
# JTT808_HOST/MYSQL_HOST等变量, 单机部署可以直接使用别名(eg: jtt808),内网多服务器部署推荐内网IP, 公网部署使用公网IP
34+
# Current server internal IP, currently no one uses it, can be left blank
35+
# JTT808_HOST/MYSQL_HOST and other variables, single machine deployment can use alias directly (eg: jtt808), intranet multi-server deployment recommends intranet IP, public network deployment uses public IP
3636
SERVER_IP_INTERNAL=''
3737

38-
# 必填, 服务器域名, 若没有域名, 则填写公网IP
38+
# Required, server domain name, if there is no domain name, fill in the public IP
3939
SERVER_HOSTNAME='' # livedvr.tripsdd.com
4040

41-
# 必填, 证书文件的绝对路径, 排除.crt/.key后缀, nginx实际读取的是 ${SSL_CERTIFICATE}.crt ${SSL_CERTIFICATE}.key 两个文件
42-
# 如果使用http, 或者使用https但暂时没有申请到证书, 可以设置成内置的假证书: /home/docker/nginx/ssl/placeholder
43-
# 若使用crotbot自动申请证书, 需要先单独启动一次(docker compose up crotbot), 申请到的证书路径会在日志中打印, 然后将它添加到变量中, 一般为: /data/certbot/live/${SERVER_HOSTNAME}/certificate,
41+
# Required, absolute path of the certificate file, excluding .crt/.key suffix. nginx actually reads the two files ${SSL_CERTIFICATE}.crt and ${SSL_CERTIFICATE}.key
42+
# If using http, or using https but no certificate has been applied for temporarily, it can be set to the built-in fake certificate: /home/docker/nginx/ssl/placeholder
43+
# If using crotbot to automatically apply for a certificate, you need to start it separately first (docker compose up crotbot). The applied certificate path will be printed in the log, and then add it to the variable, generally: /data/certbot/live/${SERVER_HOSTNAME}/certificate,
4444
SSL_CERTIFICATE='' # /home/docker/nginx/ssl/placeholder
4545

46-
# bus和track部署在同一台服务器上时, 需要通过域名区分两者
46+
# When bus and track are deployed on the same server, they need to be distinguished by domain name
4747
BUS_HOSTNAME=${SERVER_HOSTNAME}
4848
BUS_SSL_CERTIFICATE=${SSL_CERTIFICATE}
4949
TRACK_HOSTNAME=${SERVER_HOSTNAME}
5050
TRACK_SSL_CERTIFICATE=${SSL_CERTIFICATE}
5151

52-
## 前端配置
52+
## Frontend Configuration
5353
WEB_PORT_HTTP=80
5454
WEB_PORT_HTTPS=443
55-
# 前端的公网URL
56-
# jtt808和maintain分开部署时, 必须填写这个变量
55+
# Frontend public URL
56+
# This variable must be filled in when jtt808 and maintain are deployed separately
5757
WEB_BASE_URL='' # https://livedvr.tripsdd.com
5858

59-
# certbot的配置
60-
# 注意: 修改这些配置之后, 必须强制重建(docker compose up --force-recreate certbot), 才会生效
59+
# certbot configuration
60+
# Note: After modifying these configurations, you must force recreation (docker compose up --force-recreate certbot) to take effect
6161
#
62-
# DNS解析的提供商, 常用的提供商如下:
62+
# DNS resolution provider, common providers are as follows:
6363
# - dnspod: https://console.dnspod.cn/account/token/token
6464
# - cloudflare: https://go-acme.github.io/lego/dns/cloudflare/
6565
# - tencentcloud: https://console.cloud.tencent.com/cam/capi
6666
CERTBOT_DNS_PROVIDER='dnspod'
67-
CERTBOT_DNS_API_KEY='' # 必填
68-
# tencentcloud还需要额外设置这个变量
67+
CERTBOT_DNS_API_KEY='' # Required
68+
# tencentcloud also needs to set this variable extra
6969
CERTBOT_TENCENTCLOUD_SECRET_ID=''
70-
# 接收证书过期提醒的email
70+
# Email to receive certificate expiration reminder
7171
CERTBOT_EMAIL='transcodegroupdeveloper@gmail.com'
7272

7373
## ================================ Services ================================
7474

75-
## 视频服务器
76-
# 必填, 视频公网IP, APP客户端和设备连接
75+
## Video Server
76+
# Required, video public IP, APP client and device connection
7777
VIDEO_IP=${SERVER_IP_PUBLIC}
78-
# 必填
78+
# Required
7979
VIDEO_HOSTNAME=${SERVER_HOSTNAME} # livedvr.tripsdd.com
80-
# 必填
80+
# Required
8181
VIDEO_SSL_CERTIFICATE=${SSL_CERTIFICATE} # /home/docker/video-nginx/ssl/livedvr_tripsdd_com
8282

83-
# 终端-实时直播端口
83+
# Terminal - Real-time Live Port
8484
VIDEO_PORT_LIVE=9000
85-
# 终端-录像回放端口
85+
# Terminal - Video Playback Port
8686
VIDEO_PORT_RECORD=9001
87-
# 终端-对讲
87+
# Terminal - Intercom
8888
VIDEO_PORT_TALK=9002
89-
# 终端-终端监听
89+
# Terminal - Terminal Monitor
9090
VIDEO_PORT_MONITOR=9003
91-
# rtmp端口(rtp和app使用)
91+
# rtmp port (used by rtp and app)
9292
VIDEO_PORT_RTMP=9005
9393

94-
# 前端和App对讲&flv的https端口,目前使用5个端口, 大于支持30个通道
95-
# 增加端口需要修改nginx的config和docker-compose.yml以及rtp服务映射
96-
VIDEO_PORT_HTTPS_0=9084 # 推荐443或者9084
94+
# HTTPS ports for Frontend and App intercom & flv, currently using 5 ports, supporting more than 30 channels
95+
# Adding ports requires modifying nginx config and docker-compose.yml as well as rtp service mapping
96+
VIDEO_PORT_HTTPS_0=9084 # Recommended 443 or 9084
9797
VIDEO_PORT_HTTPS_1=9085
9898
VIDEO_PORT_HTTPS_2=9086
9999
VIDEO_PORT_HTTPS_3=9087
100100
VIDEO_PORT_HTTPS_4=9088
101101
VIDEO_PORT_HTTPS_5=9089
102102

103-
## 网关服务器
104-
# 必填, 后端和流媒体服务往网关服务器注册或者下发指令
103+
## Gateway Server
104+
# Required, backend and streaming media services register or issue commands to the gateway server
105105
JTT808_HOST='jtt808'
106-
JTT808_IP=${SERVER_IP_PUBLIC} # 默认使用服务器公网IP,设备使用
106+
JTT808_IP=${SERVER_IP_PUBLIC} # Default use server public IP, for device use
107107
JTT808_PORT=9011
108108
JTT808_PORT_HTTP=9012
109109
JTT808_PORT_FILE=9013
@@ -119,62 +119,62 @@ MAINTAIN_PORT='8080'
119119
MYSQL_HOST='mysql8'
120120
MYSQL_PORT=3306
121121
MYSQL_USERNAME='root'
122-
MYSQL_PASSWORD='' # 必填
122+
MYSQL_PASSWORD='' # Required
123123

124124
## REDIS
125125
REDIS_HOST='redis'
126126
REDIS_PORT=6379
127-
REDIS_PASSWORD='' # 必填
127+
REDIS_PASSWORD='' # Required
128128

129129
## MongoDB
130130
MONGODB_HOST='mongodb'
131131
MONGODB_PORT=27017
132132
MONGODB_PORT_HTTP=15672
133133
MONGODB_USERNAME='root'
134-
MONGODB_PASSWORD='' # 必填
134+
MONGODB_PASSWORD='' # Required
135135

136136
## Rabbitmq
137137
RABBITMQ_HOST='rabbitmq'
138138
RABBITMQ_PORT=5672
139139
RABBITMQ_USERNAME='admin'
140-
RABBITMQ_PASSWORD='' # 必填
140+
RABBITMQ_PASSWORD='' # Required
141141

142142
## Minio
143143
MINIO_HOST='minio'
144144
MINIO_PORT=8000
145145
MINIO_PORT_HTTP=8001
146146
MINIO_USER=minioadmin
147-
MINIO_PASSWORD='' # 必填
148-
# MINIO_ACCESSKEY/SECRETKEY, 默认使用帐号&密码, 也可以在minio的管理后台创建一组新的KEY
147+
MINIO_PASSWORD='' # Required
148+
# MINIO_ACCESSKEY/SECRETKEY, default uses account & password, creating a new set of KEYs in minio management background is also possible
149149
MINIO_ACCESSKEY=${MINIO_USER}
150150
MINIO_SECRETKEY=${MINIO_PASSWORD}
151-
# MINIO ftp功能
151+
# MINIO ftp feature
152152
MINIO_FTP_PORT=8021
153153
MINIO_FTP_PASSIVE_PORT=8523-8529
154154

155-
## 邮件
156-
# 默认使用transcodegroup的邮箱
155+
## Email
156+
# Default uses transcodegroup email
157157
MAIL_HOST=smtp.transcodegroup.com
158158
MAIL_USERNAME=bus@transcodegroup.com
159-
# 必填, 需要去企业邮箱中创建密码
159+
# Required, need to create password in enterprise email
160160
MAIL_PASSWORD=''
161161

162-
## ================================ 版本号, 设为latest则使用最新版 ================================
162+
## ================================ Version, set to latest to use the latest version ================================
163163

164-
# bus, 版本号核对日期: 2025-12-23
165-
# bus前端
164+
# bus, version check date: 2025-12-23
165+
# bus frontend
166166
BUS_WEB_VERSION=5.32.0
167-
# bus的后端
167+
# bus backend
168168
BUS_GATEWAY_VERSION=1.24.0
169-
# 公交808-2019版本号
169+
# bus 808-2019 version
170170
BUS_GATEWAY_808_2019_VERSION=25.8.25
171-
# 公交主动安全版本号
171+
# bus active safety version
172172
BUS_GATEWAY_JSATL12_VERSION=23.1.21
173173

174-
# track, 版本号核对日期: 2025-12-01
175-
# track前端
174+
# track, version check date: 2025-12-01
175+
# track frontend
176176
TRACK_WEB_VERSION=1.60.1
177-
# track后端
177+
# track backend
178178
TRACK_MAINTAIN_VERSION=1.54.0
179-
# track网关
179+
# track gateway
180180
TRACK_JTT808_VERSION=1.24.1

README.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,102 @@
11
# docker
22

3-
docker配置文件仓库
3+
docker configuration repository
44

5-
## 部署
5+
## Deployment
66

7-
### 1. 初始化
7+
### 1. Initialization
88

99
```sh
1010
mkdir -p /home/docker-compose
1111
mkdir /data
1212
git clone https://github.com/TranscodeGroup/docker.git /home/docker
1313
```
1414

15-
### 2. 配置`compse.yaml`
15+
### 2. Configure `compose.yaml`
1616

17-
创建`/home/docker-compose/compose.yaml`文件, 参考如下示例:
17+
Create `/home/docker-compose/compose.yaml` file, refer to the following example:
1818

19-
**单机单独部署**:
19+
**Single machine separate deployment**:
2020

21-
- [bus-http](./examples/bus-http/compose.yaml): Bus http单机部署
22-
- [bus-https](./examples/bus-https/compose.yaml): Bus https单机部署
23-
- [track-http](./examples/track-http/compose.yaml): Tracker V2 http单机部署
24-
- [track-https](./examples/track-https/compose.yaml): Tracker V2 https单机部署
21+
- [bus-http](./examples/bus-http/compose.yaml): Bus http single machine deployment
22+
- [bus-https](./examples/bus-https/compose.yaml): Bus https single machine deployment
23+
- [track-http](./examples/track-http/compose.yaml): Tracker V2 http single machine deployment
24+
- [track-https](./examples/track-https/compose.yaml): Tracker V2 https single machine deployment
2525

26-
**分布式部署**:
26+
**Distributed deployment**:
2727

28-
- [video-storage](./examples/video-storage/compose.yaml): RTP存储
29-
- [video-stream](./examples/video-stream/compose.yaml): RTP视频
28+
- [video-storage](./examples/video-storage/compose.yaml): RTP storage
29+
- [video-stream](./examples/video-stream/compose.yaml): RTP video
3030

31-
### 3. 配置`.env`
31+
### 3. Configure `.env`
3232

33-
创建`/home/docker-compose/.env`文件, 参考[.env.default](./.env.default)复写需要改写的配置项.
33+
Create `/home/docker-compose/.env` file, refer to [.env.default](./.env.default) to override the configuration items that need to be changed.
3434

35-
`/home/docker-compose`中执行如下命令, 校验所有使用到的必填的值, 是否已经设置:
35+
Execute the following command in `/home/docker-compose` to verify whether all required values used have been set:
3636

3737
```sh
3838
docker compose config
3939
```
4040

41-
校验通过之后, 执行如下命令, 将compose配置导出成一个文件, 方便在更新compose文件后对比差异:
41+
After passing the verification, execute the following command to export the compose configuration to a file, so as to compare the differences after updating the compose file:
4242

4343
```sh
4444
docker compose config > compose-stack.yaml
4545
```
4646

47-
### 4. 配置前端
47+
### 4. Configure Frontend
4848

49-
前端复写目录, 用来放`_app.config.js`等项目特定的前端配置文件:
49+
Frontend override directory, used to place project-specific frontend configuration files such as `_app.config.js`:
5050

51-
- `/home/docker-compose/bus-override`: bus前端复写目录
52-
- `/home/docker-compose/track-override`: track前端复写目录
51+
- `/home/docker-compose/bus-override`: bus frontend override directory
52+
- `/home/docker-compose/track-override`: track frontend override directory
5353

54-
**注意**: 修改完配置后, 需要执行`docker compose up`, 文件才会被覆盖到`/data/nginx/html/`里面去. 因为是使用的覆盖的方式, 因此不建议直接修改`/data/nginx/html/`里面的文件.
54+
**Note**: After modifying the configuration, you need to execute `docker compose up` for the file to be overwritten to `/data/nginx/html/`. Because it uses the overwrite method, it is not recommended to directly modify the files in `/data/nginx/html/`.
5555

56-
### 5. 其他可选配置
56+
### 5. Other optional configurations
5757

58-
- [jtt808视频转换工具](./jtt808/README.md)
59-
- [手动下载前端](./scripts/README.md)
58+
- [jtt808 video conversion tool](./jtt808/README.md)
59+
- [Manually download frontend](./scripts/README.md)
6060

61-
### 6. 启动
61+
### 6. Start
6262

63-
`/home/docker-compose`中执行如下命令, 启动docker:
63+
Execute the following command in `/home/docker-compose` to start docker:
6464

6565
```sh
6666
docker compose up
6767
```
6868

69-
### 7. 使用git管理docker-compose目录
69+
### 7. Manage docker-compose directory with git
7070

71-
`/home/docker-compose`中执行如下命令
71+
Execute the following commands in `/home/docker-compose`
7272

7373
```sh
74-
# 切换到目录下面
74+
# Switch to the directory
7575
cd /home/docker-compose
7676

77-
# 每次修改配置之后, 记得备份一下配置, 方便对比实际影响差异
77+
# After modifying the configuration each time, remember to back up the configuration to compare the actual impact difference
7878
docker compose config > compose-stack.yaml
7979

80-
# 配置GIT账号
80+
# Configure GIT account
8181
git config --global user.name "tg"
8282
git config --global user.email tg@gmail.com
8383

84-
# 初始化GIT
84+
# Initialize GIT
8585
git init
86-
# 加入暂存区
86+
# Add to staging area
8787
git add -A
88-
# 提交本地仓库
89-
git commit -m "Initial commit(初始化仓库)"
88+
# Commit local warehouse
89+
git commit -m "Initial commit"
9090
```
9191

92-
## 注意事项
92+
## Precautions
9393

94-
### 版本管理, 版本迭代同时, 记得同步mysql下面的脚本
94+
### Version management, while iterating the version, remember to synchronize the scripts under mysql
9595

9696
```sh
97-
# bus前端
97+
# bus frontend
9898
BUS_WEB_VERSION=xxx
99-
# bus的后端
99+
# bus backend
100100
BUS_GATEWAY_VERSION=xxx
101101
#...
102102
```

0 commit comments

Comments
 (0)