mc/docs/minio-admin-complete-guide.md

Minio Admin Complete Guide

Minio Client (mc) provides admin sub-command to perform administrative tasks on your Minio deployments.

service      stop, restart or get status of minio server
info         display minio server information
user         manage users
policy       manage canned policies
credential   change admin server access and secret keys
config       manage configuration file
heal         heal disks, buckets and objects on minio server

1. Download Minio Client

Docker Stable

docker pull minio/mc
docker run minio/mc admin info play

Docker Edge

docker pull minio/mc:edge
docker run minio/mc:edge admin info play

Homebrew (macOS)

Install mc packages using Homebrew

brew install minio/stable/mc
mc --help

Binary Download (GNU/Linux)

Platform	Architecture	URL
GNU/Linux	64-bit Intel	https://dl.minio.io/client/mc/release/linux-amd64/mc

chmod +x mc
./mc --help

Binary Download (Microsoft Windows)

Platform	Architecture	URL
Microsoft Windows	64-bit Intel	https://dl.minio.io/client/mc/release/windows-amd64/mc.exe

mc.exe --help

Install from Source

Source installation is intended only for developers and advanced users. mc update command does not support update notifications for source based installations. Please download official releases from https://minio.io/downloads/#minio-client.

If you do not have a working Golang environment, please follow How to install Golang.

go get -d github.com/minio/mc
cd ${GOPATH}/src/github.com/minio/mc
make

2. Run Minio Client

GNU/Linux

chmod +x mc
./mc --help

macOS

chmod 755 mc
./mc --help

Microsoft Windows

mc.exe --help

3. Add a Minio Storage Service

Minio server displays URL, access and secret keys.

Usage

mc config host add <ALIAS> <YOUR-MINIO-ENDPOINT> <YOUR-ACCESS-KEY> <YOUR-SECRET-KEY>

Alias is simply a short name to your Minio service. Minio end-point, access and secret keys are supplied by your Minio service. Admin API uses "S3v4" signature and cannot be changed.

mc config host add minio http://192.168.1.51:9000 BKIKJAA5BMMU2RHO6IBB V7f1CwQqAcwo80UEIJEjc5gVQUSSx5ohQ9GSrr12

4. Test Your Setup

Example:

Get Minio server information for the configured alias minio

mc admin info minio

●  192.168.1.51:9000
   Uptime : online since 1 day ago
  Version : 2018-05-28T04:31:38Z
   Region :
 SQS ARNs : <none>
    Stats : Incoming 82GiB, Outgoing 28GiB
  Storage : Used 7.4GiB

5. Everyday Use

You may add shell aliases for info, healing.

alias minfo='mc admin info'
alias mheal='mc admin heal'

6. Global Options

Option [--debug]

Debug option enables debug output to console.

Example: Display verbose debug output for info command.

mc admin --debug info minio
mc: <DEBUG> GET /minio/admin/v1/info HTTP/1.1
Host: 192.168.1.51:9000
User-Agent: Minio (linux; amd64) madmin-go/0.0.1 mc/2018-05-23T23:43:34Z
Authorization: AWS4-HMAC-SHA256 Credential=**REDACTED**/20180530/us-east-1/s3/aws4_request, SignedHeaders=host;x-amz-content-sha256;x-amz-date, Signature=**REDACTED**
X-Amz-Content-Sha256: UNSIGNED-PAYLOAD
X-Amz-Date: 20180530T001808Z
Accept-Encoding: gzip

mc: <DEBUG> HTTP/1.1 200 OK
Transfer-Encoding: chunked
Accept-Ranges: bytes
Content-Security-Policy: block-all-mixed-content
Content-Type: application/json
Date: Wed, 30 May 2018 00:18:08 GMT
Server: Minio/DEVELOPMENT.2018-05-28T04-31-38Z (linux; amd64)
Vary: Origin
X-Amz-Request-Id: 1533440573A63034
X-Xss-Protection: "1; mode=block"

mc: <DEBUG> Response Time:  140.70112ms

●  192.168.1.51:9000
   Uptime : online since 1 day ago
  Version : 2018-05-28T04:31:38Z
   Region :
 SQS ARNs : <none>
    Stats : Incoming 82GiB, Outgoing 28GiB
  Storage : Used 7.4GiB

Option [--json]

JSON option enables parseable output in JSON format.

Example: Minio server information.

mc admin --json info minio
{
  "status": "success",
  "service": "on",
  "address": "192.168.1.51:9000",
  "error": "",
  "storage": {
    "used": 7979370172,
    "backend": {
      "backendType": "FS"
    }
  },
  "network": {
    "transferred": 90473434722,
    "received": 30662519192
  },
  "server": {
    "uptime": 157467244813288,
    "version": "2018-05-28T04:31:38Z",
    "commitID": "7d8c5ffb13334f4aec20a35bd2575bd7c740fb7a",
    "region": "",
    "sqsARN": []
  }
}

Option [--no-color]

This option disables the color theme. It is useful for dumb terminals.

Option [--quiet]

Quiet option suppress chatty console output.

