Skip to content
This repository has been archived by the owner on Jul 10, 2021. It is now read-only.

Commit

Permalink
docs(AWS/S3):Mention 'api-endpoint' & 'api-region' are optional (#1736)
Browse files Browse the repository at this point in the history
* Mention 'api-endpoint' & 'api-region' are optional

Explained the need for 'api-endpoint' & 'api-region' flags are optional and only if using Minio
to avoid confusions for beginners.

* Address PR review comments

* Move out Note to a separate section

Co-authored-by: brian-armory <53799971+brian-armory@users.noreply.github.com>
  • Loading branch information
agentmilindu and 317brian committed Mar 12, 2020
1 parent 7501f3d commit 4df1d6e
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions setup/artifacts/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ ARTIFACT_ACCOUNT_NAME=my-s3-account
--region $REGION
```

**Note:** Setting `--api-endpoint` & `--api-region` is optional. It is needed only if you are using a S3 clone such as Minio.

There are more options described
[here](/reference/halyard/commands#hal-config-artifact-s3-account-edit)
if you need more control over your configuration.

0 comments on commit 4df1d6e

Please sign in to comment.