Updated Quick Start with weed mini (markdown)

Chris Lu
2025-12-23 09:09:15 -08:00
parent a45dc0559a
commit 1bb5345a6a
+2 -42
@@ -4,7 +4,7 @@
## 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.
`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. If there are enough disk space, `weed mini` should be trouble-free in most cases.
**Perfect for:**
- Learning SeaweedFS and S3-compatible storage
@@ -24,7 +24,7 @@ The `weed mini` command starts:
- **Maintenance Worker** - Background tasks (vacuuming, erasure coding, balancing)
All components run in a single process with optimized settings:
- 128MB volume size limit (suitable for most use cases)
- Auto-configured volume size limit (suitable for most use cases)
- Auto-scaling volumes based on available disk space
- Single master mode (no cluster coordination overhead)
- 1-second pre-stop time (faster startup/shutdown)
@@ -134,21 +134,9 @@ aws s3 --endpoint-url=http://localhost:8333 cp s3://my-bucket/myfile.txt ./
# Specify data directory
weed mini -dir=/data
# Custom master port
weed mini -dir=/data -master.port=9444
# Custom S3 port
weed mini -dir=/data -s3.port=8334
# Custom volume size limit (in MB)
weed mini -dir=/data -master.volumeSizeLimitMB=256
# Disable HTTP (gRPC only)
weed mini -dir=/data -disableHttp
# Enable debug mode
weed mini -dir=/data -debug
# Custom IAM config file
weed mini -dir=/data -s3.iam.config=/path/to/iam.json
```
@@ -160,34 +148,6 @@ weed mini -dir=/data -s3.iam.config=/path/to/iam.json
# All services will gracefully shut down
```
## Troubleshooting
### Health Check Warnings
During startup, you may see health check warnings like:
```
Health check for Master failed (service may still be functional, retries may succeed)
```
This is normal during rapid startup. Services will continue initializing and should become functional within a few seconds.
### Port Already in Use
If a port is already in use:
```bash
# Use custom ports
weed mini -dir=/data -master.port=9444 -s3.port=8334 -filer.port=8889
```
### File Permission Errors
Ensure the data directory is writable:
```bash
mkdir -p /data
chmod 755 /data
weed mini -dir=/data
```
## Next Steps
- Read [S3-API-FAQ.md](S3-API-FAQ.md) for S3-specific questions