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.
This documentation targets the latest stable version of MinIO, RELEASE.2022-01-08T03-11-54Z.
You can get started exploring MinIO features using our
play server at
play is a public MinIO cluster running the latest
stable MinIO server. Any file uploaded to
play should be considered public
mc alias list play mc mb --with-lock play/mynewbucket mc cp ~/data/mytestdata play/mynewbucket
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.
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
mcbinaries. Consider adding the
mcbinaries to the operating system PATH for simplified operations.
export MINIO_ROOT_USER=myminioaccesskey export MINIO_ROOT_PASSWORD=myminiosecretkey minio server /mnt/data
The root user access key. Replace the sample value with a long, random, and unique string.
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.
- 3) Open MinIO Console
Log in with the Root User and Root Pass from the previous step.
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.
We have designed MinIO as an Open Source software for the Open Source software community. This requires applications to consider whether their usage of MinIO is in compliance with the GNU AGPLv3 license.
MinIO cannot make the determination as to whether your application’s usage of MinIO is in compliance with the AGPLv3 license requirements. You should instead rely on your own legal counsel or licensing specialists to audit and ensure your application is in compliance with the licenses of MinIO and all other open-source projects with which your application integrates or interacts. We understand that AGPLv3 licensing is complex and nuanced. It is for that reason we strongly encourage using experts in licensing to make any such determinations around compliance instead of relying on apocryphal or anecdotal advice.
MinIO Commercial Licensing is the best option for applications that trigger AGPLv3 obligations (e.g. open sourcing your application). Applications using MinIO - or any other OSS-licensed code - without validating their usage do so at their own risk.