2017-01-16 23:26:26 +00:00
# Minio Quickstart Guide [](https://slack.minio.io) [](https://goreportcard.com/report/minio/minio) [](https://hub.docker.com/r/minio/minio/) [](https://codecov.io/gh/minio/minio)
2016-07-15 23:12:54 +00:00
2016-07-15 22:03:59 +00:00
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.
2015-05-28 01:34:42 +00:00
2016-07-15 22:03:59 +00:00
Minio server is light enough to be bundled with the application stack, similar to NodeJS, Redis and MySQL.
2015-10-16 18:40:47 +00:00
2016-10-14 02:34:03 +00:00
## Docker Container
### Stable
2016-12-29 00:07:05 +00:00
```
2016-12-15 01:45:47 +00:00
docker pull minio/minio
docker run -p 9000:9000 minio/minio server /export
2016-10-09 20:06:25 +00:00
```
2016-10-13 01:09:08 +00:00
2016-10-14 02:34:03 +00:00
### Edge
2016-12-29 00:07:05 +00:00
```
2016-12-15 01:45:47 +00:00
docker pull minio/minio:edge
docker run -p 9000:9000 minio/minio:edge server /export
2016-10-13 23:19:14 +00:00
```
2016-10-09 20:06:25 +00:00
Please visit Minio Docker quickstart guide for more [here ](https://docs.minio.io/docs/minio-docker-quickstart-guide )
2016-07-21 21:58:16 +00:00
2016-10-14 02:34:03 +00:00
## OS X
### Homebrew
Install minio packages using [Homebrew ](http://brew.sh/ )
2016-10-13 01:09:08 +00:00
```sh
2016-12-15 01:45:47 +00:00
brew install minio
minio server ~/Photos
2016-07-15 22:03:59 +00:00
```
2016-04-15 00:22:47 +00:00
2016-10-14 02:34:03 +00:00
### Binary Download
| Platform| Architecture | URL|
| ----------| -------- | ------|
|Apple OS X|64-bit Intel|https://dl.minio.io/server/minio/release/darwin-amd64/minio|
2016-10-13 01:09:08 +00:00
```sh
2016-12-15 01:45:47 +00:00
chmod 755 minio
./minio server ~/Photos
2016-01-09 03:42:45 +00:00
```
2016-10-14 02:34:03 +00:00
## GNU/Linux
### Binary Download
| 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|
```sh
2016-12-15 01:45:47 +00:00
chmod +x minio
./minio server ~/Photos
2016-10-14 02:34:03 +00:00
```
## Microsoft Windows
### Binary Download
| Platform| Architecture | URL|
| ----------| -------- | ------|
|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|
2016-07-15 22:03:59 +00:00
```sh
2016-12-15 01:45:47 +00:00
minio.exe server D:\Photos
2016-05-12 23:35:11 +00:00
```
2015-10-22 08:31:09 +00:00
2016-10-14 02:34:03 +00:00
## FreeBSD
### Binary Download
| Platform| Architecture | URL|
| ----------| -------- | ------|
|FreeBSD|64-bit|https://dl.minio.io/server/minio/release/freebsd-amd64/minio|
2016-07-15 22:03:59 +00:00
```sh
2016-12-15 01:45:47 +00:00
chmod 755 minio
./minio server ~/Photos
2016-03-22 07:09:44 +00:00
```
2016-12-16 17:59:02 +00:00
You can run Minio on FreeBSD with FreeNAS storage-backend - see [here ](https://docs.minio.io/docs/how-to-run-minio-in-freenas ) for more details.
2016-03-22 07:09:44 +00:00
2016-10-14 02:34:03 +00:00
## Install from Source
2016-10-14 20:20:33 +00:00
2016-10-14 02:34:03 +00:00
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 ](https://docs.minio.io/docs/how-to-install-golang ).
2016-10-14 15:49:12 +00:00
2016-07-15 22:03:59 +00:00
```sh
2016-10-14 20:20:33 +00:00
2016-12-15 01:45:47 +00:00
go get -u github.com/minio/minio
2016-10-14 20:20:33 +00:00
2016-03-22 07:09:44 +00:00
```
2016-10-14 02:34:03 +00:00
## Test using Minio Browser
Minio Server comes with an embedded web based object browser. Point your web browser to http://127.0.0.1:9000 ensure your server has started successfully.
## Test using Minio Client `mc`
`mc` provides a modern alternative to UNIX commands like ls, cat, cp, mirror, diff etc. It supports filesystems and Amazon S3 compatible cloud storage services. Follow the Minio Client [Quickstart Guide ](https://docs.minio.io/docs/minio-client-quickstart-guide ) for further instructions.
2016-03-22 07:09:44 +00:00
2016-10-14 02:34:03 +00:00
## Explore Further
2016-07-15 22:03:59 +00:00
- [Minio Erasure Code QuickStart Guide ](https://docs.minio.io/docs/minio-erasure-code-quickstart-guide )
2016-07-25 05:53:35 +00:00
- [Use `mc` with Minio Server ](https://docs.minio.io/docs/minio-client-quickstart-guide )
- [Use `aws-cli` with Minio Server ](https://docs.minio.io/docs/aws-cli-with-minio )
- [Use `s3cmd` with Minio Server ](https://docs.minio.io/docs/s3cmd-with-minio )
- [Use `minio-go` SDK with Minio Server ](https://docs.minio.io/docs/golang-client-quickstart-guide )
2016-10-22 02:31:21 +00:00
- [The Minio documentation website ](https://docs.minio.io )
2016-07-15 23:12:54 +00:00
2016-10-14 02:34:03 +00:00
## Contribute to Minio Project
2016-07-21 21:58:16 +00:00
Please follow Minio [Contributor's Guide ](https://github.com/minio/minio/blob/master/CONTRIBUTING.md )
