aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChris Lu <chris.lu@gmail.com>2020-11-01 13:26:56 -0800
committerChris Lu <chris.lu@gmail.com>2020-11-01 13:26:56 -0800
commit448475e1003b830a2969fa59c1d00ffb83573723 (patch)
tree0cbe62ed4623907ca870db7b673f4cb52e55e0a7
parent9b10d1ac3336d23d088dddee64added5f0483ee0 (diff)
downloadseaweedfs-448475e1003b830a2969fa59c1d00ffb83573723.tar.xz
seaweedfs-448475e1003b830a2969fa59c1d00ffb83573723.zip
README: add quick start
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0331e1ee5..13fe03572 100644
--- a/README.md
+++ b/README.md
@@ -141,7 +141,11 @@ On top of the object store, optional [Filer] can support directories and POSIX a
[Back to TOC](#table-of-contents)
-## Example Usage ##
+## Quick Start ##
+* Download the latest binary from https://github.com/chrislusf/seaweedfs/releases and unzip a single binary file `weed` or `weed.exe`
+* Run `weed server -s3` to start one master, one volume server, one filer, and one S3 gateway.
+
+## Example: Using Seaweed Object Store ##
By default, the master node runs on port 9333, and the volume nodes run on port 8080.
Let's start one master node, and two volume nodes on port 8080 and 8081. Ideally, they should be started from different machines. We'll use localhost as an example.