docs: 更新文档文件清单和可调参数表,同步代码重构

This commit is contained in:
2026-06-08 10:33:36 +08:00
parent 3f7ebfb52e
commit e421c43a40
3 changed files with 16 additions and 9 deletions
+8 -5
View File
@@ -22,7 +22,9 @@ MineSentinel 是一个 Minecraft 服务器守护进程,每 1.5 秒检测服务
/opt/minecraft/sentinel/ # 推荐部署目录
├── main.rb # 主程序入口 —— 检测循环 + 冷却期 + 初始宽限期
├── method_executor.rb # 日志系统 + 重启逻辑 + 重试计数器
── server_status_detector.rb # TCP 端口检测模块
── server_status_detector.rb # TCP 端口检测模块
├── systemd_notifier.rb # systemd watchdog 心跳发送
└── config.rb # 可调参数配置
minesentinel.service # systemd 单元文件(项目源码中)
```
@@ -35,7 +37,7 @@ minesentinel.service # systemd 单元文件(项目源码中)
```bash
mkdir -p /opt/minecraft/sentinel
cp main.rb method_executor.rb server_status_detector.rb /opt/minecraft/sentinel/
cp main.rb method_executor.rb server_status_detector.rb systemd_notifier.rb config.rb /opt/minecraft/sentinel/
```
### 2. 确认 Minecraft systemd 服务存在
@@ -132,9 +134,10 @@ MineSentinel 启动:
| 参数 | 文件 | 行 | 默认值 |
|------|------|-----|--------|
| 初始宽限期 | `main.rb` | 31 | `300` s |
| 检测间隔 | `main.rb` | 69 | `1.5` s |
| 冷却期 | `main.rb` | 58 | `200` s |
| 初始宽限期 | `config.rb` | 1 | `300` s |
| 冷却期 | `config.rb` | 3 | `200` s |
| 尝试次数 | `config.rb` | 2 | `3` |
| 检测间隔 | `main.rb` | 90 | `1.5` s |
| systemctl 超时 | `method_executor.rb` | 17 | `30` s |
| 最大重试 | `method_executor.rb` | 23 | `10` 次 |
| 检测端口 | `server_status_detector.rb` | 60 | `25565` |
+5 -3
View File
@@ -535,6 +535,7 @@
<p style="margin-bottom:6px;">方式二:手动复制</p>
<pre>mkdir -p /opt/minecraft/sentinel
cp main.rb method_executor.rb server_status_detector.rb \
systemd_notifier.rb config.rb \
/opt/minecraft/sentinel/</pre>
<h3>3. 手动测试</h3>
@@ -587,9 +588,10 @@ journalctl -u minesentinel -u minecraft -f # 双服务合并</pre>
<h3>⚙️ 可调参数</h3>
<table>
<tr><th>参数</th><th>文件</th><th></th><th>默认</th></tr>
<tr><td>初始宽限期</td><td>main.rb</td><td>31</td><td>300 s</td></tr>
<tr><td>检测间隔</td><td>main.rb</td><td>69</td><td>1.5 s</td></tr>
<tr><td>冷却期</td><td>main.rb</td><td>58</td><td>200 s</td></tr>
<tr><td>初始宽限期</td><td>config.rb</td><td>1</td><td>300 s</td></tr>
<tr><td>冷却期</td><td>config.rb</td><td>3</td><td>200 s</td></tr>
<tr><td>尝试次数</td><td>config.rb</td><td>2</td><td>3 次</td></tr>
<tr><td>检测间隔</td><td>main.rb</td><td>90</td><td>1.5 s</td></tr>
<tr><td>systemctl 超时</td><td>method_executor.rb</td><td>17</td><td>30 s</td></tr>
<tr><td>最大重试</td><td>method_executor.rb</td><td>23</td><td>10 次</td></tr>
<tr><td>检测端口</td><td>server_status_detector.rb</td><td>60</td><td>25565</td></tr>
+3 -1
View File
@@ -16,7 +16,7 @@ Minecraft 服务器守护进程
```bash
# 复制文件
mkdir -p /opt/minecraft/sentinel
cp main.rb method_executor.rb server_status_detector.rb /opt/minecraft/sentinel/
cp main.rb method_executor.rb server_status_detector.rb systemd_notifier.rb config.rb /opt/minecraft/sentinel/
# 安装 systemd 服务
cp minesentinel.service /etc/systemd/system/
@@ -61,6 +61,8 @@ MineSentinel 通过 `Before=minecraft.service` 确保先于 MC 启动,避免 M
| `main.rb` | 主循环、冷却期控制、初始宽限期 |
| `method_executor.rb` | 日志系统、systemctl 重启、计数器 |
| `server_status_detector.rb` | TCP 端口检测模块 |
| `systemd_notifier.rb` | systemd watchdog 心跳发送 |
| `config.rb` | 可调参数配置 |
| `minesentinel.service` | systemd 单元文件(独立源码) |
## 完整文档