Merge pull request #178 from Yan233th/debug

Docker部署文档追加更新部分，修复一些小问题
2025-03-11 03:34:57 +08:00
parent a78b93f3da 0f99d6a5b2
commit 0168f4ebdb
6 changed files with 61 additions and 34 deletions
--- a/README.md
+++ b/README.md
@@ -51,7 +51,7 @@

 ### 部署方式

-  📦 **Windows 一键傻瓜式部署**：请运行项目根目录中的 ```run.bat```，部署完成后请参照后续配置指南进行配置
+-  📦 **Windows 一键傻瓜式部署**：请运行项目根目录中的 `run.bat`，部署完成后请参照后续配置指南进行配置

 - [📦 Windows 手动部署指南 ](docs/manual_deploy_windows.md)

--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -6,8 +6,6 @@ services:
      - NAPCAT_UID=${NAPCAT_UID}
      - NAPCAT_GID=${NAPCAT_GID} # 让 NapCat 获取当前用户 GID,UID，防止权限问题
    ports:
-      - 3000:3000
-      - 3001:3001
      - 6099:6099
    restart: unless-stopped
    volumes:
--- a/docs/docker_deploy.md
+++ b/docs/docker_deploy.md
@@ -1,63 +1,93 @@
 # 🐳 Docker 部署指南

