Update README
This commit is contained in:
parent
e84295ad59
commit
162c35769c
17
README.md
17
README.md
@ -2,3 +2,20 @@
|
|||||||
|
|
||||||
Small NixOS module to do backups to my NAS.
|
Small NixOS module to do backups to my NAS.
|
||||||
|
|
||||||
|
## Usage example
|
||||||
|
|
||||||
|
```nix
|
||||||
|
# Example uses sops to store repo password
|
||||||
|
sops.secrets."backup_helper_secret" = { };
|
||||||
|
backup-helper = {
|
||||||
|
enable = true;
|
||||||
|
password-file = "/run/secrets/backup_helper_secret";
|
||||||
|
# Dirs to backup
|
||||||
|
backup-dirs = [
|
||||||
|
"/var/lib/important-data"
|
||||||
|
"/home/user/stuff"
|
||||||
|
];
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
See [this](https://git.t-juice.club/torjus/backup-helper/src/commit/e84295ad5951fe3eb97113a94c16fbed412734e5/backup.nix#L42-L71) for all options and defaults.
|
||||||
|
Loading…
Reference in New Issue
Block a user