From 909eea346c3efaf557481d4a1995f14e76a68056 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Thu, 2 Oct 2025 12:41:27 -0400 Subject: [PATCH] install-cleanup --- docs/docs/_partial-onboarding.mdx | 2 +- docs/docs/get-started/docker.mdx | 14 ++++++++++---- docs/docs/get-started/install.mdx | 2 +- docs/sidebars.js | 2 +- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/docs/_partial-onboarding.mdx b/docs/docs/_partial-onboarding.mdx index ce0d6582..5efbf2eb 100644 --- a/docs/docs/_partial-onboarding.mdx +++ b/docs/docs/_partial-onboarding.mdx @@ -1,7 +1,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -### Application onboarding +## Application onboarding The first time you start OpenRAG, whether using the TUI or a `.env` file, you must complete application onboarding. diff --git a/docs/docs/get-started/docker.mdx b/docs/docs/get-started/docker.mdx index a1fa6801..8542169a 100644 --- a/docs/docs/get-started/docker.mdx +++ b/docs/docs/get-started/docker.mdx @@ -3,6 +3,7 @@ title: Deploy with Docker slug: /get-started/docker --- +import PartialOnboarding from '@site/docs/_partial-onboarding.mdx'; import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; @@ -23,7 +24,9 @@ They deploy the same applications and containers, but to different environments. - 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: GPU support requires an NVIDIA GPU with CUDA support and compatible NVIDIA drivers installed on the OpenRAG host machine. If you don't have GPU capabilities, OpenRAG provides an alternate CPU-only deployment. -To install OpenRAG with Docker Compose: +## Deploy OpenRAG with Docker Compose + +To install OpenRAG with Docker Compose, do the following: 1. Clone the OpenRAG repository. ```bash @@ -31,7 +34,7 @@ To install OpenRAG with Docker Compose: cd openrag ``` -2. Copy the example `.env` file that is included in the repository root. +2. Copy the example `.env` file included in the repository root. The example file includes all environment variables with comments to guide you in finding and setting their values. ```bash cp .env.example .env @@ -42,7 +45,8 @@ To install OpenRAG with Docker Compose: touch .env ``` -3. Set environment variables. The Docker Compose files are populated with values from your `.env`, so the following values are **required** to be set: +3. Set environment variables. The Docker Compose files will be populated with values from your `.env`. +The following values are **required** to be set: ```bash OPENSEARCH_PASSWORD=your_secure_password @@ -87,7 +91,9 @@ To install OpenRAG with Docker Compose: - **Backend API**: http://localhost:8000 - **Langflow**: http://localhost:7860 -Continue with the [Quickstart](/quickstart). +6. Continue with [Application Onboarding](#application-onboarding). + + ## Rebuild all Docker containers diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index da8060f1..830a8f5e 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -1,5 +1,5 @@ --- -title: Install Python wheel +title: Install OpenRAG slug: /install --- diff --git a/docs/sidebars.js b/docs/sidebars.js index a319ab8d..e95a6f19 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -28,7 +28,7 @@ const sidebars = { { type: "doc", id: "get-started/install", - label: "Install Python wheel" + label: "Install OpenRAG" }, { type: "doc",