From 2098873cf29a25fc72993847b6a6d236a0b104d5 Mon Sep 17 00:00:00 2001 From: Richard Chien Date: Mon, 23 Dec 2019 15:55:20 +0800 Subject: [PATCH] Update advanced docs --- docs/.vuepress/config.js | 1 + docs/advanced/deployment.md | 9 +++++---- docs/advanced/server-app.md | 5 +++++ 3 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 docs/advanced/server-app.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index a0e98d57..d20fd38b 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -66,6 +66,7 @@ module.exports = { 'permission', 'decorator', 'database', + 'server-app', 'scheduler', 'logging', 'configuration', diff --git a/docs/advanced/deployment.md b/docs/advanced/deployment.md index 98692f1e..97c1461b 100644 --- a/docs/advanced/deployment.md +++ b/docs/advanced/deployment.md @@ -34,9 +34,9 @@ hypercorn run:app ## 使用 Docker Compose 与 酷Q 同时部署 -Docker Compose是 docker 提供的一个命令行工具,用来定义和运行由多个容器组成的应用。通过建立一个名为`docker-compose.yml`的文件,可以将部署过程中需要的参数记录在其中,并由单个命令完成应用的创建和启动。 +Docker Compose 是 Docker 官方提供的一个命令行工具,用来定义和运行由多个容器组成的应用。通过建立一个名为 `docker-compose.yml` 的文件,可以将部署过程中需要的参数记录在其中,并由单个命令完成应用的创建和启动。 -`docker-compose.yml`文件的样例如下: +`docker-compose.yml` 文件的示例如下: ```yaml version: "3" @@ -67,7 +67,8 @@ services: - "./qbot:/root/qbot" # 项目文件所在目录 command: python3 /root/qbot/bot.py ``` -部分说明见注释。nonebot运行环境由文件`./nonebot/Dockerfile`构建。如果项目中使用了第三方库,可以在这一步骤进行安装。`Dockerfile`内容举例: + +部分说明见注释。NoneBot 运行环境由文件 `./nonebot/Dockerfile` 控制构建。如果项目中使用了第三方库,可以在这一步骤进行安装。`Dockerfile` 内容例如: ```Dockerfile FROM alpine @@ -75,4 +76,4 @@ RUN apk add --no-cache tzdata python3 py3-multidict py3-yarl && \ pip3 install --no-cache-dir "nonebot[scheduler]" ``` -上述文件编辑完成后,输入命令`docker-compose up -d`在后台启动。其他Docker Compose用法见[官方文档](https://docs.docker.com/compose/reference/overview/)。 +上述文件编辑完成后,输入命令 `docker-compose up` 即可一次性启动酷Q和 NoneBot(可通过 `docker-compose up -d` 在后台启动。更多 Docker Compose 用法见 [官方文档](https://docs.docker.com/compose/reference/overview/)。 diff --git a/docs/advanced/server-app.md b/docs/advanced/server-app.md new file mode 100644 index 00000000..94443f83 --- /dev/null +++ b/docs/advanced/server-app.md @@ -0,0 +1,5 @@ +# Server App + +如果需要对 web 框架进行更详细的控制,可以通过 `bot.server_app` 访问到内部的 Quart 对象,之后可以像使用 Quart 的 app 对象一样添加路由、设置生命周期处理函数等。 + +## 自定义路由