Skip to content

Commit

Permalink
update README for v0.0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
j-keck committed Oct 5, 2014
1 parent bab20b5 commit b3646cf
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 11 deletions.
34 changes: 23 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ 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 from different zfs snapshots to the actual file version or browse in old snapshots.
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.


`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 All @@ -18,10 +19,6 @@ The backend is implemented in golang, the frontend with [angularjs](https://angu



*!! it's in a very early dev state - only tested on FreeBSD !!*



#Usage


Expand Down Expand Up @@ -79,13 +76,18 @@ When a file is selected, `zsd-snap-diff` search all snapshots where the selected

### Select a snapshot

When you select a snapshot, you can view, diff, download or restore the selected file.
When you select a snapshot, you can view, diff, download or restore the file from the selected snapshot.

#### View
View the file content from an older file version.
![File View](doc/zsd-snap-selected-view-file.png)

#### Diff
![File Diff](doc/zsd-snap-selected-diff-file.png)
Explore file differences and pick changes to revert.

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

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


## Browse snapshot state
Expand All @@ -112,9 +114,9 @@ From here you can easy restore / view a deleted file.

<ORG_FILE_NAME>-<SNAPSHOT_NAME>.<FILE_SUFFIX>

* if you restore a file, the orginal file will be renamed as:
* if you restore / patch a file, the orginal file will be saved under:

<ORG_FLILE_NAME>_<TIMESTAMP>
./zsd/<ORG_FLILE_NAME>_<TIMESTAMP>

* for snapshot differences (Browse snapshot diff), you need to set the diff permission:

Expand Down Expand Up @@ -142,9 +144,9 @@ From here you can easy restore / view a deleted file.

cd zfs-snap-diff

* fetch dependencies
* fetch dependencies ([go-diff](https://github.com/sergi/go-diff))

go get -u
go get -u

* generate golang src from static web content (this generates bindata.go)

Expand All @@ -163,6 +165,16 @@ From here you can easy restore / view a deleted file.
# Changelog

###0.0.X###

0.0.6:
* check if file in snapshot has changed filetype depend:
* text files: md5
* others: size+modTime
* diffs created in the backend (per [go-diff](https://github.com/sergi/go-diff))
* different presentation: intext / side by side
* possibility to revert single changes
* bugfixes


0.0.5:
* file compare method configurable: size+modTime (default) or md5
Expand Down
Binary file modified doc/zsd-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-file-selected.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-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 added 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 removed doc/zsd-snap-selected-diff-file.png
Binary file not shown.
Binary file modified doc/zsd-snap-selected-view-file.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 removed doc/zsd-snapshots-file-browser.png.bak
Binary file not shown.
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 b3646cf

Please sign in to comment.