Skip to content

Commit

Permalink
update README for v0.0.7
Browse files Browse the repository at this point in the history
  • Loading branch information
j-keck committed Oct 9, 2014
1 parent 586ef08 commit dcdc80c
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 10 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If i messed up a file, i need to search a clean state from the file in the snaps
# Description

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


`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).
Expand Down Expand Up @@ -46,6 +46,9 @@ The backend is implemented in golang, the frontend with [angularjs](https://angu
* size+modTime: compares per size and modification time (very cheap)
* size: compares per size (very cheap)
* md5: compares per md5 (VERY EXPENSIVE! combine it with '-scan-snap-limit' and use it only for text files!)
* -use-sudo: use sudo when executing os commands
* necessary under linux when running as non root
* 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)



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

#### Diff
Explore file differences and pick changes to revert.
Explore file differences and pick single changes to revert.

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

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

## Browse snapshot state

### Select a dataset

Select a dataset (sub zfs filesystem).

![Dataset Browser](zsd-snapshots-datasets.png)

### Search a snaphot

Search a snapshot in the snapshot browser. All snapshots are displayed in this view.
Search a snapshot in the snapshot browser. All snapshots from the selected dataset are displayed in this view.

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

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

###0.0.X###

0.0.7:
* support sub zfs filesystems (datasets)
* optional use sudo when execute zfs commands
* necessary under linux when running as non root
* 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)
* start `zfs-snap-diff` with '-use-sudo'
* new view for server messages

0.0.6:
* check if file in snapshot has changed filetype depend:
* text files: md5
Expand Down
10 changes: 3 additions & 7 deletions doc/etc/sudoers.d/zfs-snap-diff
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
# user under which zfs-snap-diff run
### !! ADJUST ZSD_USER NAME !! ###

# user under which zfs-snap-diff run
User_Alias ZSD_USER = j

# allow read only zfs commands
ZSD_USER ALL = NOPASSWD: /sbin/zfs get *, /sbin/zfs list *

# allow mount snapshots
ZSD_USER ALL = NOPASSWD: /bin/mount -t zfs *

# allow umount snapshots
ZSD_USER ALL = NOPASSWD: /bin/umount
Binary file modified doc/zsd-snap-selected-diff-file-intext.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/zsd-snap-selected-diff-file-side-by-side.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/zsd-snapshots-datasets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/zsd-snapshots-file-browser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/zsd-snapshots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dcdc80c

Please sign in to comment.