diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index d8fa252f..b50bbe45 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -28,6 +28,10 @@ If you prefer running Podman or Docker containers and manually editing `.env` fi - 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: 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. +:::note Windows users +The OpenRAG TUI has limited compatibility with PowerShell. To use the TUI, use [WSL (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install). Alternatively, skip the TUI and follow the [OpenRAG container installation](/get-started/docker) steps instead. +::: + ## Install the OpenRAG Python wheel {#install-python-wheel} The OpenRAG wheel installs the Terminal User Interface (TUI) for configuring and running OpenRAG. @@ -155,7 +159,15 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. -## Manage OpenRAG containers with the TUI +## Close the OpenRAG TUI + +To close the OpenRAG TUI, press q. +The OpenRAG containers will continue to be served until the containers are stopped. +For more information, see [Manage OpenRAG containers with the TUI ](#tui-container-management). + +To start the TUI again, run `uvx openrag`. + +## Manage OpenRAG containers with the TUI {#tui-container-management} After installation, the TUI can deploy, manage, and upgrade your OpenRAG containers.