Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/7compass/s3-mysql-backup
https://github.com/7compass/s3-mysql-backup
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/7compass/s3-mysql-backup
- Owner: 7compass
- Created: 2013-04-07T17:40:13.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-05-18T13:28:54.000Z (over 7 years ago)
- Last Synced: 2024-07-27T18:54:19.936Z (4 months ago)
- Language: Ruby
- Size: 31.3 KB
- Stars: 45
- Watchers: 3
- Forks: 23
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# S3 MySQL Backup
Simple backup of a MySQL database to Amazon S3,
with email notification via SMTP.
## What does it do?
It makes a gzipped and timestamped local backup of the specified
database using mysqldump. The local backup is then copied to
Amazon S3, and the results are emailed to the specified recipient.
Local and S3 backups are retained at this schedule:
- keep 30 days complete
- keep 90 days weekly beyond that
- keep only monthly after that
The email summary is a short email like:
From: [email protected]
To: [email protected]
Date: 2012-12-22
Subject: sql backup: my_database_name: 42.0 MB
my_database_name.20121222.170134.sql.gz
## Configuration
Configure with a YAML file:
```yaml
# backup_dir where to store the local backups, default is ~/s3_mysql_backups
backup_dir: ~/s3_mysql_backups
# remote_dir OPTIONAL, where to store the remote backups, default is the root of your s3_bucket
remote_dir: /path/to/remote/backups
# s3_access_key_id your Amazon S3 access_key_id
# s3_secret_access_key your Amazon S3 secret_access_key
# s3_bucket your Amazon S3 bucket for the backups
# s3_server OPTIONAL, your non-Amazon S3-compatible server
# s3_region: us-west-2 OPTIONAL, your aws region when not using the default
s3_access_key_id: my-key
s3_secret_access_key: my-secret
s3_bucket: my-bucket
# dump_host OPTIONAL, your mysql host name
# dump_user the database user for mysqldump
# dump_pass the password for the dump user
dump_user: my-user
dump_pass: my-pass
# mail_to where to send the backup summary email
mail_to: [email protected]
# Mail credentials
mail_user: [email protected]
mail_pass: example_password
mail_from: [email protected] # OPTIONAL, defaults to mail_user
mail_domain: smtp.example.com # OPTIONAL, defaults to: smtp.gmail.com
mail_port: 587 # OPTIONAL, defaults to: 587
mail_authentication: login # OPTIONAL, defaults to: :login
mail_start_tls: true # OPTIONAL, defaults to: true
```
## Installation
gem install s3-mysql-backup
## Usage
From Ruby:
S3MysqlBackup.new("database_name", "/path/to/s3-mysql-backup-config.yml").run
or
S3MysqlBackup.new("database_name", { hash: of_options }).run
From command line:
s3-mysql-backup database_name /path/to/s3-mysql-backup-config.yml
If you're using bundler:
cd /path/to/my/app && bundle exec s3-mysql-backup database_name /path/to/s3-mysql-backup-config.yml
## Todo
Write tests
## Changelog
- 2014-03-24 2.1.1 Bugfix for deleting old backups not happening
- 2013-10-13 2.1.0 Allow other mail hosts, allow Hash config at runtime (https://github.com/7compass/s3-mysql-backup/pull/7)
- 2013-06-01 1.2.2 Bugfix for passwords with spaces
- 2013-06-01 1.2.1 Added mysql host option (github.com/sagrimson)
- 2013-05-30 1.1.0 Added support for S3-compatible services, e.g. DreamObjects (thanks to John N. Milner - github.com/jnm)
## Credits
2008+ Seventh Compass