Files
DB-GPT/docs
alanchen 368f42227e feat(benchmark): Support Falcon Text2SQL Datasets LLM benchmark (#2918)
Co-authored-by: yaoyifan-yyf <yaoyifan.yyf@antgroup.com>
Co-authored-by: alan.cl <alan.cl@antgroup.com>
Co-authored-by: iterminatorheart <123625928+iterminatorheart@users.noreply.github.com>
Co-authored-by: VLADIMIR KOBZEV <vladimir.kobzev@improvado.io>
Co-authored-by: Aries-ckt <916701291@qq.com>
Co-authored-by: xiandu.wl <xiandu.wl@antgroup.com>
2025-10-23 14:26:36 +08:00
..
2025-03-19 11:51:50 +08:00

DB-GPT documentation

Quick Start

Install dependencies

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

launch

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.

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

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.