# SquashR

Manage backups based on SquashFS, OverlayFS and LUKS

## Installation

1. Clone this repository
2.  

```bash
make
sudo make install
```
3. Adjust default config in `/etc/squashr.conf` or copy it to a custom directory.

## Usage

```
Usage: squashr [OPTIONS] <COMMAND>

Commands:
  backup    
  minimize  
  new       
  mount     
  umount    
  delete    
  help      Print this message or the help of the given subcommand(s)

Options:
  -c, --config <CONFIG>
          
      --squashr-root <SQUASHR_ROOT>
          
      --squashr-n-snapshots-min <SQUASHR_N_SNAPSHOTS_MIN>
          
      --squashr-n-snapshots-max <SQUASHR_N_SNAPSHOTS_MAX>
          
      --squashr-include <SQUASHR_INCLUDE>
          
      --squashr-exclude <SQUASHR_EXCLUDE>
          
      --squashr-truncate <SQUASHR_TRUNCATE>
          
      --squashr-compression-enable <SQUASHR_COMPRESSION_ENABLE>
          [possible values: true, false]
      --squashr-compression-algo <SQUASHR_COMPRESSION_ALGO>
          
      --squashr-compression-args <SQUASHR_COMPRESSION_ARGS>
          
      --squashr-cryptsetup-enable <SQUASHR_CRYPTSETUP_ENABLE>
          [possible values: true, false]
      --squashr-cryptsetup-create-args <SQUASHR_CRYPTSETUP_CREATE_ARGS>
          
      --squashr-cryptsetup-open-args <SQUASHR_CRYPTSETUP_OPEN_ARGS>
          
  -h, --help
          Print help
  -V, --version
          Print version
```

## References

- [SquashFS](https://docs.kernel.org/filesystems/squashfs.html)
- [OverlayFS](https://docs.kernel.org/filesystems/overlayfs.html)
- [dm-crypt](https://docs.kernel.org/admin-guide/device-mapper/dm-crypt.html)