Added configure section with note for Docker users #2141
Conversation
Codecov Report
@@ Coverage Diff @@
## master #2141 +/- ##
======================================
Coverage 8.89% 8.89%
======================================
Files 92 92
Lines 6837 6837
======================================
Hits 608 608
Misses 6094 6094
Partials 135 135Continue to review full report at Codecov.
|
|
Thanks for the PR @marcoliceti - reviewing now. |
README.md
Outdated
| @@ -34,6 +34,8 @@ docker pull minio/mc:edge | |||
| docker run minio/mc:edge ls play | |||
| ``` | |||
|
|
|||
| **Note:** These examples refer to the _play_ environment, a public Minio server for testing pruposes. If you want to try the same commands against a different environment, check [Configure](#configure). | |||
There was a problem hiding this comment.
Typo s/pruposes/purposes/
README.md
Outdated
| @@ -95,6 +97,30 @@ If you do not have a working Golang environment, please follow [How to install G | |||
| go get -u github.com/minio/mc | |||
| ``` | |||
|
|
|||
| ## Configure | |||
|
|
|||
| By default `mc` is configured to interact with the _play_ environment, a public Minio server. If you want to configure a different server: | |||
There was a problem hiding this comment.
If you want to configure a different S3 compatible server:
README.md
Outdated
| ``` | ||
|
|
||
| You will be able to list buckets (i.e. `mc ls <ALIAS>`) or any other available operation. | ||
|
|
There was a problem hiding this comment.
BTW this looks like a repeated mention.. i.e there are details about adding S3 and GCS below, we don't need to repeat the #Configure section.
Perhaps you can move the #Docker section after # Test your setup section underneath.
There was a problem hiding this comment.
Removed duplicated info
README.md
Outdated
|
|
||
| ### Endpoint and credentials | ||
|
|
||
| At startup, Minio server provides its endpoint, access key and secret key. |
There was a problem hiding this comment.
We don't need to talk about Endpoint and credentials from just Minio server point of view. mc is a generic tool to be used with all S3 compatible servers, we can move this to # Example - Minio Cloud Storage section.
README.md
Outdated
| @@ -34,6 +34,14 @@ docker pull minio/mc:edge | |||
| docker run minio/mc:edge ls play | |||
| ``` | |||
|
|
|||
| **Note:** These examples refer to the [_play_ environment](#test-your-setup). If you want to try the same commands against a different S3 compatible server, start the container this way: | |||
There was a problem hiding this comment.
How about - Above examples run mc against Minio play environment by default. To run mc against other S3 compatible servers, start the container this way:
|
@nitisht I updated the README with your suggestions. |
|
Thank you for the contribution @marcoliceti |
No description provided.