From 51538c1537dc4d3ceac1ee98a9c790f68c7facd6 Mon Sep 17 00:00:00 2001 From: phact Date: Wed, 20 Aug 2025 04:22:12 -0400 Subject: [PATCH 1/2] readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4347b3c4..5b7f336a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,17 @@ -### OpenRAG +## OpenRAG [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/phact/openrag) +### getting started + +Set up your secrets: + + cp .env.example .env + +Populate the values in .env + +Run OpenRAG: + docker compose build docker compose up From 9bad6a80f3aba0cec90d23f04f25ac09bea3802c Mon Sep 17 00:00:00 2001 From: phact Date: Wed, 20 Aug 2025 04:23:42 -0400 Subject: [PATCH 2/2] readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 5b7f336a..8c45ed4f 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,10 @@ Set up your secrets: Populate the values in .env +Requirements: + +Docker or podman with compose installed. + Run OpenRAG: docker compose build @@ -19,3 +23,7 @@ Run OpenRAG: CPU only: docker compose -f docker-compose-cpu.yml up + +If you need to reset state: + + docker compose up --build --force-recreate --remove-orphans