wonder-people / erls3 Goto Github PK

erls3: an erlang wrapper for Amazon's S3 storage service
--------------------------------------------------------

Initial Author:  Andrew Birkett <[email protected]>
Author : Eric Cestari <[email protected]> http://www.cestari.info/ http://twitter.com/cstar
Version: 0.3
Date:    2009/03/02

What is it?
-----------

Amazon's S3 storage service is a "pay as you go" service for storing
files.  You can use it to serve web content, backup your files, etc.

This erls3erl library provides easy access to S3 for erlang applications.

More info at: http://www.amazon.com/b?node=16427261

Intent
-------
Do not use it to upload multiple Gb files. Everything is moved around in memory.
However it should behave pretty well under high load with moderately sized packets.

Requirements
------------

- OTP-R12B (released on 2007/12/05). 

- An Amazon Web Services account - see http://www.amazonaws.com

- optionally : merle and ketama for caching
    merle is available here : http://github.com/cstar/merle/tree/master
    libketama is available here : http://www.audioscrobbler.net/development/ketama/
    
= BUILDING =

./rebar compile
./rebar install

= Configuration = 

You'll need to set your credentials to Amazon SDB :
- by passing them as OTP application parameters or
- by setting the AMAZON_ACCESS_KEY_ID and AMAZON_SECRET_ACCESS_KEY environment variable (recommended)

= TODO = 
- support ACL configuration
- Improve error handling
- Support for EU-based S3 buckets
- Support for streaming objects to/from disk (should be easy with ibrowse)
- Usage will probably show some bugs and their ugly faces.

Version History
---------------
v0.5 - 2009/03/09
  - automatic retries in case of (always transient) failures
  - get_objects : fetching objets from S3 in parallel
  - bugfixes (thanks magog)
  - implemented memcached caching with merle and ketama (get this version : http://github.com/cstar/merle/tree/master)
  
v0.4 - 2009/03/02
  - added support for HEAD
  - Content-MD5 is implemented
  - x-amz-meta-* headers can be added.
  - implemented a simple POST policy file encoding.

v0.3 - 2009/03/02

  - imported into github
  - OTP'fied the code
  - http calls are now asynchronous
  - SSL supported
 

v0.2 - 2007/12/29

  - Fix timezone bug in Date: header

v0.1 - 2007/12/07

  - First release, "works for me" (tm)
  - Bucket operations: list, create, delete
  - Object operations: read, write, list, delete

 Missing features:


License
-------

Released under the GNU General Public License v2.

Feedback
--------

Thanks for using github for patches.

From Eric to Andy
------------------
Thanks for the code mate !