本项目的配置文件全放在configs目录下：
api_configs.json- 主配置文件secret_configs.json- 用于存放敏感信息(secrets)的配置文件status_codes.json- 状态码对应的信息的配置文件user_tokens.json- 用户访问令牌的配置文件
接下来分几节简述一下这几个配置文件。
这个配置是本项目的核心配置，牵涉到主控端与实例端。
{
"api_port": 2333, // HTTP API服务监听的端口
"ws_port": 2334, // 日志WebSocket服务(用于传输Minecraft服务器日志)监听的端口
"ws_ping_timeout": 20000, // 日志WebSocket连接的ping超时时间，用于判断连接是否死亡
"logs_dir": "./api_logs", // 本项目日志的存放目录
"rows_per_log": 200, // 每个日志文件最多储存的行数
"max_logs_retained": 30, // 最多保留的**旧**日志文件数量
"qcloud": { // 腾讯云API相关配置(取决于模块qcloud.js)
// (用于筛选实例)待申请的实例的地域
"region": "ap-chengdu",
// (用于筛选实例)实例族的正则表达式（反斜杠\要转义，比如表达\，需要使用\\）
"instance_family_regex": "^SA?\\d$",
// (用于筛选实例)待申请实例的CPU核数
"instance_cpu": 2,
// (用于筛选实例)待申请实例的内存大小，单位为GB
"instance_memory": 4,
// (用于筛选实例)待申请实例的**内网**带宽的**最小值**，单位为Gbps
"instance_bandwidth": 1,
// (用于筛选实例)待申请实例的价格区间，单位为CNY元
"hour_price_range": [0, 0.2],
// 腾讯云项目ID（十分重要！）
"project_id": 1275260,
// 腾讯云镜像ID，用于启动实例，建议是自制镜像
"image_id": "img-rhstpokr",
// 待创建实例的系统盘配置，可以留system_disk:null，会默认分配系统盘
"system_disk": {
// 系统盘类型（详见腾讯云文档）
"disk_type": "CLOUD_SSD",
// 系统盘大小，单位为GB
"disk_size": 50
},
// 实例绑定的私有网络配置
// 全部留DEFAULT，即为默认私网
"vpc": {
// 私有网络的ID
"vpc_id": "DEFAULT",
// 子网的ID
"subnet_id": "DEFAULT"
},
// 实例最大出网带宽，单位为Mbps
"max_bandwidth_out": 5,
// 实例绑定的安全组id
"security_group_id": "sg-c76uww9x",
// 实例主机名
"host_name": "bottlem",
// 最高竞价出价，单位为CNY元
"max_spot_price": 0.3
},
// 新建实例后，等待实例进入RUNNING(运行中)状态的最大时间，单位为毫秒
"instance_run_timeout": 90000,
// 每次建立SSH连接失败后重试的次数
"ssh_connect_retry": 3,
// 建立SSH连接时的超时时间，单位为毫秒
"ssh_ready_timeout": 20000,
// 保持SSH连接的心跳间隔，单位为毫秒
"ssh_keep_alive_interval": 8000,
// 部署实例端InsSide的脚本，位于./scripts目录下
"instance_deploy_sh": "set_up_base.sh",
// 每次连接实例端WebSocket失败时重试的次数
"instance_ws_connect_retry": 3,
// 主控端临时用户访问令牌的配置
"tokens": {
// 令牌的有效期，单位为毫秒
"default_validity": 720000,
// 最大允许有多少个临时令牌
"max_temp_tokens_num": 200,
// 临时令牌拥有的权限节点
"temp_permissions": [
"server.normal.launch",
"server.query.mc"
]
},
// 实例端InsSide的配置
"ins_side": {
// 实例端WebSocket服务监听的端口
"ws_port": 9527,
// 连接实例端WebSocket的超时时间，单位为毫秒
"ws_ping_timeout": 20000,
// 部署脚本和基本配置文件在实例端的存放目录
// 必须是绝对路径
"data_dir": "/root/baseData",
// 部署Minecraft服务器的脚本，位于主控端./scripts目录下
"deploy_scripts": [
"setup_cos.sh",
"get_server.sh"
],
// 启动Minecraft服务器的脚本，位于主控端./scripts目录下
"launch_script": "launch_server.sh",
// Minecraft服务器相关的脚本，位于主控端./scripts目录下
"server_scripts": {
// 检查Minecraft服务器Java进程是否存在的脚本
"check_process": "check_process.sh",
// 检查竞价实例是否即将被腾讯云回收的脚本
"check_termination": "check_termination.sh"
},
// 增量备份相关的配置
"incremental_backup": {
// 是否开启增量备份（建议是开启）
"enable": true,
// 增量备份的间隔时间，单位为毫秒
"interval": 600000,
// 增量备份在实例端的存放目录
// 必须是绝对路径
"dest_dir": "/root/increments",
// 增量备份相关脚本，位于主控端./scripts目录下
"scripts": {
// 上传增量备份的脚本
"backup": "incre_backup.sh",
// 下载增量备份的脚本
"restore": "incre_restore.sh",
// 抛弃增量备份的脚本
"discard": "incre_discard.sh"
},
// 增量备份针对的目录
// 必须是绝对路径
"src_dirs": [
"/root/minecraft/world",
"/root/minecraft/world_nether",
"/root/minecraft/world_the_end"
]
},
// Minecraft服务器关闭后操作的相关脚本，位于主控端./scripts目录下
"server_ending_scripts": {
// 对Minecraft服务端进行打包的脚本
"pack": "compress_and_pack.sh",
// 上传打包后的文件的脚本
"upload": "upload_server.sh"
},
// RCON配置，RCON用于控制Minecraft服务器
"rcon": {
// Minecraft服务器的rcon端口
"port": 25575,
// Minecraft服务器的rcon密码
"password": "123456"
},
// Minecraft服务器最新日志文件的绝对路径，用于监视
"mc_server_log": "/root/minecraft/logs/latest.log",
// Minecraft服务器文件压缩包所在目录，无论是刚刚开始部署的解包，还是服务器关闭后的打包，都是在这个目录内进行的，另外程序可能还会扫描该目录内压缩包总大小，在服务器关闭打包后进行比对
// 必须是绝对路径
"packed_server_dir": "/root/serverPacked",
// Minecraft服务端所在目录
"mc_server_dir": "/root/minecraft",
// 上述所有脚本执行时的工作目录(Working Directory)
"script_exec_dir": "/root",
// 等待Minecraft服务器启动的超时时间，单位为毫秒
"mc_server_launch_timeout": 90000,
// Minecraft处于无人状态下的最长空闲时间，单位为毫秒
"server_idling_timeout": 900000,
// 有玩家登入后，是否重置Minecraf服务器目前已经空闲了的时长
"player_login_reset_timeout": true,
// 最后上传压缩包前检查的压缩包大小一定要大于 **最初部署服务器时的压缩包大小** 的百分之多少
"check_packed_server_size": 90
}
}注释中已经写清了配置项各自的作用，接下来提一些值得注意的地方。
除了instance_deploy_sh配置项的脚本外，其他脚本执行时均有环境变量。
-
公共环境变量
所有
instance_deploy_sh外的脚本都有以下环境变量：环境变量名 内容 DATA_DIR同 ins_side配置中的data_dir，代表实例端的数据目录，所有的Shell脚本和配置文件都存在这个目录中PACK_DIR同 ins_side配置中的packed_server_dir，代表Minecraft压缩包存放的目录MC_DIR同 ins_side配置中的mc_server_dir，代表Minecraft服务端所在的目录TIMESTAMP执行脚本时的毫秒级时间戳 -
qcloud.js模块定义的环境变量环境变量名 内容 QCLOUD_SECRET_ID腾讯云API密钥ID QCLOUD_SECRET_KEY腾讯云API密钥KEY -
增量备份
incremental_backup配置中的脚本的共有环境变量环境变量名 内容 BACKUP_DEST_DIR增量备份的文件的存放目录 RESTORE_DEST_DIR增量备份还原的文件的存放目录 -
增量备份配置的
backup和restore脚本中的特有环境变量环境变量名 内容 BACKUP_NAME当前新建/还原的增量备份的文件名，不包括扩展名 -
增量备份配置的
discard脚本中的特有环境变量:环境变量名 内容 BACKUP_NAME_LIST当前要删除的增量备份的文件名列表(空格分隔)，不包括扩展名
-
配置项
qcloud中的project_id一定一定不要填写你腾讯云账户的默认项目的id！请务必自行建立新项目，不然可能会出现默认项目下的资源被删除的情况！注：腾讯云的项目管理在腾讯云-控制台-右上角头像-下拉菜单这里。
-
建议使用腾讯云子账户进行访问控制，别忘了给子账户授予CVM、COS服务的访问权限。
-
对于配置项
qcloud中的image_id，建议采用自制镜像。在将环境全部预装好的情况下，能极大程度上提升部署速度。 -
编写部署用的
Shell脚本时一定要注意行尾序列是LF还是CRLF，如果是CRLF可能导致脚本执行出错! -
实例端因Shell脚本问题导致错误后会中止部署，请多次测试部署脚本，保证脚本不要抛出错误。（本项目的
./scripts下有一套现成脚本可供参考使用） -
配置项
check_packed_server_size不为0时，部署脚本（参考get_server.sh的注释）在下载压缩包并解压后不要将其删除了，实例端需要记录一下文件大小！check_packed_server_size为0的时候，实例端程序不会自动删除上述压缩包，需要自行在脚本中对压缩包进行删除。 -
配置实例的安全组的时候一定要记得开放
ins_side配置的WebSocket服务端口ws_port。不要在安全组中开放
RCON端口！RCON端口供实例端本地访问，如果开放到公网上是有隐患的！ -
如果主控端(Backend)所处主机和实例之间的网络容易发生波动，建议提高
ssh_connect_retry，而稍微降低ssh_ready_timeout。
这个配置文件储存的是SECRET KEY这类敏感信息，请谨慎处置！
{
// qcloud.js模块接受的API secretKey配置
"qcloud": {
// 可以从腾讯云控制台-访问管理-访问密匙中获取到
"secretId": "wejOHzhj7686RhsH887UH899S78jauydY",
"secretKey": "9uYhFXghHjs64He9iHgaj6HgJ3Ad54Ac"
}
}这个配置文件主要针对每个状态码的对应消息进行配置，这里列出其中的一项：
"2102": {
"msg": "Deliverying the Deploy Script of the InsSide...",
"inform": false
},msg- 该状态码对应的消息，会在控制台和日志以及主控端状态文件中输出。inform- 是否通知用户（这只是个建议用的属性，实际上可能并没有什么卵用，取决于具体实现）
用于储存用于访问主控端的用户令牌，这个配置文件中的令牌没有过期时间，请谨慎对待。
{
"tokens": {
"moderator1": "rjoijrfuiwrjfwhfuiwhfiuewf",
"visitor": "sqmhuihiunuuidhe&^hunuhudw"
},
"permissions": {
"moderator1": [
// moderator1拥有所有节点的访问权限
"backend.*",
"websocket.mclog.receive",
"server.*"
],
"visitor": [
// visitor只能访问查询Minecraft服务器状态的节点
"server.query.mc"
]
}
}-
tokens- 配置用户令牌。键为用户名，值为令牌。 -
permissions- 配置用户拥有的权限。键为用户名，值为用户拥有的权限节点组成的数组。
关于节点和节点对应的权限，详见这个文档。