danvics/selfhostblocks
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

zfs: fix doc

Browse source
This commit is contained in:
ibizaman 2026-04-27 23:09:23 +02:00 committed by Pierre Penninckx
parent d830a92342
commit d4776dc2b8
2 changed files with 45 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/redirects.json
View file

@ -1922,6 +1922,12 @@
"blocks-zfs-usage": [
"blocks-zfs.html#blocks-zfs-usage"
],
"blocks-zfs-usage-backup-dataset": [
"blocks-zfs.html#blocks-zfs-usage-backup-dataset"
],
"blocks-zfs-usage-backup-files": [
"blocks-zfs.html#blocks-zfs-usage-backup-files"
],
"build-time-validation": [
"service-implementation-guide.html#build-time-validation"
],

39
modules/blocks/zfs/docs/default.md
View file

@ -54,6 +54,45 @@ shb.zfs.pools.root.datasets."syncthing" = {
};
```
### Backup dataset {#blocks-zfs-usage-backup-dataset}
To backup the dataset directly, use the [dataset backup contract](contracts-datasetbackup.html).
For example, with the sanoid module as the dataset backup contract provider:
```nix
{
shb.zfs.pools.root.datasets.home = {
path = "/home";
};
shb.sanoid.backup."root/home" = {
request = shb.zfs.pools.root.datasets.home.datasetBackup.request;
template = "yearly";
};
}
```
See the [Sanoid block](blocks-sanoid.html) for more examples.
### Backup files {#blocks-zfs-usage-backup-files}
To backup the files in the dataset, use the [file backup contract](contracts-backup.html).
For example, with the restic module as the file backup contract provider:
```nix
{
shb.zfs.pools.root.datasets.home = {
path = "/home";
};
shb.restic.instances."myservice" = {
request = shb.zfs.pools.root.datasets.home.backup.request;
};
}
```
See the [Restic block](blocks-restic.html) for more examples.
## Options Reference {#blocks-zfs-options}
```{=include=} options