2017-09-19 19:36:35 +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) [](https://build.snapcraft.io/user/minio/minio)
2018-01-19 07:46:59 +00:00
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fminio%2Fminio?ref=badge_shield)
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
2017-08-17 17:56:25 +00:00
docker run -p 9000:9000 minio/minio server /data
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
2017-08-17 17:56:25 +00:00
docker run -p 9000:9000 minio/minio:edge server /data
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
2017-04-07 08:42:59 +00:00
## macOS
2016-10-14 02:34:03 +00:00
### Homebrew
Install minio packages using [Homebrew ](http://brew.sh/ )
2016-10-13 01:09:08 +00:00
```sh
2017-04-07 08:42:59 +00:00
brew install minio/stable/minio
2017-09-15 02:17:42 +00:00
minio server /data
2016-07-15 22:03:59 +00:00
```
2017-12-07 03:08:58 +00:00
> NOTE: If you previously installed minio using `brew install minio` then it is recommended that you reinstall minio from `minio/stable/minio` official repo instead.
2017-09-19 19:41:19 +00:00
```sh
2017-08-28 18:40:26 +00:00
brew uninstall minio
2017-06-09 21:24:32 +00:00
brew install minio/stable/minio
2017-08-28 18:40:26 +00:00
```
2017-06-09 21:24:32 +00:00
2016-10-14 02:34:03 +00:00
### Binary Download
| Platform| Architecture | URL|
| ----------| -------- | ------|
2017-04-07 08:42:59 +00:00
|Apple macOS|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
2017-09-15 02:17:42 +00:00
./minio server /data
2016-01-09 03:42:45 +00:00
```
2016-10-14 02:34:03 +00:00
## GNU/Linux
### Binary Download
| Platform| Architecture | URL|
| ----------| -------- | ------|
2017-03-21 19:02:39 +00:00
|GNU/Linux|64-bit Intel|https://dl.minio.io/server/minio/release/linux-amd64/minio |
2016-10-14 02:34:03 +00:00
```sh
2016-12-15 01:45:47 +00:00
chmod +x minio
2017-09-15 02:17:42 +00:00
./minio server /data
2016-10-14 02:34:03 +00:00
```
2017-08-23 22:59:13 +00:00
### Snap
2017-12-07 03:08:58 +00:00
Install minio using [Snap ](https://snapcraft.io )
2017-08-23 22:59:13 +00:00
```sh
sudo snap install minio --edge
```
2017-12-07 03:08:58 +00:00
Start minio using `snap run` command
2017-08-28 18:40:26 +00:00
```sh
sudo snap connect minio:mount-observe
2017-12-07 03:08:58 +00:00
sudo snap run minio server /data
2017-08-28 18:40:26 +00:00
```
2016-10-14 02:34:03 +00:00
## Microsoft Windows
### Binary Download
| Platform| Architecture | URL|
| ----------| -------- | ------|
2017-03-21 19:02:39 +00:00
|Microsoft Windows|64-bit|https://dl.minio.io/server/minio/release/windows-amd64/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
2017-04-19 07:25:20 +00:00
### Port
Install minio packages using [pkg ](https://github.com/freebsd/pkg )
```sh
pkg install minio
sysrc minio_enable=yes
sysrc minio_disks=/home/user/Photos
service minio start
```
2016-10-14 02:34:03 +00:00
## 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 ](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-12-15 01:45:47 +00:00
go get -u github.com/minio/minio
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
2018-01-17 15:14:31 +00:00
## Pre-existing data
When deployed on a single drive, Minio server lets clients access any pre-existing data in the data directory. For example, if Minio is started with the command `minio server /mnt/data` , any pre-existing data in the `/mnt/data` directory would be accessible to the clients.
The above statement is also valid for all gateway backends.
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 )
2018-01-19 07:46:59 +00:00
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fminio%2Fminio?ref=badge_large)
