diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 1ec38db03..21333937b 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -131,6 +131,10 @@ export default defineConfig({ text: "修改对话流水线", link: "/zh/deploy/pipelines/readme", }, + { + text: "系统环境设置", + link: "/zh/deploy/settings", + }, { text: "更新 LangBot", link: "/zh/deploy/update", diff --git a/docs/assets/image/insight/group_chat.png b/docs/assets/image/insight/group_chat.png new file mode 100644 index 000000000..f51bd0d13 Binary files /dev/null and b/docs/assets/image/insight/group_chat.png differ diff --git a/docs/assets/image/insight/private_chat.png b/docs/assets/image/insight/private_chat.png new file mode 100644 index 000000000..d45065784 Binary files /dev/null and b/docs/assets/image/insight/private_chat.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..8c7b3173f --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ + diff --git a/docs/zh/deploy/settings.md b/docs/zh/deploy/settings.md new file mode 100644 index 000000000..db9d1a330 --- /dev/null +++ b/docs/zh/deploy/settings.md @@ -0,0 +1,97 @@ +# 系统环境设置 + +配置系统运行的一些环境信息,文件位于`data/config.yaml`。 +一般不需要修改。 + +```yaml +# 管理员会话列表,仅在处理命令时有效 +# 格式为会话ID(person_xxxx 或 group_xxxx) +# 会话ID 可以在发送消息时查看控制台日志找到 +# 例如: +# admins: +# - person_1234567890 +# - group_1234567890 +admins: [] + +# API 端口 +api: + port: 5300 + +# 命令配置 +command: + # 命令前缀,具有这些前缀的消息会被识别为命令 + prefix: + - '!' + - ! + + # 命令权限配置,key 为命令前缀,value 为权限类型 + privilege: {} + +# 并发设置 +concurrency: + # 单流水线并发数 + pipeline: 20 + # 单会话并发数 + session: 1 + +# MCP 配置 +# 后续应该会改为在 WebUI 上可以配置 +mcp: + # MCP 服务器列表 + # 目前支持两种协议的 MCP 服务器: + # - SSE + # - Stdio(Python) + # + # 格式: + # SSE 模式: + # name 服务器名称,自行定义 + # enable 是否启用本 Server + # mode 固定填写SSE + # url MCP SSE Server 的访问 URL + # headers 连接时的 headers,可选 + # timeout 连接超时时间 + # + # stdio 模式: + # name 服务器名称,自行定义 + # enable 是否启用本 Server + # mode 固定填写stdio + # command 执行命令 + # args 执行命令的参数 + # env 执行命令的环境变量,可选 + # + # 例如: + # servers: + # - name: 'SSE Server' + # enable: true + # mode: SSE + # url: 'http://127.0.0.1:8000/sse' + # headers: {} + # timeout: 10 + # - name: 'stdio Server' + # enable: true + # mode: stdio + # command: 'python' + # args: ['-m', 'weather'] + # env: {} + servers: [] + +# 代理配置 +proxy: + # HTTP 代理地址 + # 如果已经在环境变量设置了代理,则不需要配置 + # 例如: + # proxy: + # http: 'http://127.0.0.1:7890' + # https: 'http://127.0.0.1:7890' + http: '' + https: '' + +# 系统配置 +system: + # JWT 配置 + jwt: + # JWT 过期时间,单位为秒 + expire: 604800 + # JWT 密钥,首次启动时会自动生成一个密钥 + secret: 'xxxx' +``` \ No newline at end of file diff --git a/docs/zh/insight/guide.md b/docs/zh/insight/guide.md index 5a9af12a5..e2355ae9a 100644 --- a/docs/zh/insight/guide.md +++ b/docs/zh/insight/guide.md @@ -1,26 +1,18 @@ -# 快速开始 +# 欢迎来到 LangBot 文档中心 -> 两种方式快速开始: -> -> - 使用社区资源的简化版教程(见左侧) -> - 阅读文档自行部署(下述为快速开始的方法) +LangBot 是一个开源的大语言模型(LLM)原生即时通信机器人平台,支持多种消息平台和模型供应商。提供对 Dify、阿里云百炼等 LLMOps 平台的支持。并提供 WebUI 供用户快速部署和使用。 -## 1. 部署 LangBot +## 文档结构 -阅读左侧 **部署 LangBot** 部分,选择部署 LangBot 的方式 +文档分为以下几个部分: -部署完成后,打开`http://127.0.0.1:5300`或者`http://服务器公网IP:5300` +- 部署和使用(必读):部署和使用 LangBot 的详细步骤 +- 插件:插件使用和开发相关信息 +- 实践:许多不错的 LangBot 使用案例 +- 开发:参与 LangBot 开发的相关信息 -进行初始化,填入邮箱和密码并记录保存下来 +## 使用效果 -## 2. 配置机器人 +![private_chat](/assets/image/insight/private_chat.png) -查看左侧的[配置机器人](/zh/deploy/platforms/readme) - -## 3. 配置模型 - -查看左侧[配置对话模型](/zh/deploy/models/readme) - -
- -完成以上两步后即可使用,如果需要更多功能的配置,可在[流水线](/zh/deploy/pipelines/readme)中设置 +![group_chat](/assets/image/insight/group_chat.png)