mirror of
https://github.com/csunny/DB-GPT.git
synced 2026-08-09 16:12:20 +00:00
c655f55ab4
# Description Add Oracle datasource documentation examples and update duplicate command of start webserver # How Has This Been Tested? # Snapshots: Include snapshots for easier review. # Checklist: - [ ] My code follows the style guidelines of this project - [x] I have already rebased the commits and make the commit message conform to the project standard. - [x] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] Any dependent changes have been merged and published in downstream modules
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.