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

Added configure section with note for Docker users #2141

Merged
merged 3 commits into from
Apr 26, 2017
Merged

Added configure section with note for Docker users #2141

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d38fac
Added configure section with note for Docker users
marcoliceti Apr 26, 2017
a3e4b35
Removed duplicate infos and typos
marcoliceti Apr 26, 2017
34ce1e7
Update README.md
marcoliceti Apr 26, 2017
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
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo s/pruposes/purposes/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then use the mc config command.

## macOS
### Homebrew
Install mc packages using [Homebrew](http://brew.sh/)
Expand Down Expand Up @@ -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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to configure a different S3 compatible server:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed


```sh
mc config host add <ALIAS> <YOUR-S3-ENDPOINT> <YOUR-ACCESS-KEY> <YOUR-SECRET-KEY>
```

You will be able to list buckets (i.e. `mc ls <ALIAS>`) or any other available operation.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed duplicated info

### Endpoint and credentials

At startup, Minio server provides its endpoint, access key and secret key.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed


### A note for Docker users

If you are trying `mc` with Docker, keep in mind that each `docker run` invocation will start a new container, which is fine if you stick with the _play_ environment. Otherwise, you can start an interactive session with a single container:

```sh
docker run -it --entrypoint=/bin/sh minio/mc
```

This will start a shell in which you can execute `mc config` and other `mc` commands without prefixing them with `docker run minio/mc`. More importantly, any configuration done with `mc config` will be preserved until you exit from the shell.

## Add a Cloud Storage Service
If you are planning to use `mc` only on POSIX compatible filesystems, you may skip this step and proceed to [everyday use](#everyday-use).

Expand Down