add readme
This commit is contained in:
parent
9556f385a3
commit
a1ab41cdc9
60
README.md
Normal file
60
README.md
Normal file
|
@ -0,0 +1,60 @@
|
|||
# btrbk - btrfs backup and restore script
|
||||
|
||||
This is a bash script I made to create simple, incremental, PGP encrypted backups of your btrfs subvolumes.
|
||||
Rclone is used to support a wide variety of Storage Backends. Encryption is done by the Standard gpg commandline tool.
|
||||
|
||||
## Features
|
||||
|
||||
- Create incremental Backups of btrfs filesystem
|
||||
- Keep local btrfs snapshots
|
||||
- Customizable retention of Backups
|
||||
- PGP encryption
|
||||
- Rclone used for Storage Backend
|
||||
- Full System restore from Live USB
|
||||
|
||||
## Limitations
|
||||
|
||||
- Snapshots can't be restored on the fly from Remote Storage
|
||||
- PGP encryption is not optional
|
||||
- No implementation of possible Features when Remote Storage is also a btrfs
|
||||
- Backup retention settings have limited options of freedom
|
||||
- Might interfere with [digint/btrbk]
|
||||
- Testing is needed to verify reliabilty
|
||||
- I don't recommend anyone to use this
|
||||
|
||||
## Installation
|
||||
|
||||
To install the tool just clone this Repository and run the `install.sh` script.
|
||||
```sh
|
||||
git clone https://git.bsd.gay/snaki/btrbk.git
|
||||
cd btrbk
|
||||
./install.sh
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Configuration is done in `/etc/btrbk.conf`
|
||||
Documentaion for all variables you have to set is availabe in that file.
|
||||
|
||||
## Usage
|
||||
|
||||
Get help with `btrbk --help`
|
||||
```
|
||||
Usage: btrbk [options]
|
||||
A script to automatically or manually backup your btrfs subvolumes.
|
||||
options:
|
||||
-b, --backup runs backup manually if not already run today
|
||||
-f, --force force backup to override today's backup
|
||||
--date=YYYY-MM-DD define a date from which to restore when using -r
|
||||
--restore=VOLNAME restores the latest snapshot of a given subvolume
|
||||
--full-restore=PATH this walks you through an complete config restore
|
||||
and will restore the whole system to a given directory
|
||||
-h, --help display this help and exit
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
BSD 2-Clause License
|
||||
|
||||
|
||||
[digint/btrbk]: <https://github.com/digint/btrbk>
|
Loading…
Reference in a new issue