From 8a2a7399dd557d457a1b322e6f305856f1f5631c Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Mon, 22 Sep 2025 18:18:34 -0400 Subject: [PATCH 1/5] docker-installation --- docs/docs/get-started/install.mdx | 159 ++++++++++++++++++++++++++++++ docs/sidebars.js | 5 + 2 files changed, 164 insertions(+) create mode 100644 docs/docs/get-started/install.mdx diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx new file mode 100644 index 00000000..67b9d70e --- /dev/null +++ b/docs/docs/get-started/install.mdx @@ -0,0 +1,159 @@ +--- +title: Install OpenRAG +slug: /install +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +OpenRAG can be installed in multiple ways: + +* [**Docker**](#install-and-run-docker): Deploy the full OpenRAG stack with Docker Compose, including all services and dependencies. + +* [**TUI**](tui.mdx): Use the Terminal User Interface to install, run, and configure your OpenRAG deployment without running Docker commands. + +## Docker {#install-and-run-docker} + +The OpenRAG Docker compose file starts five containers: + +| Container Name | Default Address | Purpose | +|---|---|---| +| OpenRAG Backend | http://localhost:8000 | FastAPI server and core functionality. | +| OpenRAG Frontend | http://localhost:3000 | React web interface for users. | +| Langflow | http://localhost:7860 | AI workflow engine and flow management. | +| OpenSearch | http://localhost:9200 | Vector database for document storage. | +| OpenSearch Dashboards | http://localhost:5601 | Database administration interface. | + +There are two different Docker Compose files. +They deploy the same applications and containers, but to different environments. + +- [`docker-compose.yml`](https://github.com/langflow-ai/openrag/blob/main/docker-compose.yml) is an OpenRAG deployment with GPU support for accelerated AI processing. + +- [`docker-compose-cpu.yml`](https://github.com/langflow-ai/openrag/blob/main/docker-compose-cpu.yml) is a CPU-only version of OpenRAG for systems without GPU support. Use this Docker compose file for environments where GPU drivers aren't available. + +Before installing OpenRAG with Docker, ensure you have: + +- [Docker](https://docs.docker.com/get-docker/) installed +- [Docker Compose](https://docs.docker.com/compose/install/) installed +- For GPU support: (TBD) + +1. Clone the OpenRAG repository. + ```bash + git clone https://github.com/langflow-ai/openrag.git + cd openrag + ``` + +2. Create a `.env` file in the repository root. + ``` + 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: + + ```bash + OPENSEARCH_PASSWORD=your_secure_password + OPENAI_API_KEY=your_openai_api_key + + LANGFLOW_SUPERUSER=admin + LANGFLOW_SUPERUSER_PASSWORD=your_langflow_password + LANGFLOW_SECRET_KEY=your_secret_key + ``` + For more information on configuring OpenRAG with environment variables, see [Environment variables](configure/environment-variables). + For additional configuration values, including `config.yaml`, see [Configuration](/configure/configuration). + +4. Deploy OpenRAG with Docker Compose based on your deployment type. + + For GPU-enabled systems, run the following command: + ```bash + docker compose up -d + ``` + + For CPU-only systems, run the following command: + ```bash + docker compose -f docker-compose-cpu.yml up -d + ``` + +5. Verify installation by confirming all services are running. + + ```bash + docker compose ps + ``` + + You can now access the application at: + + - **Frontend**: http://localhost:3000 + - **Backend API**: http://localhost:8000 + - **Langflow**: http://localhost:7860 + +Continue with the [Quickstart](/quickstart). + +## Python wheel {#install-and-run-the-openrag-oss-python-wheel} + +### Prerequisites + +1. Make sure you have the required dependencies and infrastructure: + + - [Python](https://www.python.org/downloads/release/python-3100/) + - macOS and Linux: Version 3.10 to 3.13 + - Windows: Version 3.10 to 3.12 + - [uv](https://docs.astral.sh/uv/getting-started/installation/) + - Sufficient infrastructure: + - Minimum: Dual-core CPU and 2 GB RAM + - Recommended: Multi-core CPU and at least 4 GB RAM + +2. Create a virtual environment with [uv](https://docs.astral.sh/uv/pip/environments). + +
+ Need help with virtual environments? + + Virtual environments ensure OpenRAG is installed in an isolated, fresh environment. + To create a new virtual environment, do the following. + + + + + 1. Navigate to where you want your virtual environment to be created, and then create it with `uv`: + + ```shell + uv venv VENV_NAME + ``` + + Replace `VENV_NAME` with a name for your virtual environment. + + 2. Start the virtual environment: + + ```shell + source VENV_NAME/bin/activate + ``` + + Your shell's prompt changes to display that you're currently working in a virtual environment: + + ```text + (VENV_NAME) ➜ openrag git:(main) ✗ + ``` + + 3. To deactivate the virtual environment and return to your regular shell, type `deactivate`. + + When activated, the virtual environment temporarily modifies your `PATH` variable to prioritize packages installed within the virtual environment. + To avoid conflicts with other projects, it's a good idea to deactivate your virtual environment when you're done working in it. + + To delete the virtual environment, type `rm -rf VENV_NAME`. + This completely removes the virtual environment directory and its contents. + + + +
+ +3. Install the wheel from PyPI. + + ```bash + uv pip install openrag-*.whl + ``` + +4. Verify installation: + + ```bash + openrag --version + ``` + + This should display the installed version of OpenRAG. diff --git a/docs/sidebars.js b/docs/sidebars.js index 51a4ddc3..ff928a17 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -25,6 +25,11 @@ const sidebars = { id: "get-started/intro", label: "Introduction" }, + { + type: "doc", + id: "get-started/install", + label: "Installation" + }, { type: "doc", id: "get-started/docker", From 45c0e24c4bc4449aeaf8b21581bc358de539c425 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Tue, 23 Sep 2025 11:20:56 -0400 Subject: [PATCH 2/5] wheel-and-tui-installation --- docs/docs/get-started/install.mdx | 133 +++++++++++++++--------------- 1 file changed, 66 insertions(+), 67 deletions(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 67b9d70e..f6a547ea 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -8,13 +8,22 @@ import TabItem from '@theme/TabItem'; OpenRAG can be installed in multiple ways: -* [**Docker**](#install-and-run-docker): Deploy the full OpenRAG stack with Docker Compose, including all services and dependencies. +* [**Python wheel**](#install-python-wheel): Install the OpenRAG Python wheel and use the [OpenRAG Terminal User Interface (TUI)](/tui) to install, run, and configure your OpenRAG deployment without running Docker commands. -* [**TUI**](tui.mdx): Use the Terminal User Interface to install, run, and configure your OpenRAG deployment without running Docker commands. +* [**Docker Compose**](#install-and-run-docker): Clone the OpenRAG repository and deploy OpenRAG with Docker Compose, including all services and dependencies. + +## Prerequisites + +- [Python](https://www.python.org/downloads/release/python-3100/) + - macOS and Linux: Version 3.10 to 3.13 +- [uv](https://docs.astral.sh/uv/getting-started/installation/) +- [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/docs/installation) installed +- [Docker Compose](https://docs.docker.com/compose/install/) installed. If using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands. +- For GPU support: (TBD) ## Docker {#install-and-run-docker} -The OpenRAG Docker compose file starts five containers: +The OpenRAG Docker Compose file starts five containers: | Container Name | Default Address | Purpose | |---|---|---| @@ -31,11 +40,7 @@ They deploy the same applications and containers, but to different environments. - [`docker-compose-cpu.yml`](https://github.com/langflow-ai/openrag/blob/main/docker-compose-cpu.yml) is a CPU-only version of OpenRAG for systems without GPU support. Use this Docker compose file for environments where GPU drivers aren't available. -Before installing OpenRAG with Docker, ensure you have: - -- [Docker](https://docs.docker.com/get-docker/) installed -- [Docker Compose](https://docs.docker.com/compose/install/) installed -- For GPU support: (TBD) +To install OpenRAG with Docker Compose: 1. Clone the OpenRAG repository. ```bash @@ -87,73 +92,67 @@ Before installing OpenRAG with Docker, ensure you have: Continue with the [Quickstart](/quickstart). -## Python wheel {#install-and-run-the-openrag-oss-python-wheel} +## Python wheel {#install-python-wheel} -### Prerequisites +The Python wheel is currently available internally, but will be available on PyPI at launch. +The wheel installs the OpenRAG wheel, which includes the TUI for installing, running, and managing OpenRAG. +For more information on virtual environments, see [uv](https://docs.astral.sh/uv/pip/environments). -1. Make sure you have the required dependencies and infrastructure: +1. Create a new project with a virtual environment using [uv](https://docs.astral.sh/uv/pip/environments). - - [Python](https://www.python.org/downloads/release/python-3100/) - - macOS and Linux: Version 3.10 to 3.13 - - Windows: Version 3.10 to 3.12 - - [uv](https://docs.astral.sh/uv/getting-started/installation/) - - Sufficient infrastructure: - - Minimum: Dual-core CPU and 2 GB RAM - - Recommended: Multi-core CPU and at least 4 GB RAM + ```bash + uv init YOUR_PROJECT_NAME + cd YOUR_PROJECT_NAME + ``` +2. Add the OpenRAG wheel to your project and install it in the virtual environment. + Replace `PATH/TO/` and `VERSION` with your OpenRAG wheel location and version. + ```bash + uv add PATH/TO/openrag-VERSION-py3-none-any.whl + ``` +3. Ensure all dependencies are installed and updated in your virtual environment. + ```bash + uv sync + ``` -2. Create a virtual environment with [uv](https://docs.astral.sh/uv/pip/environments). +4. Start the OpenRAG TUI. + ```bash + uv run openrag + ``` -
- Need help with virtual environments? + The OpenRAG TUI opens. - Virtual environments ensure OpenRAG is installed in an isolated, fresh environment. - To create a new virtual environment, do the following. - - - - - 1. Navigate to where you want your virtual environment to be created, and then create it with `uv`: - - ```shell - uv venv VENV_NAME - ``` - - Replace `VENV_NAME` with a name for your virtual environment. - - 2. Start the virtual environment: - - ```shell - source VENV_NAME/bin/activate - ``` - - Your shell's prompt changes to display that you're currently working in a virtual environment: - - ```text - (VENV_NAME) ➜ openrag git:(main) ✗ - ``` - - 3. To deactivate the virtual environment and return to your regular shell, type `deactivate`. - - When activated, the virtual environment temporarily modifies your `PATH` variable to prioritize packages installed within the virtual environment. - To avoid conflicts with other projects, it's a good idea to deactivate your virtual environment when you're done working in it. - - To delete the virtual environment, type `rm -rf VENV_NAME`. - This completely removes the virtual environment directory and its contents. - - - +5. To install OpenRAG with Basic Setup, click **Basic Setup** or press 1. Basic Setup does not support OAuth connections for ingestion from Google Drive, OneDrive, or AWS. + The TUI prompts you for the required startup values. + Click **Generate Passwords** to autocomplete fields that contain **Auto-generated Secure Password**, or bring your own passwords. +
+ Where do I find the required startup values? + + | Variable | Where to Find | Description | + |----------|---------------|-------------| + | `OPENSEARCH_PASSWORD` | Auto-generated secure password | The password for OpenSearch database access. Must be at least 8 characters and must contain at least one uppercase letter, one lowercase letter, one digit, and one special character. | + | `OPENAI_API_KEY` | [OpenAI Platform](https://platform.openai.com/api-keys) | API key from your OpenAI account. | + | `LANGFLOW_SUPERUSER` | User generated | Username for Langflow admin access. For more, see [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-superuser). | + | `LANGFLOW_SUPERUSER_PASSWORD` | Auto-generated secure password | Password for Langflow admin access. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-superuser). | + | `LANGFLOW_SECRET_KEY` | Auto-generated secure key | Secret key for Langflow security. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key). | + | `LANGFLOW_AUTO_LOGIN` | Auto-generated or manual | Auto-login configuration. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login). | + | `LANGFLOW_NEW_USER_IS_ACTIVE` | Langflow | New user activation setting. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-new-user-is-active). | + | `LANGFLOW_ENABLE_SUPERUSER_CLI` | Langflow server | Superuser CLI access setting. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-enable-superuser-cli). | + | `DOCUMENTS_PATH` | Set your local path | Path to your document storage directory. | +
- -3. Install the wheel from PyPI. + To complete credentials, click **Save Configuration**. + +6. To start OpenRAG with your credentials, click **Start Container Services**. + Startup pulls container images and starts them, so it can take some time. + The operation has completed when the **Close** button is available and the terminal displays: ```bash - uv pip install openrag-*.whl + Services started successfully + Command completed successfully ``` -4. Verify installation: - - ```bash - openrag --version - ``` - - This should display the installed version of OpenRAG. +7. To open the OpenRAG application, click **Open App** or press 6. + +### Advanced Setup + + From bcadb51f69072bda654b82aa23867eb8a4d6e93e Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Tue, 23 Sep 2025 11:59:16 -0400 Subject: [PATCH 3/5] python-wheel-install --- docs/docs/get-started/install.mdx | 171 ++++++++++++++++-------------- 1 file changed, 93 insertions(+), 78 deletions(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index f6a547ea..ffd0959e 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -14,25 +14,96 @@ OpenRAG can be installed in multiple ways: ## Prerequisites -- [Python](https://www.python.org/downloads/release/python-3100/) - - macOS and Linux: Version 3.10 to 3.13 +- [Python Version 3.10 to 3.13](https://www.python.org/downloads/release/python-3100/) - [uv](https://docs.astral.sh/uv/getting-started/installation/) - [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/docs/installation) installed - [Docker Compose](https://docs.docker.com/compose/install/) installed. If using Podman, use [podman-compose](https://docs.podman.io/en/latest/markdown/podman-compose.1.html) or alias Docker compose commands to Podman commands. - For GPU support: (TBD) +## Python wheel {#install-python-wheel} + +The Python wheel is currently available internally, but will be available on PyPI at launch. +The wheel installs the OpenRAG wheel, which includes the TUI for installing, running, and managing OpenRAG. +For more information on virtual environments, see [uv](https://docs.astral.sh/uv/pip/environments). + +1. Create a new project with a virtual environment using [uv](https://docs.astral.sh/uv/pip/environments). + + ```bash + uv init YOUR_PROJECT_NAME + cd YOUR_PROJECT_NAME + ``` +2. Add the OpenRAG wheel to your project and install it in the virtual environment. + Replace `PATH/TO/` and `VERSION` with your OpenRAG wheel location and version. + ```bash + uv add PATH/TO/openrag-VERSION-py3-none-any.whl + ``` +3. Ensure all dependencies are installed and updated in your virtual environment. + ```bash + uv sync + ``` + +4. Start the OpenRAG TUI. + ```bash + uv run openrag + ``` + + The OpenRAG TUI opens. + +5. To install OpenRAG with Basic Setup, click **Basic Setup** or press 1. Basic Setup does not set up OAuth connections for ingestion from Google Drive, OneDrive, or AWS. For OAuth setup, see [Advanced Setup](#advanced-setup). + The TUI prompts you for the required startup values. + Click **Generate Passwords** to autocomplete fields that contain **Auto-generated Secure Password**, or bring your own passwords. +
+ Where do I find the required startup values? + + | Variable | Where to Find | Description | + |----------|---------------|-------------| + | `OPENSEARCH_PASSWORD` | Auto-generated secure password | The password for OpenSearch database access. Must be at least 8 characters and must contain at least one uppercase letter, one lowercase letter, one digit, and one special character. | + | `OPENAI_API_KEY` | [OpenAI Platform](https://platform.openai.com/api-keys) | API key from your OpenAI account. | + | `LANGFLOW_SUPERUSER` | User generated | Username for Langflow admin access. For more, see [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-superuser). | + | `LANGFLOW_SUPERUSER_PASSWORD` | Auto-generated secure password | Password for Langflow admin access. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-superuser). | + | `LANGFLOW_SECRET_KEY` | Auto-generated secure key | Secret key for Langflow security. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key). | + | `LANGFLOW_AUTO_LOGIN` | Auto-generated or manual | Auto-login configuration. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login). | + | `LANGFLOW_NEW_USER_IS_ACTIVE` | Langflow | New user activation setting. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-new-user-is-active). | + | `LANGFLOW_ENABLE_SUPERUSER_CLI` | Langflow server | Superuser CLI access setting. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-enable-superuser-cli). | + | `DOCUMENTS_PATH` | Set your local path | Path to your document storage directory. | + +
+ + To complete credentials, click **Save Configuration**. + +6. To start OpenRAG with your credentials, click **Start Container Services**. + Startup pulls container images and starts them, so it can take some time. + The operation has completed when the **Close** button is available and the terminal displays: + ```bash + Services started successfully + Command completed successfully + ``` + +7. To open the OpenRAG application, click **Open App** or press 6. +8. Continue with the Quickstart. + +### Advanced Setup {#advanced-setup} + +**Advanced Setup** includes the required values from **Basic Setup**, with additional settings for OAuth credentials. +If the OpenRAG TUI detects OAuth credentials, it enforces the Advanced Setup path. +1. Add your client and secret values for Google, Azure, or AWS OAuth. +These values can be found in your OAuth provider. +2. The OpenRAG TUI presents redirect URIs for your OAuth app. +These are the URLs your OAuth provider will redirect back to after user sign-in. +Register these redirect values with your OAuth provider as they are presented in the TUI. +3. To open the OpenRAG application, click **Open App** or press 6. +You will be presented with your provider's OAuth sign-in screen, and be redirected to the redirect URI after sign-in. + +Two additional variables are available for Advanced Setup: + +The LANGFLOW_PUBLIC_URL controls where the Langflow web interface can be accessed. This is where users interact with their flows in a browser. + +The WEBHOOK_BASE_URL controls where the endpoint for `/connectors/CONNECTOR_TYPE/webhook` will be available. +This connection enables real-time document synchronization with external services. +For example, for Google Drive file synchronization the webhook URL is `/connectors/google_drive/webhook`. + ## Docker {#install-and-run-docker} -The OpenRAG Docker Compose file starts five containers: - -| Container Name | Default Address | Purpose | -|---|---|---| -| OpenRAG Backend | http://localhost:8000 | FastAPI server and core functionality. | -| OpenRAG Frontend | http://localhost:3000 | React web interface for users. | -| Langflow | http://localhost:7860 | AI workflow engine and flow management. | -| OpenSearch | http://localhost:9200 | Vector database for document storage. | -| OpenSearch Dashboards | http://localhost:5601 | Database administration interface. | - There are two different Docker Compose files. They deploy the same applications and containers, but to different environments. @@ -78,6 +149,15 @@ To install OpenRAG with Docker Compose: docker compose -f docker-compose-cpu.yml up -d ``` + The OpenRAG Docker Compose file starts five containers: + | Container Name | Default Address | Purpose | + |---|---|---| + | OpenRAG Backend | http://localhost:8000 | FastAPI server and core functionality. | + | OpenRAG Frontend | http://localhost:3000 | React web interface for users. | + | Langflow | http://localhost:7860 | AI workflow engine and flow management. | + | OpenSearch | http://localhost:9200 | Vector database for document storage. | + | OpenSearch Dashboards | http://localhost:5601 | Database administration interface. | + 5. Verify installation by confirming all services are running. ```bash @@ -90,69 +170,4 @@ To install OpenRAG with Docker Compose: - **Backend API**: http://localhost:8000 - **Langflow**: http://localhost:7860 -Continue with the [Quickstart](/quickstart). - -## Python wheel {#install-python-wheel} - -The Python wheel is currently available internally, but will be available on PyPI at launch. -The wheel installs the OpenRAG wheel, which includes the TUI for installing, running, and managing OpenRAG. -For more information on virtual environments, see [uv](https://docs.astral.sh/uv/pip/environments). - -1. Create a new project with a virtual environment using [uv](https://docs.astral.sh/uv/pip/environments). - - ```bash - uv init YOUR_PROJECT_NAME - cd YOUR_PROJECT_NAME - ``` -2. Add the OpenRAG wheel to your project and install it in the virtual environment. - Replace `PATH/TO/` and `VERSION` with your OpenRAG wheel location and version. - ```bash - uv add PATH/TO/openrag-VERSION-py3-none-any.whl - ``` -3. Ensure all dependencies are installed and updated in your virtual environment. - ```bash - uv sync - ``` - -4. Start the OpenRAG TUI. - ```bash - uv run openrag - ``` - - The OpenRAG TUI opens. - -5. To install OpenRAG with Basic Setup, click **Basic Setup** or press 1. Basic Setup does not support OAuth connections for ingestion from Google Drive, OneDrive, or AWS. - The TUI prompts you for the required startup values. - Click **Generate Passwords** to autocomplete fields that contain **Auto-generated Secure Password**, or bring your own passwords. -
- Where do I find the required startup values? - - | Variable | Where to Find | Description | - |----------|---------------|-------------| - | `OPENSEARCH_PASSWORD` | Auto-generated secure password | The password for OpenSearch database access. Must be at least 8 characters and must contain at least one uppercase letter, one lowercase letter, one digit, and one special character. | - | `OPENAI_API_KEY` | [OpenAI Platform](https://platform.openai.com/api-keys) | API key from your OpenAI account. | - | `LANGFLOW_SUPERUSER` | User generated | Username for Langflow admin access. For more, see [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-superuser). | - | `LANGFLOW_SUPERUSER_PASSWORD` | Auto-generated secure password | Password for Langflow admin access. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-superuser). | - | `LANGFLOW_SECRET_KEY` | Auto-generated secure key | Secret key for Langflow security. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-secret-key). | - | `LANGFLOW_AUTO_LOGIN` | Auto-generated or manual | Auto-login configuration. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-auto-login). | - | `LANGFLOW_NEW_USER_IS_ACTIVE` | Langflow | New user activation setting. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-new-user-is-active). | - | `LANGFLOW_ENABLE_SUPERUSER_CLI` | Langflow server | Superuser CLI access setting. For more, see the [Langflow docs](https://docs.langflow.org/api-keys-and-authentication#langflow-enable-superuser-cli). | - | `DOCUMENTS_PATH` | Set your local path | Path to your document storage directory. | - -
- - To complete credentials, click **Save Configuration**. - -6. To start OpenRAG with your credentials, click **Start Container Services**. - Startup pulls container images and starts them, so it can take some time. - The operation has completed when the **Close** button is available and the terminal displays: - ```bash - Services started successfully - Command completed successfully - ``` - -7. To open the OpenRAG application, click **Open App** or press 6. - -### Advanced Setup - - +Continue with the [Quickstart](/quickstart). \ No newline at end of file From e74f135f070028d183eb7582ca9a761fc3f30399 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Tue, 23 Sep 2025 12:15:43 -0400 Subject: [PATCH 4/5] fix-links-for-build --- docs/docs/get-started/install.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index ffd0959e..ee62b16d 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; OpenRAG can be installed in multiple ways: -* [**Python wheel**](#install-python-wheel): Install the OpenRAG Python wheel and use the [OpenRAG Terminal User Interface (TUI)](/tui) to install, run, and configure your OpenRAG deployment without running Docker commands. +* [**Python wheel**](#install-python-wheel): Install the OpenRAG Python wheel and use the [OpenRAG Terminal User Interface (TUI)](/get-started/tui) to install, run, and configure your OpenRAG deployment without running Docker commands. * [**Docker Compose**](#install-and-run-docker): Clone the OpenRAG repository and deploy OpenRAG with Docker Compose, including all services and dependencies. @@ -96,9 +96,9 @@ You will be presented with your provider's OAuth sign-in screen, and be redirect Two additional variables are available for Advanced Setup: -The LANGFLOW_PUBLIC_URL controls where the Langflow web interface can be accessed. This is where users interact with their flows in a browser. +The `LANGFLOW_PUBLIC_URL` controls where the Langflow web interface can be accessed. This is where users interact with their flows in a browser. -The WEBHOOK_BASE_URL controls where the endpoint for `/connectors/CONNECTOR_TYPE/webhook` will be available. +The `WEBHOOK_BASE_URL` controls where the endpoint for `/connectors/CONNECTOR_TYPE/webhook` will be available. This connection enables real-time document synchronization with external services. For example, for Google Drive file synchronization the webhook URL is `/connectors/google_drive/webhook`. @@ -134,7 +134,7 @@ To install OpenRAG with Docker Compose: LANGFLOW_SUPERUSER_PASSWORD=your_langflow_password LANGFLOW_SECRET_KEY=your_secret_key ``` - For more information on configuring OpenRAG with environment variables, see [Environment variables](configure/environment-variables). + For more information on configuring OpenRAG with environment variables, see [Environment variables](/configure/configuration). For additional configuration values, including `config.yaml`, see [Configuration](/configure/configuration). 4. Deploy OpenRAG with Docker Compose based on your deployment type. @@ -170,4 +170,4 @@ To install OpenRAG with Docker Compose: - **Backend API**: http://localhost:8000 - **Langflow**: http://localhost:7860 -Continue with the [Quickstart](/quickstart). \ No newline at end of file +Continue with the Quickstart. \ No newline at end of file From c259da8524fc9c454d41bff87e7b8765d79d6528 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Wed, 24 Sep 2025 09:23:29 -0400 Subject: [PATCH 5/5] use-env-example-in-docker-compose --- docs/docs/get-started/install.mdx | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index ee62b16d..67f4ae89 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -47,7 +47,7 @@ For more information on virtual environments, see [uv](https://docs.astral.sh/uv uv run openrag ``` - The OpenRAG TUI opens. + The OpenRAG TUI opens. 5. To install OpenRAG with Basic Setup, click **Basic Setup** or press 1. Basic Setup does not set up OAuth connections for ingestion from Google Drive, OneDrive, or AWS. For OAuth setup, see [Advanced Setup](#advanced-setup). The TUI prompts you for the required startup values. @@ -119,10 +119,16 @@ To install OpenRAG with Docker Compose: cd openrag ``` -2. Create a `.env` file in the repository root. - ``` - touch .env - ``` +2. Copy the example `.env` file that is 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 + ``` + + Alternatively, create a new `.env` file in the repository root. + ``` + 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: