From 6a2102f9d5cde0c266574ae710d6b3fc4538233b Mon Sep 17 00:00:00 2001 From: sonnh-uit Date: Wed, 8 May 2024 16:20:01 +0700 Subject: [PATCH 1/4] update guide for build project from source code, add detail for signature flag --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index ea4821b..0946ff0 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,26 @@ S3 benchmarking tool. # Download +## From binary [Download Binary Releases](https://github.com/minio/warp/releases) for various platforms. +## Build with source + +Warp require minimum version is `go1.22`, please ensure you have compatible version for this build. + +You can follow easy step below to build project +- Clone project +``` +git clone https://github.com/minio/warp.git +``` +- Change directory and build +``` +cd warp && go run main.go +``` +- To run a test, please run +``` +go run main.go command [options] +``` # Configuration Warp can be configured either using commandline parameters or environment variables. @@ -27,6 +45,8 @@ you can enable [server-side-encryption](https://docs.aws.amazon.com/AmazonS3/lat of objects using `--encrypt`. A random key will be generated and used for objects. To use [SSE-S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingServerSideEncryption.html) encryption use the `--sse-s3-encrypt` flag. +`S3V4` is default signature to create connect to S3 server. If it not same yours, change it to `S3V2` by `--signature` flag. + # Usage `warp command [options]` From acef6963b22a656f0f5fb0d940f363078ae8fe4f Mon Sep 17 00:00:00 2001 From: Son Nguyen-Hong <62142647+sonnh-uit@users.noreply.github.com> Date: Wed, 8 May 2024 16:43:12 +0700 Subject: [PATCH 2/4] Update README.md build a binary Co-authored-by: Klaus Post --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0946ff0..e68f543 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ git clone https://github.com/minio/warp.git ``` - Change directory and build ``` -cd warp && go run main.go +cd warp && go build ``` - To run a test, please run ``` From a2297079a8a433144f7cb94aa341ba0fa0555f8f Mon Sep 17 00:00:00 2001 From: Son Nguyen-Hong <62142647+sonnh-uit@users.noreply.github.com> Date: Wed, 8 May 2024 16:43:25 +0700 Subject: [PATCH 3/4] Update README.md Run test with binary Co-authored-by: Klaus Post --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e68f543..0008092 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ cd warp && go build ``` - To run a test, please run ``` -go run main.go command [options] +./warp [options] ``` # Configuration From d9e854c45d8f2f4e6d899705def45fa77b6d20be Mon Sep 17 00:00:00 2001 From: Son Nguyen-Hong <62142647+sonnh-uit@users.noreply.github.com> Date: Wed, 8 May 2024 16:43:47 +0700 Subject: [PATCH 4/4] Update README.md Co-authored-by: Klaus Post --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0008092..ba2cbce 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ you can enable [server-side-encryption](https://docs.aws.amazon.com/AmazonS3/lat of objects using `--encrypt`. A random key will be generated and used for objects. To use [SSE-S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingServerSideEncryption.html) encryption use the `--sse-s3-encrypt` flag. -`S3V4` is default signature to create connect to S3 server. If it not same yours, change it to `S3V2` by `--signature` flag. +If your server is incompatible with [AWS v4 signatures](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) the older v2 signatures can be used with `--signature=S3V2`. # Usage