Contents

[![Build Status](https://secure.travis-ci.org/intuit/heirloom.png)](http://travis-ci.org/intuit/heirloom)

Heirloom
========

The goal of Heirloom is to securely and easily transport data to cloud hosted applciations.

Heirloom creates archives from directories. Their archives are versioned and hosted in geographic distributed locations. Heirloom tracks metadata about those archives, both about the archive locations, as well as arbitrary tags which can be set by an engineer or process. It supports encryption and authorization to allow for securely transporting sensitive data over cloud storage services.

Prerequisites
-------------

* Ruby version 1.9.2 or higher installed.
* AWS account access key and secret key.

Installation
------------

Install the gem

```
gem install heirloom --no-ri --no-rdoc
```

To get started copy the sample below into ~/.heirloom.yml and update the specified fields.

```
aws:
  access_key: UPDATE_ME
  secret_key: UPDATE_ME
  metadata_region: us-west-1
```

Proxy Support
-------------

Heirloom supports accessing AWS API endpoint throught a proxy.  This can be set via the http_proxy and https_proxy variables.

```
export http_proxy=http://1.2.3.4:80
export http_proxys=http://1.2.3.4:80
```

Documentation
-------------

For more information, please view the [Heirloom Wiki](https://github.com/intuit/heirloom/wiki).

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
heirloom-0.9.0	README.md
heirloom-0.8.3	README.md
heirloom-0.8.2	README.md