mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-11-03 22:32:27 +08:00
doc: add system settings doc
This commit is contained in:
@@ -131,6 +131,10 @@ export default defineConfig({
|
||||
text: "修改对话流水线",
|
||||
link: "/zh/deploy/pipelines/readme",
|
||||
},
|
||||
{
|
||||
text: "系统环境设置",
|
||||
link: "/zh/deploy/settings",
|
||||
},
|
||||
{
|
||||
text: "更新 LangBot",
|
||||
link: "/zh/deploy/update",
|
||||
|
||||
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 57 KiB |
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 53 KiB |
@@ -0,0 +1,3 @@
|
||||
<script setup>
|
||||
window.location.href = '/zh/insight/guide'
|
||||
</script>
|
||||
@@ -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'
|
||||
```
|
||||
+11
-13
@@ -1,20 +1,18 @@
|
||||
# 阅读指引
|
||||
# 欢迎来到 LangBot 文档中心
|
||||
|
||||
## 部署板块
|
||||
LangBot 是一个开源的大语言模型(LLM)原生即时通信机器人平台,支持多种消息平台和模型供应商。提供对 Dify、阿里云百炼等 LLMOps 平台的支持。并提供 WebUI 供用户快速部署和使用。
|
||||
|
||||
部署使用本项目请严格按照以下三步进行,其中每一步可以选择不同的方式进行。
|
||||
## 文档结构
|
||||
|
||||
- 阅读 部署 LangBot 页,选择部署方式
|
||||
- 阅读 部署消息平台页,选择要使用的消息平台
|
||||
- 阅读 填写配置信息页,根据情况填写配置
|
||||
文档分为以下几个部分:
|
||||
|
||||
## 使用板块
|
||||
- 部署和使用(必读):部署和使用 LangBot 的详细步骤
|
||||
- 插件:插件使用和开发相关信息
|
||||
- 实践:许多不错的 LangBot 使用案例
|
||||
- 开发:参与 LangBot 开发的相关信息
|
||||
|
||||
- 阅读命令语法了解机器人可用命令,可以在对话中实现切换预设、切换模型等
|
||||
- 阅读插件列表,获得插件,增强功能
|
||||
- 阅读常见问题,可有助于解决部署和使用时的问题
|
||||
## 使用效果
|
||||
|
||||
## 配置板块
|
||||

|
||||
|
||||
- 功能配置,具体解释所有的配置信息,实现更多自定义需求
|
||||
- 元数据配置,控制敏感词、模型列表等
|
||||

|
||||
|
||||
Reference in New Issue
Block a user