diff --git a/website/docs/cli/tailchat-cli.md b/website/docs/cli/tailchat-cli.md index 5f349e59..94d370ff 100644 --- a/website/docs/cli/tailchat-cli.md +++ b/website/docs/cli/tailchat-cli.md @@ -9,6 +9,11 @@ title: 命令行工具 tailchat-cli npm install -g tailchat-cli@latest # 安装与更新同一命令 ``` +或直接使用 +```bash +npx tailchat-cli +``` + 安装成功后输入`tailchat` 后返回如下 ```bash diff --git a/website/docs/deployment/assets/docker-init.png b/website/docs/deployment/assets/docker-init.png new file mode 100644 index 00000000..2d588b7d Binary files /dev/null and b/website/docs/deployment/assets/docker-init.png differ diff --git a/website/docs/deployment/docker-compose.mdx b/website/docs/deployment/docker-compose.mdx index f64acb10..ac46c8d7 100644 --- a/website/docs/deployment/docker-compose.mdx +++ b/website/docs/deployment/docker-compose.mdx @@ -24,15 +24,26 @@ title: Docker Compose 部署 你可以通过从**公共镜像拉取已经编译好的镜像**或者**通过源码手动编译** +> 使用已经编译好的镜像可以无需花费足够的计算机资源进行编译,对小资源配置的服务器会十分友好。另外相对于源码编译,公共镜像的代码更加稳定。 import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; - + -> 使用已经编译好的镜像可以无需花费足够的计算机资源进行编译,对小资源配置的服务器会十分友好。另外相对于源码编译,公共镜像的代码更加稳定。 +> 使用 `cli` 请确保在你的服务器上已经拥有了node环境(建议node版本 16+) +> 如果对node不了解可以使用`从公共镜像中手动安装`方式 + +使用 命令行工具 tailchat-cli 一键拉取/更新镜像: +```bash +npx tailchat-cli docker update +``` + + + +使用Docker原生命令手动安装: ```bash docker pull moonrailgun/tailchat # 从公共镜像库拉取 tailchat镜像 docker tag moonrailgun/tailchat tailchat # 将下载的镜像改名为tailchat(和源码编译保持一致,如果不改的话会走源码编译流程) @@ -88,7 +99,19 @@ cd tailchat && docker compose build ## 启动项目 - + + +```bash +npx tailchat-cli docker init +``` + +执行该命令会以交互式的方式向你询问一些配置相关的问题(如下图),填写完毕后即可自动生成配置文件 + +![](./assets/docker-init.png) + + + + > 启动之前需要下载配置文件以告知 `docker-compose` 要如何启动镜像 > 从仓库下载配置文件与配置环境变量: @@ -101,14 +124,16 @@ wget https://raw.githubusercontent.com/msgbyte/tailchat/master/docker-compose.ym wget https://raw.githubusercontent.com/msgbyte/tailchat/master/docker-compose.env ``` +在启动之前需要修改一下配置 - - +修改 `docker-compose.env` 文件的配置,以下字段推荐修改: - - +- `API_URL` 对外可访问的url地址,用于文件服务访问, 可以是域名也可以是ip +- `SECRET` 服务端加密秘钥,用于生成Token. 默认为 `tailchat` + + 在启动之前需要修改一下配置 @@ -117,6 +142,12 @@ wget https://raw.githubusercontent.com/msgbyte/tailchat/master/docker-compose.en - `API_URL` 对外可访问的url地址,用于文件服务访问, 可以是域名也可以是ip - `SECRET` 服务端加密秘钥,用于生成Token. 默认为 `tailchat` + + + + + + 完成配置后使用`docker-compose` 一键启动 `Tailchat` 应用: ```bash