Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Readme #315

Merged
merged 4 commits into from
May 8, 2024
Merged

Update Readme #315

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6a2102f
update guide for build project from source code, add detail for signa…
May 8, 2024
acef696
Update README.md
sonnh-uit May 8, 2024
a229707
Update README.md
sonnh-uit May 8, 2024
d9e854c
Update README.md
sonnh-uit May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
sonnh-uit marked this conversation as resolved.
Show resolved Hide resolved
```
- To run a test, please run
```
go run main.go command [options]
sonnh-uit marked this conversation as resolved.
Show resolved Hide resolved
```
# Configuration

Warp can be configured either using commandline parameters or environment variables.
Expand All @@ -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.
sonnh-uit marked this conversation as resolved.
Show resolved Hide resolved

# Usage

`warp command [options]`
Expand Down