From 40da7caa94f48385578f08cf679aa80981b0a0d2 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Mon, 10 Nov 2025 16:40:38 -0500 Subject: [PATCH] Apply suggestions from code review Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com> --- docs/docs/get-started/install.mdx | 4 ++-- docs/docs/reference/configuration.mdx | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 74aaa7ea..ec736ec8 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -25,7 +25,7 @@ If you prefer running Podman or Docker containers and manually editing `.env` fi - Install [uv](https://docs.astral.sh/uv/getting-started/installation/) - Install [Podman](https://podman.io/docs/installation) (recommended) or [Docker](https://docs.docker.com/get-docker/) - Install [Docker Compose](https://docs.docker.com/compose/install/). If using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands. -- Optional: Create an [OpenAI API key](https://platform.openai.com/api-keys). You can provide this key during [Application Onboarding](#application-onboarding) or choose a different model provider. +- Optional: Create an [OpenAI API key](https://platform.openai.com/api-keys). During [Application Onboarding](#application-onboarding), you can provide this key or choose a different model provider. - Optional: Install GPU support with an NVIDIA GPU, [CUDA](https://docs.nvidia.com/cuda/) support, and compatible NVIDIA drivers on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment. ## Install OpenRAG {#install} @@ -174,7 +174,7 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. The OpenSearch password is required. The Langflow admin password is optional. If no Langflow admin password is generated, Langflow runs in [autologin mode](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login) with no password required. - 3. Optionally, paste your OpenAI API key in the OpenAI API key field. You can also provide this during onboarding or choose a different model provider. + 3. Optional: Paste your OpenAI API key in the OpenAI API key field. You can also provide this during onboarding or choose a different model provider. 4. Click **Save Configuration**. Your passwords are saved in the `.env` file used to start OpenRAG. 5. To start OpenRAG, click **Start All Services**. diff --git a/docs/docs/reference/configuration.mdx b/docs/docs/reference/configuration.mdx index 8a5c2425..1827e94a 100644 --- a/docs/docs/reference/configuration.mdx +++ b/docs/docs/reference/configuration.mdx @@ -64,7 +64,7 @@ For more information, see [Application onboarding](/install#application-onboardi | `EMBEDDING_MODEL` | `text-embedding-3-small` | Embedding model for vector search. | | `LLM_MODEL` | `gpt-4o-mini` | Language model for the chat agent. | | `MODEL_PROVIDER` | `openai` | Model provider, such as OpenAI or IBM watsonx.ai. | -| `OPENAI_API_KEY` | - | Your OpenAI API key. Optional. Can be provided during Application onboarding. | +| `OPENAI_API_KEY` | - | Your OpenAI API key. Optional. Can be provided during application onboarding when installing OpenRAG. | | `PROVIDER_API_KEY` | - | API key for the model provider. | | `PROVIDER_ENDPOINT` | - | Custom provider endpoint. Only used for IBM or Ollama providers. | | `PROVIDER_PROJECT_ID` | - | Project ID for providers. Only required for the IBM watsonx.ai provider. |