2016-08-17 00:59:59 +00:00
# Minio Quickstart Guide [](https://gitter.im/minio/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://codecov.io/gh/minio/minio) [](https://goreportcard.com/report/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
## 1. Download
2016-07-15 23:12:54 +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-07-15 22:03:59 +00:00
| 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|
2015-10-16 18:40:47 +00:00
2016-07-15 23:12:54 +00:00
### Install from Source
2016-02-15 20:45:02 +00:00
2016-07-15 22:03:59 +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 ).
2015-07-14 17:57:53 +00:00
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
```sh
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
$ go get -d github.com/minio/minio
$ cd $GOPATH/src/github.com/minio/minio
$ make
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
```
2016-07-15 23:12:54 +00:00
## 2. Run Minio Server
2016-07-21 21:58:16 +00:00
### GNU/Linux
2015-07-14 17:57:53 +00:00
2016-07-15 22:03:59 +00:00
```sh
2016-07-21 21:58:16 +00:00
2015-11-14 10:39:02 +00:00
$ chmod +x minio
2016-01-08 18:17:08 +00:00
$ ./minio --help
2016-07-15 22:03:59 +00:00
$ ./minio server ~/Photos
2015-05-28 01:34:42 +00:00
2016-07-15 22:03:59 +00:00
Endpoint: http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000
2016-07-15 23:12:54 +00:00
AccessKey: USWUXHGYZQYFYFFIT3RE
SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
2016-07-15 22:03:59 +00:00
Region: us-east-1
2015-11-14 10:39:02 +00:00
2016-07-15 22:03:59 +00:00
Browser Access:
http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000
2015-11-14 10:39:02 +00:00
2016-07-26 22:46:41 +00:00
Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide
2016-07-15 22:03:59 +00:00
$ mc config host add myminio http://10.0.0.10:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
2015-11-14 10:39:02 +00:00
2016-07-15 22:03:59 +00:00
Object API (Amazon S3 compatible):
Go: https://docs.minio.io/docs/golang-client-quickstart-guide
Java: https://docs.minio.io/docs/java-client-quickstart-guide
Python: https://docs.minio.io/docs/python-client-quickstart-guide
JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
```
2016-04-15 00:22:47 +00:00
2016-07-21 21:58:16 +00:00
### OS X
2016-04-15 00:22:47 +00:00
2016-07-15 22:03:59 +00:00
```sh
2016-07-21 21:58:16 +00:00
2016-04-15 00:22:47 +00:00
$ chmod 755 minio
$ ./minio --help
2016-07-15 22:03:59 +00:00
$ ./minio server ~/Photos
config/main: Re-write config files - add to new config v3
- New config format.
```
{
"version": "3",
"address": ":9000",
"backend": {
"type": "fs",
"disk": "/path"
},
"credential": {
"accessKey": "WLGDGYAQYIGI833EV05A",
"secretKey": "BYvgJM101sHngl2uzjXS/OBF/aMxAN06JrJ3qJlF"
},
"region": "us-east-1",
"logger": {
"file": {
"enable": false,
"fileName": "",
"level": "error"
},
"syslog": {
"enable": false,
"address": "",
"level": "debug"
},
"console": {
"enable": true,
"level": "fatal"
}
}
}
```
New command lines in lieu of supporting XL.
Minio initialize filesystem backend.
~~~
$ minio init fs <path>
~~~
Minio initialize XL backend.
~~~
$ minio init xl <url1>...<url16>
~~~
For 'fs' backend it starts the server.
~~~
$ minio server
~~~
For 'xl' backend it waits for servers to join.
~~~
$ minio server
... [PROGRESS BAR] of servers connecting
~~~
Now on other servers execute 'join' and they connect.
~~~
....
minio join <url1> -- from <url2> && minio server
minio join <url1> -- from <url3> && minio server
...
...
minio join <url1> -- from <url16> && minio server
~~~
2016-02-12 23:27:10 +00:00
2016-07-13 06:21:18 +00:00
Endpoint: http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000
2016-07-15 23:12:54 +00:00
AccessKey: USWUXHGYZQYFYFFIT3RE
SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
2016-07-13 06:21:18 +00:00
Region: us-east-1
Browser Access:
http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000
2016-07-26 22:46:41 +00:00
Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide
2016-07-15 22:03:59 +00:00
$ mc config host add myminio http://10.0.0.10:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
2016-07-13 06:21:18 +00:00
Object API (Amazon S3 compatible):
Go: https://docs.minio.io/docs/golang-client-quickstart-guide
Java: https://docs.minio.io/docs/java-client-quickstart-guide
Python: https://docs.minio.io/docs/python-client-quickstart-guide
JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide
2016-07-21 21:58:16 +00:00
2016-01-09 03:42:45 +00:00
```
2016-07-21 21:58:16 +00:00
### Microsoft Windows
2016-01-09 03:42:45 +00:00
2016-07-15 22:03:59 +00:00
```sh
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
C:\Users\Username\Downloads> minio.exe --help
C:\Users\Username\Downloads> minio.exe server D:\Photos
2016-01-09 03:42:45 +00:00
2016-07-15 22:03:59 +00:00
Endpoint: http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000
2016-07-15 23:12:54 +00:00
AccessKey: USWUXHGYZQYFYFFIT3RE
SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
2016-07-15 22:03:59 +00:00
Region: us-east-1
2016-05-12 23:35:11 +00:00
2016-07-15 22:03:59 +00:00
Browser Access:
http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000
2016-05-12 23:35:11 +00:00
2016-07-26 22:46:41 +00:00
Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide
2016-07-15 22:03:59 +00:00
$ mc.exe config host add myminio http://10.0.0.10:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
2016-05-12 23:35:11 +00:00
2016-07-15 22:03:59 +00:00
Object API (Amazon S3 compatible):
Go: https://docs.minio.io/docs/golang-client-quickstart-guide
Java: https://docs.minio.io/docs/java-client-quickstart-guide
Python: https://docs.minio.io/docs/python-client-quickstart-guide
JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide
2016-05-12 23:35:11 +00:00
2016-07-21 21:58:16 +00:00
2016-05-12 23:35:11 +00:00
```
2015-10-22 08:31:09 +00:00
2016-07-21 21:58:16 +00:00
### Docker Container
2015-10-22 08:31:09 +00:00
2016-07-15 22:03:59 +00:00
```sh
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
$ docker pull minio/minio
$ docker run -p 9000:9000 minio/minio
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
```
2015-12-06 21:40:48 +00:00
2016-07-21 21:58:16 +00:00
### FreeBSD
2016-01-09 03:42:45 +00:00
2016-07-15 22:03:59 +00:00
```sh
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
$ chmod 755 minio
$ ./minio --help
$ ./minio server ~/Photos
2015-12-09 23:38:40 +00:00
2016-07-15 22:03:59 +00:00
Endpoint: http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000
2016-07-15 23:12:54 +00:00
AccessKey: USWUXHGYZQYFYFFIT3RE
SecretKey: MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
2016-07-15 22:03:59 +00:00
Region: us-east-1
2015-12-09 23:38:40 +00:00
2016-07-15 22:03:59 +00:00
Browser Access:
http://10.0.0.10:9000 http://127.0.0.1:9000 http://172.17.0.1:9000
2016-03-22 07:09:44 +00:00
2016-07-26 22:46:41 +00:00
Command-line Access: https://docs.minio.io/docs/minio-client-quickstart-guide
2016-07-15 22:03:59 +00:00
$ mc config host add myminio http://10.0.0.10:9000 USWUXHGYZQYFYFFIT3RE MOJRH0mkL1IPauahWITSVvyDrQbEEIwljvmxdq03
2016-03-22 07:09:44 +00:00
2016-07-15 22:03:59 +00:00
Object API (Amazon S3 compatible):
Go: https://docs.minio.io/docs/golang-client-quickstart-guide
Java: https://docs.minio.io/docs/java-client-quickstart-guide
Python: https://docs.minio.io/docs/python-client-quickstart-guide
JavaScript: https://docs.minio.io/docs/javascript-client-quickstart-guide
2016-03-22 07:09:44 +00:00
2016-07-21 21:58:16 +00:00
2016-03-22 07:09:44 +00:00
```
2016-07-15 22:03:59 +00:00
## 3. Test Minio Server using Minio Browser
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
Open a web browser and navigate to http://127.0.0.1:9000 to view your buckets on minio server.
2016-03-22 07:09:44 +00:00
2016-07-24 10:32:45 +00:00
2015-12-09 23:38:40 +00:00
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
## 4. Test Minio Server using `mc`
2015-12-06 21:40:48 +00:00
2016-07-21 21:58:16 +00:00
2016-07-26 22:54:11 +00:00
Install mc from [here ](https://docs.minio.io/docs/minio-client-quickstart-guide ). Use `mc ls` command to list all the buckets on your minio server.
2016-07-15 23:12:54 +00:00
2016-07-15 22:03:59 +00:00
```sh
2016-07-21 21:58:16 +00:00
2016-07-15 22:03:59 +00:00
$ mc ls myminio/
[2015-08-05 08:13:22 IST] 0B andoria/
[2015-08-05 06:14:26 IST] 0B deflector/
[2015-08-05 08:13:11 IST] 0B ferenginar/
[2016-03-08 14:56:35 IST] 0B jarjarbing/
[2016-01-20 16:07:41 IST] 0B my.minio.io/
2016-07-21 21:58:16 +00:00
2016-03-22 07:09:44 +00:00
```
2016-07-15 22:03:59 +00:00
For more examples please navigate to [Minio Client Complete Guide ](https://docs.minio.io/docs/minio-client-complete-guide ).
2016-03-22 07:09:44 +00:00
2016-07-15 23:12:54 +00:00
2016-07-15 22:03:59 +00:00
## 5. Explore Further
2016-07-15 23:12:54 +00:00
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
- [Minio Docker Quickstart Guide ](https://docs.minio.io/docs/minio-docker-quickstart-guide )
- [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-07-15 23:12:54 +00:00
2016-07-15 22:03:59 +00:00
## 6. 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 )
