Linux/obackup
1
0
Fork 0
mirror of https://github.com/deajan/obackup.git synced 2025-01-12 23:23:53 +01:00
Code Issues Releases Wiki Activity

Renewed install info

Browse Source
This commit is contained in:
deajan 2016-08-06 13:45:41 +02:00
parent 200b0a8685
commit 759621c045
1 changed files with 12 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,12 +1,11 @@
obackup obackup
======= =======
A small robust file & database backup script for local to local or remote to local backups via ssh. A robust file & database backup script that works for local and remote push or pull backups via ssh.
Works especially well for multiple virtualhost backups with 'backup divide task' functionnality.
## About ## About
OBackup is designed from ground to make the backup process as reliable as possible. obackup is designed 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. 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 in list is processed. If a task doesn't finish in time, it's stopped and the next task in list is processed.
Before a task gets stopped, a first warning message is generated telling the task takes too long. Before a task gets stopped, a first warning message is generated telling the task takes too long.
@ -14,22 +13,19 @@ Every action gets logged, and if a warning has been generated, a task gets stopp
Remote backups are initiated from the backup server instead of the production server, so hacked servers won't get ssh access to the backup server. Remote backups are initiated from the backup server instead of the production server, so hacked servers won't get ssh access to the backup server.
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 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. It will do several checks before launching a backup like execution checks, dryruns, checking backup size and available local disk space.
Obackup can execute local and remote commands before and after backup execution, obackup can execute local and remote commands before and after backup execution,
thus providing an easy way to handle snapshots (see https://github.com/deajan/zsnap for a zfs snapshot management script). thus providing an easy way to handle snapshots (see https://github.com/deajan/zsnap for a zfs snapshot management script).
It may also rotate backups for you. 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. As of today, obackup has been tested successfully on RHEL / CentOS 5, 6 and 7, Debian 6 and 7, Linux Mint 14 and 17, FreeBSD 8.3 and 10.3.
Currently, Obackup also runs on FreeBSD and Windows MSYS environment, altough it is not fully tested yet. Currently, obackup also runs on MacOSX and Windows MSYS environment.
Feel free to drop me a mail for limited support in my free time.
## Warning ## Warning
Starting with Obackup 1.84RC4, the default behavior is modified.
Obackup now follows symlinks and treats them as the referent files / dirs, following symlinks even outside the backup root, which IMHO is more secure in terms of backups. Obackup now follows symlinks and treats them as the referent files / dirs, following symlinks even outside the backup root, which IMHO is more secure in terms of backups.
You may disable this behavior in the config file. You may disable this behavior in the config file.
@ -38,10 +34,11 @@ You may disable this behavior in the config file.
You can download the latest obackup script from authors website. You can download the latest obackup script from authors website.
You may also clone the following git which will maybe have some more recent builds. You may also clone the following git which will maybe have some more recent builds.
$ git clone git://github.com/deajan/obackup.git $ git clone -b "v2.0" git://github.com/deajan/obackup.git
$ chmod +x ./obackup.sh $ cd obackup
$ ./install.sh
Obackup needs to run with bash shell, using any other shell will most probably fail. obackup needs to run with bash shell, using any other shell will most probably fail.
Once you have grabbed a copy, just edit the config file with your favorite text editor to setup your environment and you're ready to run. Once you have grabbed a copy, just edit the config file with your favorite text editor to setup your environment and you're ready to run.
A detailled documentation can be found on the author's site. A detailled documentation can be found on the author's site.
You can run multiple instances of obackup scripts with different backup environments. Just create another configuration file, You can run multiple instances of obackup scripts with different backup environments. Just create another configuration file,
@ -75,7 +72,7 @@ You may mix "--silent" and "--verbose" parameters to output verbose input only i
## Final words ## Final words
Backup tasks aren't always reliable, connectivity loss, insufficient disk space, hacked servers with tons of unusefull stuff to backup... Anything can happen. Backup tasks aren't always reliable, connectivity loss, insufficient disk space, hacked servers with tons of unusefull stuff to backup... Anything can happen.
Obackup will sent your a warning email for every issue it can handle. obackup will sent your a warning email for every issue it can handle.
Nevertheless, you should assure yourself that your backup tasks will get done the way you meant it. Also, a backup isn't valuable until you're sure Nevertheless, you should assure yourself that your backup tasks will get done the way you meant it. Also, a backup isn't valuable until you're sure
you can successfully restore. Try to restore your backups to check whether everything is okay. Backups will keep file permissions and owners, you can successfully restore. Try to restore your backups to check whether everything is okay. Backups will keep file permissions and owners,
but may loose ACLs if destination file system won't handle them. but may loose ACLs if destination file system won't handle them.
@ -83,7 +80,4 @@ but may loose ACLs if destination file system won't handle them.
## Author ## Author
Feel free to mail me for limited support in my free time :) Feel free to mail me for limited support in my free time :)
Orsiris "Ozy" de Jong | ozy@netpower.fr Orsiris de Jong | ozy@netpower.fr