Quickstart

DB-GPT supports the installation and use of various open-source and closed-source models. Different models have different requirements for environment and resources. If local model deployment is required, GPU resources are necessary. The API proxy model requires relatively few resources and can be deployed and started on a CPU machine.

:::info note

Detailed installation and deployment tutorials can be found in Installation.
This page only introduces deployment based on ChatGPT proxy and local GLM model. :::

Environment Preparation

Download Source Code

:::tip Download DB-GPT :::

git clone https://github.com/eosphoros-ai/DB-GPT.git

Environment Setup

The default database uses SQLite, so there is no need to install a database in the default startup mode. If you need to use other databases, please refer to the advanced tutorials below. Starting from version 0.7.0, DB-GPT uses uv for environment and package management, providing faster and more stable dependency management.

:::info note There are some ways to install uv: :::

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

curl -LsSf https://astral.sh/uv/install.sh | sh

python -m pip install --upgrade pip
python -m pip install --upgrade pipx
python -m pipx ensurepath
pipx install uv --global

You can see more installation methods on the uv installation

Then, you can run uv --version to check if uv is installed successfully.

uv --version

Deploy DB-GPT

:::tip If you are in the China region, you can add --index-url=https://pypi.tuna.tsinghua.edu.cn/simple at the end of the command.Like this:

uv sync --all-packages \
--extra "base" \
--extra "proxy_openai" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "dbgpts" \
--index-url=https://pypi.tuna.tsinghua.edu.cn/simple

And we recommend you to configure you pypi index to environment variable UV_INDEX_URL example:

echo "export UV_INDEX_URL=https://pypi.tuna.tsinghua.edu.cn/simple" >> ~/.bashrc

This tutorial assumes that you can establish network communication with the dependency download sources. :::

Install Dependencies

# Use uv to install dependencies needed for OpenAI proxy
uv sync --all-packages \
--extra "base" \
--extra "proxy_openai" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "dbgpts"

Run Webserver

To run DB-GPT with OpenAI proxy, you must provide the OpenAI API key in the configs/dbgpt-proxy-openai.toml configuration file or privide it in the environment variable with key OPENAI_API_KEY.

# Model Configurations
[models]
[[models.llms]]
...
api_key = "your-openai-api-key"
[[models.embeddings]]
...
api_key = "your-openai-api-key"

Then run the following command to start the webserver:

uv run dbgpt start webserver --config configs/dbgpt-proxy-openai.toml

In the above command, --config specifies the configuration file, and configs/dbgpt-proxy-openai.toml is the configuration file for the OpenAI proxy model, you can also use other configuration files or create your own configuration file according to your needs.

Optionally, you can also use the following command to start the webserver:

uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-openai.toml

# Use uv to install dependencies needed for OpenAI proxy
uv sync --all-packages \
--extra "base" \
--extra "proxy_openai" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "dbgpts"

Run Webserver

To run DB-GPT with DeepSeek proxy, you must provide the DeepSeek API key in the configs/dbgpt-proxy-deepseek.toml.

And you can specify your embedding model in the configs/dbgpt-proxy-deepseek.toml configuration file, the default embedding model is BAAI/bge-large-zh-v1.5. If you want to use other embedding models, you can modify the configs/dbgpt-proxy-deepseek.toml configuration file and specify the name and provider of the embedding model in the [[models.embeddings]] section. The provider can be hf.Finally, you need to append --extra "hf" at the end of the dependency installation command. Here's the updated command:

uv sync --all-packages \
--extra "base" \
--extra "proxy_openai" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "dbgpts" \
--extra "hf" \
--extra "cpu"

Model Configurations:

# Model Configurations
[models]
[[models.llms]]
# name = "deepseek-chat"
name = "deepseek-reasoner"
provider = "proxy/deepseek"
api_key = "your-deepseek-api-key"
[[models.embeddings]]
name = "BAAI/bge-large-zh-v1.5"
provider = "hf"
# If not provided, the model will be downloaded from the Hugging Face model hub
# uncomment the following line to specify the model path in the local file system
# path = "the-model-path-in-the-local-file-system"
path = "/data/models/bge-large-zh-v1.5"

Then run the following command to start the webserver:

uv run dbgpt start webserver --config configs/dbgpt-proxy-deepseek.toml

In the above command, --config specifies the configuration file, and configs/dbgpt-proxy-deepseek.toml is the configuration file for the DeepSeek proxy model, you can also use other configuration files or create your own configuration file according to your needs.

Optionally, you can also use the following command to start the webserver:

uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-deepseek.toml

# Use uv to install dependencies needed for GLM4
# Install core dependencies and select desired extensions
uv sync --all-packages \
--extra "base" \
--extra "cuda121" \
--extra "hf" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "quant_bnb" \
--extra "dbgpts"

Run Webserver

To run DB-GPT with the local model. You can modify the configs/dbgpt-local-glm.toml configuration file to specify the model path and other parameters.

# Model Configurations
[models]
[[models.llms]]
name = "THUDM/glm-4-9b-chat-hf"
provider = "hf"
# If not provided, the model will be downloaded from the Hugging Face model hub
# uncomment the following line to specify the model path in the local file system
# path = "the-model-path-in-the-local-file-system"

