OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.
Python
exception for OpenRAG within Linux-based VMs
April M8b700616641b
diff --git a/docs/docs/_partial-container-vm.mdx b/docs/docs/_partial-container-vm.mdxnew file mode 100644index 000000000..a61d4df74--- /dev/null+++ b/docs/docs/_partial-container-vm.mdx@@ -0,0 +1,6 @@+A Docker or Podman VM must be running before you start OpenRAG unless you are running OpenRAG with a Linux-based VM, such as a Linux-based [WSL](/install-windows) image.++The container VM must have sufficient resources to run the OpenRAG containers.+The minimum recommendation is 8 GB of RAM and at least 50 GB of free disk space.++For more information, see [Troubleshoot OpenRAG](/support/troubleshoot).\ No newline at end of filediff --git a/docs/docs/_partial-prereq-docker.mdx b/docs/docs/_partial-prereq-docker.mdxindex 213235125..e3834c972 100644--- a/docs/docs/_partial-prereq-docker.mdx+++ b/docs/docs/_partial-prereq-docker.mdx@@ -1,11 +1,8 @@-* Install [Podman](https://podman.io/docs/installation) or [Docker](https://docs.docker.com/get-docker/).-- The OpenRAG team recommends, at minimum, 8 GB of RAM for container VMs.- However, if you plan to upload large files regularly, more RAM is recommended.+import PartialContainerVm from '@site/docs/_partial-container-vm.mdx';- A Docker or Podman VM must be running before you start OpenRAG.+* Install [Podman](https://podman.io/docs/installation) or [Docker](https://docs.docker.com/get-docker/).- For more information, see [Troubleshoot OpenRAG](/support/troubleshoot).+ <PartialContainerVm />* Install [`podman-compose`](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or [Docker Compose](https://docs.docker.com/compose/install/).To use Docker Compose with Podman, you must alias Docker Compose commands to Podman commands.\ No newline at end of filediff --git a/docs/docs/get-started/manage-services.mdx b/docs/docs/get-started/manage-services.mdxindex 29caf576d..98f7d154d 100644--- a/docs/docs/get-started/manage-services.mdx+++ b/docs/docs/get-started/manage-services.mdx@@ -9,6 +9,7 @@ import PartialDockerComposeUp from '@site/docs/_partial-docker-compose-up.mdx';import PartialDockerComposeDownAndPrune from '@site/docs/_partial-docker-compose-down-and-prune.mdx';import PartialFactorResetWarning from '@site/docs/_partial-factory-reset-warning.mdx';import PartialExportFlows from '@site/docs/_partial-export-flows.mdx';+import PartialContainerVm from '@site/docs/_partial-container-vm.mdx';Service management is an essential part of maintaining your OpenRAG deployment.@@ -53,8 +54,7 @@ For fine-grained controls, you must [start the terminal session with `--tui`](/tThen, click **Status** to access controls to stop, start, or restart individual services.:::tip-A Docker or Podman VM must be running before you start OpenRAG, and it must have sufficient resources to run the OpenRAG containers.-For more information, see [Troubleshoot OpenRAG](/support/troubleshoot).+<PartialContainerVm />:::<details>diff --git a/docs/docs/get-started/tui.mdx b/docs/docs/get-started/tui.mdxindex b08f2b511..72a559690 100644--- a/docs/docs/get-started/tui.mdx+++ b/docs/docs/get-started/tui.mdx@@ -4,6 +4,7 @@ slug: /tui---import PartialGpuModeTip from '@site/docs/_partial-gpu-mode-tip.mdx';+import PartialContainerVm from '@site/docs/_partial-container-vm.mdx';The OpenRAG terminal session provides a simplified and guided experience for configuring, managing, and monitoring your OpenRAG deployment directly from the terminal.@@ -33,8 +34,7 @@ The GUI terminal, also known as the Terminal User Interface (TUI), provides the## Manage services with the terminal:::tip-A Docker or Podman VM must be running before you start OpenRAG, and it must have sufficient resources to run the OpenRAG containers.-For more information, see [Troubleshoot OpenRAG](/support/troubleshoot).+<PartialContainerVm />:::Use the terminal's **Start services** and **Stop services** options to start and stop the OpenRAG services.diff --git a/docs/docs/support/troubleshoot.mdx b/docs/docs/support/troubleshoot.mdxindex 46fb2ced4..157478253 100644--- a/docs/docs/support/troubleshoot.mdx+++ b/docs/docs/support/troubleshoot.mdx@@ -19,13 +19,13 @@ open "/Applications/Python 3.13/Install Certificates.command"## No container runtime found, or Docker/Podman not ready-When you start OpenRAG, `No container runtime found` and `Docker/Podman not ready` errors indicate that OpenRAG cannot find a running Docker or Podman machine to run the OpenRAG containers.+When you start OpenRAG, `No container runtime found` and `Docker/Podman not ready` errors indicate that OpenRAG cannot find or start a running Docker or Podman machine to run the OpenRAG containers.Before you starting OpenRAG, do the following:1. Install Docker or Podman as well as docker-compose or podman-compose.2. Make sure Docker or Podman is available in the PATH.-3. Make sure a container VM is running.+3. Unless you are running OpenRAG with a Linux-based VM, such as a Linux-based [WSL](/install-windows) image, start the container VM.Either run `podman machine start` or a similar command, or start the Docker/Podman Desktop app.For Linux environments, you can find more troubleshooting advice in the [Podman installation documentation](https://podman.io/docs/installation#installing-on-linux) and the [Docker installation documentation](https://docs.docker.com/engine/install/).