Skip to content

Commit

Permalink
updated readme to add minio to s3 protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
lfarnell committed Jun 21, 2017
1 parent 2ce3599 commit ab8bd7c
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,8 +231,8 @@ characters, including the username and password, must be URL encoded.
### S3 (`s3`)

S3 takes various access configurations in the URL. Note that it will also
read these from standard AWS environment variables if they're set. If
the query parameters are present, these take priority.
read these from standard AWS environment variables if they're set. S3 compliant servers like Minio
are also supported. If the query parameters are present, these take priority.

* `aws_access_key_id` - AWS access key.
* `aws_access_key_secret` - AWS access key secret.
Expand All @@ -244,6 +244,14 @@ If you use go-getter and want to use an EC2 IAM Instance Profile to avoid
using credentials, then just omit these and the profile, if available will
be used automatically.

### Using S3 with Minio
If you use go-gitter for Minio support, you must consider the following:

* `aws_access_key_id` (required) - Minio access key.
* `aws_access_key_secret` (required) - Minio access key secret.
* `region` (optional - defaults to us-east-1) - Region identifier to use.
* `version` (optional - fefaults to Minio default) - Configuration file format.

#### S3 Bucket Examples

S3 has several addressing schemes used to reference your bucket. These are
Expand All @@ -254,4 +262,5 @@ Some examples for these addressing schemes:
- s3::https://s3-eu-west-1.amazonaws.com/bucket/foo
- bucket.s3.amazonaws.com/foo
- bucket.s3-eu-west-1.amazonaws.com/foo/bar
- "s3::http://127.0.0.1:9000/test-bucket/hello.txt?aws_access_key_id=KEYID&aws_access_key_secret=SECRETKEY&region=us-east-2"

0 comments on commit ab8bd7c

Please sign in to comment.