doc:README.md/Updated to sync with docs.minio.io (#2210)

* doc:README.md/Updated to sync with docs.minio.io * doc:README.me/Modified the minio server output terminal to reflect new release changes. * docs:README.md/Modified and changed location of other markdown files.
2026-07-19 04:00:25 +03:00 · 2016-07-15 15:03:59 -07:00
parent 3bce5db6d1
commit 204ec2c6c0
8 changed files with 171 additions and 216 deletions
@@ -0,0 +1,76 @@
+## Using aws-sdk-go with Minio
+
+aws-sdk-go is the official AWS SDK for the Go programming language. This document covers
+how to use aws-sdk-go with Minio server.
+
+### Install AWS SDK S3 service
+
+```sh
+$ go get github.com/aws/aws-sdk-go/service/s3
+```
+
+### List all buckets on Minio
+
+```go
+package main
+
+import (
+	"fmt"
+
+	"github.com/aws/aws-sdk-go/aws"
+	"github.com/aws/aws-sdk-go/aws/credentials"
+	"github.com/aws/aws-sdk-go/aws/session"
+	"github.com/aws/aws-sdk-go/service/s3"
+)
+
+func main() {
+	newSession := session.New()
+	s3Config := &aws.Config{
+		Credentials: credentials.NewStaticCredentials("<YOUR-ACCESS-KEY-ID>", "<YOUR-SECRET-ACCESS-KEY", ""),
+		Endpoint:         aws.String("http://localhost:9000"),
+		Region:           aws.String("us-east-1"),
+		DisableSSL:       aws.Bool(true),
+		S3ForcePathStyle: aws.Bool(true),
+	}
+	// Create an S3 service object in the default region.
+	s3Client := s3.New(newSession, s3Config)
+
+	cparams := &s3.CreateBucketInput{
+		Bucket: aws.String("newbucket"), // Required
+	}
+	_, err := s3Client.CreateBucket(cparams)
+	if err != nil {
+		// Message from an error.
+		fmt.Println(err.Error())
+		return
+	}
+
+	var lparams *s3.ListBucketsInput
+	// Call the ListBuckets() Operation
+	resp, err := s3Client.ListBuckets(lparams)
+	if err != nil {
+		// Message from an error.
+		fmt.Println(err.Error())
+		return
+	}
+
+	// Pretty-print the response data.
+	fmt.Println(resp)
+}
+```
+
+Populate your AccessKeyId and SecretAccessKey credentials and run the program as shown below.
+
+```sh
+$ go run aws-sdk-minio.go
+{
+  Buckets: [{
+      CreationDate: 2015-10-22 01:46:04 +0000 UTC,
+      Name: "newbucket"
+    }],
+  Owner: {
+    DisplayName: "minio",
+    ID: "minio"
+  }
+}
+```
@@ -0,0 +1,27 @@
+## Setting up Proxy using Caddy.
+
+Please download [Caddy Server](https://caddyserver.com/download)
+
+Create a caddy configuration file as below, change the ip addresses according to your local
+minio and DNS configuration.
+
+```bash
+$ ./minio --address localhost:9000 server <your_export_dir>
+```
+
+```bash
+your.public.com {
+    proxy / localhost:9000 {
+        proxy_header Host {host}
+        proxy_header X-Real-IP {remote}
+        proxy_header X-Forwarded-Proto {scheme}
+    }
+}
+```
+
+```bash
+$ ./caddy
+Activating privacy features... done.
+your.public.com:443
+your.public.com:80
+```
@@ -0,0 +1,28 @@
+### Run Minio docker image
+
+## Test Minio Docker Container
+Minio generates new access and secret keys each time you run this command. Container state is lost after you end this session. This mode is only intended for testing purpose.
+```bash
+docker run -p 9000:9000 minio/minio /export
+```
+
+## Run Minio Docker Container
+Minio container requires a persistent volume to store configuration and application data. Following command maps local persistent directories from the host OS to virtual config `~/.minio` and export `/export` directories. 
+
+```bash
+docker run -p 9000:9000 --name minio1 \
+  -v /mnt/export/minio1:/export \
+  -v /mnt/config/minio1:/root/.minio \
+  minio/minio /export
+```
+
+## Custom Access and Secret Keys
+To override Minio's auto-generated keys, you may pass secret and access keys explicitly as environment variables. Minio server also allows regular strings as access and secret keys.
+```bash
+docker run -p 9000:9000 --name minio1 \
+  -e "MINIO_ACCESS_KEY=AKIAIOSFODNN7EXAMPLE" \
+  -e "MINIO_SECRET_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" \
+  -v /mnt/export/minio1:/export \
+  -v /mnt/config/minio1:/root/.minio \
+  minio/minio /export
+```
@@ -0,0 +1,84 @@
+## Ubuntu (Kylin) 14.04
+### Build Dependencies
+This installation document assumes Ubuntu 14.04+ on x86-64 platform.
+
+##### Install Git, GCC
+```sh
+$ sudo apt-get install git build-essential
+```
+
+##### Install Go 1.6+
+
+Download Go 1.6+ from [https://golang.org/dl/](https://golang.org/dl/).
+
+```sh
+$ wget https://storage.googleapis.com/golang/go1.6.linux-amd64.tar.gz
+$ mkdir -p ${HOME}/bin/
+$ mkdir -p ${HOME}/go/
+$ tar -C ${HOME}/bin/ -xzf go1.6.linux-amd64.tar.gz
+```
+##### Setup GOROOT and GOPATH
+
+Add the following exports to your ``~/.bashrc``. Environment variable GOROOT specifies the location of your golang binaries
+and GOPATH specifies the location of your project workspace.
+
+```sh
+export GOROOT=${HOME}/bin/go
+export GOPATH=${HOME}/go
+export PATH=${HOME}/bin/go/bin:${GOPATH}/bin:$PATH
+```
+##### Source the new enviornment
+
+```sh
+$ source ~/.bashrc
+```
+
+##### Testing it all
+
+```sh
+$ go env
+```
+
+## OS X (Yosemite) 10.10
+### Build Dependencies
+This installation document assumes OS X Yosemite 10.10+ on x86-64 platform.
+
+##### Install brew
+```sh
+$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
+```
+
+##### Install Git, Python
+```sh
+$ brew install git python
+```
+
+##### Install Go 1.6+
+
+Install golang binaries using `brew`
+
+```sh
+$ brew install go
+$ mkdir -p $HOME/go
+```
+
+##### Setup GOROOT and GOPATH
+
+Add the following exports to your ``~/.bash_profile``. Environment variable GOROOT specifies the location of your golang binaries
+and GOPATH specifies the location of your project workspace.
+
+```sh
+export GOPATH=${HOME}/go
+export GOVERSION=$(brew list go | head -n 1 | cut -d '/' -f 6)
+export GOROOT=$(brew --prefix)/Cellar/go/${GOVERSION}/libexec
+export PATH=${GOPATH}/bin:$PATH
+```
+##### Source the new enviornment
+```sh
+$ source ~/.bash_profile
+```
+##### Testing it all
+
+```sh
+$ go env
+```
@@ -0,0 +1,44 @@
+Minio protects data against hardware failures and silent data corruption using erasure code and checksums. You may lose roughly half the number ((N/2)-1) of drives and still be able to recover the data.
+
+## 1. Prerequisites:
+Install Minio - [Minio Quickstart Guide](https://docs.minio.io/docs/minio)
+
+## What is Erasure Code?
+Erasure code is a mathematical algorithm to reconstruct missing or corrupted data. Minio uses Reed-Solomon code to shard objects into N/2 data and N/2 parity blocks. This means that in a 12 drive setup, an object is sharded across as 6 data and 6 parity blocks. You can lose as many as 5 drives (be it parity or data) and still reconstruct the data reliably from the remaining drives. 
+
+## Why is Erasure Code useful?
+Erasure code protects data from multiple drives failure unlike RAID or replication. Minio encodes each object individually with a high parity count. Storage servers once deployed should not require drive replacement or healing for the lifetime of the server. Minio's erasure coded backend is designed for operational efficiency and takes full advantage of hardware acceleration whenever available.
+
+[![Screenshot](https://www.filepicker.io/api/file/hbaiKmmR9Fg3NZ1yEb8A)](https://docs.minio.io/)
+
+## What is Bit Rot protection?
+Bit Rot also known as Data Rot or Silent Data Corruption is a serious data loss issue faced by disk drives today. Data on the drive may silently get corrupted without signalling an error has occurred. This makes Bit Rot more dangerous than permanent hard drive failure. 
+
+Minio's erasure coded backend uses high speed [BLAKE2](https://blog.minio.io/accelerating-blake2b-by-4x-using-simd-in-go-assembly-33ef16c8a56b#.jrp1fdwer) hash based checksums to protect against Bit Rot.  
+
+## Deployment Scenarios
+Minio server runs on a variety of hardware, operating systems and virtual/container environments. 
+
+Minio erasure code backend is limited by design to a minimum of 6 drives and a maximum of 16 drives. The hard limit of 16 drives comes from operational experience. Failure domain becomes too large beyond 16 drives. If you need to scale beyond 16 drives, you may run multiple instances of Minio server on different ports. 
+
+#### Reference Physical Hardware: 
+* [SMC 5018A-AR12L (Intel Atom)](http://www.supermicro.com/products/system/1U/5018/SSG-5018A-AR12L.cfm?parts=SHOW) - SMC 1U SoC Atom C2750 platform with 12x 3.5” drive bays
+* [Quanta Grid D51B-2U (OCP Compliant) ](http://www.qct.io/Product/Servers/Rackmount-Servers/2U/QuantaGrid-D51B-2U-p256c77c70c83c118)- Quanta 2U DP E5-2600v3 platform with 12x 3.5” drive bays
+* [Cisco UCS C240 M4 Rack Server](http://www.cisco.com/c/en/us/products/servers-unified-computing/ucs-c240-m4-rack-server/index.html) - Cisco 2U DP E5-2600v3 platform with 12x 3.5” drive bays
+* [Intel® Server System R2312WTTYSR](http://ark.intel.com/products/88286) - Intel 2U DP E5-2600v3 platform with 12x 3.5” drive bays
+
+#### Reference Cloud Hosting Providers:
+* [Packet](https://www.packet.net): Packet is the baremetal cloud provider.
+* [Digital Ocean](https://www.digitalocean.com): Deploy an SSD cloud server in 55 seconds.
+* [OVH](https://www.ovh.com/us): Build your own infrastructure with OVH public cloud.
+* [Onlinetech](http://www.onlinetech.com): Secure, compliant enterprise cloud.
+* [SSD Nodes](https://www.ssdnodes.com): Simple, high performance cloud provider with truly personalized support.
+
+## 2. Run Minio Server with Erasure Code.
+Example: Start Minio server in a 12 drives setup.
+```
+$ minio server /mnt/export1/backend /mnt/export2/backend /mnt/export3/backend /mnt/export4/backend /mnt/export5/backend /mnt/export6/backend /mnt/export7/backend /mnt/export8/backend /mnt/export9/backend /mnt/export10/backend /mnt/export11/backend /mnt/export12/backend
+```
+
+## 3. Test your setup
+You may unplug drives randomly and continue to perform I/O on the system.