add s3 store docs (#79)

Signed-off-by: Pablo Chacin <[email protected]>
grafana · Dec 13, 2024 · 06f494e · 06f494e
1 parent e5234dd
commit 06f494e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -248,6 +248,12 @@ k6build server -c /path/to/catalog.json
 # start the build server using a custom GOPROXY
 k6build server -e GOPROXY=http://localhost:80
 
+# start the build server with a localstack s3 storage backend
+# aws credentials are expected in the default location (e.g. env variables)
+export AWS_ACCESS_KEY_ID="test"
+export AWS_SECRET_ACCESS_KEY="test"
+k6build server --s3-endpoint http://localhost:4566 --store-bucket k6build
+
 ```
 
 ## Flags

diff --git a/cmd/server/server.go b/cmd/server/server.go
@@ -65,6 +65,12 @@ k6build server -c /path/to/catalog.json
 
 # start the build server using a custom GOPROXY
 k6build server -e GOPROXY=http://localhost:80
+
+# start the build server with a localstack s3 storage backend
+# aws credentials are expected in the default location (e.g. env variables)
+export AWS_ACCESS_KEY_ID="test"
+export AWS_SECRET_ACCESS_KEY="test"
+k6build server --s3-endpoint http://localhost:4566 --store-bucket k6build
 `
 )