torjus/backup-helper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Torjus Håkestad
2024-10-04 01:26:07 +02:00
parent ba823b8961
commit ed4a13b9de
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -2,3 +2,20 @@
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.