diff --git a/BUILDDEPS.md b/BUILDDEPS.md index 52a92cf31..f3a84a7b5 100644 --- a/BUILDDEPS.md +++ b/BUILDDEPS.md @@ -2,10 +2,9 @@ ### Build Dependencies This installation document assumes Ubuntu 14.04 or later on x86-64 platform. -##### Install Git, GCC and MkDocs +##### Install Git, GCC ```sh -$ sudo apt-get install git build-essential python-pip -$ sudo pip install mkdocs +$ sudo apt-get install git build-essential ``` ##### Install YASM @@ -53,10 +52,9 @@ This installation document assumes Mac OSX Yosemite 10.10 or later on x86-64 pla $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" ``` -##### Install Git, Python and MkDocs +##### Install Git, Python ```sh $ brew install git python -$ pip install mkdocs ``` ##### Install YASM diff --git a/Dockerfile b/Dockerfile index c48722434..1a6a7be8f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -6,7 +6,7 @@ MAINTAINER Minio Community ENV GOLANG_TARBALL go1.4.2.linux-amd64.tar.gz ENV GOROOT /usr/local/go/ -ENV GOPATH /go-workspace +ENV GOPATH /go-workspace ENV PATH ${GOROOT}/bin:${GOPATH}/bin/:$PATH RUN apt-get update -y && apt-get install -y -q \ @@ -14,24 +14,21 @@ RUN apt-get update -y && apt-get install -y -q \ git \ build-essential \ ca-certificates \ - yasm \ - python-pip + yasm RUN curl -O -s https://storage.googleapis.com/golang/${GOLANG_TARBALL} && \ tar -xzf ${GOLANG_TARBALL} -C ${GOROOT%*go*} && \ - rm ${GOLANG_TARBALL} && \ - pip install mkdocs + rm ${GOLANG_TARBALL} ADD . ${GOPATH}/src/github.com/minio-io/minio RUN cd ${GOPATH}/src/github.com/minio-io/minio && \ make -RUN apt-get remove -y build-essential curl git python-pip && \ +RUN apt-get remove -y build-essential curl git && \ apt-get -y autoremove && \ rm -rf /var/lib/apt/lists/* EXPOSE 9000 9001 CMD ["sh", "-c", "${GOPATH}/bin/minio"] - diff --git a/Makefile b/Makefile index 46e3b6d96..0f6836904 100644 --- a/Makefile +++ b/Makefile @@ -62,9 +62,6 @@ restore: env: @godep go env -docs-deploy: - @mkdocs gh-deploy --clean - clean: @echo "Cleaning up all the generated files:" @rm -fv cover.out diff --git a/NOTICE b/NOTICE index 488c200e7..d731663e0 100644 --- a/NOTICE +++ b/NOTICE @@ -1,5 +1,4 @@ -Minimalist Object Storage -Copyright 2014 Minio, Inc. +Minimalist Object Storage, (C) 2014,2015 Minio, Inc. This product includes software developed at Minio, Inc. (http://minio.io/). diff --git a/README.md b/README.md index 95a501411..9cbe26fb7 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,6 @@ Minio's design is inspired by Amazon's S3 for its API and Facebook's Haystack fo * Community hangout on Gitter [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Minio-io/minio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) * 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) -### Documentation -* [Minio Reference](http://minio-io.github.io/minio/) - ### Developers * [Get Source](./CONTRIBUTING.md) * [Build Dependencies](./BUILDDEPS.md) diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 3f55e06f8..000000000 --- a/TODO.md +++ /dev/null @@ -1 +0,0 @@ -- Finish the project \ No newline at end of file diff --git a/docs/architecture.md b/docs/architecture.md deleted file mode 100644 index 6e47ebddc..000000000 --- a/docs/architecture.md +++ /dev/null @@ -1 +0,0 @@ -### Overview diff --git a/docs/contributing.md b/docs/contributing.md deleted file mode 120000 index 44fcc6343..000000000 --- a/docs/contributing.md +++ /dev/null @@ -1 +0,0 @@ -../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/errors.md b/docs/errors.md deleted file mode 100644 index 1c748b0c1..000000000 --- a/docs/errors.md +++ /dev/null @@ -1,63 +0,0 @@ -### List of Error Responses - -This section provides information about Minio API errors. XML and JSON results have been prettified for readability. As a result, the Content-Length may not match exactly for both styles - -#### Error Codes Table - -The following table lists Minio error codes. - -| Error Code | Description | HTTP Status Code | -|:---------- |:----------- |:----------------:| -| AccessDenied | Access Denied | 403 Forbidden | -| BadDigest | The Content-MD5 you specified did not match what we received. | 400 Bad Request | -| BucketAlreadyExists | The requested bucket name is not available. | 409 Conflict | -| EntityTooSmall | Your proposed upload is smaller than the minimum allowed object size. | 400 Bad Request | -| EntityTooLarge | Your proposed upload exceeds the maximum allowed object size. | 400 Bad Request | -| IncompleteBody | You did not provide the number of bytes specified by the Content-Length HTTP header | 400 Bad Request | -| InternalError | We encountered an internal error. Please try again. | 500 Internal Server Error | -| InvalidAccessKeyId | The access key Id you provided does not exist in our records. | 403 Forbidden | -| InvalidBucketName | The specified bucket is not valid. | 400 Bad Request | -| InvalidDigest | The Content-MD5 you specified is not valid. | 400 Bad Request | -| InvalidRange | The requested range cannot be satisfied. | 416 Requested Range Not Satisfiable | -| MalformedXML | The XML you provided was not well-formed or did not validate against our published schema. | 400 Bad Request | -| MissingContentLength | You must provide the Content-Length HTTP header. | 411 Length Required | -| MissingRequestBodyError | Request body is empty. | 400 Bad Request | -| NoSuchBucket | The specified bucket does not exist. | 404 Not Found | -| NoSuchKey | The specified key does not exist. | 404 Not Found | -| NoSuchUpload | The specified multipart upload does not exist | 404 Not Found | -| NotImplemented | A header you provided implies functionality that is not implemented. | 501 Not Implemented | -| RequestTimeTooSkewed | The difference between the request time and the server's time is too large. | 403 Forbidden | -| SignatureDoesNotMatch | The request signature we calculated does not match the signature you provided. | 403 Forbidden | -| TooManyBuckets | You have attempted to create more buckets than allowed. | 400 Bad Request | -| InvalidPolicyDocument | The content of the form does not meet the conditions specified in the policy document. | 400 Bad Request | -| NoSuchBucketPolicy | The specified bucket does not have a bucket policy. | 404 Not Found | -
- -#### REST Error Responses - -When there is an error, the header information contains: - - - Content-Type: application/xml or application/json (Depending on ``Accept`` HTTP header) - - An appropriate 4xx, or 5xx HTTP status code - -The body or the response also contains information about the error. The following sample error response shows the structure of response elements common to all REST error responses. - -``` - - - NoSuchKey - The resource you requested does not exist - /minio-bucket/images.bz2 - ******** - -``` - -The following table explains the REST error response elements - -| Name | Description | -|:---------- |:-----------| -|*Code*| The error code is a string that uniquely identifies an error condition.
*Type: String*
*Ancestor: Error*| -|*Error*| XML container for error.
*Type: Container*
*Ancestor: None*| -|*Message*| The error message contains a generic description of the error condition.
*Type: String*
*Ancestor: Error*| -|*RequestId*| ID of the request associated with the error.
*Type: String*
*Ancestor: Error*| -|*Resource*| The bucket or object for which the error generated.
*Type: String*
*Ancestor: Error*| diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index f882dd503..000000000 --- a/docs/index.md +++ /dev/null @@ -1,11 +0,0 @@ -# Welcome to *MINIO* - -Minio is an open source object storage released under [Apache license v2](http://www.apache.org/licenses/LICENSE-2.0). - -It uses ``Rubberband Erasure`` coding to dynamically protect the data. This documents explains various API operations, related request and response structures, and error codes. - -## Topics - -- [Minio](./architecture.md) -- [Minio API](./minio.md) -- [Error Codes](./errors.md) diff --git a/docs/introduction.md b/docs/introduction.md deleted file mode 100644 index 1d2162a2b..000000000 --- a/docs/introduction.md +++ /dev/null @@ -1,3 +0,0 @@ -### Minio API Reference - -This API reference explains Minio operations, their parameters, responses, and errors. There are separate sections for each API, which include example requests and responses. diff --git a/docs/manage.md b/docs/manage.md deleted file mode 100644 index a506821fa..000000000 --- a/docs/manage.md +++ /dev/null @@ -1,3 +0,0 @@ -### Management API - -#### GET / diff --git a/docs/minio.md b/docs/minio.md deleted file mode 100644 index eef39e481..000000000 --- a/docs/minio.md +++ /dev/null @@ -1,214 +0,0 @@ -### Minio API - -#### General Overview - -Minio stores and retrieves data in a logical format based upon REST based URLs. - -**Note about examples:** - -XML and JSON results have been prettified for readability. As a result, the Content-Length may not match exactly. -``` -Form: -http://minio.example.com/{bucket}/{path:.*} - -Examples: -http://minio.example.com/bucket/object -http://minio.example.com/bucket/path/to/object -http://minio.example.com/bucket2/path/to/object -``` - -#### GET / - -List buckets accessible by the user. - -The default output is XML. JSON output may also be requested by adding the following header: - -``` -Accept: "application/json" -``` - -Example: -``` -GET / HTTP/1.1 -``` -``` -HTTP/1.1 200 OK -Connection: close -Content-Type: application/xml -Server: Minio -Date: Mon, 02 Feb 2015 22:09:00 GMT -Content-Length: 306 - - - - minio - minio - - - - bucket - 2015-01-30T15:20:09.013Z - - - minio - 2015-01-27T17:46:28.264Z - - - -``` - -``` -GET / HTTP/1.1 -Accept: application/json -``` - -``` -HTTP/1.1 200 OK -Connection: close -Content-Type: application/json -Server: Minio -Date: Wed, 04 Feb 2015 21:59:10 GMT -Content-Length: 223 - -{ - "Owner" : { - "ID" : "minio" - "DisplayName" : "minio", - }, - "Buckets" : { - "Bucket" : [ - { - "Name" : "bucket", - "CreationDate" : "2015-01-30T15:20:09.013Z" - }, - { - "Name" : "minio", - "CreationDate" : "2015-02-02T14:52:34.914Z" - } - ] - } -} -``` - -NOTE: ``Accept: application/json`` is Minio Object Server specific - -#### GET /{bucket}/ - -Lists objects in a bucket. - -Example: -``` -GET /minio/ HTTP/1.1 -``` -``` -HTTP/1.1 200 OK -Connection: close -Content-Type: application/xml -Server: Minio -Date: Tue, 03 Feb 2015 00:57:59 GMT -Content-Length: 579 - - - minio - - 1000 - false - - hello - 2015-02-02T14:52:34.914Z - minio#hello - 75 - STANDARD - - minio - minio - - - - one - 2015-01-27T17:46:28.264Z - minio#one - 4096 - STANDARD - - minio - minio - - - -``` - -#### PUT /{bucket}/ - -Example: -``` -PUT /books/ HTTP/1.1 -``` -``` -HTTP/1.1 200 OK -Connection: close -Server: Minio -Date: Mon, 02 Feb 2015 22:05:43 GMT -Content-Length: 0 -Content-Type: text/plain; charset=utf-8 -``` - -EXAMPLE -#### GET /{bucket}/{object} - -``` -GET /minio/hello HTTP/1.1 -``` -``` -HTTP/1.1 200 OK -Connection: close -Content-Length: 75 -Content-Type: text/plain -Etag: minio#hello -Last-Modified: Mon, 02 Feb 2015 14:52:34 PST -Server: Minio -Date: Mon, 02 Feb 2015 22:59:51 GMT - - - - - Hello World! - -``` - -Retrieves an object from a bucket - -#### HEAD /{bucket}/{object} -``` -HEAD /minio/hello HTTP/1.1 -``` -``` -HTTP/1.1 200 OK -Connection: close -Content-Length: 75 -Content-Type: text/plain -Etag: minio#hello -Last-Modified: Mon, 02 Feb 2015 14:52:34 PST -Server: Minio -Date: Mon, 02 Feb 2015 23:02:30 GMT -``` - -Retrieves meta-data about an object - -#### PUT /{bucket}/{object} - -Stores an object - -``` -PUT /minio/hello HTTP/1.1 -Content-Length: 75 - - - - - Hello World! - -``` -``` -HTTP/1.1 200 OK -``` diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index cafd83883..000000000 --- a/mkdocs.yml +++ /dev/null @@ -1,12 +0,0 @@ -site_name: Minio Documentation -copyright: Minio, Inc. -include_search: true -pages: -- ['index.md', Welcome to Minio] -- ['architecture.md', 'Minio', Architecture] -- ['contributing.md', 'Minio', Contribute] -- ['introduction.md', 'API', Reference] -- ['minio.md', 'API', REST API] -- ['errors.md', 'API', Error Responses] -- ['manage.md', 'API', Management API] -theme: readthedocs diff --git a/mkdocs_linux.go b/mkdocs_linux.go deleted file mode 100644 index c93d25d11..000000000 --- a/mkdocs_linux.go +++ /dev/null @@ -1,3 +0,0 @@ -package main - -//go:generate mkdocs build --clean