diff --git a/README.md b/README.md index 977c8cee..ffebc579 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ A more detailed [Quickstart](https://docs.docsgpt.cloud/quickstart) is available PowerShell -ExecutionPolicy Bypass -File .\setup.ps1 ``` -Either script will guide you through setting up DocsGPT. Four options available: using the public API, running locally, connecting to a local inference engine, or using a cloud API provider. Scripts will automatically configure your `.env` file and handle necessary downloads and installations based on your chosen option. +Either script will guide you through setting up DocsGPT. Five options available: using the public API, running locally, connecting to a local inference engine, using a cloud API provider, or build the docker image locally. Scripts will automatically configure your `.env` file and handle necessary downloads and installations based on your chosen option. **Navigate to http://localhost:5173/** diff --git a/docs/pages/quickstart.mdx b/docs/pages/quickstart.mdx index 11a17895..6cd62cd4 100644 --- a/docs/pages/quickstart.mdx +++ b/docs/pages/quickstart.mdx @@ -43,7 +43,8 @@ The easiest way to launch DocsGPT is using the provided `setup.sh` script. This 2) Serve Local (with Ollama) 3) Connect Local Inference Engine 4) Connect Cloud API Provider - Choose option (1-4): + 5) Advanced: Build images locally (for developers) + Choose option (1-5): ``` Let's break down each option: @@ -56,6 +57,8 @@ The easiest way to launch DocsGPT is using the provided `setup.sh` script. This * **4) Connect Cloud API Provider:** This option lets you connect DocsGPT to a commercial Cloud API provider such as OpenAI, Google (Vertex AI/Gemini), Anthropic (Claude), Groq, HuggingFace Inference API, or Azure OpenAI. You will need an API key from your chosen provider. Select this if you prefer to use a powerful cloud-based LLM. + * **5) Modify DocsGPT's source code and rebuild the Docker images locally. Instead of pulling prebuilt images from Docker Hub or using the hosted/public API, you build the entire backend and frontend from source, customizing how DocsGPT works internally, or run it in an environment without internet access. + After selecting an option and providing any required information (like API keys or model names), the script will configure your `.env` file and start DocsGPT using Docker Compose. 4. **Access DocsGPT in your browser:**