minio/README.md
2016-10-13 16:19:14 -07:00

4.4 KiB

Minio Quickstart Guide Gitter Go Report Card Docker Pulls codecov

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.

1. Download

Minio server is light enough to be bundled with the application stack, similar to NodeJS, Redis and MySQL.

Platform Architecture URL
GNU/Linux 64-bit Intel https://dl.minio.io/server/minio/release/linux-amd64/minio
32-bit Intel https://dl.minio.io/server/minio/release/linux-386/minio
32-bit ARM https://dl.minio.io/server/minio/release/linux-arm/minio
Apple OS X 64-bit Intel https://dl.minio.io/server/minio/release/darwin-amd64/minio
Microsoft Windows 64-bit https://dl.minio.io/server/minio/release/windows-amd64/minio.exe
32-bit https://dl.minio.io/server/minio/release/windows-386/minio.exe
FreeBSD 64-bit https://dl.minio.io/server/minio/release/freebsd-amd64/minio

Install from Homebrew

Install minio packages using Homebrew

$ brew install minio
$ minio --help

Install from Source

Source installation is only intended for developers and advanced users. If you do not have a working Golang environment, please follow How to install Golang.

$ go get -u github.com/minio/minio

2. Run Minio Server

In the examples below, Minio serves the contents of the Photos directory as an object store.

Docker Container

Latest Stable

$ docker pull minio/minio
$ docker run -p 9000:9000 minio/minio server /export

Latest Edge (Testing Only)

$ docker pull minio/minio:edge
$ docker run -p 9000:9000 minio/minio:edge server /export

Please visit Minio Docker quickstart guide for more here

GNU/Linux

$ chmod +x minio
$ ./minio --help
$ ./minio server ~/Photos
...

OS X

$ chmod 755 minio
$ ./minio --help
$ ./minio server ~/Photos
...

Microsoft Windows

C:\Users\Username\Downloads> minio.exe --help
C:\Users\Username\Downloads> minio.exe server D:\Photos
...

FreeBSD

$ chmod 755 minio
$ ./minio --help
$ ./minio server ~/Photos
...

Please visit official zfs FreeBSD guide for more details here

3. Test Minio Server using Minio Browser

Open a web browser and navigate to http://127.0.0.1:9000 to view your buckets on minio server.

Screenshot

4. Test Minio Server using mc

Install mc from here. Use mc ls command to list all the buckets on your minio server.

$ mc config host add myminio http://10.0.0.10:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
$ mc mb myminio/mybucket
$ mc ls myminio/
[2015-08-05 08:13:11 IST]     0B mybucket/

For more examples please navigate to Minio Client Complete Guide.

5. Explore Further

6. Contribute to Minio Project

Please follow Minio Contributor's Guide