diff --git a/docs/docs/_partial-docker-remove-and-cleanup-steps.mdx b/docs/docs/_partial-docker-remove-and-cleanup-steps.mdx index ccc91713..edcb7345 100644 --- a/docs/docs/_partial-docker-remove-and-cleanup-steps.mdx +++ b/docs/docs/_partial-docker-remove-and-cleanup-steps.mdx @@ -1,4 +1,10 @@ -2. Remove all containers, including stopped containers: +import PartialDockerStopAll from '@site/docs/_partial-docker-stop-all.mdx'; + +1. Stop all running containers: + + + +1. Remove all containers, including stopped containers: ```bash title="Docker" docker rm --force $(docker ps -aq) @@ -8,7 +14,7 @@ podman rm --all --force ``` -3. Remove all images: +1. Remove all images: ```bash title="Docker" docker rmi --force $(docker images -q) @@ -18,7 +24,7 @@ podman rmi --all --force ``` -4. Remove all volumes: +1. Remove all volumes: ```bash title="Docker" docker volume prune --force @@ -28,7 +34,7 @@ podman volume prune --force ``` -5. Remove all networks except the default network: +1. Remove all networks except the default network: ```bash title="Docker" docker network prune --force @@ -38,7 +44,7 @@ podman network prune --force ``` -6. Clean up any leftover data: +1. Clean up any leftover data: ```bash title="Docker" docker system prune --all --force --volumes diff --git a/docs/docs/_partial-setup.mdx b/docs/docs/_partial-setup.mdx index 3ace03fe..493075cf 100644 --- a/docs/docs/_partial-setup.mdx +++ b/docs/docs/_partial-setup.mdx @@ -63,7 +63,7 @@ If OpenRAG detects OAuth credentials during setup, it recommends **Advanced Setu -1. In the TUI, select ** Advanced Setup**. +1. In the TUI, select **Advanced Setup**. 2. Enter administrator passwords for the OpenRAG OpenSearch and Langflow services. diff --git a/docs/docs/core-components/ingestion.mdx b/docs/docs/core-components/ingestion.mdx index 8caab2ba..119a4b80 100644 --- a/docs/docs/core-components/ingestion.mdx +++ b/docs/docs/core-components/ingestion.mdx @@ -115,10 +115,10 @@ You can do this during [initial set up](/docker#setup), or you can add the crede ``` * **Amazon**: Provide your AWS Access Key ID and AWS Secret Access Key with access to your S3 instance. For more information, see the AWS documentation on [Configuring access to AWS applications](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-applications.html). - ```env - AWS_ACCESS_KEY_ID= - AWS_SECRET_ACCESS_KEY= - ``` + ```env + AWS_ACCESS_KEY_ID= + AWS_SECRET_ACCESS_KEY= + ``` 3. Save the `.env` file. diff --git a/docs/docs/get-started/install.mdx b/docs/docs/get-started/install.mdx index 82d1499e..6aca6ad5 100644 --- a/docs/docs/get-started/install.mdx +++ b/docs/docs/get-started/install.mdx @@ -54,14 +54,14 @@ For other installation methods, see [Select an installation method](/install-opt 3. Wait while the installer script prepares your environment and installs OpenRAG. You might be prompted to install certain dependencies if they aren't already present in your environment. -The entire process can take a few minutes. -Once the environment is ready, the OpenRAG TUI starts. + The entire process can take a few minutes. + Once the environment is ready, the OpenRAG TUI starts. -![OpenRAG TUI Interface](@site/static/img/openrag_tui_dec_2025.png) + ![OpenRAG TUI Interface](@site/static/img/openrag_tui_dec_2025.png) -Because the installer script uses `uvx`, it creates a cached, ephemeral environment in your local `uv` cache, and your OpenRAG configuration files and data are stored separately from the `uv` cache. -Clearing the cache doesn't delete your entire OpenRAG installation, only the temporary TUI environment. -After clearing the cache, run `uvx openrag` to [access the TUI](/tui) and continue with your preserved configuration and data. + Because the installer script uses `uvx`, it creates a cached, ephemeral environment in your local `uv` cache, and your OpenRAG configuration files and data are stored separately from the `uv` cache. + Clearing the cache doesn't delete your entire OpenRAG installation, only the temporary TUI environment. + After clearing the cache, run `uvx openrag` to [access the TUI](/tui) and continue with your preserved configuration and data. If you encounter errors during installation, see [Troubleshoot OpenRAG](/support/troubleshoot). diff --git a/docs/docs/get-started/reinstall.mdx b/docs/docs/get-started/reinstall.mdx index 34caf8c9..f24d56de 100644 --- a/docs/docs/get-started/reinstall.mdx +++ b/docs/docs/get-started/reinstall.mdx @@ -70,16 +70,12 @@ If you want to reinstall one container, specify the container name in the comman -2. Stop all running containers: - - - -8. Optional: Edit OpenRAG's `.env` file if needed. +1. Optional: Edit OpenRAG's `.env` file if needed. -9. Optional: If you removed all containers or specifically the OpenSearch container, then you can remove any files from the `~/.openrag/documents` subdirectory that you don't want to reingest after redeploying the containers. +1. Optional: If you removed all containers or specifically the OpenSearch container, then you can remove any files from the `~/.openrag/documents` subdirectory that you don't want to reingest after redeploying the containers. It is recommended that you preserve OpenRAG's [default documents](https://github.com/langflow-ai/openrag/tree/main/openrag-documents). -10. If you removed all OpenRAG containers, [redeploy OpenRAG](/docker). +1. If you removed all OpenRAG containers, [redeploy OpenRAG](/docker). If you removed only one container, redeploy that container with the appropriate `docker run` or `podman run` command. \ No newline at end of file diff --git a/docs/docs/get-started/uninstall.mdx b/docs/docs/get-started/uninstall.mdx index 5a9c10b4..a9261f62 100644 --- a/docs/docs/get-started/uninstall.mdx +++ b/docs/docs/get-started/uninstall.mdx @@ -41,15 +41,11 @@ Use these steps to uninstall a self-managed OpenRAG deployment with streamlined Use these commands to uninstall a self-managed OpenRAG deployment with discrete `docker` or `podman` commands: -1. Stop all running containers: - - - -7. Remove OpenRAG's `.env` file and the `~/.openrag/documents` directory, which aren't deleted by the previous commands. +1. Remove OpenRAG's `.env` file and the `~/.openrag/documents` directory, which aren't deleted by the previous commands. -8. Stop `docling-serve`: +1. Stop `docling-serve`: ```bash uv run python scripts/docling_ctl.py stop