diff --git a/README.md b/README.md index 87733bbe..0ee5d4e6 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ On Mac OS or Linux, write: `./setup.sh` -It will install all the dependencies and allow you to download the local model or use OpenAI. +It will install all the dependencies and allow you to download the local model, use OpenAI or use our LLM API. Otherwise, refer to this Guide: @@ -95,6 +95,7 @@ Otherwise, refer to this Guide: It should look like this inside: ``` + LLM_NAME=[docsgpt or openai or others] API_KEY=Yourkey VITE_API_STREAMING=true ``` @@ -126,7 +127,7 @@ docker compose -f docker-compose-dev.yaml up -d > Make sure you have Python 3.10 or 3.11 installed. 1. Export required environment variables or prepare a `.env` file in the `/application` folder: - - Copy [.env_sample](https://github.com/arc53/DocsGPT/blob/main/application/.env_sample) and create `.env` with your OpenAI API token for the `API_KEY` and `EMBEDDINGS_KEY` fields. + - Copy [.env_sample](https://github.com/arc53/DocsGPT/blob/main/application/.env_sample) and create `.env`. (check out [`application/core/settings.py`](application/core/settings.py) if you want to see more config options.) diff --git a/docs/pages/Deploying/Quickstart.md b/docs/pages/Deploying/Quickstart.md index cb5fcf38..3aa53cf3 100644 --- a/docs/pages/Deploying/Quickstart.md +++ b/docs/pages/Deploying/Quickstart.md @@ -8,7 +8,7 @@ Just run the following command: ./setup.sh ``` -This command will install all the necessary dependencies and provide you with an option to download the local model or use OpenAI. +This command will install all the necessary dependencies and provide you with an option to use our LLM API, download the local model or use OpenAI. If you prefer to follow manual steps, refer to this guide: @@ -16,7 +16,7 @@ If you prefer to follow manual steps, refer to this guide: ```bash git clone https://github.com/arc53/DocsGPT.git ``` -2. Create a `.env` file in your root directory and set your `API_KEY` with your [OpenAI API key](https://platform.openai.com/account/api-keys). +2. Create a `.env` file in your root directory and set your `API_KEY` with your [OpenAI API key](https://platform.openai.com/account/api-keys). (optional in case you want to use OpenAI) 3. Run the following commands: ```bash docker-compose build && docker-compose up