From 8f282384d3fd7bae30061aab476275f436ed0f72 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Mon, 10 Nov 2025 11:46:41 -0500 Subject: [PATCH] openai-key-not-reqd --- docs/docs/get-started/docker.mdx | 15 ++++++++------- docs/docs/get-started/install.mdx | 6 +++--- docs/docs/reference/configuration.mdx | 2 +- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index 24658a0b..719db1be 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -19,7 +19,7 @@ OpenRAG has two Docker Compose files. Both files deploy the same applications an - 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. -- Create an [OpenAI API key](https://platform.openai.com/api-keys). This key is **required** to start OpenRAG, but you can choose a different model provider during [Application Onboarding](#application-onboarding). +- 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: 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 with Docker Compose @@ -48,19 +48,20 @@ To install OpenRAG with Docker Compose, do the following: touch .env ``` -4. The Docker Compose files are populated with the values from your `.env` file. The following values must be set: +4. The Docker Compose files are populated with the values from your `.env` file. + The `OPENSEARCH_PASSWORD` value must be set. + `OPENSEARCH_PASSWORD` can be automatically generated when using the TUI, but for a Docker Compose installation, you can set it manually instead. To generate an OpenSearch admin password, see the [OpenSearch documentation](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password). + + The following values are optional: ```bash - OPENSEARCH_PASSWORD=your_secure_password OPENAI_API_KEY=your_openai_api_key LANGFLOW_SECRET_KEY=your_secret_key ``` - `OPENSEARCH_PASSWORD` can be automatically generated when using the TUI, but for a Docker Compose installation, you can set it manually instead. To generate an OpenSearch admin password, see the [OpenSearch documentation](https://docs.opensearch.org/latest/security/configuration/demo-configuration/#setting-up-a-custom-admin-password). + `OPENAI_API_KEY` is optional. You can provide it during [Application Onboarding](#application-onboarding) or choose a different model provider. If you want to set it in your `.env` file, you can find your OpenAI API key in your [OpenAI account](https://platform.openai.com/api-keys). - The `OPENAI_API_KEY` is found in your OpenAI account. - - `LANGFLOW_SECRET_KEY` is automatically generated when using the TUI, and Langflow will also auto-generate it if not set. For more information, see the [Langflow documentation](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key). + `LANGFLOW_SECRET_KEY` is optional. Langflow will auto-generate it if not set. For more information, see the [Langflow documentation](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key). The following Langflow configuration values are optional but important to consider: diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index fd992864..f8a8e488 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. -- Create an [OpenAI API key](https://platform.openai.com/api-keys). This key is **required** to start OpenRAG, but you can choose a different model provider during [Application Onboarding](#application-onboarding). +- 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: 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} @@ -163,7 +163,7 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. - **Basic Setup** can generate all of the required values for OpenRAG except the OpenAI API key. + **Basic Setup** can generate all of the required values for OpenRAG. The OpenAI API key is optional and can be provided during onboarding. **Basic Setup** does not set up OAuth connections for ingestion from cloud providers. For OAuth setup, use **Advanced Setup**. For information about the difference between basic (no auth) and OAuth in OpenRAG, see [Authentication and document access](/knowledge#auth). @@ -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. Paste your OpenAI API key in the OpenAI API key field. + 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. 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 7451a405..8a5c2425 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. Required. | +| `OPENAI_API_KEY` | - | Your OpenAI API key. Optional. Can be provided during Application onboarding. | | `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. |