Source Code Deployment

Environmental requirements

Startup Mode	CPU * MEM	GPU	Remark
Proxy model	4C * 8G	None	Proxy model does not rely on GPU
Local model	8C * 32G	24G	It is best to start locally with a GPU of 24G or above

Environment Preparation

Download Source Code

提示

Download DB-GPT

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

note

There are some ways to install uv:

Command (macOS And Linux)

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

PyPI

Install uv using pipx.

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

Other

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

Install Dependencies

OpenAI (proxy)

# 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

DeepSeek (proxy)

# 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.

# 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

GLM4 (local)

# 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

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

Install DB-GPT Application Database

SQLite

NOTE

You do not need to separately create the database tables related to the DB-GPT application in SQLite; they will be created automatically for you by default.

Modify your toml configuration file to use SQLite as the database(Is the default setting).

[service.web.database]
type = "sqlite"
path = "pilot/meta_data/dbgpt.db"

MySQL

NOTE

After version 0.4.7, we removed the automatic generation of MySQL database Schema for safety.

1. Frist, execute MySQL script to create database and tables.

$ mysql -h127.0.0.1 -uroot -p{your_password} < ./assets/schema/dbgpt.sql

2. Second, modify your toml configuration file to use MySQL as the database.

[service.web.database]
type = "mysql"
host = "127.0.0.1"
port = 3306
user = "root"
database = "dbgpt"
password = "aa123456"

Please replace the host, port, user, database, and password with your own MySQL database settings.

Test data (optional)

The DB-GPT project has a part of test data built-in by default, which can be loaded into the local database for testing through the following command

• Linux

bash ./scripts/examples/load_examples.sh

• Windows

.\scripts\examples\load_examples.bat

:::

Visit website

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