feat: supports docker compose deployment

2025-09-01 09:06:55 +00:00 · 2023-07-26 20:07:25 +08:00
parent 700d9bf3e9
commit 671cddf4e7
16 changed files with 531 additions and 45 deletions
--- a/docs/getting_started/getting_started.md
+++ b/docs/getting_started/getting_started.md
@@ -86,3 +86,98 @@ $ python pilot/server/dbgpt_server.py --light

 If you want to learn about dbgpt-webui, read https://github.com/csunny/DB-GPT/tree/new-page-framework/datacenter

+### 4. Docker (Experimental)
+
+#### 4.1 Building Docker image
+
+```bash
+$ bash docker/build_all_images.sh
+```
+
+Review images by listing them:
+
+```bash
+$ docker images|grep db-gpt
+```
+
+Output should look something like the following:
+
+```
+db-gpt-allinone    latest     e1ffd20b85ac   45 minutes ago   14.5GB
+db-gpt             latest     e36fb0cca5d9   3 hours ago      14GB
+```
+
+#### 4.2. Run all in one docker container
+
+**Run with local model**
+
+```bash
+$ docker run --gpus "device=0" -d -p 3306:3306 \
+    -p 5000:5000 \
+    -e LOCAL_DB_HOST=127.0.0.1 \
+    -e LOCAL_DB_PASSWORD=aa123456 \
+    -e MYSQL_ROOT_PASSWORD=aa123456 \
+    -e LLM_MODEL=vicuna-13b \
+    -e LANGUAGE=zh \
+    -v /data/models:/app/models \
+    --name db-gpt-allinone \
+    db-gpt-allinone
+```
+
+Open http://localhost:5000 with your browser to see the product.
+
+
+- `-e LLM_MODEL=vicuna-13b`, means we use vicuna-13b as llm model, see /pilot/configs/model_config.LLM_MODEL_CONFIG
+- `-v /data/models:/app/models`, means we mount the local model file directory `/data/models` to the docker container directory `/app/models`, please replace it with your model file directory.
+
+You can see log with command:
+
+```bash
+$ docker logs db-gpt-allinone -f
+```
+
+**Run with openai interface**
+
+```bash
+$ PROXY_API_KEY="You api key"
+$ PROXY_SERVER_URL="https://api.openai.com/v1/chat/completions"
+$ docker run --gpus "device=0" -d -p 3306:3306 \
+    -p 5000:5000 \
+    -e LOCAL_DB_HOST=127.0.0.1 \
+    -e LOCAL_DB_PASSWORD=aa123456 \
+    -e MYSQL_ROOT_PASSWORD=aa123456 \
+    -e LLM_MODEL=proxyllm \
+    -e PROXY_API_KEY=$PROXY_API_KEY \
+    -e PROXY_SERVER_URL=$PROXY_SERVER_URL \
+    -e LANGUAGE=zh \
+    -v /data/models/text2vec-large-chinese:/app/models/text2vec-large-chinese \
+    --name db-gpt-allinone \
+    db-gpt-allinone
+```
+
+- `-e LLM_MODEL=proxyllm`, means we use proxy llm(openai interface, fastchat interface...)
+- `-v /data/models/text2vec-large-chinese:/app/models/text2vec-large-chinese`, means we mount the local text2vec model to the docker container.
+
+#### 4.2. Run with docker compose
+
+```bash
+$ docker compose up -d
+```
+
+Output should look something like the following:
+```
+[+] Building 0.0s (0/0)
+[+] Running 2/2
+ ✔ Container db-gpt-db-1         Started                                                                                                                                                                                          0.4s
+ ✔ Container db-gpt-webserver-1  Started
+```
+
+You can see log with command:
+
+```bash
+$ docker logs db-gpt-webserver-1 -f
+```
+
+Open http://localhost:5000 with your browser to see the product.
+
+You can open docker-compose.yml in the project root directory to see more details.