s3proxy/README.md

S3Proxy
=======
S3Proxy allows applications using the
[S3 API](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services)
to access other storage backends,
e.g., local file system, Google Cloud Storage, Microsoft Azure, OpenStack Swift.

Installation
------------
Users can [download releases](https://github.com/andrewgaul/s3proxy/releases)
from GitHub.  Developers can build the project by running `mvn package` which
produces a binary at `target/s3proxy`.  S3Proxy requires Java 7 to run.

Usage
-----
Configure S3Proxy via a properties file.  An example using the local
file system as the storage backend with anonymous access:

```
s3proxy.authorization=none
s3proxy.endpoint=http://127.0.0.1:8080
jclouds.provider=filesystem
jclouds.filesystem.basedir=/tmp/s3proxy
```

First create the filesystem basedir:

```
mkdir /tmp/s3proxy
```

Next run S3Proxy.  Linux and Mac OS X users can run the executable jar:

```
chmod +x s3proxy
s3proxy --properties s3proxy.conf
```

Windows users must explicitly invoke java:

```
java -jar s3proxy --properties s3proxy.conf
```

Finally test by creating a bucket then listing all the buckets:

```
$ curl --request PUT http://localhost:8080/testbucket

$ curl http://localhost:8080/
<?xml version="1.0" ?><ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Owner><ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID><DisplayName>CustomersName@amazon.com</DisplayName></Owner><Buckets><Bucket><Name>testbucket</Name><CreationDate>2015-08-05T22:16:24.000Z</CreationDate></Bucket></Buckets></ListAllMyBucketsResult>
```

See the wiki for [examples of other storage backends](https://github.com/andrewgaul/s3proxy/wiki).

Supported storage backends
--------------------------
* atmos
* aws-s3
* azureblob
* b2
* filesystem (on-disk storage)
* google-cloud-storage
* openstack-swift
* rackspace-cloudfiles-uk and rackspace-cloudfiles-us
* s3
* transient (in-memory storage)

Limitations
-----------

S3Proxy has broad compatibility with the S3 API, however, it does not support:

* ACLs other than private and public-read
* BitTorrent hosting
* bucket logging
* cross-origin resource sharing, see [#142](https://github.com/andrewgaul/s3proxy/issues/142)
* POST upload policies, see [#73](https://github.com/andrewgaul/s3proxy/issues/73)
* object server-side encryption
* object versioning, see [#74](https://github.com/andrewgaul/s3proxy/issues/74)
* requester pays buckets

S3Proxy emulates the following operations:

* copy multi-part objects, see [#76](https://github.com/andrewgaul/s3proxy/issues/76)

The wiki collects
[compatability notes](https://github.com/andrewgaul/s3proxy/wiki/Storage-backend-compatibility)
for specific storage backends.

References
----------

* Apache [jclouds](http://jclouds.apache.org/) provides storage backend support for S3Proxy
* Ceph [s3-tests](https://github.com/ceph/s3-tests) help maintain and improve compatibility with the S3 API
* [fake-s3](https://github.com/jubos/fake-s3), [gofakes3](https://github.com/johannesboyne/gofakes3), [S3 ninja](https://github.com/scireum/s3ninja), and [s3rver](https://github.com/jamhall/s3rver) provide functionality similar to S3Proxy when using the filesystem backend
* [GlacierProxy](https://github.com/bouncestorage/glacier-proxy) and [SwiftProxy](https://github.com/bouncestorage/swiftproxy) provide similar functionality for the Amazon Glacier and OpenStack Swift APIs
* [s3proxydocker](https://github.com/ritazh/s3proxydocker) packages S3Proxy as a Docker container
* [sbt-s3](https://github.com/localytics/sbt-s3) run S3Proxy via the Scala Build Tool
* [swift3](https://github.com/openstack/swift3) provides an S3 middleware for OpenStack Swift

License
-------
Copyright (C) 2014-2016 Andrew Gaul

Licensed under the Apache License, Version 2.0
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00			`S3Proxy`
			`=======`
Update README 2014-08-18 07:17:48 +00:00			`S3Proxy allows applications using the`
			`[S3 API](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services)`
Rewrite summary and rework features Users should assume these features work; instead document the limitations. 2015-11-11 01:12:16 +00:00			`to access other storage backends,`
			`e.g., local file system, Google Cloud Storage, Microsoft Azure, OpenStack Swift.`
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00
			`Installation`
			`------------`
Add more features and limitations to README Also use more accurate links for upstream issues. 2014-08-12 08:30:17 +00:00			`Users can [download releases](https://github.com/andrewgaul/s3proxy/releases)`
Consistently refer to storage backends 2015-12-17 19:03:22 +00:00			from GitHub. Developers can build the project by running `mvn package` which
Add more features and limitations to README Also use more accurate links for upstream issues. 2014-08-12 08:30:17 +00:00			produces a binary at `target/s3proxy`. S3Proxy requires Java 7 to run.
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00
Simplify usage and add curl example Link to wiki for more complicated examples. 2015-11-17 00:14:38 +00:00			`Usage`
			`-----`
			`Configure S3Proxy via a properties file. An example using the local`
			`file system as the storage backend with anonymous access:`
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00
			```
Add more features and limitations to README Also use more accurate links for upstream issues. 2014-08-12 08:30:17 +00:00			`s3proxy.authorization=none`
			`s3proxy.endpoint=http://127.0.0.1:8080`
			`jclouds.provider=filesystem`
Simplify usage and add curl example Link to wiki for more complicated examples. 2015-11-17 00:14:38 +00:00			`jclouds.filesystem.basedir=/tmp/s3proxy`
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00			```

Simplify usage and add curl example Link to wiki for more complicated examples. 2015-11-17 00:14:38 +00:00			`First create the filesystem basedir:`
Add support for listening on HTTPS Fixes #3. 2014-07-26 20:19:43 +00:00
			```
Simplify usage and add curl example Link to wiki for more complicated examples. 2015-11-17 00:14:38 +00:00			`mkdir /tmp/s3proxy`
Add support for listening on HTTPS Fixes #3. 2014-07-26 20:19:43 +00:00			```

Simplify usage and add curl example Link to wiki for more complicated examples. 2015-11-17 00:14:38 +00:00			`Next run S3Proxy. Linux and Mac OS X users can run the executable jar:`
breakup the line for readability 2015-05-09 01:13:44 +00:00
			```
Simplify usage and add curl example Link to wiki for more complicated examples. 2015-11-17 00:14:38 +00:00			`chmod +x s3proxy`
			`s3proxy --properties s3proxy.conf`
breakup the line for readability 2015-05-09 01:13:44 +00:00			```

Simplify usage and add curl example Link to wiki for more complicated examples. 2015-11-17 00:14:38 +00:00			`Windows users must explicitly invoke java:`
add a blurb about SSL setup 2015-05-09 01:12:26 +00:00
			```
Simplify usage and add curl example Link to wiki for more complicated examples. 2015-11-17 00:14:38 +00:00			`java -jar s3proxy --properties s3proxy.conf`
			```

			`Finally test by creating a bucket then listing all the buckets:`

			```
			`$ curl --request PUT http://localhost:8080/testbucket`

			`$ curl http://localhost:8080/`
			`<?xml version="1.0" ?><ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Owner><ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID><DisplayName>CustomersName@amazon.com</DisplayName></Owner><Buckets><Bucket><Name>testbucket</Name><CreationDate>2015-08-05T22:16:24.000Z</CreationDate></Bucket></Buckets></ListAllMyBucketsResult>`
add a blurb about SSL setup 2015-05-09 01:12:26 +00:00			```

Consistently refer to storage backends 2015-12-17 19:03:22 +00:00			`See the wiki for [examples of other storage backends](https://github.com/andrewgaul/s3proxy/wiki).`
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00
Rewrite summary and rework features Users should assume these features work; instead document the limitations. 2015-11-11 01:12:16 +00:00			`Supported storage backends`
			`--------------------------`
			`* atmos`
			`* aws-s3`
			`* azureblob`
Update README for 1.5.0 release 2015-04-09 01:29:41 +00:00			`* b2`
Rewrite summary and rework features Users should assume these features work; instead document the limitations. 2015-11-11 01:12:16 +00:00			`* filesystem (on-disk storage)`
			`* google-cloud-storage`
			`* openstack-swift`
			`* rackspace-cloudfiles-uk and rackspace-cloudfiles-us`
			`* s3`
			`* transient (in-memory storage)`

Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00			`Limitations`
			`-----------`

Reword limitations 2016-02-05 08:19:44 +00:00			`S3Proxy has broad compatibility with the S3 API, however, it does not support:`
Update limitations 2016-01-21 20:13:01 +00:00
			`* ACLs other than private and public-read`
Add more limitations Also update wiki link. 2016-01-08 23:30:56 +00:00			`* BitTorrent hosting`
			`* bucket logging`
Add CORS to limitations 2016-06-22 18:58:16 +00:00			`* cross-origin resource sharing, see [#142](https://github.com/andrewgaul/s3proxy/issues/142)`
Update README for 1.5.0 release 2015-04-09 01:29:41 +00:00			`* POST upload policies, see [#73](https://github.com/andrewgaul/s3proxy/issues/73)`
Add references to fake-s3 and abustany s3proxy 2014-08-28 18:41:56 +00:00			`* object server-side encryption`
Add issue links to limitations 2015-08-03 00:11:31 +00:00			`* object versioning, see [#74](https://github.com/andrewgaul/s3proxy/issues/74)`
Add more limitations Also update wiki link. 2016-01-08 23:30:56 +00:00			`* requester pays buckets`
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00
Rewrite summary and rework features Users should assume these features work; instead document the limitations. 2015-11-11 01:12:16 +00:00			`S3Proxy emulates the following operations:`

Update README for 1.5.0 release 2015-04-09 01:29:41 +00:00			`* copy multi-part objects, see [#76](https://github.com/andrewgaul/s3proxy/issues/76)`
Rewrite summary and rework features Users should assume these features work; instead document the limitations. 2015-11-11 01:12:16 +00:00
Update limitations 2016-01-21 20:13:01 +00:00			`The wiki collects`
			`[compatability notes](https://github.com/andrewgaul/s3proxy/wiki/Storage-backend-compatibility)`
			`for specific storage backends.`
Add compatibility notes 2015-11-17 01:45:50 +00:00
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00			`References`
			`----------`
Format references with bullet points 2015-05-13 18:44:49 +00:00
Consistently refer to storage backends 2015-12-17 19:03:22 +00:00			`* Apache [jclouds](http://jclouds.apache.org/) provides storage backend support for S3Proxy`
Format references with bullet points 2015-05-13 18:44:49 +00:00			`* Ceph [s3-tests](https://github.com/ceph/s3-tests) help maintain and improve compatibility with the S3 API`
Add gofakes3 to references 2016-03-01 17:51:12 +00:00			`* [fake-s3](https://github.com/jubos/fake-s3), [gofakes3](https://github.com/johannesboyne/gofakes3), [S3 ninja](https://github.com/scireum/s3ninja), and [s3rver](https://github.com/jamhall/s3rver) provide functionality similar to S3Proxy when using the filesystem backend`
Simplify usage and add curl example Link to wiki for more complicated examples. 2015-11-17 00:14:38 +00:00			`* [GlacierProxy](https://github.com/bouncestorage/glacier-proxy) and [SwiftProxy](https://github.com/bouncestorage/swiftproxy) provide similar functionality for the Amazon Glacier and OpenStack Swift APIs`
Add s3proxydocker to references Fixes #103. 2015-12-10 23:30:55 +00:00			`* [s3proxydocker](https://github.com/ritazh/s3proxydocker) packages S3Proxy as a Docker container`
Add sbt-s3 to references 2016-02-05 08:14:06 +00:00			`* [sbt-s3](https://github.com/localytics/sbt-s3) run S3Proxy via the Scala Build Tool`
Add swift3 to references 2015-12-09 07:51:21 +00:00			`* [swift3](https://github.com/openstack/swift3) provides an S3 middleware for OpenStack Swift`
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00
			`License`
			`-------`
Update copyright year to 2016 2016-01-10 05:14:59 +00:00			`Copyright (C) 2014-2016 Andrew Gaul`
Initial commit of S3Proxy 2014-07-22 03:25:31 +00:00
			`Licensed under the Apache License, Version 2.0`