Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

docs(migration): say which volumes the backup actually covers (#18626)

MarMar Labs57f25ea16e3d
diff --git a/docker/migration.sh b/docker/migration.sh
index b881dbc45e..f4c529bd4a 100644
--- a/docker/migration.sh
+++ b/docker/migration.sh
@@ -31,7 +31,7 @@ show_help() {
echo " $0 [-p project_name] <operation> [backup_folder]"
echo ""
echo "OPERATIONS:"
- echo " backup - Create backup of all RAGFlow data volumes"
+ echo " backup - Create backup of the RAGFlow data volumes listed below"
echo " restore - Restore RAGFlow data volumes from backup"
echo " help - Show this help message"
echo ""
@@ -56,6 +56,12 @@ show_help() {
echo " - ${DEFAULT_PROJECT_NAME}_redis_data (Redis cache)"
echo " - ${DEFAULT_PROJECT_NAME}_esdata01 (Elasticsearch indices)"
echo ""
+ echo " Those four are the whole set. DOC_ENGINE chooses where your indices live,"
+ echo " and only 'elasticsearch' keeps them in ${DEFAULT_PROJECT_NAME}_esdata01. Under 'infinity',"
+ echo " 'opensearch' or 'serenedb' the index volume is not part of this backup, and"
+ echo " because no es_backup.tar.gz is written, a later 'restore' stops on the"
+ echo " missing file. Back up the index volume separately until that is handled."
+ echo ""
echo "NOTE:"
echo " If you started RAGFlow with 'docker compose -p myproject up', the volume"
echo " names will be prefixed with 'myproject' instead of 'docker'. In that case,"