diff --git a/README.md b/README.md index e9e8149..10be90d 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,20 @@ Wrapper to simplify backups with borgbackup ----- # Auto Installation -Copy `config.example` to `config` -Edit `config with your settings` -Edit `systemd timer` files if you want to change backup timing - -Run `./install` from borgwrapper directory - +Copy `config.example` to `config` +Edit `config with your settings` +Edit `systemd timer` files if you want to change backup timing Follow instructions under Manual Installation to set up prerequisits for database dumps. +Run `./install` from borgwrapper directory + +This will install borgwrapper and create a basic setup using one config file. +From there you can modify as you want. +* Create additional config files in `/etc/borgwrapper/` +* Change systemd timer file(s) +* Edit the log rotation +* Other + ----- # Manual Installation @@ -22,9 +28,9 @@ Put the [script](src/borgwrapper) somewhere practical chmod 750 /usr/local/bin/borgwrapper ## Configuration -By default borgwrapper expects the configuration to be located at `/etc/borgwrapper/config`. -An example configuration file is included in [config.example](src/config.example). -Ensure restrictive permissions on this file as it exposes the passphrase. +By default borgwrapper expects the configuration to be located at `/etc/borgwrapper/config`. +An example configuration file is included in [config.example](src/config.example). +Ensure restrictive permissions on this file as it exposes the passphrase. chown root. config chmod 600 config @@ -33,10 +39,10 @@ To be able to dump special files there are a few things that need to be done. ### Installed package list Must have the package **apt-mark** installed. ### MySql Dump -Must have the package **mysqldump** installed. -Must have `.my.cnf` configuration file in `/root` directory. +Must have the package **mysqldump** installed. +Must have `.my.cnf` configuration file in `/root` directory. -Create `.my.cnf` in `/root` directory: +Create `.my.cnf` in `/root` directory: [mysql] user="root"