BackMeUp

BackMeUp is an automated MySQL databases and files backup solution on Linux Machines using Amazon S3, Dropbox and Owncloud as remote storage.

  ____             _    __  __      _    _       
 |  _ \           | |  |  \/  |    | |  | |      
 | |_) | __ _  ___| | _| \  / | ___| |  | |_ __  
 |  _ < / _, |/ __| |/ / |\/| |/ _ \ |  | | '_ \ 
 | |_) | (_| | (__|   <| |  | |  __/ |__| | |_) |
 |____/ \__,_|\___|_|\_\_|  |_|\___|\____/| .__/ 
                                          | |    
                                          |_|

Why?

I'm managing my own server, and I wanted to have a simple and easy tool to backup my database and all VirtualHost files, and to save them into a remote server with cronjob.

What This Script Does

This script does some simple tasks:

The script dumps all of your MySQL databases individually.
The script backs up all of your Web files (e.g: root of all of your virtual hosts).
The script compresses your web-root and databases to a single archive.
The script uploads the compressed archive into a folder in your Dropbox account, Amazon S3 bucket or Owncloud Server.
If the method is set to dropbox, The script makes sure that you always have the newest Dropbox-Uploader script.
After the upload, the script cleans up the temporary files (dumps, the archive itself).

You may easily add this script to your crontab, and just forget about it 😄

Requirements

curl - To download the Dropbox-uploader script and to upload the backup to Dropbox or to Owncloud.
mysql (cli) - To list databases.
mysqldump - To dump databases (in most cases, it comes with mysql cli).
aws-cli must be installed and configured if the method is set as s3.

Don't Have a Dropbox Account?

Don't worry :)

Just click on this link to start Dropbox with a bonus space. With my referral, we both earn bonus space.

Installation

Run these commands first:

curl -s https://raw.githubusercontent.com/Ardakilic/backmeup/master/backmeup.sh -o backmeup.sh
curl -s https://raw.githubusercontent.com/Ardakilic/backmeup/master/.backmeuprc -o ~/.backmeuprc
chmod 600 ~/.backmeuprc

Now, edit the configuration values as stated here.

Make the files secure, executable and only accessible by your root user and group (or the user you'd like the script to run):

chown root:root backmeup.sh #or any user and group who will run the script or with cron
chown root:root ~/.backmeuprc #or any user and group who will run the script manually or with cron
chmod 400 ~/.backmeuprc #Only readable by owner, and is read-only. To make it writable, change to 600 on demand
chmod +x backmeup.sh

(Suggested) Copy or move the script into one of the PATHs as stated here.

Configuration Values

After downloading the script, before running, you must edit your configuration values found in ~/.backmeuprc:

TIMEZONE="Europe/Istanbul" #Your timezone, for a better timestamp in archived filenames
DBHOST="localhost" #MySQL Hostname
DBUSER="root" #MySQL user that can dump all databases
DBPASSWORD="" #MySQL password
DBPORT="3306" #MySQL Port Number
FILESROOT="/var/www" #root of your (virtual) hosting files, E.g: For apache, it is /var/www, for nginx, it's /usr/share/nginx/html "WITHOUT THE END TRAILING SLASH"
BASEFOLDER="/tmp" #Temporary folder to create database dump folder (a subfolder will be created to this folder upon dumping)
BACKUPFOLDER="backmeup" #your backup folder that'll be created on Backup provider
METHOD="dropbox" #Method name, can be "dropbox", "s3" or "owncloud". More providers soon
S3_BUCKET_NAME="my-aws-bucket" #AWS S3 Bucket name
S3_STORAGE_CLASS="STANDARD_IA" #AWS S3 storage class. Values are "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA". http://docs.aws.amazon.com/cli/latest/reference/s3/cp.html
OWNCLOUD_USER="admin" #Owncloud user for WebDAV Access
OWNCLOUD_PASSWORD="password" #Owncloud Password for WebDAV Access
OWNCLOUD_WEBDAV_ENDPOINT="https://owncloud-host.com/remote.php/webdav/" #Owncloud WebDAV Host, you can get this endpoint from the low end "cog" Settings icon from your OwnCloud WebUI, This has to have the end / character

On-the-fly Configuration

You can set various configuration values on the fly. Here are some full featured examples:

backmeup -tz "Europe/Istanbul" -dbh localhost -dbu root -dbpass "rootpass" -dbp 3306 -f "/usr/share/nginx/html" -b "/tmp" -bf=my_backups -m s3 -s3bn my-aws-bucket -ocdu "owncloud-user" -ocdp "owncloud-password" -ocdwebdav "https://owncloud-host.com/remote.php/webdav/"

Or like this:

backmeup --timezone="Europe/Istanbul" --database-host="localhost" --database-user="root" --database-password="rootpass" --database-port="3306" --files-root="/usr/share/nginx/html" --base-folder="/tmp" --backup-folder=my-remote-backup-folder -owncloud-user="owncloud-user" --owncloud-password="owncloud-password" --owncloud-webdav="https://owncloud-host.com/remote.php/webdav/"

None of these are mandatory, you can just use any of these however you want, and even mix together!

Usage

Execute the configured script:

./backmeup.sh #or backmeup directly if it's in your PATH.

If this is the first attempt to running and method is set to dropbox, Dropbox-Uploader will ask for an APP key and secret. You should create an application, provide these values and click on provided authorization link (Don't worry, the Dropbox-uploader has a nice wizard which guides you, can't be easier). After you've authorized, re-run the script using ./backmeup.sh
If everything went well, in a couple of minutes, you should see your database and files copied into the remote server.

Important Notice

This script saves MySQL password (any user which can show and dump (all) databases will suffice actually) inside, but it's only accessible by its owner (which is root in examples). In any ways, use it at your own risk. I'm not holding any responsibilities for any damage that this script may do (which shouldn't).

Additional Notes

You can also copy the script to one of your PATHS, such as /usr/local/bin/backmeup and run from there directly. This is suggested

Screenshots

Special Thanks

@andreafabrizi for maintaining the Dropbox-Uploader script.

TODOs

Tests on CentOS, Arch etc.
Mega.nz integration
~~Owncloud Integration~~
~~AWS S3 integration~~
Increased security?
~~Reading configuration from an external file~~
Postgres support
Option to dump only the database(s) or only Virtualhost files
Multiple Virtualhost folder support

Version History

###1.2.0

Owncloud Integration: You can now upload your backup files to your Owncloud server using WebDAV bridge and curl. You can refer to updated .backmeuprc and update if necessary.

###1.1.0

You can now define "Database Host" and "Database Port" parameters, so you may even get dumps from remote services such as Amazon RDS. DBHOST and DBHOST values should be added in .backmeuprc
The version numbers will follow Semantic Versioning from now on.

###1.0.1

External configuration file support. Now you can update backmeup hassle-free! The file's located at: ~/.backmeuprc
Amazon S3 Storage Class Support: Now you can set how the backup will be stored (Normal or Infrequent Access or Reduced Redundancy for lesser storage costs).
An issue with Dropbox-uploader download path is fixed.

###1.0.0

Amazon S3 support (using official aws-cli)
The code is optimised to use in cron
Arguments and options support. You can pass the arguments and options to the script on-the-fly

###0.1.1

Defined PATHs to the script so that it should work better on cron withot needing to define before running.

###0.1.0

Initial Release

License

MIT

Freebase394/backmeup