From 7f1ac8cf1a2cb67e2ef674cdc0161d3a3f197df5 Mon Sep 17 00:00:00 2001 From: Chris Lu Date: Sun, 3 May 2026 23:56:24 -0700 Subject: [PATCH] docs(readme): dedup Quick Start, drop "weed server" section Remove the "Quick Start with Single Binary" section which duplicated the binary-download instructions and pushed users toward "weed server". Fold the go install alternative and the volume-scaling tip into the weed mini section so there is one canonical Quick Start path. --- README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2e5973d9a..3a7fda26d 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,6 @@ Table of Contents * [Quick Start](#quick-start) * [Quick Start with weed mini](#quick-start-with-weed-mini) * [Quick Start for S3 API on Docker](#quick-start-for-s3-api-on-docker) - * [Quick Start with Single Binary](#quick-start-with-single-binary) * [Introduction](#introduction) * [Features](#features) * [Additional Features](#additional-features) @@ -81,7 +80,7 @@ Table of Contents ## Quick Start with weed mini ## -Download the latest binary from https://github.com/seaweedfs/seaweedfs/releases and unzip the single `weed` (or `weed.exe`) file. Then start a ready-to-use S3 object store with credentials and a pre-created bucket in one command: +Download the latest binary from https://github.com/seaweedfs/seaweedfs/releases and unzip the single `weed` (or `weed.exe`) file, or run `go install github.com/seaweedfs/seaweedfs/weed@latest`. Then start a ready-to-use S3 object store with credentials and a pre-created bucket in one command: ```bash AWS_ACCESS_KEY_ID=admin \ @@ -102,19 +101,12 @@ The same command starts everything else too: > macOS: if the binary is quarantined, run `xattr -d com.apple.quarantine ./weed` first. -Perfect for development, testing, learning SeaweedFS, and single-node deployments. +Perfect for development, testing, learning SeaweedFS, and single-node deployments. To scale out, add more volume servers by running `weed volume -dir="/some/data/dir2" -master=":9333" -port=8081` locally, on another machine, or on thousands of machines. ## Quick Start for S3 API on Docker ## `docker run -p 8333:8333 chrislusf/seaweedfs server -s3` -## Quick Start with Single Binary ## -* Download the latest binary from https://github.com/seaweedfs/seaweedfs/releases and unzip a single binary file `weed` or `weed.exe`. Or run `go install github.com/seaweedfs/seaweedfs/weed@latest`. -* `export AWS_ACCESS_KEY_ID=admin ; export AWS_SECRET_ACCESS_KEY=key` as the admin credentials to access the object store. -* Run `weed server -dir=/some/data/dir -s3` to start one master, one volume server, one filer, and one S3 gateway. The difference with `weed mini` is that `weed mini` can auto configure based on the single host environment, while `weed server` requires manual configuration and are designed for production use. - -Also, to increase capacity, just add more volume servers by running `weed volume -dir="/some/data/dir2" -master=":9333" -port=8081` locally, or on a different machine, or on thousands of machines. That is it! - # Introduction # SeaweedFS is a simple and highly scalable distributed file system. There are two objectives: