From 7097d676c2cee7f7e0bac86428fa996ac0f15c5a Mon Sep 17 00:00:00 2001 From: Chris Lu Date: Sat, 20 Dec 2025 21:45:34 -0800 Subject: [PATCH] Add production use warnings to weed mini documentation --- Getting-Started.md | 2 ++ Quick-Start-with-weed-mini.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/Getting-Started.md b/Getting-Started.md index 2175d9b..1530eee 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -2,6 +2,8 @@ ## Quick Start with `weed mini` (Recommended for Beginners) +> **⚠️ Warning**: The `weed mini` command is for learning and development only. It may not guarantee backward compatibility and **should not be used in production**. For production use, see [Multi-Component Setup](#multi-component-setup-for-production-and-advanced-users) below. + The easiest way to get started with SeaweedFS is using the `weed mini` command, which starts all components in one process with sensible defaults: ```bash diff --git a/Quick-Start-with-weed-mini.md b/Quick-Start-with-weed-mini.md index bf14aa0..5d30297 100644 --- a/Quick-Start-with-weed-mini.md +++ b/Quick-Start-with-weed-mini.md @@ -1,5 +1,7 @@ # Quick Start with `weed mini` +> **⚠️ Warning**: The `weed mini` command is designed for learning, development, and testing only. It may not guarantee backward compatibility between versions and **should not be used in production environments**. For production deployments, use the [Multi-Component Setup](Getting-Started.md#multi-component-setup-for-production-and-advanced-users). + ## Overview `weed mini` is an all-in-one SeaweedFS command designed specifically for S3 beginners, small deployments, and development environments. It starts all essential SeaweedFS components in a single process with optimized defaults.