S3Proxy
=======
[](https://github.com/gaul/s3proxy/releases/)
[](https://hub.docker.com/r/andrewgaul/s3proxy/)
[](https://search.maven.org/#search%7Cga%7C1%7Ca%3A%22s3proxy%22)
[](https://twitter.com/S3Proxy)
S3Proxy implements the
[S3 API](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services)
and *proxies* requests, enabling several use cases:
* translation from S3 to Backblaze B2, Google Cloud, Microsoft Azure, or OpenStack Swift
* testing without Amazon by using the local filesystem
* extension via middlewares
* embedding into Java applications
Usage with Docker
-----------------
[Docker Hub](https://hub.docker.com/r/andrewgaul/s3proxy/) hosts a Docker image
and has instructions on how to run it.
Usage without Docker
--------------------
Users can [download releases](https://github.com/gaul/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.
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/
75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06aCustomersName@amazon.comtestbucket2015-08-05T22:16:24.000Z
```
Usage with Java
---------------
Maven Central hosts S3Proxy artifacts and the wiki has
[instructions on Java use](https://github.com/gaul/s3proxy/wiki/Using-S3Proxy-in-Java-projects).
Supported storage backends
--------------------------
* atmos
* aws-s3 (Amazon-only)
* azureblob
* b2
* filesystem (on-disk storage)
* google-cloud-storage
* openstack-swift
* rackspace-cloudfiles-uk and rackspace-cloudfiles-us
* s3 (all implementations)
* transient (in-memory storage)
See the wiki for [examples of configurations](https://github.com/gaul/s3proxy/wiki/Storage-backend-examples).
Middlewares
-----------
S3Proxy can modify its behavior based on middlewares:
* [eventual consistency modeling](https://github.com/gaul/s3proxy/wiki/Middleware---eventual-consistency)
* [large object mocking](https://github.com/gaul/s3proxy/wiki/Middleware-large-object-mocking)
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/gaul/s3proxy/issues/142)
* hosting static websites
* POST upload policies, see [#73](https://github.com/gaul/s3proxy/issues/73)
* list objects v2, see [#168](https://github.com/gaul/s3proxy/issues/168)
* object server-side encryption
* object tagging
* object versioning, see [#74](https://github.com/gaul/s3proxy/issues/74)
* requester pays buckets
* storage classes, see [#234](https://github.com/gaul/s3proxy/issues/234)
S3Proxy emulates the following operations:
* copy multi-part objects, see [#76](https://github.com/gaul/s3proxy/issues/76)
The wiki collects
[compatability notes](https://github.com/gaul/s3proxy/wiki/Storage-backend-compatibility)
for specific storage backends.
Support
-------
[GitHub issues](https://github.com/gaul/s3proxy/issues) provide community
support. Andrew Gaul provides commercial support via .
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), [s3rver](https://github.com/jamhall/s3rver), and [Scality S3 Server](https://s3.scality.com/) 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
* [minio](https://github.com/minio/minio) provides functionality similar to S3Proxy when using the filesystem and Azure storage backends
* [s3mock](https://github.com/findify/s3mock) mocks the S3 API for Java/Scala projects
* [sbt-s3](https://github.com/localytics/sbt-s3) runs S3Proxy via the Scala Build Tool
* [swift3](https://github.com/openstack/swift3) provides an S3 middleware for OpenStack Swift
License
-------
Copyright (C) 2014-2017 Andrew Gaul
Licensed under the Apache License, Version 2.0