minio/README.md

65 lines
2.3 KiB
Markdown
Raw Normal View History

## Minio [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/minio/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2015-05-28 01:34:42 +00:00
Minio is a minimal cloud storage server for Micro Services & Magnetic Disks. Written in Golang and licensed under [Apache license v2](./LICENSE). Compatible with Amazon S3 APIs.
2015-05-28 01:34:42 +00:00
2015-07-14 18:58:37 +00:00
## Minio Client
2015-07-14 17:57:53 +00:00
2015-07-25 01:09:53 +00:00
[Minio Client (mc)](https://github.com/minio/mc#minio-client-mc-) provides a modern alternative to Unix commands like ``ls``, ``cat``, ``cp``, ``sync``, and ``diff``. It supports POSIX compatible filesystems and Amazon S3 compatible cloud storage systems. It is entirely written in Golang.
2015-07-14 17:57:53 +00:00
## Amazon S3 Compatible Client Libraries
- [Golang Library](https://github.com/minio/minio-go)
- [Java Library](https://github.com/minio/minio-java)
- [Nodejs Library](https://github.com/minio/minio-js)
- [Python Library](https://github.com/minio/minio-py)
- [.Net Library](https://github.com/minio/minio-dotnet)
### Install [![Build Status](https://travis-ci.org/minio/minio.svg?branch=master)](https://travis-ci.org/minio/minio)[![Build status](https://ci.appveyor.com/api/projects/status/k61d0v3ritbwm2su?svg=true)](https://ci.appveyor.com/project/harshavardhana/minio)
#### Linux, OS X, Windows
2015-07-14 17:57:53 +00:00
2015-05-28 01:34:42 +00:00
~~~
$ go get github.com/minio/minio
2015-05-28 01:34:42 +00:00
~~~
### How to use Minio?
2015-09-17 22:16:28 +00:00
~~~
$ minio server
NAME:
minio server - Start Minio cloud storage server.
2015-09-17 22:16:28 +00:00
USAGE:
minio server PATH
2015-06-16 23:03:17 +00:00
EXAMPLES:
1. Start minio server on Linux.
$ minio server /home/shared
2015-06-16 23:09:10 +00:00
2. Start minio server on Windows.
$ minio server C:\MyShare
2015-06-16 23:09:10 +00:00
3. Start minio server bound to a specific IP:PORT, when you have multiple network interfaces.
$ minio --address 192.168.1.101:9000 /home/shared
2015-06-16 23:03:17 +00:00
~~~
2015-06-16 23:03:17 +00:00
~~~
$ minio server ~/Photos
AccessKey: G5GJRH51R2HSUWYPGIX5 SecretKey: uxhBC1Yscut3/u81l5L8Yp636ZUk32N4m/gFASuZ
2015-09-17 22:16:28 +00:00
To configure Minio Client.
2015-06-16 23:09:10 +00:00
$ wget https://dl.minio.io:9000/updates/2015/Oct/darwin-amd64/mc
$ chmod 755 mc
$ ./mc config host add localhost:9000 G5GJRH51R2HSUWYPGIX5 uxhBC1Yscut3/u81l5L8Yp636ZUk32N4m/gFASuZ
$ ./mc mb localhost/photobucket
$ ./mc cp ~/Photos... localhost/photobucket
2015-06-16 23:09:10 +00:00
Starting minio server:
Listening on http://127.0.0.1:9000
Listening on http://172.30.2.17:9000
2015-06-16 23:03:17 +00:00
~~~
2015-06-16 23:09:10 +00:00
2015-09-26 22:29:05 +00:00
### Contribute to Minio Project
2015-09-26 22:34:28 +00:00
Please follow Minio [Contributor's Guide](./CONTRIBUTING.md)
2015-09-26 22:29:05 +00:00