Skip to content

Commit

Permalink
docs: add section on using with S3 to README
Browse files Browse the repository at this point in the history
  • Loading branch information
TillaTheHun0 committed Aug 23, 2023
1 parent f790593 commit 26ae33f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
- [Credentials](#credentials)
- [From the URL](#from-the-url)
- [from ENV VARS](#from-env-vars)
- [Usage with AWS S3](#usage-with-aws-s3)
- [Multiple Buckets or Namespaced Single Bucket](#multiple-buckets-or-namespaced-single-bucket)
- [Features](#features)
- [Methods](#methods)
Expand Down Expand Up @@ -72,6 +73,15 @@ You can also set the environment variables `MINIO_ROOT_USER` to your `accessKey`
> variables. In other words, if credentials are provided in both ways, the credentials derived from
> the url will be used.
## Usage with AWS S3

This adapter can also be used on top on AWS' popular S3 service. To do so, simply adjust the `host`
in the `url` provided to the adapter to point to `s3`:

```js
minio({ url: 'https://accessKey:[email protected]', bucketPrefix: 'uniquePrefix' })
```

## Multiple Buckets or Namespaced Single Bucket

This adapter can be configured to either create a bucket, in the underying S3 or MinIO, per hyper
Expand Down

0 comments on commit 26ae33f

Please sign in to comment.