From c0bee906d21fb521a9b421a388958a74bdb91c09 Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Fri, 16 May 2025 19:02:36 +0800 Subject: [PATCH] Docs: Added a guide on switching document engine (#7692) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- docs/develop/acquire_ragflow_api_key.md | 2 +- docs/develop/mcp/_category_.json | 2 +- docs/develop/switch_doc_engine.md | 34 +++++++++++++++++++++++ docs/guides/team/join_or_leave_team.md | 2 +- docs/guides/team/manage_team_members.md | 2 +- docs/guides/team/share_agents.md | 2 +- docs/guides/team/share_chat_assistant.md | 2 +- docs/guides/team/share_knowledge_bases.md | 2 +- docs/guides/team/share_model.md | 2 +- 9 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 docs/develop/switch_doc_engine.md diff --git a/docs/develop/acquire_ragflow_api_key.md b/docs/develop/acquire_ragflow_api_key.md index fe1220798..65c5a4c8f 100644 --- a/docs/develop/acquire_ragflow_api_key.md +++ b/docs/develop/acquire_ragflow_api_key.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 slug: /acquire_ragflow_api_key --- diff --git a/docs/develop/mcp/_category_.json b/docs/develop/mcp/_category_.json index 73ff6805b..35324fdcf 100644 --- a/docs/develop/mcp/_category_.json +++ b/docs/develop/mcp/_category_.json @@ -1,6 +1,6 @@ { "label": "MCP", - "position": 4, + "position": 40, "link": { "type": "generated-index", "description": "Guides and references on accessing RAGFlow's knowledge bases via MCP." diff --git a/docs/develop/switch_doc_engine.md b/docs/develop/switch_doc_engine.md new file mode 100644 index 000000000..07a3c2e4c --- /dev/null +++ b/docs/develop/switch_doc_engine.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 3 +slug: /switch_doc_engine +--- + +# Switch document engine + +Switch your doc engine from Elasticsearch to Infinity. + +--- + +RAGFlow uses Elasticsearch by default for storing full text and vectors. To switch to [Infinity](https://github.com/infiniflow/infinity/), follow these steps: + +:::danger WARNING +Switching to Infinity on a Linux/arm64 machine is not yet officially supported. +::: + +1. Stop all running containers: + + ```bash + $ docker compose -f docker/docker-compose.yml down -v + ``` + +:::cautiion WARNING +`-v` will delete the docker container volumes, and the existing data will be cleared. +::: + +2. Set `DOC_ENGINE` in **docker/.env** to `infinity`. + +3. Start the containers: + + ```bash + $ docker compose -f docker-compose.yml up -d + ``` \ No newline at end of file diff --git a/docs/guides/team/join_or_leave_team.md b/docs/guides/team/join_or_leave_team.md index 42c54c230..a62cf5a52 100644 --- a/docs/guides/team/join_or_leave_team.md +++ b/docs/guides/team/join_or_leave_team.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 slug: /join_or_leave_team --- diff --git a/docs/guides/team/manage_team_members.md b/docs/guides/team/manage_team_members.md index 983abfc6e..2243ea97d 100644 --- a/docs/guides/team/manage_team_members.md +++ b/docs/guides/team/manage_team_members.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 slug: /manage_team_members --- diff --git a/docs/guides/team/share_agents.md b/docs/guides/team/share_agents.md index b2796a35f..a523542e3 100644 --- a/docs/guides/team/share_agents.md +++ b/docs/guides/team/share_agents.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 slug: /share_agent --- diff --git a/docs/guides/team/share_chat_assistant.md b/docs/guides/team/share_chat_assistant.md index 9524dabf2..f8f172ee5 100644 --- a/docs/guides/team/share_chat_assistant.md +++ b/docs/guides/team/share_chat_assistant.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 slug: /share_chat_assistant --- diff --git a/docs/guides/team/share_knowledge_bases.md b/docs/guides/team/share_knowledge_bases.md index 404ed168a..614e08dfe 100644 --- a/docs/guides/team/share_knowledge_bases.md +++ b/docs/guides/team/share_knowledge_bases.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 slug: /share_datasets --- diff --git a/docs/guides/team/share_model.md b/docs/guides/team/share_model.md index 4cf2f8fe5..459641fca 100644 --- a/docs/guides/team/share_model.md +++ b/docs/guides/team/share_model.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 7 slug: /share_model ---