ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

DB-GPT 快速安装指南:一条命令从零到可用的 Web UI

DB-GPT 快速安装指南:一条命令从零到可用的 Web UI 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 兼容 Profileopenaicurl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \ | OPENAI_API_KEYsk-xxx bash -s -- --profile openaiKimi 2.5Moonshot APIcurl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \ | MOONSHOT_API_KEYsk-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_KEYsk-xxxMiniMaxOpenAI 兼容 APIcurl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \ | MINIMAX_API_KEYsk-xxx bash -s -- --profile minimax完整 Profile 清单根据 scripts/install/lib/profiles.sh安装器目前支持以下 7 个 Profile并可通过交互菜单或--profile指定Profile提供商对应 API Key 环境变量额外安装的 extrasopenaiOpenAIOPENAI_API_KEYbase、proxy_openai、rag、storage_chromadb、dbgptskimiKimiMoonshotMOONSHOT_API_KEY另需OPENAI_API_KEY做 Embeddingbase、proxy_openai、rag、storage_chromadb、dbgptsqwenQwenDashScopeDASHSCOPE_API_KEYbase、proxy_openai、proxy_tongyi、rag、storage_chromadb、dbgptsminimaxMiniMaxMINIMAX_API_KEYbase、proxy_openai、rag、storage_chromadb、dbgptsglmGLMZhipuAIZHIPUAI_API_KEYbase、proxy_openai、proxy_zhipuai、rag、storage_chromadb、dbgptscustom自定义 OpenAI 兼容端点OPENAI_API_KEYbase、proxy_openai、rag、storage_chromadb、dbgptsdefault默认OpenAI 兼容OPENAI_API_KEYbase、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部署 Profileopenai、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_KEYsk-xxx bash install.sh --profile qwen --yes # 指定 GLM / ZhipuAI ZHIPUAI_API_KEYsk-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、defaultq退出。而一旦指定--yesstep_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_KEYsk-xxx \ bash scripts/install/install.sh --profile openai --repo-dir $(pwd) --yes # 复用本地仓库 Kimi MOONSHOT_API_KEYsk-xxx \ bash scripts/install/install.sh --profile kimi --repo-dir $(pwd) --yes # 复用本地仓库 MiniMax MINIMAX_API_KEYsk-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/Linuxstep_ensure_base_commands确保curl、git存在step_choose_profile交互选择或按--yes默认 openaivalidate_profile校验 Profile 合法性来自 scripts/install/lib/profiles.shstep_apply_mirror若--mirror china导出UV_INDEX_URLhttps://pypi.tuna.tsinghua.edu.cn/simplestep_prepare_dirs创建~/.dbgpt目录resolve_repo_dir确定仓库路径默认~/.dbgpt/DB-GPT或复用--repo-dirstep_ensure_uv若uv不存在通过curl -LsSf https://astral.sh/uv/install.sh | sh安装并自动把~/.local/bin、~/.cargo/bin加入 PATHstep_clone_or_update_repo不存在则git clone --depth 1 --branch version已存在则询问是否git fetch --tags --prune并 checkoutstep_install_deps在仓库内执行uv sync --all-packages --extra e1 --extra e2 ...extras 由profile_extras决定step_check_api_key检查对应 API Key 环境变量是否设置kimi 额外检查 OPENAI_API_KEYstep_generate_config执行dbgpt setup生成~/.dbgpt/configs/profile.tomlstep_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元数据库默认使用SQLitepilot/meta_data/dbgpt.db表会自动创建无需额外初始化LLM 与 Embedding 模型均采用${env:...}语法读取环境变量:-后为兜底默认值。因此即使安装时未传 API Key只要启动前export OPENAI_API_KEYsk-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.shProfile 定义与 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_URLhttps://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),仅供参考
返回列表