diff --git a/README.md b/README.md index 21730819a..117fcd9a5 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ 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. ## 1. Download - Minio server is light enough to be bundled with the application stack, similar to NodeJS, Redis and MySQL. | Platform| Architecture | URL| @@ -17,7 +16,6 @@ Minio server is light enough to be bundled with the application stack, similar t |FreeBSD|64-bit|https://dl.minio.io/server/minio/release/freebsd-amd64/minio| ### Install from Homebrew - Install minio packages using [Homebrew](http://brew.sh/) ```sh @@ -26,25 +24,26 @@ $ minio --help ``` ### 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). ```sh - $ go get -u github.com/minio/minio - - ``` ## 2. Run Minio Server - In the examples below, Minio serves the contents of the ``Photos`` directory as an object store. -### GNU/Linux +### Docker Container +```sh +$ docker pull minio/minio +$ docker run -p 9000:9000 minio/minio ~/Photos - ```sh +``` +Please visit Minio Docker quickstart guide for more [here](https://docs.minio.io/docs/minio-docker-quickstart-guide) +### GNU/Linux + ```sh $ chmod +x minio $ ./minio --help $ ./minio server ~/Photos @@ -69,10 +68,7 @@ Object API (Amazon S3 compatible): ``` ### OS X - - ```sh - $ chmod 755 minio $ ./minio --help $ ./minio server ~/Photos @@ -93,13 +89,10 @@ Object API (Amazon S3 compatible): 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 - ``` ### Microsoft Windows - ```sh - C:\Users\Username\Downloads> minio.exe --help C:\Users\Username\Downloads> minio.exe server D:\Photos @@ -119,24 +112,10 @@ Object API (Amazon S3 compatible): 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 - - ``` -### Docker Container - -```sh - -$ docker pull minio/minio -$ docker run -p 9000:9000 minio/minio - -``` -Please visit Minio Docker quickstart guide for more [here](https://docs.minio.io/docs/minio-docker-quickstart-guide) - ### FreeBSD - ```sh - $ chmod 755 minio $ ./minio --help $ ./minio server ~/Photos @@ -157,22 +136,15 @@ Object API (Amazon S3 compatible): 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 - - ``` Please visit official zfs FreeBSD guide for more details [here](https://www.freebsd.org/doc/handbook/zfs-quickstart.html) ## 3. Test Minio Server using Minio Browser - - Open a web browser and navigate to http://127.0.0.1:9000 to view your buckets on minio server. ![Screenshot](https://github.com/minio/minio/blob/master/docs/screenshots/minio-browser.jpg?raw=true) - ## 4. Test Minio Server using `mc` - - 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. ```sh @@ -184,9 +156,7 @@ $ mc ls myminio/ For more examples please navigate to [Minio Client Complete Guide](https://docs.minio.io/docs/minio-client-complete-guide). - ## 5. Explore Further - - [Minio Erasure Code QuickStart Guide](https://docs.minio.io/docs/minio-erasure-code-quickstart-guide) - [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)