minio/README.md

75 lines
2.4 KiB
Markdown
Raw Normal View History

2015-07-14 14:58:37 -04:00
## Minio Server [![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-27 21:34:42 -04:00
2015-07-24 21:09:53 -04:00
Minio is a minimal cloud storage server written in Golang and licensed under [Apache license v2](./LICENSE). Minio is compatible with Amazon S3 APIs. [![Build Status](https://travis-ci.org/minio/minio.svg?branch=master)](https://travis-ci.org/minio/minio)
2015-05-27 21:34:42 -04:00
2015-07-14 14:58:37 -04:00
## Minio Client
2015-07-14 13:57:53 -04:00
2015-07-24 21:09:53 -04: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 13:57:53 -04: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)
2015-07-14 14:56:47 -04:00
## Server Roadmap
2015-05-27 21:34:42 -04:00
~~~
Storage Backend:
- Donut: Erasure coded backend.
2015-07-24 21:09:53 -04:00
- Status: Standalone mode complete.
2015-05-27 21:34:42 -04:00
Storage Operations:
- Collective:
2015-07-14 14:56:47 -04:00
- Status: Work in progress.
2015-05-27 21:34:42 -04:00
Storage Management:
2015-07-24 21:09:53 -04:00
- WebCLI:
2015-05-27 21:34:42 -04:00
- Status: Work in progress.
- Authentication:
- Status: Work in progress.
- Admin Console:
- Status: Work in progress.
2015-07-24 21:09:53 -04:00
- User Console:
2015-05-27 21:34:42 -04:00
- Status: Work in progress.
2015-07-24 21:09:53 -04:00
- Logging:
2015-05-27 21:34:42 -04:00
- Status: Work in progress.
~~~
2015-09-17 18:16:28 -04:00
### Install
<blockquote>
2015-09-17 18:50:30 -04:00
NOTE: If you happen to compile from source code, following options are not available anymore. Minio master branch is going through lots of rapid changes, documentation will be updated subsequently.
2015-09-17 18:16:28 -04:00
</blockquote>
2015-06-16 19:03:17 -04:00
2015-07-24 21:09:53 -04:00
#### GNU/Linux
2015-06-16 19:09:10 -04:00
Download ``minio`` from https://dl.minio.io:9000/updates/2015/Jun/linux-amd64/minio
2015-06-16 19:03:17 -04:00
~~~
$ wget https://dl.minio.io:9000/updates/2015/Jun/linux-amd64/minio
$ chmod +x minio
$ ./minio mode memory limit 12GB expire 2h
~~~
2015-09-17 18:16:28 -04:00
2015-06-16 19:03:17 -04:00
#### OS X
2015-06-16 19:09:10 -04:00
Download ``minio`` from https://dl.minio.io:9000/updates/2015/Jun/darwin-amd64/minio
2015-06-16 19:03:17 -04:00
~~~
$ wget https://dl.minio.io:9000/updates/2015/Jun/darwin-amd64/minio
$ chmod +x minio
$ ./minio mode memory limit 12GB expire 2h
~~~
2015-06-16 19:09:10 -04:00
### How to use Minio?
2015-06-17 16:58:40 -04:00
[![asciicast](https://asciinema.org/a/21575.png)](https://asciinema.org/a/21575)
2015-09-26 18:29:05 -04:00
### Contribute to Minio Project
2015-09-26 18:34:28 -04:00
Please follow Minio [Contributor's Guide](./CONTRIBUTING.md)
2015-09-26 18:29:05 -04:00
### Jobs
If you think in Lisp or Haskell and hack in go, you would blend right in. Send your github link to callhome@minio.io.