From 558aa51029736b2b568c4f3aca09d17a147a4e43 Mon Sep 17 00:00:00 2001 From: deajan Date: Wed, 12 Jun 2013 10:55:16 -0700 Subject: [PATCH 1/6] Initial commit --- README.md | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5d1776b --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +obackup +======= + +A local / remote backup script tailored for multiple virtualhost backups. Yet it actually works for a lot of backup tasks. From 79e136f928fbc6ee76537b704198c9ccd1caf6f0 Mon Sep 17 00:00:00 2001 From: deajan Date: Wed, 12 Jun 2013 21:25:25 +0300 Subject: [PATCH 2/6] Update README.md --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d1776b..20bbb86 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ obackup ======= -A local / remote backup script tailored for multiple virtualhost backups. Yet it actually works for a lot of backup tasks. +A local or remote file & database backup script tailored for multiple virtualhost backups. Yet it actually works for a lot of backup tasks. + +OBackup is designed from ground to make the backup process as reliable as possible. +It divides the whole backup process into tasks, allowing each task to execute for a certain amount of time. +If a task doesn't finish in time, it's stopped and the next task is processed. +Before a task gets stopped, a first warning message is generated telling the task takes too long. +Every action gets logged, and at the end of the backup process, if there was a warning, a stopped task or an error an email will be sent. + +Obackup manages to backup MariaDB / MySQL databases and files (with or without root rights). From 938803a188a8a8ed91fc728ee18f4deac2069096 Mon Sep 17 00:00:00 2001 From: deajan Date: Wed, 12 Jun 2013 21:08:07 +0200 Subject: [PATCH 3/6] Update README.md --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20bbb86..ef5698a 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,42 @@ obackup A local or remote file & database backup script tailored for multiple virtualhost backups. Yet it actually works for a lot of backup tasks. +## About + OBackup is designed from ground to make the backup process as reliable as possible. It divides the whole backup process into tasks, allowing each task to execute for a certain amount of time. If a task doesn't finish in time, it's stopped and the next task is processed. Before a task gets stopped, a first warning message is generated telling the task takes too long. -Every action gets logged, and at the end of the backup process, if there was a warning, a stopped task or an error an email will be sent. +Every action gets logged, and at the end of the backup process, if there was a warning, +a stopped task or an error an alert email will be sent. -Obackup manages to backup MariaDB / MySQL databases and files (with or without root rights). +OBackup can enumerate and backup all MariaDB / MySQL databases present on a server. +It can also enumerate all subdirectories of a given path and process them as separate tasks (usefull for multiple vhosts). +It will do several checks before launching a backup like checking backup size and available local disk space. + +Obackup will work well to backup to a snapshot aware filesystem like ZFS or btrfs. +In case you don't work with one of these, it may also rotate backups for you. + +As of today, obackup has been tested successfully on RHEL / CentOS 5, CentOS 6, Debian 6.0.7 and Linux Mint 14 +but it should basically run on any linux flavor. It relies on well known programs like rsync, ssh, mysqldump along +with other great GNU coreutils. + +## Installation + +You can download the latest obackup script from authors website. +You may also clone this git which will maybe have some recent bugfixes. + + $ git clone git://github.com/sickill/bitpocket.git + $ chmod +x ./bin/obackup.sh + +Once you have grabbed a copy of Obackup, just edit it with your favorite text editor to setup your environment +and you're ready to run. + +You can run multiple instances of obackup scripts with different backup environments. Just copy the script to another +filename, edit it's environment and you're ready to run concurrently. + +## Author + +Orsiris "Ozy" de Jong. + + From 16a948098b643aa8956c94c07a61601e6d0a87d4 Mon Sep 17 00:00:00 2001 From: deajan Date: Thu, 13 Jun 2013 08:24:25 +0200 Subject: [PATCH 4/6] fixed some typos. --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ef5698a..e28a252 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,15 @@ Every action gets logged, and at the end of the backup process, if there was a w a stopped task or an error an alert email will be sent. OBackup can enumerate and backup all MariaDB / MySQL databases present on a server. -It can also enumerate all subdirectories of a given path and process them as separate tasks (usefull for multiple vhosts). -It will do several checks before launching a backup like checking backup size and available local disk space. +It can also enumarate all subdirectories of a given path and process them as separate tasks (usefull for multiple vhosts). +It will do several checks before launching a backup like execution checks, dryruns, +checking backup size and available local disk space. Obackup will work well to backup to a snapshot aware filesystem like ZFS or btrfs. In case you don't work with one of these, it may also rotate backups for you. As of today, obackup has been tested successfully on RHEL / CentOS 5, CentOS 6, Debian 6.0.7 and Linux Mint 14 -but it should basically run on any linux flavor. It relies on well known programs like rsync, ssh, mysqldump along +but should basically run on your favorite linux flavor. It relies on well known programs like rsync, ssh, mysqldump along with other great GNU coreutils. ## Installation @@ -28,11 +29,11 @@ with other great GNU coreutils. You can download the latest obackup script from authors website. You may also clone this git which will maybe have some recent bugfixes. - $ git clone git://github.com/sickill/bitpocket.git - $ chmod +x ./bin/obackup.sh + $ git clone git://github.com/deajan/obackup.git + $ chmod +x ./obackup.sh Once you have grabbed a copy of Obackup, just edit it with your favorite text editor to setup your environment -and you're ready to run. +and you're ready to run. A detailled documentation can be found in the CONFIG.TXT file. You can run multiple instances of obackup scripts with different backup environments. Just copy the script to another filename, edit it's environment and you're ready to run concurrently. From 4d14e28ece6c046350348ccb75d3b13234aa2168 Mon Sep 17 00:00:00 2001 From: deajan Date: Thu, 13 Jun 2013 20:14:21 +0300 Subject: [PATCH 5/6] Update README.md --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e28a252..584e73c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ obackup ======= -A local or remote file & database backup script tailored for multiple virtualhost backups. Yet it actually works for a lot of backup tasks. +A file & database backup script tailored for multiple virtualhost backups locally or remotely via ssh. +Yet it actually works for a lot of backup tasks. ## About @@ -12,7 +13,7 @@ Before a task gets stopped, a first warning message is generated telling the tas Every action gets logged, and at the end of the backup process, if there was a warning, a stopped task or an error an alert email will be sent. -OBackup can enumerate and backup all MariaDB / MySQL databases present on a server. +OBackup can enumerate and backup all MariaDB / MySQL databases present on a server It can also enumarate all subdirectories of a given path and process them as separate tasks (usefull for multiple vhosts). It will do several checks before launching a backup like execution checks, dryruns, checking backup size and available local disk space. @@ -38,6 +39,20 @@ and you're ready to run. A detailled documentation can be found in the CONFIG.TX You can run multiple instances of obackup scripts with different backup environments. Just copy the script to another filename, edit it's environment and you're ready to run concurrently. +## Usage + +MariaDB / MySQL backups are consistent because dumps are done with the --single-transaction option. +File backups can be done directly of the data won't change while backing up but a snapshot of the actual data to backup +is preferable as it will stay consistent (LVM, zfs or btrfs snapshots will do fine). + + $ ./obackup.sh TASKNAME --dry + $ ./obackup.sh TASKNAME + + + + + + ## Author Orsiris "Ozy" de Jong. From 6ff27d426031436f725187f6989bd4fb86cd3005 Mon Sep 17 00:00:00 2001 From: deajan Date: Fri, 14 Jun 2013 13:09:56 +0200 Subject: [PATCH 6/6] Initial TODO.list --- TODO.list | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 TODO.list diff --git a/TODO.list b/TODO.list new file mode 100644 index 0000000..de0871c --- /dev/null +++ b/TODO.list @@ -0,0 +1,14 @@ +## Main version 1.82 build 30052013 + +Upcomming features: + +- Check for environment sanity before execution +- Local disk space check triggers an error if backup size is bigger than a given value but should also trigger an alert if space is lower than a given value. + +Bugs not yet addressed: + +- Recursive task creation doesn't include files, it should + +Future plans: + +- Conquest world :)