Skip to content

Commit

Permalink
Version 0.1: Prepare for publishing
Browse files Browse the repository at this point in the history
Update the readme with how to get started, and
make package.json presentable.
  • Loading branch information
pmanijak committed Jul 13, 2014
1 parent 1f0d5ee commit 96c0a75
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,41 @@
couch-to-s3
===========
Backup your CouchDB database files to Amazon's S3 service.

npm install couch-to-s3

Usage
-----------
Install the module, and edit the config.json file:

{
"dbUrl": "http://localhost:5984",
"dbName": "the name of your database",
"s3BucketName": "your S3 bucket",
"awsCredentialsPath": ".aws/credentials"
}

Then from the prompt:

npm start

This will save your local `database-name.couch` file to your S3 bucket, as `database-name-backup.couch`.

AWS credentials
-------
As this is an early version of couch-to-s3, it doesn't support many configuration options. Right now, you'll need to create an AWS credentials file, like so:

[default]
aws_access_key_id = <access-key>
aws_secret_access_key = <secret-access-key>

Setting up S3
--------
Setting up Amazon's S3 will be the most complicated part of running this script, and might take around 15 minutes if you're not familiar with the process. Amazon's walkthrough is here: [http://docs.aws.amazon.com/AmazonS3/latest/dev/example-walkthroughs-managing-access-example1.html](http://docs.aws.amazon.com/AmazonS3/latest/dev/example-walkthroughs-managing-access-example1.html)

### Turn on S3 versioning
Turning on versioning in your S3 bucket is recommended, as couch-to-s3 writes to the same file each time.

License
-------
BSD.
6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
{
"name": "couch-to-s3",
"version": "0.1.0",
"description": "Backup your CouchDB database files to Amazon's S3 service.",
"keywords": ["couch", "couchdb", "aws", "s3", "backup"],
"license": "BSD-2-Clause",
"author": {
"name": "Phil Manijak",
"email": "npm@exclsr.com"
},
"repository": {
"type": "git",
"url": "https://github.com/exclsr/couch-to-s3.git"
Expand Down

0 comments on commit 96c0a75

Please sign in to comment.