From b9d049cb05ef229140a0416ce6a14c898c30cb36 Mon Sep 17 00:00:00 2001
From: Vineeth B V <37930821+vinsdragonis@users.noreply.github.com>
Date: Sun, 9 Feb 2025 16:43:34 +0530
Subject: [PATCH] Create OpenSearch docker setup.md

---
 docs/OpenSearch docker setup.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 docs/OpenSearch docker setup.md

diff --git a/docs/OpenSearch docker setup.md b/docs/OpenSearch docker setup.md
new file mode 100644
index 000000000..850e20b09
--- /dev/null
+++ b/docs/OpenSearch docker setup.md	
@@ -0,0 +1,13 @@
+# Setup
+- This addresses the setup process between only Open-WebUI and OpenSearch.
+- This does not get into the details regarding Ollama, OpenAI, or their models.
+
+## Steps
+1. `Docker pull` the images for OpenSearch and Open-WebUI
+2. Setup a docker network as these services need to be on the same network to interact with each other correctly. For more info, refer to [Creating a docker network](https://docs.docker.com/reference/cli/docker/network/create/)
+3. For the setup process of OpenSearch, refer to [OpenSearch docker setup](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/docker/)
+4. To set Open-WebUI to use OpenSearch as the vector database, refer to [Open-WebUI RAG setup](https://docs.openwebui.com/getting-started/env-configuration#retrieval-augmented-generation-rag) and [OpenSearch environment variables](https://docs.openwebui.com/getting-started/env-configuration#opensearch)
+5. Ensure that both OpenSearch and Open-WebUI are running within the same docker network by specifying the same in your `docker run` command
+
+## Short note
+- While performing the setup process, it is recommended to use OpenSearch with **SSL enabled** as some functionalities will not work on HTTP, but rather on HTTPS, even if not explicitly mentioned.