From 538602a2ea5588f52d1ee44e7dd085c78e922550 Mon Sep 17 00:00:00 2001 From: April M <36110273+aimurphy@users.noreply.github.com> Date: Fri, 5 Dec 2025 15:46:54 -0800 Subject: [PATCH] reuse --- ..._partial-docker-compose-down-and-prune.mdx | 9 ++ docs/docs/_partial-docker-compose-up.mdx | 7 + ...artial-docker-remove-and-cleanup-steps.mdx | 49 +++++++ docs/docs/_partial-docker-stop-all.mdx | 7 + docs/docs/_partial-factory-reset-warning.mdx | 25 ++++ docs/docs/_partial-onboarding.mdx | 36 ++++- docs/docs/core-components/ingestion.mdx | 36 ++--- docs/docs/core-components/knowledge.mdx | 12 +- docs/docs/get-started/docker.mdx | 54 +++----- docs/docs/get-started/install-uv.mdx | 2 +- docs/docs/get-started/install-uvx.mdx | 4 +- docs/docs/get-started/install.mdx | 4 +- docs/docs/get-started/manage-services.mdx | 58 ++------ docs/docs/get-started/quickstart.mdx | 2 +- docs/docs/get-started/reinstall.mdx | 127 ++---------------- docs/docs/get-started/tui.mdx | 2 +- docs/docs/get-started/uninstall.mdx | 100 +------------- docs/docs/get-started/upgrade.mdx | 27 ++-- docs/docs/reference/configuration.mdx | 14 +- docs/docs/support/troubleshoot.mdx | 32 ++--- docs/docusaurus.config.js | 1 + 21 files changed, 238 insertions(+), 370 deletions(-) create mode 100644 docs/docs/_partial-docker-compose-down-and-prune.mdx create mode 100644 docs/docs/_partial-docker-compose-up.mdx create mode 100644 docs/docs/_partial-docker-remove-and-cleanup-steps.mdx create mode 100644 docs/docs/_partial-docker-stop-all.mdx create mode 100644 docs/docs/_partial-factory-reset-warning.mdx diff --git a/docs/docs/_partial-docker-compose-down-and-prune.mdx b/docs/docs/_partial-docker-compose-down-and-prune.mdx new file mode 100644 index 00000000..179c0525 --- /dev/null +++ b/docs/docs/_partial-docker-compose-down-and-prune.mdx @@ -0,0 +1,9 @@ +```bash title="Docker" +docker compose down --volumes --remove-orphans --rmi local +docker system prune -f +``` + +```bash title="Podman" +podman compose down --volumes --remove-orphans --rmi local +podman system prune -f +``` \ No newline at end of file diff --git a/docs/docs/_partial-docker-compose-up.mdx b/docs/docs/_partial-docker-compose-up.mdx new file mode 100644 index 00000000..535effb3 --- /dev/null +++ b/docs/docs/_partial-docker-compose-up.mdx @@ -0,0 +1,7 @@ +```bash title="Docker" +docker compose up -d +``` + +```bash title="Podman" +podman compose up -d +``` \ No newline at end of file diff --git a/docs/docs/_partial-docker-remove-and-cleanup-steps.mdx b/docs/docs/_partial-docker-remove-and-cleanup-steps.mdx new file mode 100644 index 00000000..ccc91713 --- /dev/null +++ b/docs/docs/_partial-docker-remove-and-cleanup-steps.mdx @@ -0,0 +1,49 @@ +2. Remove all containers, including stopped containers: + + ```bash title="Docker" + docker rm --force $(docker ps -aq) + ``` + + ```bash title="Podman" + podman rm --all --force + ``` + +3. Remove all images: + + ```bash title="Docker" + docker rmi --force $(docker images -q) + ``` + + ```bash title="Podman" + podman rmi --all --force + ``` + +4. Remove all volumes: + + ```bash title="Docker" + docker volume prune --force + ``` + + ```bash title="Podman" + podman volume prune --force + ``` + +5. Remove all networks except the default network: + + ```bash title="Docker" + docker network prune --force + ``` + + ```bash title="Podman" + podman network prune --force + ``` + +6. Clean up any leftover data: + + ```bash title="Docker" + docker system prune --all --force --volumes + ``` + + ```bash title="Podman" + podman system prune --all --force --volumes + ``` \ No newline at end of file diff --git a/docs/docs/_partial-docker-stop-all.mdx b/docs/docs/_partial-docker-stop-all.mdx new file mode 100644 index 00000000..3fbf17f9 --- /dev/null +++ b/docs/docs/_partial-docker-stop-all.mdx @@ -0,0 +1,7 @@ +```bash title="Docker" +docker stop $(docker ps -q) +``` + +```bash title="Podman" +podman stop --all +``` \ No newline at end of file diff --git a/docs/docs/_partial-factory-reset-warning.mdx b/docs/docs/_partial-factory-reset-warning.mdx new file mode 100644 index 00000000..582125fb --- /dev/null +++ b/docs/docs/_partial-factory-reset-warning.mdx @@ -0,0 +1,25 @@ +:::warning +This is a destructive action that does the following: + +* Destroys all OpenRAG containers, volumes, and local images with `docker compose down --volumes --remove-orphans --rmi local`. +* Prunes any additional Docker objects with `docker system prune -f`. +* Deletes the contents of OpenRAG's `config` and `./opensearch-data` directories. +* Deletes the `conversations.json` file. + +

Destroyed containers and deleted data are lost and cannot be recovered after running this operation. + +This operation _doesn't_ remove the `.env` file or the contents of the `./openrag-documents` directory. +::: + + \ No newline at end of file diff --git a/docs/docs/_partial-onboarding.mdx b/docs/docs/_partial-onboarding.mdx index ca8a994f..feca9955 100644 --- a/docs/docs/_partial-onboarding.mdx +++ b/docs/docs/_partial-onboarding.mdx @@ -33,7 +33,13 @@ Anthropic doesn't provide embedding models. If you select Anthropic for your lan 4. Select a provider for embeddings, provide the required information, and then select the embedding model you want to use. For information about another provider's credentials and settings, see the instructions for that provider. -5. Continue through the overview slides for a brief introduction to OpenRAG, or click