minio/README.md

65 lines
1.9 KiB
Markdown
Raw Normal View History

2015-05-28 01:34:42 +00:00
## Minio Server (minio) [![Build Status](https://travis-ci.org/minio/minio.svg)](https://travis-ci.org/minio/minio)
2015-05-28 01:54:03 +00:00
Minio is a minimal object storage server written in Golang and licensed under [Apache license v2](./LICENSE). Minio is compatible with Amazon S3 APIs.
2015-05-28 01:34:42 +00:00
## Roadmap
~~~
Storage Backend:
- Donut: Erasure coded backend.
- Status: Standalone mode complete.
- Memory: In-memory backend.
- Status: Complete.
- Filesystem: Local disk filesystem backend.
- Status: Work in progress.
Storage Operations:
- Collective:
- Status: Not started.
Storage Management:
- WebCLI:
- Status: Work in progress.
- Authentication:
- Status: Work in progress.
- Admin Console:
- Status: Work in progress.
- User Console:
- Status: Work in progress.
- Logging:
- Status: Work in progress.
~~~
### How to use Minio?
2015-06-16 22:58:04 +00:00
[![asciicast](https://asciinema.org/a/21508.png)](https://asciinema.org/a/21508)
2015-05-28 01:54:03 +00:00
### Minio Client (mc)
``mc`` provides minimal tools to work with Amazon S3 compatible object storage and filesystems. Go to [Minio Client](https://github.com/minio/mc#minio-client-mc-).
### Minimal 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)
2015-05-28 01:34:42 +00:00
### Join The Community
* Community hangout on Gitter [![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-01-09 03:05:21 +00:00
* Ask questions on Quora [![Quora](http://upload.wikimedia.org/wikipedia/commons/thumb/5/57/Quora_logo.svg/55px-Quora_logo.svg.png)](http://www.quora.com/Minio)
2015-05-28 01:54:03 +00:00
### Contribute
* [Contributors Guide](./CONTRIBUTING.md)
2015-01-09 03:05:21 +00:00
2014-12-30 00:35:56 +00:00
### Download
2014-12-20 17:09:35 +00:00
2014-12-30 10:44:08 +00:00
-- No releases yet --
2014-12-20 17:09:35 +00:00
2015-01-06 09:22:03 +00:00
### Supported platforms
| Name | Supported |
| ------------- | ------------- |
| Linux | Yes |
| Mac OSX | Yes |
2015-05-28 01:34:42 +00:00
| Windows | Work in progress |
2015-01-06 09:22:03 +00:00