From 2c3b1f01d9460cc8cddc186a6343bb840f75cb07 Mon Sep 17 00:00:00 2001 From: SCDealy Date: Thu, 1 Aug 2019 22:01:07 -0700 Subject: [PATCH] Update README.md (#8006) Since MinIO by default is not fully S3 compatible, this fact should be specified in a prominent place in the quick start guide so people new to MinIO don't have to spend hours figuring it out the hard way. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 482eff503..4746e32f2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,15 @@ # MinIO Quickstart Guide [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) [![Go Report Card](https://goreportcard.com/badge/minio/minio)](https://goreportcard.com/report/minio/minio) [![Docker Pulls](https://img.shields.io/docker/pulls/minio/minio.svg?maxAge=604800)](https://hub.docker.com/r/minio/minio/) -MinIO is an object storage server released under Apache License v2.0. It is compatible with Amazon S3 cloud storage service. It is best suited for storing unstructured data such as photos, videos, log files, backups and container / VM images. Size of an object can range from a few KBs to a maximum of 5TB. +MinIO is an object storage server released under Apache License v2.0. It is compatible[1] with Amazon S3 cloud storage service. It is best suited for storing unstructured data such as photos, videos, log files, backups and container / VM images. Size of an object can range from a few KBs to a maximum of 5TB. MinIO server is light enough to be bundled with the application stack, similar to NodeJS, Redis and MySQL. +[1]: MinIO in its default mode is faster and does not calculate MD5Sum unless passed by client. This may lead to incompatibility with few S3 clients like s3ql that heavily depend on MD5Sum. For full compatibility with Amazon S3 API, start MinIO with `--compat` option. +```sh +minio --compat server /data +``` + ## Docker Container ### Stable ```