From 81d14dd1c9c4004609e397d7a675ac0f671caa49 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Thu, 4 Dec 2025 10:35:11 -0800 Subject: [PATCH] broken links --- docs/docs/get-started/install-options.mdx | 2 +- docs/docs/get-started/reinstall.mdx | 10 ++++++---- docs/docs/get-started/uninstall.mdx | 4 ++-- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/docs/get-started/install-options.mdx b/docs/docs/get-started/install-options.mdx index a9c6d8cf..8e68daa8 100644 --- a/docs/docs/get-started/install-options.mdx +++ b/docs/docs/get-started/install-options.mdx @@ -14,7 +14,7 @@ Choose the installation method that best fits your needs: * [**`uv`**](/install-uv): Install OpenRAG as a dependency of a new or existing Python project. * [**`uvx`**](/install-uvx): Invoke OpenRAG without permanently installing it in a Python project. -* [**Install OpenRAG on Microsoft Windows**](/install-wsl): On Windows machines, you must install OpenRAG within the Windows Subsystem for Linux (WSL). +* [**Install OpenRAG on Microsoft Windows**](/install-windows): On Windows machines, you must install OpenRAG within the Windows Subsystem for Linux (WSL). OpenRAG doesn't support nested virtualization; don't run OpenRAG on a WSL distribution that is inside a Windows VM. diff --git a/docs/docs/get-started/reinstall.mdx b/docs/docs/get-started/reinstall.mdx index 22f803f0..be20b6db 100644 --- a/docs/docs/get-started/reinstall.mdx +++ b/docs/docs/get-started/reinstall.mdx @@ -7,7 +7,7 @@ You can reset your OpenRAG deployment to its initial state by recreating the con ## Reinstall TUI-managed containers -1. In the TUI, [reset your containers](/manage-containers#reset-containers) to destroy the following: +1. In the TUI, [reset your containers](/manage-containers) to destroy the following: * All existing OpenRAG containers, volumes, and local images * Any additional Docker objects @@ -17,11 +17,13 @@ You can reset your OpenRAG deployment to its initial state by recreating the con 2. Optional: Remove data that wasn't deleted by the **Factory Reset** operation. For a completely fresh installation, delete all of this data. - * **OpenRAG's `.env` file**: Contains your OpenRAG configuration, including OpenRAG passwords, API keys, OAuth settings, and other [environment variables](/reference/configuration). If you delete this file, you must either repeat the [setup process](#setup) to create a new `.env` file, or add a populated `.env` file to your OpenRAG installation directory before restarting OpenRAG. + * **OpenRAG's `.env` file**: Contains your OpenRAG configuration, including OpenRAG passwords, API keys, OAuth settings, and other [environment variables](/reference/configuration). If you delete this file, OpenRAG automatically generates a new one after you repeat the initial setup and onboarding process. Alternatively, you can add a prepopulated `.env` file to your OpenRAG installation directory before restarting OpenRAG. * **The contents of the `./openrag-documents` directory**: Contains documents that you uploaded to OpenRAG. Delete these files to prevent documents from being reingested to your knowledge base after restarting OpenRAG. However, you might want to preserve OpenRAG's [default documents](https://github.com/langflow-ai/openrag/tree/main/openrag-documents). -3. In the TUI **Setup** menu, repeat the [setup process](#setup) to configure OpenRAG, restart the services, and launch the OpenRAG app, and repeat [application onboarding](#application-onboarding). -If OpenRAG detects a `.env` file, it automatically populates any OpenRAG passwords, OAuth credentials, and onboarding configuration set in that file. +3. In the TUI **Setup** menu, repeat the **Basic/Advanced Setup** process to configure OpenRAG and restart all services. +Then, launch the OpenRAG app and repeat application onboarding. + + If OpenRAG detects a `.env` file during start up, it automatically populates any OpenRAG passwords, OAuth credentials, and onboarding configuration set in that file. ## Reinstall self-managed containers diff --git a/docs/docs/get-started/uninstall.mdx b/docs/docs/get-started/uninstall.mdx index bdce92cc..e438fdd4 100644 --- a/docs/docs/get-started/uninstall.mdx +++ b/docs/docs/get-started/uninstall.mdx @@ -4,11 +4,11 @@ slug: /uninstall --- :::tip -If you want to reset your OpenRAG containers without removing OpenRAG entirely, see [Reset OpenRAG containers](/manage-containers#reset-containers) and [Reinstall OpenRAG](/reinstall). +If you want to reset your OpenRAG containers without removing OpenRAG entirely, see [Reset OpenRAG containers](/manage-containers) and [Reinstall OpenRAG](/reinstall). ::: If you used the [automated installer script](/install) or [`uvx`](/install-uvx) to install OpenRAG, run `uv cache clean openrag` to remove the cached OpenRAG environment. If you used [`uv`](/install-uv) to install OpenRAG, run `uv remove openrag` in your Python project. -For self-managed containers, destroy the containers, prune any additional Docker objects, and delete any remaining OpenRAG files, as explained in [Reset OpenRAG containers](/manage-containers#reset-containers). \ No newline at end of file +For self-managed containers, destroy the containers, prune any additional Docker objects, and delete any remaining OpenRAG files, as explained in [Reset OpenRAG containers](/manage-containers). \ No newline at end of file