Linux
/
obackup
mirror of https://github.com/deajan/obackup.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update documentation files

This commit is contained in:
deajan 2013-06-15 14:55:50 +02:00
parent bce13a8392
commit 8a91749731
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
DOCUMENTATION.txt Normal file
View File

@ -0,0 +1 @@
## Documentation is being worked on... really... !

5
README.md
View File

@ -36,9 +36,12 @@ You may also clone this git which will maybe have some more recent build.
$ chmod +x ./obackup.sh
Once you have grabbed a copy of Obackup, 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 in the DOCUMENTATION.md file.
You can run multiple instances of obackup scripts with different backup environments. Just create another configuration file, edit it's environment and you're ready to run concurrently.
Performing remote backups requires you to create RSA private / public key pair. Please see documentation for further information.
Performing mysql backups requires to create a mysql user with SELECT rights on all databases. Please see documentation for further information.
Performing backup with SUDO_EXEC option requires to configure sudoers file to allow some commands without password. Keep in mind that running backup as superuser might be a security risk. You should generally prefer a read only enabled user. Please see documentation for further information.
## Usage
MariaDB / MySQL backups are consistent because dumps are done with the --single-transaction option.