bryan
/
borgwrapper
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add to README.md

master
Bryan 2020-11-08 12:46:13 -06:00
parent 18274ea63a
commit 01aaafddda
1 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -4,14 +4,20 @@ Wrapper to simplify backups with borgbackup
----- -----
# Auto Installation # Auto Installation
Copy `config.example` to `config` Copy `config.example` to `config`
Edit `config with your settings` Edit `config with your settings`
Edit `systemd timer` files if you want to change backup timing Edit `systemd timer` files if you want to change backup timing
Run `./install` from borgwrapper directory
Follow instructions under Manual Installation to set up prerequisits for database dumps. 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 # Manual Installation
@ -22,9 +28,9 @@ Put the [script](src/borgwrapper) somewhere practical
chmod 750 /usr/local/bin/borgwrapper chmod 750 /usr/local/bin/borgwrapper
## Configuration ## Configuration
By default borgwrapper expects the configuration to be located at `/etc/borgwrapper/config`. 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). An example configuration file is included in [config.example](src/config.example).
Ensure restrictive permissions on this file as it exposes the passphrase. Ensure restrictive permissions on this file as it exposes the passphrase.
chown root. config chown root. config
chmod 600 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 ### Installed package list
Must have the package **apt-mark** installed. Must have the package **apt-mark** installed.
### MySql Dump ### MySql Dump
Must have the package **mysqldump** installed. Must have the package **mysqldump** installed.
Must have `.my.cnf` configuration file in `/root` directory. Must have `.my.cnf` configuration file in `/root` directory.
Create `.my.cnf` in `/root` directory: Create `.my.cnf` in `/root` directory:
[mysql] [mysql]
user="root" user="root"