quick start: -dir=./data for the bare binary, region for s3tables

-dir=/data fails on macOS and on Linux without root; the Docker line
keeps /data since the image owns it. The s3tables CLI refuses to run
without a region, so the lakehouse recipe passes one.

Claude-Session: https://claude.ai/code/session_014apMEkkquAtAYp89paTkAT
Chris Lu
2026-09-03 00:14:53 -07:00
parent 1677e11d32
commit c182f792fd
3 changed files with 10 additions and 10 deletions
+1 -1
@@ -5,7 +5,7 @@
The easiest way to get started with SeaweedFS is the `weed mini` command, which starts all components (master, volume, filer, S3, WebDAV, Admin UI, and the maintenance worker for vacuum/EC/balance) in one process with auto-tuned defaults:
```bash
weed mini -dir=/data
weed mini -dir=./data
```
This gives you a complete SeaweedFS setup including S3 compatibility and a built-in Admin UI. See [Quick-Start-with-weed-mini.md](Quick-Start-with-weed-mini.md) for detailed instructions.
+1 -1
@@ -144,7 +144,7 @@ Create a table bucket, then point engines at the S3 endpoint and the catalog:
```bash
export S3_ENDPOINT=http://seaweedfs-s3.seaweedfs.svc:8333
aws s3tables create-table-bucket --endpoint-url $S3_ENDPOINT --name warehouse
aws s3tables --region us-east-1 --endpoint-url $S3_ENDPOINT create-table-bucket --name warehouse
```
The Iceberg REST catalog is `http://seaweedfs-s3.seaweedfs.svc:8181`, or set `s3.icebergIngress` to reach it from outside. Engine setup is in [[Spark Iceberg Integration]], [[Trino Iceberg Integration]], [[DuckDB Iceberg Integration]], and the other pages under [[S3 Table Bucket]]. `s3.lancePort` (default 9101) serves the [[SeaweedFS Lance Catalog]] the same way.
+8 -8
@@ -6,7 +6,7 @@ Start a ready-to-use S3 object store with credentials and a pre-created bucket i
AWS_ACCESS_KEY_ID=admin \
AWS_SECRET_ACCESS_KEY=secret \
S3_BUCKET=my-bucket \
weed mini -dir=/data
weed mini -dir=./data
```
That's it — the S3 endpoint is at http://localhost:8333, `my-bucket` already exists, and `admin`/`secret` are valid credentials. Test it:
@@ -32,7 +32,7 @@ The same command also brings up:
### Custom port
```bash
weed mini -dir=/data -master.port=9444 -s3.port=8334
weed mini -dir=./data -master.port=9444 -s3.port=8334
```
### S3 with Reverse Proxy
@@ -41,7 +41,7 @@ If `weed mini` is behind a reverse proxy (e.g. Nginx, Cloudflare Tunnel), use th
```bash
# SeaweedFS reachable externally at https://s3.example.com
weed mini -dir=/data -s3.externalUrl=https://s3.example.com
weed mini -dir=./data -s3.externalUrl=https://s3.example.com
```
For more configuration details, see the **[[S3 Nginx Proxy]]** page.
@@ -227,19 +227,19 @@ aws --endpoint-url $S3_ENDPOINT s3 ls s3://my-bucket/
```bash
# Specify data directory
weed mini -dir=/data
weed mini -dir=./data
# Custom S3 port
weed mini -dir=/data -s3.port=8334
weed mini -dir=./data -s3.port=8334
# Custom IAM config file
weed mini -dir=/data -s3.iam.config=/path/to/iam.json
weed mini -dir=./data -s3.iam.config=/path/to/iam.json
# Pre-create one or more S3 buckets on startup if they do not already exist
weed mini -dir=/data -bucket=raw,processed
weed mini -dir=./data -bucket=raw,processed
# Pre-create an S3 Tables (Iceberg) bucket
weed mini -dir=/data -tableBucket=iceberg-tables
weed mini -dir=./data -tableBucket=iceberg-tables
```
## Growing Into a Small Cluster