Skip to content

Commit 04e87db

Browse files
committed
update README
1 parent 244f3f7 commit 04e87db

File tree

1 file changed

+31
-27
lines changed

1 file changed

+31
-27
lines changed

README.md

Lines changed: 31 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -116,23 +116,7 @@ From here you can easy restore / view a deleted file.
116116
![File Browser](doc/zsd-snapshots-file-browser.png)
117117

118118

119-
120-
#Notes
121-
122-
* if you download a file from a snapshot, the generated file name has the snapshot name included:
123-
124-
<ORG_FILE_NAME>-<SNAPSHOT_NAME>.<FILE_SUFFIX>
125-
126-
* if you restore / patch a file, the orginal file will be saved under:
127-
128-
./zsd/<ORG_FLILE_NAME>_<TIMESTAMP>
129-
130-
* for snapshot differences (Browse snapshot diff), you need to set the diff permission:
131-
132-
zfs allow -u <USER_NAME> diff <ZFS_NAME>
133-
134-
135-
119+
136120

137121

138122
# Installation
@@ -155,22 +139,42 @@ From here you can easy restore / view a deleted file.
155139

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

158-
go get -u
142+
go get -u
159143

160-
* generate golang src from static web content (this generates bindata.go)
161-
162-
go-bindata webapp/...
144+
* build it
145+
146+
go build -ldflags "-X main.VERSION $(git describe)"
163147

164-
or start it later per `ZSD_SERVE_FROM_WEBAPP=YES ./zfs-snap-diff <ZFS_NAME>`
165-
to serve the static content from the `webapp` folder.
166-
167148

168-
* build it
169149

170-
go build -ldflags "-X main.VERSION $(git describe)"
150+
#Notes
151+
152+
* if you download a file from a snapshot, the generated file name has the snapshot name included:
153+
154+
<ORG_FILE_NAME>-<SNAPSHOT_NAME>.<FILE_SUFFIX>
155+
156+
* if you restore / patch a file, the orginal file will be saved under:
157+
158+
./zsd/<ORG_FLILE_NAME>_<TIMESTAMP>
159+
160+
* for snapshot differences (Browse snapshot diff), you need to set the diff permission:
161+
162+
zfs allow -u <USER_NAME> diff <ZFS_NAME>
163+
164+
165+
166+
# Coding Notes
167+
168+
* if you change something under 'webapp/'
169+
170+
* start `zfs-snap-diff` per `ZSD_SERVE_FROM_WEBAPP=YES ./zfs-snap-diff <ZFS_NAME>`
171+
to serve the static content from the `webapp` folder
172+
173+
* re-generate bindata.go and recompile `zfs-snap-diff`
174+
* sh ./gen-bindata.sh
175+
* go build -ldflags "-X main.VERSION $(git describe)"
171176

172177

173-
174178
# Changelog
175179

176180
###0.0.X###

0 commit comments

Comments
 (0)