DB-GPT 快速安装指南:一条命令从零到可用的 Web UI
【免费下载链接】DB-GPTopen-source agentic AI data assistant for the next generation of AI + Data products.项目地址: https://gitcode.com/GitHub_Trending/db/DB-GPT
本文是一份面向 DB-GPT 的快速安装实战指南,核心围绕仓库内置的官方安装器脚本(scripts/install/install.sh)展开,涵盖从环境检查、模型提供商(Provider)配置生成到 Web 服务启动的完整闭环。读完本文,你将掌握使用一行命令完成 DB-GPT 安装、通过 Profile 预置 OpenAI / Kimi / MiniMax 等提供商配置、复用本地仓库以及排查启动故障的完整能力,并能理解安装器每一步在仓库源码中的实际落点。
快速安装方式总览
DB-GPT 提供了一条最快从零到可用 Web UI 的路径:安装器脚本(Installer Script)。它会在本地准备一个 DB-GPT 工作区、自动生成提供商配置文件(Provider Profile),并给出可直接运行的 Web 服务器启动命令。
官方推荐的最小化安装命令如下:
curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh | bash该命令从仓库拉取 scripts/install/install.sh 并通过 bash 直接执行。如果你更希望先审查脚本再执行,也可以先下载到本地:
curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh -o install.sh less install.sh bash install.sh --profile openai系统要求
快速安装流程针对以下环境设计:
- macOS 或 Linux(安装器的
step_check_platform步骤通过uname -s检测系统,仅放行Darwin与Linux,其他系统直接报错退出,见 scripts/install/install.sh); - 一个可以运行bash的 Shell 环境;
- 能够联网下载依赖(安装器依赖
curl与git,缺失时会在step_ensure_base_commands阶段提示安装); - 如果计划立即使用托管模型提供商(Hosted Model Provider),需要准备一个API Key。
适用场景:想快速体验 DB-GPT,又不想自己管理仓库结构时,这一路径是最佳选择。
安装器需要准备什么(Installation Prerequisites)
在真正执行前,有必要先明确安装器会做什么、不会做什么,这决定了你后续需要额外准备什么。仓库中安装器头部注释对此有清晰说明(见 scripts/install/install.sh):
安装器会完成:
- 检测操作系统(macOS / Linux);
- 确保
git与curl可用; - 安装
uv(如果尚未安装); - 克隆(或更新)DB-GPT 仓库;
- 按所选 Profile 执行
uv sync安装对应 extras 依赖; - 通过
dbgpt setup向导生成配置文件; - 打印下一步指引(启动命令、访问 URL)。
安装器不会完成:
- 安装 GPU 驱动或 CUDA;
- 下载大型本地模型;
- 修改 Shell 的 rc 文件(uv 安装器除外);
- 收集遥测数据。
也就是说,对于无 GPU 的 API 代理模式,安装器已覆盖全部必要步骤;但如果计划使用本地模型推理,仍需自行准备 GPU 环境与模型权重。
带提供商 Profile 的安装
如果已经确定要使用哪个模型提供商,可以在安装时直接把 Profile 和 API Key 传进去,跳过交互式选择。安装器通过--profile参数选定提供商,而 API Key 通过环境变量注入。
OpenAI 兼容 Profile(openai)
curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \ | OPENAI_API_KEY=sk-xxx bash -s -- --profile openaiKimi 2.5(Moonshot API)
curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \ | MOONSHOT_API_KEY=sk-xxx bash -s -- --profile kimi注意:Kimi Profile 除MOONSHOT_API_KEY外,还需要OPENAI_API_KEY用于 Embedding。安装器的step_check_api_key步骤会专门检测这一项并给出警告(见 scripts/install/install.sh):
# Kimi profile also needs OPENAI_API_KEY for embeddings. export OPENAI_API_KEY=sk-xxxMiniMax(OpenAI 兼容 API)
curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \ | MINIMAX_API_KEY=sk-xxx bash -s -- --profile minimax完整 Profile 清单
根据 scripts/install/lib/profiles.sh,安装器目前支持以下 7 个 Profile,并可通过交互菜单或--profile指定:
| Profile | 提供商 | 对应 API Key 环境变量 | 额外安装的 extras |
|---|---|---|---|
openai | OpenAI | OPENAI_API_KEY | base、proxy_openai、rag、storage_chromadb、dbgpts |
kimi | Kimi(Moonshot) | MOONSHOT_API_KEY(另需OPENAI_API_KEY做 Embedding) | base、proxy_openai、rag、storage_chromadb、dbgpts |
qwen | Qwen(DashScope) | DASHSCOPE_API_KEY | base、proxy_openai、proxy_tongyi、rag、storage_chromadb、dbgpts |
minimax | MiniMax | MINIMAX_API_KEY | base、proxy_openai、rag、storage_chromadb、dbgpts |
glm | GLM(ZhipuAI) | ZHIPUAI_API_KEY | base、proxy_openai、proxy_zhipuai、rag、storage_chromadb、dbgpts |
custom | 自定义 OpenAI 兼容端点 | OPENAI_API_KEY | base、proxy_openai、rag、storage_chromadb、dbgpts |
default | 默认(OpenAI 兼容) | OPENAI_API_KEY | base、proxy_openai、rag、storage_chromadb、dbgpts |
从源码结构看,所有代理型 Profile 均共享base + proxy_openai + rag + storage_chromadb + dbgpts这套 extras 组合,qwen与glm分别额外追加proxy_tongyi、proxy_zhipuai以启用原生厂商通道。这些 extras 与仓库根目录 install_help.py 中get_deployment_presets()定义的部署预设完全一致,也对应 docs/docs/getting-started/deploy/source-code.md 中uv sync的推荐参数。
安装器 CLI 参考
install.sh是一个标准的 bash 脚本,支持如下命令行选项(可直接运行bash scripts/install/install.sh --help查看,见 scripts/install/install.sh):
| 选项 | 说明 | 默认值 |
|---|---|---|
--profile <name> | 部署 Profile(openai、kimi、qwen、minimax、glm、custom、default) | 交互选择(--yes时为 openai) |
--config <path> | 使用已有的 TOML 配置,跳过配置生成 | 无 |
--install-dir <path> | 安装目录 | ~/.dbgpt |
--version <git-ref> | 要检出的 Git 标签或分支 | main |
--repo-dir <path> | 使用已有的本地 DB-GPT 检出 | 无 |
--mirror china | 使用清华 PyPI 镜像 | 无 |
--yes | 非交互模式,接受所有默认值 | 关闭 |
--start | 安装完成后自动启动 DB-GPT 服务 | 关闭 |
-h, --help | 显示帮助 | — |
环境变量:
| 环境变量 | 用途 |
|---|---|
OPENAI_API_KEY | 自动注入 OpenAI / custom / default / kimi(embedding) 配置 |
MOONSHOT_API_KEY | 自动注入 Kimi 配置 |
DASHSCOPE_API_KEY | 自动注入 Qwen 配置 |
MINIMAX_API_KEY | 自动注入 MiniMax 配置 |
ZHIPUAI_API_KEY | 自动注入 GLM 配置 |
DBGPT_INSTALL_DIR | 覆盖默认安装目录 |
DBGPT_REPO_DIR | 复用已有本地 DB-GPT 仓库 |
DBGPT_VERSION | 覆盖默认 Git ref |
几个典型用法示例(与安装器 usage 输出一致):
# 交互式安装(会询问选择哪个 Profile) bash install.sh # 完全非交互 bash install.sh --profile openai --yes # 指定 Qwen / DashScope DASHSCOPE_API_KEY=sk-xxx bash install.sh --profile qwen --yes # 指定 GLM / ZhipuAI ZHIPUAI_API_KEY=sk-xxx bash install.sh --profile glm --yes # 高级用法:提供自己的配置文件(跳过配置生成) bash install.sh --config /path/to/my.toml --profile openai --yes # 中国镜像 bash install.sh --profile openai --mirror china非交互模式的 Profile 默认值
如果不传--profile且未加--yes,安装器会弹出交互菜单让你选择 Profile(数字 1-7 分别对应 openai、kimi、qwen、minimax、glm、custom、default,q退出)。而一旦指定--yes,step_choose_profile会将 Profile 默认设为openai(见 scripts/install/install.sh)。因此CI/CD 或无人值守场景请务必显式传--profile,以免默认行为与预期不符。
复用已有的本地仓库
如果你本地已经有一份 DB-GPT 仓库,可以用--repo-dir复用,而不是让安装器重新克隆到~/.dbgpt/DB-GPT。安装器会通过git rev-parse --show-toplevel校验该目录确实是一个 git 检出(见 scripts/install/install.sh)。
# 复用本地仓库 + OpenAI OPENAI_API_KEY=sk-xxx \ bash scripts/install/install.sh --profile openai --repo-dir "$(pwd)" --yes # 复用本地仓库 + Kimi MOONSHOT_API_KEY=sk-xxx \ bash scripts/install/install.sh --profile kimi --repo-dir "$(pwd)" --yes # 复用本地仓库 + MiniMax MINIMAX_API_KEY=sk-xxx \ bash scripts/install/install.sh --profile minimax --repo-dir "$(pwd)" --yes关于--repo-dir有两点需要注意:
- 当指定
--repo-dir时,--version会被忽略,安装器会给出警告并使用现有检出(见 scripts/install/install.sh); - 复用仓库模式下,安装器仍会在
~/.dbgpt/configs/下生成对应的 Profile 配置文件,只是跳过克隆/更新步骤。
安装器准备了什么(运行时目录布局)
安装完成后,安装器会在你的主目录下建立如下标准布局:
~/.dbgpt/ # DB-GPT 主目录(可通过 --install-dir 或 DBGPT_INSTALL_DIR 覆盖) ├── DB-GPT/ # DB-GPT 仓库检出(使用 --repo-dir 时不存在) └── configs/ ├── openai.toml # 按所选 Profile 生成的提供商配置 ├── kimi.toml └── ...- 除非使用
--repo-dir,否则仓库检出位于~/.dbgpt/DB-GPT; - 生成的提供商配置位于
~/.dbgpt/configs/; - DB-GPT 主目录位于
~/.dbgpt/; - 安装完成后会打印一条可直接运行的 Web 服务器启动命令(使用生成的 Profile)。
安装器生成配置的流程是:在仓库目录内执行uv run dbgpt setup --profile <profile> --yes,如果检测到对应环境变量已设置,还会追加--api-key参数透传,最终配置写入~/.dbgpt/configs/<profile>.toml(见 scripts/install/install.sh)。
安装器内部执行流程拆解
结合 scripts/install/install.sh 的main()函数,安装过程实际按以下步骤串行执行:
parse_args:解析命令行参数;step_check_platform:检测 OS(仅支持 macOS/Linux);step_ensure_base_commands:确保curl、git存在;step_choose_profile:交互选择或按--yes默认 openai;validate_profile:校验 Profile 合法性(来自 scripts/install/lib/profiles.sh);step_apply_mirror:若--mirror china,导出UV_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple;step_prepare_dirs:创建~/.dbgpt目录;resolve_repo_dir:确定仓库路径(默认~/.dbgpt/DB-GPT,或复用--repo-dir);step_ensure_uv:若uv不存在,通过curl -LsSf https://astral.sh/uv/install.sh | sh安装,并自动把~/.local/bin、~/.cargo/bin加入 PATH;step_clone_or_update_repo:不存在则git clone --depth 1 --branch <version>;已存在则询问是否git fetch --tags --prune并 checkout;step_install_deps:在仓库内执行uv sync --all-packages --extra <e1> --extra <e2> ...,extras 由profile_extras决定;step_check_api_key:检查对应 API Key 环境变量是否设置(kimi 额外检查 OPENAI_API_KEY);step_generate_config:执行dbgpt setup生成~/.dbgpt/configs/<profile>.toml;step_validate:运行uv run dbgpt --version验证 CLI 可用;step_print_summary:打印 Profile、仓库路径、配置路径与下一步命令;step_start_if_requested:若传了--start,直接启动 Web 服务器。
其中step_install_deps实际执行的是uv sync --all-packages(带所选 Profile 的 extras),这与 docs/docs/getting-started/deploy/source-code.md 中手动源码安装的uv sync --all-packages --extra "base" --extra "proxy_openai" ...方式一致,只是安装器替你拼好了 extras。日志与交互辅助函数(info、warn、success、die、run、confirm、prompt_input)定义在 scripts/install/lib/common.sh。
安装后启动 DB-GPT
安装完成后,用生成的 Profile 配置启动 Web 服务器:
cd ~/.dbgpt/DB-GPT && uv run dbgpt start webserver --profile <profile>然后打开浏览器访问 http://localhost:5670。
验证安装是否成功
以下三个信号都满足,说明安装成功:
- Web 服务器启动时没有配置错误;
- Web UI 能在
http://localhost:5670正常打开; - 在浏览器中可以发起一次聊天。
启动命令背后的配置解析
dbgpt start webserver --profile <profile>会从~/.dbgpt/configs/<profile>.toml读取配置。安装器生成的配置属于 OpenAI 兼容代理风格,其核心结构与仓库示例 configs/dbgpt-proxy-openai.toml 一致,关键片段如下:
[service.web] host = "0.0.0.0" port = 5670 cors_allowed_origins = "${env:DBGPT_CORS_ALLOWED_ORIGINS:-*}" [service.web.database] type = "sqlite" path = "pilot/meta_data/dbgpt.db" [models] [[models.llms]] name = "${env:LLM_MODEL_NAME:-gpt-4o}" provider = "${env:LLM_MODEL_PROVIDER:-proxy/openai}" api_base = "${env:OPENAI_API_BASE:-https://api.openai.com/v1}" api_key = "${env:OPENAI_API_KEY}" [[models.embeddings]] name = "${env:EMBEDDING_MODEL_NAME:-text-embedding-3-small}" provider = "${env:EMBEDDING_MODEL_PROVIDER:-proxy/openai}" api_url = "${env:EMBEDDING_MODEL_API_URL:-https://api.openai.com/v1/embeddings}" api_key = "${env:OPENAI_API_KEY}"可以看到:
- 默认 Web 端口为5670,监听
0.0.0.0; - 元数据库默认使用SQLite(
pilot/meta_data/dbgpt.db),表会自动创建,无需额外初始化; - LLM 与 Embedding 模型均采用
${env:...}语法读取环境变量,:-后为兜底默认值。因此即使安装时未传 API Key,只要启动前export OPENAI_API_KEY=sk-xxx也能正常运行。
安装完成后如何管理多个提供商 Profile
快速安装本质上是把「提供商 Profile」这套配置体系自动化了。如果你想在安装后新增、切换或删除 Profile,可以使用dbgpt profile系列子命令(完整参考见 docs/docs/getting-started/cli-quickstart.md):
# 列出所有 Profile(当前激活的带 * 号) dbgpt profile list # 查看某个 Profile 的 TOML 内容 dbgpt profile show openai # 创建新 Profile(走 setup 向导) dbgpt profile create qwen # 切换激活的 Profile dbgpt profile switch openai # 删除 Profile dbgpt profile delete minimaxWeb 服务器启动时的配置解析优先级为(见 docs/docs/getting-started/cli-quickstart.md):
--config指定的文件优先;- 其次
--profile对应的~/.dbgpt/configs/<profile>.toml; - 再次是
~/.dbgpt/config.toml中记录的激活 Profile; - 如果完全未配置,则拉起交互式 setup 向导。
这也解释了安装器为什么要将配置写到~/.dbgpt/configs/:它把「激活 Profile」机制作为一个中间层,方便用户在多提供商之间平滑切换。
先审查脚本再执行(安全提示)
对 curl-pipe-bash 心存疑虑的用户,官方流程同样给出了「先下载、再审查、后执行」的替代路径:
curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh -o install.sh less install.sh bash install.sh --profile openai仓库内也可以直接阅读安装器及其两个辅助库的完整源码:
- 安装器主逻辑:scripts/install/install.sh
- 日志与交互辅助函数:scripts/install/lib/common.sh
- Profile 定义与 extras 映射:scripts/install/lib/profiles.sh
备选安装方式
如果安装器脚本不适合你的环境,DB-GPT 还提供了另外两条官方路径:
- CLI 安装(PyPI):基于 PyPI 的安装,核心命令为
uv pip install dbgpt-app/pip install dbgpt-app,随后dbgpt start直接启动,无需源码检出; - 源码安装:面向开发、调试与深度定制,暴露完整仓库布局与
uv sync工作流。
三者的关系可以概括为:安装器脚本是「源码安装的自动化封装」,它替你完成了克隆、依赖安装与配置生成;而 CLI 安装则适合不想碰仓库结构的纯使用场景。
故障排查
安装器与我的 Shell / 平台不匹配
安装器仅支持 macOS 与 Linux 下的 bash。如果不符合,请改用 CLI 安装 或 源码安装。
想对依赖和配置有更多掌控
使用 源码安装,它会暴露完整的仓库布局与uv sync工作流。在仓库根目录还可以运行交互式安装助手来生成精确的uv sync命令:
uv run install_help.py install-cmd --interactive uv run install_help.py list安装完成但 DB-GPT 无法干净启动
- 检查
~/.dbgpt/configs/下生成的配置:确认[models]中的api_key是否正确(若使用了${env:OPENAI_API_KEY}语法,请确认环境变量已导出); - 若
uv sync阶段失败,先确认 Python 与 uv 满足前置要求;在中国大陆可设置UV_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple加速(安装器也内置了--mirror china选项); - 若服务启动但 UI 空白,确认终端显示 Web 服务器正常启动,并检查端口 5670 是否被其他进程占用;
- 若仍未解决,可查阅 安装问题排查。
小结
快速安装器脚本是 DB-GPT 交付「最短路径」的核心工具:一条命令完成平台检测、uv 安装、仓库克隆、依赖同步、Profile 配置生成与启动指引。通过--profile与环境变量,它把 OpenAI、Kimi、MiniMax、Qwen、GLM 等多提供商的接入成本压缩到一行之内;通过--repo-dir、--config与--mirror china,又能覆盖复用仓库、自带配置与国内网络加速等进阶诉求。理解本文所拆解的每一步在 scripts/install/install.sh 中的实现,你就掌握了在任意 macOS / Linux 环境快速拉起 DB-GPT Web UI 的完整方法论。
【免费下载链接】DB-GPTopen-source agentic AI data assistant for the next generation of AI + Data products.项目地址: https://gitcode.com/GitHub_Trending/db/DB-GPT
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考