kopia lustrzana https://github.com/gaul/s3proxy
125 wiersze
3.8 KiB
Markdown
125 wiersze
3.8 KiB
Markdown
S3Proxy
|
|
=======
|
|
S3Proxy allows applications using the
|
|
[S3 API](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services)
|
|
to access other object stores,
|
|
e.g., EMC Atmos, Google Cloud Storage, Microsoft Azure, OpenStack Swift.
|
|
It also allows local testing of S3 without the cost or latency associated with
|
|
using AWS.
|
|
Finally users can extend S3Proxy with custom middlewares, e.g., caching,
|
|
encryption, tiering.
|
|
|
|
Features
|
|
--------
|
|
* create, remove, and list buckets (including user-specified regions)
|
|
* put, get, delete, and list objects
|
|
* multi-part uploads (emulated operation, see [#2](https://github.com/andrewgaul/s3proxy/issues/2))
|
|
* copy objects (emulated operation, see [#46](https://github.com/andrewgaul/s3proxy/issues/46))
|
|
* delete multiple objects
|
|
* store and retrieve object metadata, including user metadata
|
|
* set and get canned bucket and object ACLs (private and public-read only)
|
|
* authorization via AWS signature v2 (including pre-signed URLs) or anonymous access
|
|
* listen on HTTP or HTTPS
|
|
|
|
Supported object stores:
|
|
|
|
* atmos
|
|
* aws-s3
|
|
* azureblob
|
|
* filesystem (on-disk storage)
|
|
* google-cloud-storage
|
|
* hpcloud-objectstorage
|
|
* openstack-swift
|
|
* rackspace-cloudfiles-uk and rackspace-cloudfiles-us
|
|
* s3
|
|
* swift and swift-keystone (legacy)
|
|
* transient (in-memory storage)
|
|
|
|
Installation
|
|
------------
|
|
Users can [download releases](https://github.com/andrewgaul/s3proxy/releases)
|
|
from GitHub. One can also build the project by running `mvn package` which
|
|
produces a binary at `target/s3proxy`. S3Proxy requires Java 7 to run.
|
|
|
|
Examples
|
|
--------
|
|
Linux and Mac OS X users can run S3Proxy via the executable jar:
|
|
|
|
```
|
|
chmod +x s3proxy
|
|
s3proxy --properties s3proxy.conf
|
|
```
|
|
|
|
Windows users must explicitly invoke java:
|
|
|
|
```
|
|
java -jar s3proxy --properties s3proxy.conf
|
|
```
|
|
|
|
Users can configure S3Proxy via a properties file. An example using Rackspace
|
|
CloudFiles (based on OpenStack Swift) as the backing store:
|
|
|
|
```
|
|
s3proxy.endpoint=http://127.0.0.1:8080
|
|
s3proxy.authorization=aws-v2
|
|
s3proxy.identity=local-identity
|
|
s3proxy.credential=local-credential
|
|
jclouds.provider=rackspace-cloudfiles-us
|
|
jclouds.identity=remote-identity
|
|
jclouds.credential=remote-credential
|
|
```
|
|
|
|
Another example using the local file system as the backing store with anonymous
|
|
access:
|
|
|
|
```
|
|
s3proxy.authorization=none
|
|
s3proxy.endpoint=http://127.0.0.1:8080
|
|
jclouds.provider=filesystem
|
|
jclouds.identity=identity
|
|
jclouds.credential=credential
|
|
jclouds.filesystem.basedir=/tmp
|
|
```
|
|
|
|
S3Proxy can listen on HTTPS by setting the endpoint and
|
|
[configuring a keystore](http://wiki.eclipse.org/Jetty/Howto/Configure_SSL#Generating_Keys_and_Certificates_with_JDK_keytool).
|
|
An example:
|
|
|
|
```
|
|
s3proxy.endpoint=https://127.0.0.1:8080
|
|
s3proxy.keystore-path=keystore.jks
|
|
s3proxy.keystore-password=password
|
|
```
|
|
|
|
Users can also set other Java,
|
|
[jclouds](https://github.com/jclouds/jclouds/blob/master/core/src/main/java/org/jclouds/Constants.java),
|
|
and [S3Proxy](https://github.com/andrewgaul/s3proxy/blob/master/src/main/java/org/gaul/s3proxy/S3ProxyConstants.java)
|
|
properties.
|
|
|
|
Limitations
|
|
-----------
|
|
S3Proxy does not support:
|
|
|
|
* POST uploads
|
|
* object metadata with filesystem provider on Mac OS X ([OpenJDK issue](https://bugs.openjdk.java.net/browse/JDK-8030048))
|
|
* object server-side encryption
|
|
* object versioning
|
|
* XML ACLs
|
|
|
|
References
|
|
----------
|
|
Apache [jclouds](http://jclouds.apache.org/) provides object store 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) provides functionality similar to
|
|
S3Proxy when using the filesystem provider.
|
|
Another project named [s3proxy](https://github.com/abustany/s3proxy) provides
|
|
HTTP access to non-S3-aware applications.
|
|
|
|
License
|
|
-------
|
|
Copyright (C) 2014-2015 Andrew Gaul
|
|
|
|
Licensed under the Apache License, Version 2.0
|