mirror of
https://github.com/csunny/DB-GPT.git
synced 2026-07-17 01:58:47 +00:00
docs: quick-start installation
This commit is contained in:
14
README.md
14
README.md
@@ -158,6 +158,13 @@ curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/in
|
||||
| MOONSHOT_API_KEY=sk-xxx bash -s -- --profile kimi
|
||||
```
|
||||
|
||||
For MiniMax via the OpenAI-compatible API:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \
|
||||
| MINIMAX_API_KEY=sk-xxx bash -s -- --profile minimax
|
||||
```
|
||||
|
||||
Already have a local DB-GPT checkout? Reuse it instead of cloning `~/.dbgpt/DB-GPT`:
|
||||
|
||||
```bash
|
||||
@@ -172,6 +179,13 @@ MOONSHOT_API_KEY=sk-xxx \
|
||||
bash scripts/install/install.sh --profile kimi --repo-dir "$(pwd)" --yes
|
||||
```
|
||||
|
||||
Or reuse your local repo with MiniMax:
|
||||
|
||||
```bash
|
||||
MINIMAX_API_KEY=sk-xxx \
|
||||
bash scripts/install/install.sh --profile minimax --repo-dir "$(pwd)" --yes
|
||||
```
|
||||
|
||||
After installation, start the server with the generated profile config:
|
||||
|
||||
```bash
|
||||
|
||||
14
README.zh.md
14
README.zh.md
@@ -160,6 +160,13 @@ curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/in
|
||||
| MOONSHOT_API_KEY=sk-xxx bash -s -- --profile kimi
|
||||
```
|
||||
|
||||
如果你想使用 MiniMax(OpenAI 兼容接口):
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/eosphoros-ai/DB-GPT/main/scripts/install/install.sh \
|
||||
| MINIMAX_API_KEY=sk-xxx bash -s -- --profile minimax
|
||||
```
|
||||
|
||||
如果你已经有本地 DB-GPT 仓库,也可以直接复用当前仓库,跳过 `~/.dbgpt/DB-GPT` 的重复 clone:
|
||||
|
||||
```bash
|
||||
@@ -174,6 +181,13 @@ MOONSHOT_API_KEY=sk-xxx \
|
||||
bash scripts/install/install.sh --profile kimi --repo-dir "$(pwd)" --yes
|
||||
```
|
||||
|
||||
如果你想在当前仓库里直接测试 MiniMax:
|
||||
|
||||
```bash
|
||||
MINIMAX_API_KEY=sk-xxx \
|
||||
bash scripts/install/install.sh --profile minimax --repo-dir "$(pwd)" --yes
|
||||
```
|
||||
|
||||
安装完成后,使用生成的 profile 配置启动服务:
|
||||
|
||||
```bash
|
||||
|
||||
BIN
packages/dbgpt-app/src/dbgpt_app/static/web/models/minimax.png
Normal file
BIN
packages/dbgpt-app/src/dbgpt_app/static/web/models/minimax.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
@@ -89,7 +89,7 @@ Usage:
|
||||
install.sh [options]
|
||||
|
||||
Options:
|
||||
--profile <name> Deployment profile (currently: openai, kimi)
|
||||
--profile <name> Deployment profile (currently: openai, kimi, minimax)
|
||||
--install-dir <path> Where to install (default: ~/.dbgpt)
|
||||
--version <git-ref> Git tag or branch to check out (default: main)
|
||||
--repo-dir <path> Use an existing local DB-GPT checkout
|
||||
@@ -117,6 +117,9 @@ Examples:
|
||||
# With Kimi / Moonshot API key
|
||||
MOONSHOT_API_KEY=sk-xxx bash install.sh --profile kimi --yes
|
||||
|
||||
# With Minimax API key
|
||||
MINIMAX_API_KEY=sk-xxx bash install.sh --profile minimax --yes
|
||||
|
||||
# Reuse your current local repo (skip clone/update)
|
||||
OPENAI_API_KEY=sk-xxx bash install.sh --profile openai --repo-dir . --yes
|
||||
|
||||
@@ -210,6 +213,7 @@ step_choose_profile() {
|
||||
printf '%b' "${COLOR_CYAN}Select a deployment profile:${COLOR_RESET}\n"
|
||||
printf ' 1) openai — OpenAI API proxy (recommended)\n'
|
||||
printf ' 2) kimi — Kimi 2.5 via Moonshot API\n'
|
||||
printf ' 3) minimax — MiniMax OpenAI-compatible API\n'
|
||||
printf ' q) quit\n'
|
||||
printf '\n'
|
||||
|
||||
@@ -220,6 +224,7 @@ step_choose_profile() {
|
||||
case "${choice}" in
|
||||
1|openai) PROFILE="openai" ;;
|
||||
2|kimi) PROFILE="kimi" ;;
|
||||
3|minimax) PROFILE="minimax" ;;
|
||||
q|Q) info "Installation cancelled."; exit 0 ;;
|
||||
*) die "Invalid choice: ${choice}" ;;
|
||||
esac
|
||||
|
||||
@@ -9,12 +9,12 @@
|
||||
# ── Validation ────────────────────────────────────────────────────────────────
|
||||
|
||||
# Currently supported profiles. Extend this list when adding new profiles.
|
||||
readonly SUPPORTED_PROFILES="openai kimi"
|
||||
readonly SUPPORTED_PROFILES="openai kimi minimax"
|
||||
|
||||
validate_profile() {
|
||||
local profile="$1"
|
||||
case "${profile}" in
|
||||
openai|kimi) ;;
|
||||
openai|kimi|minimax) ;;
|
||||
*)
|
||||
die "Unsupported profile: ${profile}. Supported profiles: ${SUPPORTED_PROFILES}"
|
||||
;;
|
||||
@@ -44,6 +44,15 @@ proxy_openai
|
||||
rag
|
||||
storage_chromadb
|
||||
dbgpts
|
||||
EOF
|
||||
;;
|
||||
minimax)
|
||||
cat <<'EOF'
|
||||
base
|
||||
proxy_openai
|
||||
rag
|
||||
storage_chromadb
|
||||
dbgpts
|
||||
EOF
|
||||
;;
|
||||
*)
|
||||
@@ -60,6 +69,7 @@ profile_template() {
|
||||
case "${profile}" in
|
||||
openai) echo "openai.toml" ;;
|
||||
kimi) echo "kimi.toml" ;;
|
||||
minimax) echo "minimax.toml" ;;
|
||||
*) die "No template defined for profile: ${profile}" ;;
|
||||
esac
|
||||
}
|
||||
@@ -71,6 +81,7 @@ profile_repo_config() {
|
||||
case "${profile}" in
|
||||
openai) echo "configs/dbgpt-proxy-openai.toml" ;;
|
||||
kimi) echo "configs/dbgpt-proxy-moonshot.toml" ;;
|
||||
minimax) echo "configs/dbgpt-proxy-openai.toml" ;;
|
||||
*) die "No repo config path defined for profile: ${profile}" ;;
|
||||
esac
|
||||
}
|
||||
@@ -82,6 +93,7 @@ profile_api_key_env() {
|
||||
case "${profile}" in
|
||||
openai) echo "OPENAI_API_KEY" ;;
|
||||
kimi) echo "MOONSHOT_API_KEY" ;;
|
||||
minimax) echo "MINIMAX_API_KEY" ;;
|
||||
*) echo "" ;;
|
||||
esac
|
||||
}
|
||||
@@ -93,6 +105,7 @@ profile_api_key_token() {
|
||||
case "${profile}" in
|
||||
openai) echo "__OPENAI_API_KEY__" ;;
|
||||
kimi) echo "__MOONSHOT_API_KEY__" ;;
|
||||
minimax) echo "__MINIMAX_API_KEY__" ;;
|
||||
*) echo "" ;;
|
||||
esac
|
||||
}
|
||||
|
||||
@@ -35,6 +35,11 @@ export const MODEL_ICON_INFO: Record<string, ModelIconInfo> = {
|
||||
icon: '/models/moonshot.png',
|
||||
patterns: ['moonshot', 'kimi'],
|
||||
},
|
||||
minimax: {
|
||||
label: 'MiniMax',
|
||||
icon: '/models/minimax.png',
|
||||
patterns: ['minimax', 'm2.5', 'm2.1', 'm2'],
|
||||
},
|
||||
doubao: {
|
||||
label: 'Doubao',
|
||||
icon: '/models/doubao.png',
|
||||
|
||||
Reference in New Issue
Block a user