Welcome to the upcoming version of the MinIO Documentation! The content on this page is under active development and may change at any time. If you can't find what you're looking for, check our legacy documentation. Thank you for your patience.

MinIO High Performance Object Storage

Welcome to the MinIO Documentation! MinIO is a high performance object storage solution with native support for Kubernetes deployments. MinIO provides an Amazon Web Services S3-compatible API and supports all core S3 features. MinIO is released under GNU Affero General Public License v3.0.

You can get started exploring MinIO features using our play server at https://play.min.io. play is a public MinIO cluster running the latest stable MinIO server. Any file uploaded to play should be considered public and non-protected.

The MinIO Client mc commandline interface includes an alias for the play server. After Downloading the MinIO Client, use the play alias to perform S3-compatible object storage operations:

mc alias list play
mc mb --with-lock play/mynewbucket
mc cp ~/data/mytestdata play/mynewbucket

See the MinIO Client Complete Reference for complete documentation on the available mc commands.

  • First-time users of MinIO or object storage services should start with our Introduction.

  • Users deploying onto a Kubernetes cluster should start with our Kubernetes documentation.

Quickstart

The following steps deploys MinIO in filesystem mode with a single folder or disk on the local host. This deployment is best used for initial evaluation of MinIO S3-compatible object storage. Filesystem mode does not support features such as versioning and replication.

1) Create a Data Folder

Create a folder on the local drive for MinIO to use for object storage operations. For example:

mkdir /mnt/data
sudo chmod -R 775 /mnt/data
2) Download MinIO Server and Commandline Tools

Visit https://min.io/downloads and following the instructions for your host operating system to download and configure the minio and mc binaries. Consider adding the minio and mc binaries to the operating system PATH for simplified operations.

Follow the instructions on the download site to start the minio server process. For example, the following command starts the minio server using the created directory:

export MINIO_ROOT_USER=myminioaccesskey
export MINIO_ROOT_PASSWORD=myminiosecretkey

minio server /mnt/data

MINIO_ROOT_USER

The root user access key. Replace the sample value with a long, random, and unique string.

MINIO_ROOT_PASSWORD

The root user secret key. Replace the sample value with a long, random, and unique string.

The output resembles the following:

API: http://127.0.0.1:9000
RootUser: minioadmin
RootPass: minioadmin
Region:   us-east-1
Console: http://127.0.0.1:64518
RootUser: minioadmin
RootPass: minioadmin
Command-line: https://docs.min.io/docs/minio-client-quickstart-guide
   $ mc alias set myminio http://127.0.0.1:9000 minioadmin minioadmin
Documentation: https://docs.min.io

Applications should use one of the addresses listed in the API key for connecting to and performing operations on the MinIO Tenant. For early development and application, applications can authenticate using the RootUser and RootPass credentials. For long-term development and production, create dedicated users. See Security for more information.

You can also use the mc commandline tool to perform operations on the MinIO server. Use mc alias set to update the myminio alias with the access key and secret key set on the MinIO server.

3) Open MinIO Console

Open your browser and http://127.0.0.1:9000 to open the MinIO Console login page.

Log in with the Root User and Root Pass from the previous step.

MinIO Console Dashboard displaying Monitoring Data

You can use the MinIO Console for general administration tasks like Identity and Access Management, Metrics and Log Monitoring, or Server Configuration. See MinIO Console for more information.