-## 部署步骤（推荐，但不一定是最新）
+## 部署步骤 (推荐，但不一定是最新)
+
+**"更新镜像与容器"部分在本文档 [Part 6](#6-更新镜像与容器)**
+
+### 0. 前提说明
+
+**本文假设读者已具备一定的 Docker 基础知识。若您对 Docker 不熟悉，建议先参考相关教程或文档进行学习，或选择使用 [📦Linux手动部署指南](./manual_deploy_linux.md) 或 [📦Windows手动部署指南](./manual_deploy_windows.md) 。**


-### 1. 获取Docker配置文件:
+### 1. 获取Docker配置文件
+
+- 建议先单独创建好一个文件夹并进入，作为工作目录

 ```bash
 wget https://raw.githubusercontent.com/SengokuCola/MaiMBot/main/docker-compose.yml -O docker-compose.yml
 ```

- 若需要启用MongoDB数据库的用户名和密码，可进入docker-compose.yml，取消MongoDB处的注释并修改变量`=`后方的值为你的用户名和密码\
-修改后请注意在之后配置`.env.prod`文件时指定MongoDB数据库的用户名密码
+- 若需要启用MongoDB数据库的用户名和密码，可进入docker-compose.yml，取消MongoDB处的注释并修改变量旁 `=` 后方的值为你的用户名和密码\
+修改后请注意在之后配置 `.env.prod` 文件时指定MongoDB数据库的用户名密码


-### 2. 启动服务:
+### 2. 启动服务

- **!!! 请在第一次启动前确保当前工作目录下`.env.prod`与`bot_config.toml`文件存在 !!!**\
+- **!!! 请在第一次启动前确保当前工作目录下 `.env.prod` 与 `bot_config.toml` 文件存在 !!!**\
 由于Docker文件映射行为的特殊性，若宿主机的映射路径不存在，可能导致意外的目录创建，而不会创建文件，由于此处需要文件映射到文件，需提前确保文件存在且路径正确，可使用如下命令:
+
 ```bash
 touch .env.prod
 touch bot_config.toml
 ```

 - 启动Docker容器:
+
 ```bash
 NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker compose up -d
+# 旧版Docker中可能找不到docker compose，请使用docker-compose工具替代
+NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker-compose up -d
 ```

- 旧版Docker中可能找不到docker compose，请使用docker-compose工具替代

+### 3. 修改配置并重启Docker

-### 3. 修改配置并重启Docker:
-
- 请前往 [🎀 新手配置指南](docs/installation_cute.md) 或 [⚙️ 标准配置指南](docs/installation_standard.md) 完成`.env.prod`与`bot_config.toml`配置文件的编写\
-**需要注意`.env.prod`中HOST处IP的填写，Docker中部署和系统中直接安装的配置会有所不同**
+- 请前往 [🎀新手配置指南](./installation_cute.md) 或 [⚙️标准配置指南](./installation_standard.md) 完成 `.env.prod` 与 `bot_config.toml` 配置文件的编写\
+**需要注意 `.env.prod` 中HOST处IP的填写，Docker中部署和系统中直接安装的配置会有所不同**

 - 重启Docker容器:
+
 ```bash
-docker restart maimbot  # 若修改过容器名称则替换maimbot为你自定的名臣
+docker restart maimbot  # 若修改过容器名称则替换maimbot为你自定的名称
 ```

 - 下方命令可以但不推荐，只是同时重启NapCat、MongoDB、MaiMBot三个服务
+
 ```bash
 NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker compose restart
+# 旧版Docker中可能找不到docker compose，请使用docker-compose工具替代
+NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker-compose restart
 ```

- 旧版Docker中可能找不到docker compose，请使用docker-compose工具替代
-

 ### 4. 登入NapCat管理页添加反向WebSocket

- 在浏览器地址栏输入`http://<宿主机IP>:6099/`进入NapCat的管理Web页，添加一个Websocket客户端
+- 在浏览器地址栏输入 `http://<宿主机IP>:6099/` 进入NapCat的管理Web页，添加一个Websocket客户端
+
 > 网络配置 -> 新建 -> Websocket客户端

- Websocket客户端的名称自定，URL栏填入`ws://maimbot:8080/onebot/v11/ws`，启用并保存即可\
+- Websocket客户端的名称自定，URL栏填入 `ws://maimbot:8080/onebot/v11/ws`，启用并保存即可\
 (若修改过容器名称则替换maimbot为你自定的名称)


-### 5. 愉快地和麦麦对话吧!
+### 5. 部署完成，愉快地和麦麦对话吧!
+
+
+### 6. 更新镜像与容器
+
+- 拉取最新镜像
+
+```bash
+docker-compose pull
+```
+
+- 执行启动容器指令，该指令会自动重建镜像有更新的容器并启动
+
+```bash
+NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker compose up -d
+# 旧版Docker中可能找不到docker compose，请使用docker-compose工具替代
+NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker-compose up -d
+```


 ## ⚠️ 注意事项
--- a/docs/installation_standard.md
+++ b/docs/installation_standard.md
@@ -8,7 +8,7 @@

 ## API配置说明

-`.env.prod`和`bot_config.toml`中的API配置关系如下：
+`.env.prod` 和 `bot_config.toml` 中的API配置关系如下：

 ### 在.env.prod中定义API凭证：
 ```ini
--- a/docs/manual_deploy_linux.md
+++ b/docs/manual_deploy_linux.md
@@ -66,7 +66,7 @@ pip install -r requirements.txt

 ## 数据库配置
 ### 3️⃣ **安装并启动MongoDB**
- 安装与启动：Debian参考[官方文档](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-debian/)，Ubuntu参考[官方文档](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/)
+- 安装与启动: Debian参考[官方文档](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-debian/)，Ubuntu参考[官方文档](https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/)

 - 默认连接本地27017端口
 ---
@@ -76,15 +76,14 @@ pip install -r requirements.txt

 - 参考[NapCat官方文档](https://www.napcat.wiki/guide/boot/Shell#napcat-installer-linux%E4%B8%80%E9%94%AE%E4%BD%BF%E7%94%A8%E8%84%9A%E6%9C%AC-%E6%94%AF%E6%8C%81ubuntu-20-debian-10-centos9)安装

-  使用QQ小号登录，添加反向WS地址：
-`ws://127.0.0.1:8080/onebot/v11/ws`
+-  使用QQ小号登录，添加反向WS地址: `ws://127.0.0.1:8080/onebot/v11/ws`

 ---

 ## 配置文件设置
 ### 5️⃣ **配置文件设置，让麦麦Bot正常工作**
- 修改环境配置文件：`.env.prod`
- 修改机器人配置文件：`bot_config.toml`
+- 修改环境配置文件: `.env.prod`
+- 修改机器人配置文件: `bot_config.toml`


 ---
@@ -107,9 +106,9 @@ python3 bot.py
 ---

 ## 常见问题
-🔧 权限问题：在命令前加`sudo`  
-🔌 端口占用：使用`sudo lsof -i :8080`查看端口占用  
-🛡️ 防火墙：确保8080/27017端口开放  
+🔧 权限问题: 在命令前加 `sudo`  
+🔌 端口占用: 使用 `sudo lsof -i :8080` 查看端口占用  
+🛡️ 防火墙: 确保8080/27017端口开放  
 ```bash
 sudo ufw allow 8080/tcp
 sudo ufw allow 27017/tcp
--- a/docs/manual_deploy_windows.md
+++ b/docs/manual_deploy_windows.md
@@ -30,7 +30,7 @@

 在创建虚拟环境之前，请确保你的电脑上安装了Python 3.9及以上版本。如果没有，可以按以下步骤安装：

-1. 访问Python官网下载页面：https://www.python.org/downloads/release/python-3913/
+1. 访问Python官网下载页面: https://www.python.org/downloads/release/python-3913/
 2. 下载Windows安装程序 (64-bit): `python-3.9.13-amd64.exe`
 3. 运行安装程序，并确保勾选"Add Python 3.9 to PATH"选项
 4. 点击"Install Now"开始安装
@@ -79,11 +79,11 @@ pip install -r requirements.txt

 ### 3️⃣ **配置NapCat，让麦麦bot与qq取得联系**
 - 安装并登录NapCat（用你的qq小号）
- 添加反向WS：`ws://127.0.0.1:8080/onebot/v11/ws`
+- 添加反向WS: `ws://127.0.0.1:8080/onebot/v11/ws`

 ### 4️⃣ **配置文件设置，让麦麦Bot正常工作**
- 修改环境配置文件：`.env.prod`
- 修改机器人配置文件：`bot_config.toml`
+- 修改环境配置文件: `.env.prod`
+- 修改机器人配置文件: `bot_config.toml`

 ### 5️⃣ **启动麦麦机器人**
 - 打开命令行，cd到对应路径