[[models.embeddings]]
name = "BAAI/bge-large-zh-v1.5"
provider = "hf"
# If not provided, the model will be downloaded from the Hugging Face model hub
# uncomment the following line to specify the model path in the local file system
# path = "the-model-path-in-the-local-file-system"

In the above configuration file, [[models.llms]] specifies the LLM model, and [[models.embeddings]] specifies the embedding model. If you not provide the path parameter, the model will be downloaded from the Hugging Face model hub according to the name parameter.

Then run the following command to start the webserver:

uv run dbgpt start webserver --config configs/dbgpt-local-glm.toml

# Use uv to install dependencies needed for vllm
# Install core dependencies and select desired extensions
uv sync --all-packages \
--extra "base" \
--extra "hf" \
--extra "cuda121" \
--extra "vllm" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "quant_bnb" \
--extra "dbgpts"

Run Webserver

To run DB-GPT with the local model. You can modify the configs/dbgpt-local-vllm.toml configuration file to specify the model path and other parameters.

# Model Configurations
[models]
[[models.llms]]
name = "THUDM/glm-4-9b-chat-hf"
provider = "vllm"
# If not provided, the model will be downloaded from the Hugging Face model hub
# uncomment the following line to specify the model path in the local file system
# path = "the-model-path-in-the-local-file-system"

[[models.embeddings]]
name = "BAAI/bge-large-zh-v1.5"
provider = "hf"
# If not provided, the model will be downloaded from the Hugging Face model hub
# uncomment the following line to specify the model path in the local file system
# path = "the-model-path-in-the-local-file-system"

Then run the following command to start the webserver:

uv run dbgpt start webserver --config configs/dbgpt-local-vllm.toml

If you has a Nvidia GPU, you can enable the CUDA support by setting the environment variable CMAKE_ARGS="-DGGML_CUDA=ON".

# Use uv to install dependencies needed for llama-cpp
# Install core dependencies and select desired extensions
CMAKE_ARGS="-DGGML_CUDA=ON" uv sync --all-packages \
--extra "base" \
--extra "hf" \
--extra "cuda121" \
--extra "llama_cpp" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "quant_bnb" \
--extra "dbgpts"

Otherwise, run the following command to install dependencies without CUDA support.

# Use uv to install dependencies needed for llama-cpp
# Install core dependencies and select desired extensions
uv sync --all-packages \
--extra "base" \
--extra "hf" \
--extra "llama_cpp" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "quant_bnb" \
--extra "dbgpts"

Run Webserver

To run DB-GPT with the local model. You can modify the configs/dbgpt-local-llama-cpp.toml configuration file to specify the model path and other parameters.

# Model Configurations
[models]
[[models.llms]]
name = "DeepSeek-R1-Distill-Qwen-1.5B"
provider = "llama.cpp"
# If not provided, the model will be downloaded from the Hugging Face model hub
# uncomment the following line to specify the model path in the local file system
# path = "the-model-path-in-the-local-file-system"

[[models.embeddings]]
name = "BAAI/bge-large-zh-v1.5"
provider = "hf"
# If not provided, the model will be downloaded from the Hugging Face model hub
# uncomment the following line to specify the model path in the local file system
# path = "the-model-path-in-the-local-file-system"

Then run the following command to start the webserver:

uv run dbgpt start webserver --config configs/dbgpt-local-llama-cpp.toml

# Use uv to install dependencies needed for Ollama proxy
uv sync --all-packages \
--extra "base" \
--extra "proxy_ollama" \
--extra "rag" \
--extra "storage_chromadb" \
--extra "dbgpts"

Run Webserver

To run DB-GPT with Ollama proxy, you must provide the Ollama API base in the configs/dbgpt-proxy-ollama.toml configuration file.

# Model Configurations
[models]
[[models.llms]]
...
api_base = "your-ollama-api-base"
[[models.embeddings]]
...
api_base = "your-ollama-api-base"

Then run the following command to start the webserver:

uv run dbgpt start webserver --config configs/dbgpt-proxy-ollama.toml

In the above command, --config specifies the configuration file, and configs/dbgpt-proxy-ollama.toml is the configuration file for the Ollama proxy model, you can also use other configuration files or create your own configuration file according to your needs.

Optionally, you can also use the following command to start the webserver:

uv run python packages/dbgpt-app/src/dbgpt_app/dbgpt_server.py --config configs/dbgpt-proxy-ollama.toml

(Optional) More Configuration

You can view the configuration in Configuration to learn more about the configuration options.

For example, if you want to configure the LLM model, you can see all available options in the LLM Configuration.

And another example, if you want to how to configure the vllm model, you can see all available options in the VLLM Configuration.

DB-GPT Install Help Tool

If you need help with the installation, you can use the uv script to get help.

uv run install_help.py --help

Generate Install Command

You can use the uv script to generate the install command in the interactive mode.

uv run install_help.py install-cmd --interactive

And you can generate an install command with all the dependencies needed for the OpenAI proxy model.

uv run install_help.py install-cmd --all

You can found all the dependencies and extras.

uv run install_help.py list

Visit Website

Open your browser and visit http://localhost:5670

(Optional) Run Web Front-end Separately

You can also run the web front-end separately:

cd web && npm install
cp .env.template .env
// Set API_BASE_URL to your DB-GPT server address, usually http://localhost:5670
npm run dev

Open your browser and visit http://localhost:3000

Source: docs/i18n/zh-CN/docusaurus-plugin-content-docs/current/quickstart.md