Skip to content

Commit dcdc80c

Browse files
committed
update README for v0.0.7
1 parent 586ef08 commit dcdc80c

File tree

7 files changed

+23
-10
lines changed

7 files changed

+23
-10
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ If i messed up a file, i need to search a clean state from the file in the snaps
99
# Description
1010

1111
With `zfs-snap-diff` you can explore file differences and restore changes from older file versions in different zfs snapshots.
12-
You can restore the whole file from a older version, or select changes to revert in the 'Diff' view.
12+
You can restore the whole file from a older version, or select single changes to revert in the 'Diff' view.
1313

1414

1515
`zfs-snap-diff` has a web frontend, so it can run on your local work machine or on your remote file / backup server (no Xserver necesarry).
@@ -46,6 +46,9 @@ The backend is implemented in golang, the frontend with [angularjs](https://angu
4646
* size+modTime: compares per size and modification time (very cheap)
4747
* size: compares per size (very cheap)
4848
* md5: compares per md5 (VERY EXPENSIVE! combine it with '-scan-snap-limit' and use it only for text files!)
49+
* -use-sudo: use sudo when executing os commands
50+
* necessary under linux when running as non root
51+
* adjust sudo rules (see [doc/etc/sudoers.d/zfs-snap-diff](https://github.com/j-keck/zfs-snap-diff/blob/master/doc/etc/sudoers.d/zfs-snap-diff)
4952

5053

5154

@@ -83,7 +86,7 @@ View the file content from an older file version.
8386
![File View](doc/zsd-snap-selected-view-file.png)
8487

8588
#### Diff
86-
Explore file differences and pick changes to revert.
89+
Explore file differences and pick single changes to revert.
8790

8891
![intext diff](doc/zsd-snap-selected-diff-file-intext.png)
8992

@@ -92,9 +95,15 @@ Explore file differences and pick changes to revert.
9295

9396
## Browse snapshot state
9497

98+
### Select a dataset
99+
100+
Select a dataset (sub zfs filesystem).
101+
102+
![Dataset Browser](zsd-snapshots-datasets.png)
103+
95104
### Search a snaphot
96105

97-
Search a snapshot in the snapshot browser. All snapshots are displayed in this view.
106+
Search a snapshot in the snapshot browser. All snapshots from the selected dataset are displayed in this view.
98107

99108
![Snapshot Browser](doc/zsd-snapshots.png)
100109

@@ -166,6 +175,14 @@ From here you can easy restore / view a deleted file.
166175

167176
###0.0.X###
168177

178+
0.0.7:
179+
* support sub zfs filesystems (datasets)
180+
* optional use sudo when execute zfs commands
181+
* necessary under linux when running as non root
182+
* needs sudo rules (see [doc/etc/sudoers.d/zfs-snap-diff](https://github.com/j-keck/zfs-snap-diff/blob/master/doc/etc/sudoers.d/zfs-snap-diff)
183+
* start `zfs-snap-diff` with '-use-sudo'
184+
* new view for server messages
185+
169186
0.0.6:
170187
* check if file in snapshot has changed filetype depend:
171188
* text files: md5

doc/etc/sudoers.d/zfs-snap-diff

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
# user under which zfs-snap-diff run
1+
### !! ADJUST ZSD_USER NAME !! ###
2+
3+
# user under which zfs-snap-diff run
24
User_Alias ZSD_USER = j
35

46
# allow read only zfs commands
57
ZSD_USER ALL = NOPASSWD: /sbin/zfs get *, /sbin/zfs list *
6-
7-
# allow mount snapshots
8-
ZSD_USER ALL = NOPASSWD: /bin/mount -t zfs *
9-
10-
# allow umount snapshots
11-
ZSD_USER ALL = NOPASSWD: /bin/umount
3.3 KB
Loading
-4 KB
Loading

doc/zsd-snapshots-datasets.png

13.7 KB
Loading

doc/zsd-snapshots-file-browser.png

8.84 KB
Loading

doc/zsd-snapshots.png

-9.32 KB
Loading

0 commit comments

Comments
 (0)