install-cleanup

This commit is contained in:
Mendon Kissling 2025-10-02 12:41:27 -04:00
parent 631aca0518
commit 909eea346c
4 changed files with 13 additions and 7 deletions

View file

@ -1,7 +1,7 @@
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; 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. The first time you start OpenRAG, whether using the TUI or a `.env` file, you must complete application onboarding.

View file

@ -3,6 +3,7 @@ title: Deploy with Docker
slug: /get-started/docker slug: /get-started/docker
--- ---
import PartialOnboarding from '@site/docs/_partial-onboarding.mdx';
import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx'; import PartialExternalPreview from '@site/docs/_partial-external-preview.mdx';
<PartialExternalPreview /> <PartialExternalPreview />
@ -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). - 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. - 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. 1. Clone the OpenRAG repository.
```bash ```bash
@ -31,7 +34,7 @@ To install OpenRAG with Docker Compose:
cd openrag 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. The example file includes all environment variables with comments to guide you in finding and setting their values.
```bash ```bash
cp .env.example .env cp .env.example .env
@ -42,7 +45,8 @@ To install OpenRAG with Docker Compose:
touch .env 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 ```bash
OPENSEARCH_PASSWORD=your_secure_password OPENSEARCH_PASSWORD=your_secure_password
@ -87,7 +91,9 @@ To install OpenRAG with Docker Compose:
- **Backend API**: http://localhost:8000 - **Backend API**: http://localhost:8000
- **Langflow**: http://localhost:7860 - **Langflow**: http://localhost:7860
Continue with the [Quickstart](/quickstart). 6. Continue with [Application Onboarding](#application-onboarding).
<PartialOnboarding />
## Rebuild all Docker containers ## Rebuild all Docker containers

View file

@ -1,5 +1,5 @@
--- ---
title: Install Python wheel title: Install OpenRAG
slug: /install slug: /install
--- ---

View file

@ -28,7 +28,7 @@ const sidebars = {
{ {
type: "doc", type: "doc",
id: "get-started/install", id: "get-started/install",
label: "Install Python wheel" label: "Install OpenRAG"
}, },
{ {
type: "doc", type: "doc",