MinIO Admin Client
The MinIO Client mc
command line tool provides The command
command for performing administrative tasks on your MinIO deployments.
While mc
supports any S3-compatible service,
mc admin
only supports MinIO deployments.
mc admin
has the following syntax:
mc admin [FLAGS] COMMAND [ARGUMENTS]
Command Quick reference
The following table lists mc admin
commands:
Command |
Description |
---|---|
The |
|
The |
|
The |
|
The |
|
The |
|
The |
|
The |
|
Use the |
|
The |
|
The |
|
The |
|
The Site replication mimics an active-active bucket replication, but for multiple MinIO deployments. Wherever a change occurs to IAM settings, buckets, or objects across the set of sites, the change replicates across all sites in the site replication group. |
|
The |
|
The |
|
The |
|
The |
Installation
The following commands add a temporary extension to your system
PATH for running the mc
utility. Defer to your operating system
instructions for making permanent modifications to your system PATH.
Alternatively, execute mc
by navigating to the parent folder and
running ./mc --help
64-bit Intel
curl https://dl.min.io/client/mc/release/linux-amd64/mc \
--create-dirs \
-o $HOME/minio-binaries/mc
chmod +x $HOME/minio-binaries/mc
export PATH=$PATH:$HOME/minio-binaries/
mc --help
64-bit PPC
curl https://dl.min.io/client/mc/release/linux-ppc64le/mc \
--create-dirs \
-o ~/minio-binaries/mc
chmod +x $HOME/minio-binaries/mc
export PATH=$PATH:$HOME/minio-binaries/
mc --help
ARM64
curl https://dl.min.io/client/mc/release/linux-arm64/mc \
--create-dirs \
-o ~/minio-binaries/mc
chmod +x $HOME/minio-binaries/mc
export PATH=$PATH:$HOME/minio-binaries/
mc --help
Install from the MinIO Download Page
MinIO does not officially publish its binaries to common Linux repositories or package managers (Ubuntu, RHEL, Archlinux/AUR). The only official source of MinIO binaries is the MinIO Download Page.
MinIO does not recommend installation through a package manager, as upstream repositories may install the incorrect package or a renamed package.
All documentation assumes the installation of the official mc
client binary through the download page only, with no changes to binary naming.
brew install minio/stable/mc
mc --help
Open the following file in a browser:
https://dl.min.io/client/mc/release/windows-amd64/mc.exe
Execute the file by double clicking on it, or by running the following in the command prompt or powershell:
\path\to\mc.exe --help
Installation from source is intended for developers and advanced users and requires a working Golang environment. See How to install Golang.
Run the following commands in a terminal environment to install mc
from source:
go install github.com/minio/mc@latest
mc update
does not support source-based installations.
Quickstart
Ensure that the host machine has mc
installed prior to starting this procedure.
Important
The following example temporarily disables the bash history to mitigate the risk of authentication credentials leaking in plain text. This is a basic security measure and does not mitigate all possible attack vectors. Defer to security best practices for your operating system for inputting sensitive information on the command line.
Use the mc alias set
command to add the
deployment to the mc configuration.
bash +o history
mc config host add <ALIAS> <ENDPOINT> ACCESS_KEY SECRET_KEY
bash -o history
Replace each argument with the required values. Specifying only the
mc config host add
command starts an input prompt for entering the
required values.
Use the mc admin info
command to test the connection to
the newly added MinIO deployment:
mc admin info <ALIAS>
Global Options
mc admin
supports the same global options as mc
.
See Global Options.