From 8a917497311a072321b8f17978a99ece900f61f6 Mon Sep 17 00:00:00 2001 From: deajan Date: Sat, 15 Jun 2013 14:55:50 +0200 Subject: [PATCH] Update documentation files --- DOCUMENTATION.txt | 1 + README.md | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 DOCUMENTATION.txt diff --git a/DOCUMENTATION.txt b/DOCUMENTATION.txt new file mode 100644 index 0000000..3e0e44f --- /dev/null +++ b/DOCUMENTATION.txt @@ -0,0 +1 @@ +## Documentation is being worked on... really... ! diff --git a/README.md b/README.md index 09adc63..f39226f 100644 --- a/README.md +++ b/README.md @@ -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.