From 2d397a530442f9b2602313ff848b972e89bb55f8 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Thu, 23 Oct 2025 21:17:31 -0400 Subject: [PATCH] split-out-tui-and-remove --- README.md | 2 +- docs/docs/get-started/install.mdx | 66 ++++++++++++++++++++++- docs/docs/get-started/tui.mdx | 90 ------------------------------- docs/sidebars.js | 5 -- 4 files changed, 66 insertions(+), 97 deletions(-) delete mode 100644 docs/docs/get-started/tui.mdx diff --git a/README.md b/README.md index 4cc99a71..f3b3e1d4 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ To launch OpenRAG with the TUI, do the following: The TUI opens and guides you through OpenRAG setup. -For the full TUI guide, see [TUI](https://docs.openr.ag/get-started/tui). +For the full TUI installation guide, see [TUI](https://docs.openr.ag/install). ## Docker installation diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index a776cb98..c5f3c858 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -9,6 +9,14 @@ import PartialOnboarding from '@site/docs/_partial-onboarding.mdx'; [Install the OpenRAG Python wheel](#install-python-wheel), and then run the [OpenRAG Terminal User Interface(TUI)](#setup) to start your OpenRAG deployment with a guided setup process. +The OpenRAG Terminal User Interface (TUI) allows you to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system. + +![OpenRAG TUI Interface](@site/static/img/OpenRAG_TUI_2025-09-10T13_04_11_757637.svg) + +Instead of starting OpenRAG using Docker commands and manually editing values in the `.env` file, the TUI walks you through the setup. It prompts for variables where required, creates a `.env` file for you, and then starts OpenRAG. + +Once OpenRAG is running, use the TUI to monitor your application, control your containers, and retrieve logs. + If you prefer running Docker commands and manually editing `.env` files, see [Install with Docker](/get-started/docker). ## Prerequisites @@ -126,4 +134,60 @@ If the TUI detects OAuth credentials, it enforces the **Advanced Setup** path. - \ No newline at end of file + + +## Manage OpenRAG containers with the TUI + +After installation, the TUI can deploy, manage, and upgrade your OpenRAG containers. + +### Start container services + +Click **Start Container Services** to start the OpenRAG containers. +The TUI automatically detects your container runtime, and then checks if your machine has compatible GPU support by checking for `CUDA`, `NVIDIA_SMI`, and Docker/Podman runtime support. This check determines which Docker Compose file OpenRAG uses. +The TUI then pulls the images and deploys the containers with the following command. +```bash +docker compose up -d +``` + +If images are missing, the TUI runs `docker compose pull`, then runs `docker compose up -d`. + +### Start native services + +A "native" service in OpenRAG refers to a service run natively on your machine, and not within a container. +The `docling serve` process is a native service in OpenRAG, because it's a document processing service that is run on your local machine, and controlled separately from the containers. + +To start or stop `docling serve` or any other native services, in the TUI main menu, click **Start Native Services** or **Stop Native Services**. + +To view the status, port, or PID of a native service, in the TUI main menu, click [Status](#status). + +### Status + +The **Status** menu displays information on your container deployment. +Here you can check container health, find your service ports, view logs, and upgrade your containers. + +To view streaming logs, select the container you want to view, and press l. +To copy your logs, click **Copy to Clipboard**. + +To **upgrade** your containers, click **Upgrade**. +**Upgrade** runs `docker compose pull` and then `docker compose up -d --force-recreate`. +The first command pulls the latest images of OpenRAG. +The second command recreates the containers with your data persisted. + +To **reset** your containers, click **Reset**. +Reset gives you a completely fresh start. +Reset deletes all of your data, including OpenSearch data, uploaded documents, and authentication. +**Reset** runs two commands. +It first stops and removes all containers, volumes, and local images. +``` +docker compose down --volumes --remove-orphans --rmi local +``` + +When the first command is complete, OpenRAG removes any additional Docker objects with `prune`. + +``` +docker system prune -f +``` + +## Diagnostics + +The **Diagnostics** menu provides health monitoring for your container runtimes and monitoring of your OpenSearch security. \ No newline at end of file diff --git a/docs/docs/get-started/tui.mdx b/docs/docs/get-started/tui.mdx deleted file mode 100644 index 7691430b..00000000 --- a/docs/docs/get-started/tui.mdx +++ /dev/null @@ -1,90 +0,0 @@ ---- -title: Terminal User Interface (TUI) commands -slug: /get-started/tui ---- - -The OpenRAG Terminal User Interface (TUI) allows you to set up, configure, and monitor your OpenRAG deployment directly from the terminal, on any operating system. - -![OpenRAG TUI Interface](@site/static/img/OpenRAG_TUI_2025-09-10T13_04_11_757637.svg) - -Instead of starting OpenRAG using Docker commands and manually editing values in the `.env` file, the TUI walks you through the setup. It prompts for variables where required, creates a `.env` file for you, and then starts OpenRAG. - -Once OpenRAG is running, use the TUI to monitor your application, control your containers, and retrieve logs. - -## Start the TUI - -To start the TUI, run the following commands from the directory where you installed OpenRAG. - -```bash -uv sync -uv run openrag -``` - -The TUI Welcome Screen offers basic and advanced setup options. -For more information on setup values during installation, see [Install OpenRAG](/install). - -## Navigation - -The TUI accepts mouse input or keyboard commands. - -- Arrow keys: move between options -- Tab/Shift+Tab: switch fields and buttons -- Enter: select/confirm -- Escape: back -- Q: quit -- Number keys (1-4): quick access to main screens - -## Container management - -The TUI can deploy, manage, and upgrade your OpenRAG containers. - -### Start container services - -Click **Start Container Services** to start the OpenRAG containers. -The TUI automatically detects your container runtime, and then checks if your machine has compatible GPU support by checking for `CUDA`, `NVIDIA_SMI`, and Docker/Podman runtime support. This check determines which Docker Compose file OpenRAG uses. -The TUI then pulls the images and deploys the containers with the following command. -```bash -docker compose up -d -``` -If images are missing, the TUI runs `docker compose pull`, then runs `docker compose up -d`. - -### Start native services - -A "native" service in OpenRAG refers to a service run natively on your machine, and not within a container. -The `docling serve` process is a native service in OpenRAG, because it's a document processing service that is run on your local machine, and controlled separately from the containers. - -To start or stop `docling serve` or any other native services, in the TUI main menu, click **Start Native Services** or **Stop Native Services**. - -To view the status, port, or PID of a native service, in the TUI main menu, click [Status](#status). - -### Status - -The **Status** menu displays information on your container deployment. -Here you can check container health, find your service ports, view logs, and upgrade your containers. - -To view streaming logs, select the container you want to view, and press l. -To copy your logs, click **Copy to Clipboard**. - -To **upgrade** your containers, click **Upgrade**. -**Upgrade** runs `docker compose pull` and then `docker compose up -d --force-recreate`. -The first command pulls the latest images of OpenRAG. -The second command recreates the containers with your data persisted. - -To **reset** your containers, click **Reset**. -Reset gives you a completely fresh start. -Reset deletes all of your data, including OpenSearch data, uploaded documents, and authentication. -**Reset** runs two commands. -It first stops and removes all containers, volumes, and local images. -``` -docker compose down --volumes --remove-orphans --rmi local -``` - -When the first command is complete, OpenRAG removes any additional Docker objects with `prune`. - -``` -docker system prune -f -``` - -## Diagnostics - -The **Diagnostics** menu provides health monitoring for your container runtimes and monitoring of your OpenSearch security. \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index dd561b33..a80e1490 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -40,11 +40,6 @@ const sidebars = { id: "get-started/quickstart", label: "Quickstart" }, - { - type: "doc", - id: "get-started/tui", - label: "Terminal User Interface (TUI)" - }, ], }, {