gmakstutis/openrag
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

slight-config-change

Browse source
This commit is contained in:
Mendon Kissling 2025-10-02 14:21:30 -04:00
parent ac5ff9725e
commit 1598857552
2 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/docs/get-started/install.mdx
View file

@ -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 `.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`. 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} ## 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. **Basic Setup** does not set up OAuth connections for ingestion from Google Drive, OneDrive, or AWS.
For OAuth setup, use **Advanced Setup**. For OAuth setup, use **Advanced Setup**.

6
docs/docs/reference/configuration.mdx
View file

@ -16,7 +16,9 @@ OpenRAG recognizes [supported environment variables](#supported-environment-vari
## Configure environment variables ## 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 ### Precedence
@ -34,8 +36,6 @@ To set environment variables, do the following.
``` ```
3. Start OpenRAG. 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 ## Supported environment variables
All OpenRAG configuration can be controlled through environment variables. All OpenRAG configuration can be controlled through environment variables.