From 3bbb48dd2539946cc9e60e0f2cc48f7c1f421a80 Mon Sep 17 00:00:00 2001
From: Ju4tCode <42488585+yanyongyu@users.noreply.github.com>
Date: Mon, 3 Apr 2023 21:32:12 +0800
Subject: [PATCH] :memo: update deploy docs (#1890)
---
website/docs/best-practice/deployment.mdx | 48 ++++++++++++++++++++++-
1 file changed, 46 insertions(+), 2 deletions(-)
diff --git a/website/docs/best-practice/deployment.mdx b/website/docs/best-practice/deployment.mdx
index 0a137811..001577e6 100644
--- a/website/docs/best-practice/deployment.mdx
+++ b/website/docs/best-practice/deployment.mdx
@@ -94,28 +94,59 @@ nb docker up
当看到 `Running` 字样时，说明机器人已经启动成功。我们可以通过以下命令来查看机器人的运行日志：
+
+
+
```bash
nb docker logs
```
+
+
+
+```bash
+docker compose logs
+```
+
+
+
+
如果需要停止机器人，我们可以使用以下命令：
+
+
+
```bash
nb docker down
```
+
+
+
+```bash
+docker compose down
+```
+
+
+
+
### 自定义部署
-通常情况下，自动生成的配置文件并不能满足复杂场景，我们需要根据实际需求手动修改配置文件。使用以下命令来生成基础配置文件：
+在部分情况下，我们需要事先生成 Docker 配置文件，再到生产环境进行部署；或者自动生成的配置文件并不能满足复杂场景，需要根据实际需求手动修改配置文件。我们可以使用以下命令来生成基础配置文件：
```bash
nb docker generate
```
-nb-cli 将会在项目目录下生成 `docker-compose.yml` 和 `Dockerfile` 等配置文件，我们可以参考 [Dockerfile 文件规范](https://docs.docker.com/engine/reference/builder/)和 [Compose 文件规范](https://docs.docker.com/compose/compose-file/)修改这两个文件。
+nb-cli 将会在项目目录下生成 `docker-compose.yml` 和 `Dockerfile` 等配置文件。在 nb-cli 完成配置文件的生成后，我们可以根据部署环境的实际情况使用 nb-cli 或者 Docker Compose 来启动机器人。
+
+我们可以参考 [Dockerfile 文件规范](https://docs.docker.com/engine/reference/builder/)和 [Compose 文件规范](https://docs.docker.com/compose/compose-file/)修改这两个文件。
修改完成后我们可以直接启动或者手动构建镜像：
+
+
+
```bash
# 启动机器人
nb docker up
@@ -123,6 +154,19 @@ nb docker up
nb docker build
```
+
+
+
+```bash
+# 启动机器人
+docker compose up -d
+# 手动构建镜像
+docker compose build
+```
+
+
+
+
### 持续集成
我们可以使用 GitHub Actions 来实现持续集成（CI），我们只需要在 GitHub 上发布 Release 即可自动构建镜像并推送至镜像仓库。