https://github.com/briangershon/s3backup
A simple folder backup solution to AWS S3.
https://github.com/briangershon/s3backup
Last synced: about 2 months ago
JSON representation
A simple folder backup solution to AWS S3.
- Host: GitHub
- URL: https://github.com/briangershon/s3backup
- Owner: briangershon
- License: mit
- Created: 2015-02-01T22:41:17.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-05-31T04:55:56.000Z (almost 10 years ago)
- Last Synced: 2025-01-12T09:45:04.882Z (4 months ago)
- Language: Ruby
- Size: 215 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
s3backup
========
A simple folder backup solution to AWS S3.
* Central configuration - Job configuration is downloaded from S3 allowing easy
changes from a central location instead of separate config files on each machine.
* S3 Cache - File metadata is cached initially to avoid hitting S3 for each file.
Author: Brian Gershon
License: MIT
Usage
-----
s3backup.rb job backup_job_s3_key aws_bucket aws_profile
Example:
s3backup.rb job laptop_backup_job.yml my-bucket brian
Description
-----------
`aws_bucket` is a string like `my-s3-bucket`
`aws_profile` is a profile name in `~/.aws/credentials`
See [Setting up AWS Credentials](http://docs.aws.amazon.com/AWSSdkDocsRuby/latest/DeveloperGuide/set-up-creds.html)
`backup_job_s3_key` is the name (s3_key) of a YAML file in aws_bucket.
See below for file format.
Job Configuration (YAML file)
-----------------------------
Here is an example `laptop_backup_job.yml` job file:
```
---
backup_base_path: /Volumes
backup_folder: /Volumes/stuff
backup_folder_excludes:
- /Volumes/stuff/Lib/
- /Volumes/stuff/cache/
```
`backup_folder` is the absolute path of the folder you want to backup, recursively.
`backup_base_path` is the part that is stripped off the beginning to determine the S3 key.
If you don't want to strip anything off, you must include just a `/` (forward slash),
you can't leave it blank.
`backup_folder_excludes` is an array of absolute paths to exclude from the backup_folder.
If you don't have any excludes just use this line: `backup_folder_excludes: []`.