Option [--config-dir]

Use this option to set a custom config path.

Option [ --insecure]

Skip SSL certificate verification.

7. Commands

service - start, stop or get the status of minio server
info - display minio server information
user - manage users
policy - manage canned policies
credential - change admin server access and secret keys
config - manage server configuration file
heal - heal disks, buckets and objects on minio server

Command service - stop, restart or get status of minio server

service command provides a way to restart, stop one or get the status of Minio servers (distributed cluster)

NAME:
  mc admin service - stop, restart or get status of minio server

FLAGS:
  --help, -h                       show help

COMMANDS:
  status   get the status of minio server
  restart  restart minio server
  stop     stop minio server

Example: Display service uptime for Minio server.

mc admin service status play
Uptime: 1 days 19 hours 57 minutes 39 seconds.

Example: Restart remote minio service.

NOTE: restart and stop sub-commands are disruptive operations for your Minio service, any on-going API operations will be forcibly canceled. So, it should be used only under certain circumstances. Please use it with caution.

mc admin service restart play
Restarted `play` successfully.

Command info - Display Minio server information

info command displays server information of one or many Minio servers (under distributed cluster)

NAME:
  mc admin info - get minio server information

FLAGS:
  --help, -h                       show help

Example: Display Minio server information.

mc admin info play
●  play.minio.io:9000
   Uptime : online since 1 day ago
  Version : 2018-05-28T04:31:38Z
   Region :
 SQS ARNs : <none>
    Stats : Incoming 82GiB, Outgoing 28GiB
  Storage : Used 8.2GiB

Command policy - Manage canned policies

policy command to add, remove, list policies on Minio server.

NAME:
  mc admin policy - manage policies

FLAGS:
  --help, -h                       show help

COMMANDS:
  add      add new policy
  remove   remove policy
  list     List all policies

Example: Add a new policy 'newpolicy' on Minio, with policy from /tmp/newpolicy.json.

mc admin policy add myminio/ newpolicy /tmp/newpolicy.json

Example: Remove policy 'newpolicy' on Minio.

mc admin policy remove myminio/ newpolicy

Example: List all policies on Minio.

mc admin policy list --json myminio/
{"status":"success","policy":"newpolicy"}

Command user - Manage users

user command to add, remove, enable, disable, list users on minio server.

NAME:
  mc admin user - manage users

FLAGS:
  --help, -h                       show help

COMMANDS:
  add      add new user
  policy   set policy for user
  disable  disable user
  enable   enable user
  remove   remove user
  list     list all users

Example: Add a new user 'newuser' on Minio, with 'newpolicy' policy.

mc admin user add myminio/ newuser newuser123 newpolicy

Example: Change policy for a user 'newuser' on Minio to 'writeonly' policy.

mc admin user policy myminio/ newuser writeonly

Example: Disable a user 'newuser' on Minio.

mc admin user disable myminio/ newuser

Example: Enable a user 'newuser' on Minio.

mc admin user enable myminio/ newuser

Example: Remove user 'newuser' on Minio.

mc admin user remove myminio/ newuser

Example: List all users on Minio.

mc admin user list --json myminio/
{"status":"success","accessKey":"newuser","userStatus":"enabled"}

Command credential - Change server admin access and secret keys

credential command to set new admin credential of a Minio server.

NAME:
  mc admin credential - Change server **admin** access and secret keys

FLAGS:
  --help, -h                       Show help.

Example: Set new admin credential of a Minio server represented by its alias 'myminio'.

mc admin credential myminio/ minio minio123

Command config - Manage server configuration

config command to manage Minio server configuration.

NAME:
  mc admin config - manage configuration file

USAGE:
  mc admin config COMMAND [COMMAND FLAGS | -h] [ARGUMENTS...]

COMMANDS:
  get  get config of a Minio server/cluster.
  set  set new config file to a Minio server/cluster.

FLAGS:
  --help, -h                       Show help.

Example: Get server configuration of a Minio server/cluster.

mc admin config get myminio > /tmp/my-serverconfig

Example: Set server configuration of a Minio server/cluster.

mc admin config set myminio < /tmp/my-serverconfig

Command heal - Heal disks, buckets and objects on Minio server

heal command heals disks, missing buckets, objects on Minio server. NOTE: This command is only applicable for Minio erasure coded setup (standalone and distributed).

NAME:
  mc admin heal - heal disks, buckets and objects on Minio server

FLAGS:
  --recursive, -r                  heal recursively
  --dry-run, -n                    only inspect data, but do not mutate
  --force-start, -f                force start a new heal sequence
  --help, -h                       show help

Example: Heal Minio cluster after replacing a fresh disk, recursively heal all buckets and objects, where 'myminio' is the Minio server alias.

mc admin heal -r myminio

Example: Heal Minio cluster on a specific bucket recursively, where 'myminio' is the Minio server alias.

mc admin heal -r myminio/mybucket

Example: Heal Minio cluster on a specific object prefix recursively, where 'myminio' is the Minio server alias.

mc admin heal -r myminio/mybucket/myobjectprefix