DB-GPT Documentation

Open-source agentic AI data assistant for the next generation of AI + Data products.

20,179 stars Python Python 101 files ยท ~126,782 tokens #agents#bgi#database#deepseek#gpt#gpt-4#hacktoberfest#llm
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy DB-GPT on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run)
docker run -d --name db-gpt -p 3306:3306 --restart always eosphorosai/dbgpt-openai:latest
Configured Services & Ports
โš™๏ธ db
image: mysql/mysql-server
๐Ÿ”Œ Ports: 3306:3306
โš™๏ธ webserver
image: eosphorosai/dbgpt-openai:latest
๐Ÿ”Œ Ports: 5670:5670/tcp
docker-compose.yml
yaml (docker-compose.yml)
# To run current docker compose file, you should prepare the silliconflow api key in your environment.
# SILICONFLOW_API_KEY=${SILICONFLOW_API_KEY} docker compose up -d
services:
  db:
    image: mysql/mysql-server
    environment:
      MYSQL_USER: 'user'
      MYSQL_PASSWORD: 'password'
      MYSQL_ROOT_PASSWORD: 'aa123456'
      TZ: "${TZ:-UTC}"
    ports:
      - 3306:3306
    volumes:
      - dbgpt-myql-db:/var/lib/mysql
      - ./docker/examples/my.cnf:/etc/my.cnf
      - ./docker/examples/sqls:/docker-entrypoint-initdb.d
      - ./assets/schema/dbgpt.sql:/docker-entrypoint-initdb.d/dbgpt.sql
    restart: unless-stopped
    networks:
      - dbgptnet
  webserver:
    image: eosphorosai/dbgpt-openai:latest
    command: dbgpt start webserver --config /app/configs/dbgpt-proxy-siliconflow-mysql.toml
    environment:
      - SILICONFLOW_API_KEY=${SILICONFLOW_API_KEY}
      - MYSQL_PASSWORD=aa123456
      - MYSQL_HOST=db
      - MYSQL_PORT=3306
      - MYSQL_DATABASE=dbgpt
      - MYSQL_USER=root
      - TZ=${TZ:-UTC}
    volumes:
      - ./configs:/app/configs
      - /data:/data
      # May be you can mount your models to container
      - /data/models:/app/models
      - dbgpt-data:/app/pilot/data
      - dbgpt-message:/app/pilot/message
    depends_on:
      - db
    ports:
      - 5670:5670/tcp
    # webserver may be failed, it must wait all sqls in /docker-entrypoint-initdb.d execute finish.
    restart: unless-stopped
    networks:
      - dbgptnet
    ipc: host
volumes:
  dbgpt-myql-db:
  dbgpt-data:
  dbgpt-message:
  dbgpt-alembic-versions:
networks:
  dbgptnet:
    driver: bridge
    name: dbgptnet

DB-GPT documentation

Quick Start

Install dependencies

  • Clone current project firstly!
  • Install docusaurus dependencies, generate node_modules folder.
text
yarn install

launch

text
yarn start

The default service starts on port 3000, visit localhost:3000

Deploy Multi-Version Documentation

We can deploy multiple versions of the documentation by docker.

Build Docker Image

Firstly, build the docker image in DB-GPT project root directory.

bash
# Use the default NPM_REGISTRY=https://registry.npmjs.org
# Use https://www.npmmirror.com/
NPM_REGISTRY=https://registry.npmmirror.com
docker build -f docs/Dockerfile-deploy \
-t eosphorosai/dbgpt-docs \
--build-arg NPM_REGISTRY=$NPM_REGISTRY \
--build-arg CI=false \
--build-arg NUM_VERSION=2 .

Run Docker Container

Run the docker container with the following command:

bash
docker run -it --rm -p 8089:8089 \
--name my-dbgpt-docs \
-v $(pwd)/docs/nginx/nginx-docs.conf:/etc/nginx/nginx.conf \
eosphorosai/dbgpt-docs

Open the browser and visit localhost:8089 to see the documentation.