minio-go travis-ci

Minio Go Library for Amazon S3 compatible cloud storage

Minio Golang Library for Amazon S3 Compatible Cloud Storage Gitter

The Minio Golang Client SDK provides simple APIs to access any Amazon S3 compatible object storage server.

Supported cloud storage providers:

  • AWS Signature Version 4

    • Amazon S3
    • Minio
  • AWS Signature Version 2

    • Google Cloud Storage (Compatibility Mode)
    • Openstack Swift + Swift3 middleware
    • Ceph Object Gateway
    • Riak CS

This quickstart guide will show you how to install the Minio client SDK, connect to Minio, and provide a walkthrough of a simple file uploader. For a complete list of APIs and examples, please take a look at the Golang Client API Reference.

This document assumes that you have a working Golang setup.

Download from Github


$ go get -u github.com/minio/minio-go

Initialize Minio Client

You need four items to connect to Minio object storage server.

Parameter Description
endpoint URL to object storage service.
accessKeyID Access key is the user ID that uniquely identifies your account.
secretAccessKey Secret key is the password to your account.
secure Set this value to 'true' to enable secure (HTTPS) access.

package main

import (
    "github.com/minio/minio-go"
    "log"
)

func main() {
    endpoint := "play.minio.io:9000"
    accessKeyID := "Q3AM3UQ867SPQQA43P2F"
    secretAccessKey := "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
    useSSL := true

    // Initialize minio client object.
    minioClient, err := minio.New(endpoint, accessKeyID, secretAccessKey, useSSL)
    if err != nil {
        log.Fatalln(err)
    }

    log.Println("%v", minioClient) // minioClient is now setup

Quick Start Example - File Uploader

This example program connects to an object storage server, makes a bucket on the server and then uploads a file to the bucket.

We will use the Minio server running at https://play.minio.io:9000 in this example. Feel free to use this service for testing and development. Access credentials shown in this example are open to the public.

FileUploader.go

package main

import (
    "github.com/minio/minio-go"
    "log"
)

func main() {
    endpoint := "play.minio.io:9000"
    accessKeyID := "Q3AM3UQ867SPQQA43P2F"
    secretAccessKey := "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
    useSSL := true

    // Initialize minio client object.
    minioClient, err := minio.New(endpoint, accessKeyID, secretAccessKey, useSSL)
    if err != nil {
        log.Fatalln(err)
    }

    // Make a new bucked called mymusic.
    bucketName := "mymusic"
    location := "us-east-1"

    err = minioClient.MakeBucket(bucketName, location)
    if err != nil {
        // Check to see if we already own this bucket (which happens if you run this twice)
        exists, err := minioClient.BucketExists(bucketName)
        if err == nil && exists {
            log.Printf("We already own %s\n", bucketName)
        } else {
            log.Fatalln(err)
        }
    }
    log.Printf("Successfully created %s\n", bucketName)

    // Upload the zip file
    objectName := "golden-oldies.zip"
    filePath := "/tmp/golden-oldies.zip"
    contentType := "application/zip"

    // Upload the zip file with FPutObject
    n, err := minioClient.FPutObject(bucketName, objectName, filePath, contentType)
    if err != nil {
        log.Fatalln(err)
    }

    log.Printf("Successfully uploaded %s of size %d\n", objectName, n)
}

Run FileUploader


$ go run file-uploader.go
2016/08/13 17:03:28 Successfully created mymusic 
2016/08/13 17:03:40 Successfully uploaded golden-oldies.zip of size 16253413

$ mc ls play/mymusic/
[2016-05-27 16:02:16 PDT]  17MiB golden-oldies.zip

API Reference

The full API Reference is available here.

API Reference : Bucket Operations

API Reference : Bucket policy Operations

API Reference : Bucket notification Operations

API Reference : File Object Operations

API Reference : Object Operations

API Reference : Presigned Operations

Full Examples

Full Examples : Bucket Operations

Full Examples : Bucket policy Operations

Full Examples : Bucket notification Operations

Full Examples : File Object Operations

Full Examples : Object Operations

Full Examples : Presigned Operations

Explore Further

Contribute

Contributors Guide

Build Status Build status

Related Repositories

minio

minio

Minio is an open source object storage server compatible with Amazon S3 APIs ...

awesome-go-storage

awesome-go-storage

A curated list of awesome Go storage projects and libraries ...

minio

minio

Minio Object Storage in Kubernetes, used by Deis Workflow. ...

awesome-minio

awesome-minio

A curated list of Minio community projects. ...

awesome-go

awesome-go

A curated list of awesome Go frameworks, libraries and software ...


Top Contributors

harshavardhana abperiasamy vadmeste krishnasrinivas koolhead17 hackintoshrao awwalker mkash32 fkautz balamurugana ckemper67 krisis donatello GarimaKapoor minio-trusted ptrimble nl5887 ajayk fd0 deekoder ericychoi fwessels JamesClonk dudymas justinclift breml nkatsaros montoias shatrugna Kane-Sendgrid

Releases

-   v2.0.2 zip tar
-   v2.0.1 zip tar
-   v2.0.0 zip tar
-   v1.0.0 zip tar
-   v0.2.5 zip tar
-   v0.2.4 zip tar
-   v0.2.3 zip tar
-   v0.2.2 zip tar
-   v0.2.1 zip tar
-   v0.2.0 zip tar
-   v0.1.0 zip tar