https://github.com/jliuhtonen/skyhook

A utility written in Ruby for backing up files in Amazon Web Services S3 buckets
https://github.com/jliuhtonen/skyhook

Last synced: 3 months ago
JSON representation

A utility written in Ruby for backing up files in Amazon Web Services S3 buckets

• Host: GitHub
• URL: https://github.com/jliuhtonen/skyhook
• Owner: jliuhtonen
• Created: 2012-05-06T14:52:33.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-05-24T19:31:34.000Z (over 12 years ago)
• Last Synced: 2024-04-15T00:13:35.742Z (9 months ago)
• Language: Ruby
• Size: 141 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
# Skyhook

Skyhook is a command line utility for backing up files in Amazon's S3. 

Directories that are backed up are defined along with other settings in a YAML configuration file.

## Installation

Requirements:

-	Ruby 1.9.x

-	Rubygems

-	Fog gem: `gem install fog`

## Sample configuration yml file

If no specific configuration is defined, skyhook tries to read its configuration from config.yml in ~/.skyhook and finally the same directory where skyhook resides.

	aws_access_key_id: (your AWS access key)

	aws_secret_key_id: (your AWS secret key)

	bucket_name: (name for the bucket to back up to)

	region: (AWS region, e.g. us-east-1)

	multipart_chunk_size: 5242880 #Upload chunk size for large files, 5MB

	compress: true		#compress backups with gzip? (true/false)

	backup:

      -

         path: /Users/janne/git

      - 

         path: /Users/janne/important

         excludes: 

           - '^foo(.*)' 							#file names starting with "foo"

           - '(.+)\.o$'								#file names ending with ".o"

           - '/Users/janne/important/not-important' #a directory

## Usage

	GLaDOS:skyhook janne$ ./skyhook 

	Usage: skyhook.rb [options]

    	-r, --recover PATH               Recover backed up file or directory

    	-b, --backup [CONFIGFILE]        Make backups (optionally using a specific config, config.yml by default)

    	-v, --[no-]verbose               Verbose output

## Logging

Skyhook writes its log to ~/.skyhook/logs/skyhook.log and rotates the logfile each day you run backups.

## License

Licensed under MIT license:

Copyright (c) 2012 Janne Liuhtonen

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

"Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be included

in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.