diff --git a/docs/docker_deploy.md b/docs/docker_deploy.md index c9b069309..59f4c6e11 100644 --- a/docs/docker_deploy.md +++ b/docs/docker_deploy.md @@ -2,20 +2,51 @@ ## 部署步骤(推荐,但不一定是最新) -1. 获取配置文件: +1. 获取Docker配置文件: ```bash -wget https://raw.githubusercontent.com/SengokuCola/MaiMBot/main/docker-compose.yml +wget https://raw.githubusercontent.com/SengokuCola/MaiMBot/main/docker-compose.yml -O docker-compose.yml ``` -2. 启动服务: +### 1. 启动服务: + +- **!!! 请在第一次启动前确保当前工作目录下`.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工具替代 -3. 修改配置后重启: +### 2. 修改配置并重启Docker: + +- 请前往 [🎀 新手配置指南](docs/installation_cute.md) 或 [⚙️ 标准配置指南](docs/installation_standard.md) 完成`.env.prod`与`bot_config.toml`配置文件的编写\ +**需要注意`.env.prod`中HOST处IP的填写,Docker中部署和系统中直接安装的配置会有所不同** + +- 重启Docker容器: +```bash +docker restart maimbot # 若修改过容器名称则替换maimbot为你自定的名臣 +``` + +- 下方命令可以但不推荐,只是同时重启NapCat、MongoDB、MaiMBot三个服务 ```bash NAPCAT_UID=$(id -u) NAPCAT_GID=$(id -g) docker compose restart ``` +旧版Docker中可能找不到docker compose,请使用docker-compose工具替代 + +### 3. 登入NapCat管理页添加反向WebSocket + +- 在浏览器地址栏输入`http://<宿主机IP>:6099/`进入NapCat的管理Web页,添加一个Websocket客户端 +> 网络配置 -> 新建 -> Websocket客户端 + +- Websocket客户端的名称自定,URL栏填入`ws://maimbot:8080/onebot/v11/ws`,启用并保存即可\ +(若修改过容器名称则替换maimbot为你自定的名称) + +### 4. 愉快地和麦麦对话吧! ## ⚠️ 注意事项 diff --git a/docs/installation_cute.md b/docs/installation_cute.md index 278cbfe20..e7541f7d3 100644 --- a/docs/installation_cute.md +++ b/docs/installation_cute.md @@ -88,11 +88,11 @@ CHAT_ANY_WHERE_KEY=your_key CHAT_ANY_WHERE_BASE_URL=https://api.chatanywhere.tech/v1 # 如果你不知道这是什么,那么下面这些不用改,保持原样就好啦 -HOST=127.0.0.1 +HOST=127.0.0.1 # 如果使用Docker部署,需要改成0.0.0.0喵,不然听不见群友讲话了喵 PORT=8080 # 这些是数据库设置,一般也不用改呢 -MONGODB_HOST=127.0.0.1 +MONGODB_HOST=127.0.0.1 # 如果使用Docker部署,需要改成数据库容器的名字喵,默认是mongodb喵 MONGODB_PORT=27017 DATABASE_NAME=MegBot MONGODB_USERNAME = "" # 如果数据库需要用户名,就在这里填写喵 diff --git a/docs/installation_standard.md b/docs/installation_standard.md index 6e4920220..5f52676d1 100644 --- a/docs/installation_standard.md +++ b/docs/installation_standard.md @@ -52,11 +52,11 @@ CHAT_ANY_WHERE_KEY=your_key CHAT_ANY_WHERE_BASE_URL=https://api.chatanywhere.tech/v1 # 服务配置 -HOST=127.0.0.1 +HOST=127.0.0.1 # 如果使用Docker部署,需要改成0.0.0.0,否则QQ消息无法传入 PORT=8080 # 数据库配置 -MONGODB_HOST=127.0.0.1 +MONGODB_HOST=127.0.0.1 # 如果使用Docker部署,需要改成数据库容器的名字,默认是mongodb MONGODB_PORT=27017 DATABASE_NAME=MegBot MONGODB_USERNAME = "" # 数据库用户名