diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 27e94c83..1759e813 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -29,7 +29,7 @@ If you prefer running Docker commands and manually editing `.env` files, see [De The `.whl` file is currently available as an internal download during public preview, and will be published to PyPI in a future release. ::: -The OpenRAG wheel installs the Terminal User Interface (TUI) for running and managing OpenRAG. +The OpenRAG wheel installs the Terminal User Interface (TUI) for configuring and running OpenRAG. 1. Create a new project with a virtual environment using `uv init`. @@ -64,7 +64,9 @@ The OpenRAG wheel installs the Terminal User Interface (TUI) for running and man ## Set up OpenRAG with the TUI {#setup} -**Basic Setup** completes or auto-generates most of the required values to start OpenRAG. +The TUI creates a `.env` file in your OpenRAG directory root and starts OpenRAG. + +**Basic Setup** generates all of the required values except the OpenAI API key. **Basic Setup** does not set up OAuth connections for ingestion from Google Drive, OneDrive, or AWS. For OAuth setup, use **Advanced Setup**. @@ -120,4 +122,4 @@ If the TUI detects a `.env` file in the OpenRAG root directory, it will source a - + \ No newline at end of file diff --git a/docs/docs/reference/configuration.mdx b/docs/docs/reference/configuration.mdx index b6d6218d..a22f7900 100644 --- a/docs/docs/reference/configuration.mdx +++ b/docs/docs/reference/configuration.mdx @@ -16,7 +16,9 @@ OpenRAG recognizes [supported environment variables](#supported-environment-vari ## Configure environment variables -Environment variables can be set in a `.env` or `docker-compose.yml` file. +Environment variables are set in a `.env` file in the root of your OpenRAG project directory. + +The Docker Compose files are populated with values from your `.env`, so you don't need to edit the Compose files manually. ### Precedence @@ -34,8 +36,6 @@ To set environment variables, do the following. ``` 3. Start OpenRAG. -The Docker Compose files are also populated with values from your `.env`, so you don't need to edit the files manually. - ## Supported environment variables All OpenRAG configuration can be controlled through environment variables.