Skip to content

Commit 9f0c8d3

Browse files
committed
update README.md
1 parent fbc3ffd commit 9f0c8d3

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ make deploy
6060

6161
## One Time Setup
6262

63+
### Background Event Listening
64+
6365
zfs-file-history can listen to zpool events to automatically update the UI when things change in the background.
6466
Unfortunately, due to the current design of ZFS, this requires root privileges.
6567
To avoid having to run zfs-file-history as root, a one-time setup command can be run as root, which creates
@@ -69,6 +71,16 @@ a suders rule that lets your user run `zpool events` as root without requiring i
6971
sudo zfs-file-history setup
7072
```
7173

74+
### Permissions
75+
76+
To create or destroy ZFS snapshots, the user running zfs-file-history needs to have the appropriate permissions, f.ex.:
77+
78+
```shell
79+
sudo zfs allow markus mount,snapshot,destroy rpool/HOME/default/markus
80+
```
81+
82+
otherwise zfs-file-history will show a permission error.
83+
7284
## Configuration
7385

7486
> **Note:**
@@ -90,16 +102,6 @@ nano ~/.config/zfs-file-history/zfs-file-history.yaml
90102
An example configuration file including more detailed documentation can be found
91103
in [zfs-file-history.yaml](/zfs-file-history.yaml).
92104

93-
## Permissions
94-
95-
To create or destroy ZFS snapshots, the user running zfs-file-history needs to have the appropriate permissions, f.ex.:
96-
97-
```shell
98-
sudo zfs allow markus mount,snapshot,destroy rpool/HOME/default/markus
99-
```
100-
101-
otherwise zfs-file-history will show a permission error.
102-
103105
# Dependencies
104106

105107
See [go.mod](go.mod)

0 commit comments

Comments
 (0)