Skip to content

Commit

Permalink
update site
Browse files Browse the repository at this point in the history
  • Loading branch information
j-keck committed Apr 19, 2020
1 parent 149e936 commit 11c4653
Show file tree
Hide file tree
Showing 14 changed files with 127 additions and 60 deletions.
5 changes: 2 additions & 3 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,13 @@ See the [[https://j-keck.github.io/zfs-snap-diff/][website]] for more details.

*** Prebuild

You can download a prebuild version from: [[https://j-keck.github.io/zfs-snap-diff/docs/install][here]].
You can download a prebuild version from [[https://j-keck.github.io/zfs-snap-diff/docs/install][here]].

*** Build from source

You only need go to build this project.

Check: [[https://j-keck.github.io/zfs-snap-diff/docs/install/#build-from-source][the docs]] for more information.

Check [[https://j-keck.github.io/zfs-snap-diff/docs/install/#build-from-source][the docs]] for more information.

** Run it

Expand Down
7 changes: 6 additions & 1 deletion doc/site/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ snapshot, revert a single change or restore a whole file.

## Management {#management}

You can create and destroy zfs snapshots, use the integrated directory browser to
You can create, destroy, rename, rollback and clone zfs snapshots, use the integrated directory browser to
navigate in your snapshots (directory history) and download a directory as a zip-archive.


Expand All @@ -35,3 +35,8 @@ as a single static compiled executable.
For a quick file version lookup / restore in the terminal, it contains the independent [`zsd`](/docs/zsd) cli tool.

{{< figure src="/images/zfs-snap-diff.gif" alt="Example session from zfs-snap-diff" link="/images/zfs-snap-diff.gif" >}}

{{< hint warning >}}
If you have any questions, trouble or other input, feel free to open an issue,
contact me per mail (see my github profile), or check [keybase.io](https://keybase.io/jkeck) for other channels.
{{< /hint >}}
17 changes: 17 additions & 0 deletions doc/site/content/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@ creator = "Emacs 26.3 (Org mode 9.1.9 + ox-hugo)"
weight = 50
+++

## 1.1.0 {#1-dot-1-dot-0}

- add snapshot management functions ([see docs](/docs/zfs-snap-diff/#snapshot-management))
- rename
- destroy
- clone
- rollback

- handle keyboard events in input fields
- 'Enter' for 'Submit'
- 'Esc' for 'Cancel' / close modal

- update npm deps

[all commits from v1.0.1...v1.1.0](https://github.com/j-keck/zfs-snap-diff/compare/v1.0.1...v1.1.0)


## 1.0.1 {#1-dot-0-dot-1}

- fix destroy snapshot
Expand Down
35 changes: 12 additions & 23 deletions doc/site/content/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,62 +7,51 @@ weight = 20

## Binary packages {#binary-packages}

{{< hint warning >}}
This is the first release after a complete rewrite. You find older versions on the [GitHub release page](https://github.com/j-keck/zfs-snap-diff/releases).

If you have any questions, trouble or other input, feel free to open an
issue, contact me per mail (see my github profile), or over [keybase.io](https://keybase.io/jkeck).
{{< /hint >}}

{{< hint info >}}
The tar archive contains currently only the executables. In the following releases
i will provide distribution specific packages.
{{< /hint >}}

You can download the latest binary package from here or from the [GitHub release page](https://github.com/j-keck/zfs-snap-diff/releases).

{{<tabs "install">}}
{{< tab "Linux" >}}
1.) ****Download**** the latest version for ****Linux amd64****: [zfs-snap-diff-linux-v1.0.1.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.1/zfs-snap-diff-linux-v1.0.1.tgz)
1.) ****Download**** the latest version for ****Linux amd64****: [zfs-snap-diff-linux-v1.1.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.1.0/zfs-snap-diff-linux-v1.1.0.tgz)

2.) Unpack the archive: `tar xvf zfs-snap-diff-linux-v1.0.1.tgz`
2.) Unpack the archive: `tar xvf zfs-snap-diff-linux-v1.1.0.tgz`

3.) Run it: `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
{{< /tab >}}

{{< tab "FreeBSD" >}}
1.) ****Download**** the latest version for ****FreeBSD amd64****: [zfs-snap-diff-freebsd-v1.0.1.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.1/zfs-snap-diff-freebsd-v1.0.1.tgz)
1.) ****Download**** the latest version for ****FreeBSD amd64****: [zfs-snap-diff-freebsd-v1.1.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.1.0/zfs-snap-diff-freebsd-v1.1.0.tgz)

2.) Unpack the archive: `tar xvf zfs-snap-diff-freebsd-v1.0.1.tgz`
2.) Unpack the archive: `tar xvf zfs-snap-diff-freebsd-v1.1.0.tgz`

3.) Run it: `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
{{< /tab >}}

{{< tab "FreeBSD (pkg)" >}} You can use `pkg install zfs-snap-diff` to install it from the package repository.{{< /tab >}}
{{< tab "macOS" >}}
1.) ****Download**** the latest version for ****macOS amd64****: [zfs-snap-diff-darwin-v1.0.1.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.1/zfs-snap-diff-darwin-v1.0.1.tgz)
1.) ****Download**** the latest version for ****macOS amd64****: [zfs-snap-diff-darwin-v1.1.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.1.0/zfs-snap-diff-darwin-v1.1.0.tgz)

2.) Unpack the archive: `tar xvf zfs-snap-diff-darwin-v1.0.1.tgz`
2.) Unpack the archive: `tar xvf zfs-snap-diff-darwin-v1.1.0.tgz`

3.) Run it: `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
{{< /tab >}}

{{< tab "Solaris" >}}
1.) ****Download**** the latest version for ****Solaris amd64****: [zfs-snap-diff-solaris-v1.0.1.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.0.1/zfs-snap-diff-solaris-v1.0.1.tgz)
1.) ****Download**** the latest version for ****Solaris amd64****: [zfs-snap-diff-solaris-v1.1.0.tgz](https://github.com/j-keck/zfs-snap-diff/releases/download/v1.1.0/zfs-snap-diff-solaris-v1.1.0.tgz)

2.) Unpack the archive: `tar xvf zfs-snap-diff-solaris-v1.0.1.tgz`
2.) Unpack the archive: `tar xvf zfs-snap-diff-solaris-v1.1.0.tgz`

3.) Run it: `./zfs-snap-diff [OPTIONS] <ZFS_DATASET_NAME>`
{{< /tab >}}

{{< /tabs >}}

{{< hint warning >}}
Try with the `-use-sudo` flag if it's not working - and please give feedback.
If you use any snapshot management functions, remember to use the `-use-sudo` flag!
{{< /hint >}}

{{< hint info >}}
If you need a 32bit version, or a binary for a different
platform, feel free to contact me!
The tar archive contains currently only the executables.
If you need distribution specific packages, or binaries for any other platform, feel free to contact me.
{{< /hint >}}


Expand Down
41 changes: 34 additions & 7 deletions doc/site/content/docs/zfs-snap-diff.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ weight = 30

With `zfs-snap-diff` you can

- create, destroy, rename, rollback and clone snapshots in the webapp

- find older file versions in your zfs-snapshots for a given file

- view the file content from a given snapshot
Expand All @@ -25,8 +27,6 @@ With `zfs-snap-diff` you can

- download a zip-archive from any folder in your snapshots

- create and destroy snapshots in the webapp

- bookmark often used folders


Expand Down Expand Up @@ -109,7 +109,7 @@ file version in the selected snapshot, revert a single change or restore a whole

## Browse snapshots {#browse-snapshots}

In this view you can view all snapshots.
In this view you can view and manage all snapshots.

{{< figure src="/images/browse-snapshots-snapshots.png" alt="Screenshot from 'Browse snapshots'" link="/images/browse-snapshots-snapshots.png" >}}

Expand Down Expand Up @@ -147,12 +147,39 @@ Format sequences are alike the `date` command
The default snapshot name template is per [`snapshot-name-template`](/docs/configuration/#snapshot-name-template) configurable.


## Destroy snapshot {#destroy-snapshot}
## Snapshot management {#snapshot-management}

{{< hint warning >}}
If you use any snapshot management functions, remember to use the `-use-sudo` flag!
{{< /hint >}}

You can click the {{< fa ellipsis-v >}} symbol to show the snapshots actions.

{{< figure src="/images/browse-snapshots-actions.png" link="/images/delete-snapshot.png" >}}


### Rename snapshot {#rename-snapshot}

{{< figure src="/images/browse-snapshots-rename.png" link="/images/delete-snapshot.png" >}}


### Destroy snapshot {#destroy-snapshot}

{{< figure src="/images/browse-snapshots-destroy.png" link="/images/delete-snapshot.png" >}}


### Clone snapshot {#clone-snapshot}

{{< figure src="/images/browse-snapshots-clone.png" >}}

{{< hint warning >}}
The new created dataset will only listed if the parent datasets mountpoint is ****not**** `none` or `legacy`.
{{< /hint >}}


You can destroy snapshots with the {{< fa trash >}} symbol in **"Browse snapshots"**
where you see all snapshots for the selected dataset.
### Rollback snapshot {#rollback-snapshot}

{{< figure src="/images/delete-snapshot.png" link="/images/delete-snapshot.png" >}}
{{< figure src="/images/browse-snapshots-rollback.png" >}}


## Download zip-archive {#download-zip-archive}
Expand Down
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/site/static/images/browse-snapshots-clone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/site/static/images/browse-snapshots-snapshots.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/site/static/images/create-snapshot.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/site/static/images/delete-snapshot.png
Binary file not shown.
82 changes: 56 additions & 26 deletions site.org
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

** Management

You can create and destroy zfs snapshots, use the integrated directory browser to
You can create, destroy, rename, rollback and clone zfs snapshots, use the integrated directory browser to
navigate in your snapshots (directory history) and download a directory as a zip-archive.


Expand All @@ -46,6 +46,11 @@ navigate in your snapshots (directory history) and download a directory as a zip
[[/images/zfs-snap-diff.gif][file:/images/zfs-snap-diff.gif]]


{{< hint warning >}}
If you have any questions, trouble or other input, feel free to open an issue,
contact me per mail (see my github profile), or check [[https://keybase.io/jkeck][keybase.io]] for other channels.
{{< /hint >}}


* Installation
:PROPERTIES:
Expand All @@ -56,19 +61,6 @@ navigate in your snapshots (directory history) and download a directory as a zip

** Binary packages

{{< hint warning >}}
This is the first release after a complete rewrite. You find older versions on the [[https://github.com/j-keck/zfs-snap-diff/releases][GitHub release page]].

If you have any questions, trouble or other input, feel free to open an
issue, contact me per mail (see my github profile), or over [[https://keybase.io/jkeck][keybase.io]].
{{< /hint >}}

{{< hint info >}}
The tar archive contains currently only the executables. In the following releases
i will provide distribution specific packages.
{{< /hint >}}


You can download the latest binary package from here or from the [[https://github.com/j-keck/zfs-snap-diff/releases][GitHub release page]].

#+BEGIN_SRC elisp :results output raw :exports results
Expand All @@ -93,23 +85,22 @@ You can download the latest binary package from here or from the [[https://githu
(princ "\n\n{{<tabs \"install\">}}\n")
(princ (section-for "Linux" (archive-name-string "linux" v) v))
(princ (section-for "FreeBSD" (archive-name-string "freebsd" v) v))
(princ "{{< tab \"FreeBSD (pkg)\" >}} You can use ~pkg install zfs-snap-diff~ to install it from the package repository.{{< /tab >}}\n")
(princ (section-for "macOS" (archive-name-string "darwin" v) v))
(princ (section-for "Solaris" (archive-name-string "solaris" v) v))
(princ "{{< /tabs >}}\n\n"))
#+END_SRC


{{< hint warning >}}
Try with the ~-use-sudo~ flag if it's not working - and please give feedback.
If you use any snapshot management functions, remember to use the ~-use-sudo~ flag!
{{< /hint >}}

{{< hint info >}}
If you need a 32bit version, or a binary for a different
platform, feel free to contact me!
The tar archive contains currently only the executables.
If you need distribution specific packages, or binaries for any other platform, feel free to contact me.
{{< /hint >}}



** Build from source

The backend from ~zfs-snap-diff~ is implemented in [[https://golang.org][Go]], the frontend in [[http://purescript.org][PureScript]].
Expand Down Expand Up @@ -158,6 +149,8 @@ To crosscompile the binary use:

With ~zfs-snap-diff~ you can

- create, destroy, rename, rollback and clone snapshots in the webapp

- find older file versions in your zfs-snapshots for a given file

- view the file content from a given snapshot
Expand All @@ -174,8 +167,6 @@ With ~zfs-snap-diff~ you can

- download a zip-archive from any folder in your snapshots

- create and destroy snapshots in the webapp

- bookmark often used folders


Expand Down Expand Up @@ -255,7 +246,7 @@ file version in the selected snapshot, revert a single change or restore a whole

** Browse snapshots

In this view you can view all snapshots.
In this view you can view and manage all snapshots.

#+attr_html: :alt Screenshot from 'Browse snapshots'
[[/images/browse-snapshots-snapshots.png][file:/images/browse-snapshots-snapshots.png]]
Expand Down Expand Up @@ -293,12 +284,34 @@ The template supports the following format sequences:

The default snapshot name template is per [[/docs/configuration/#snapshot-name-template][~snapshot-name-template~]] configurable.

** Destroy snapshot
** Snapshot management

{{< hint warning >}}
If you use any snapshot management functions, remember to use the ~-use-sudo~ flag!
{{< /hint >}}

You can click the {{< fa ellipsis-v >}} symbol to show the snapshots actions.

[[/images/delete-snapshot.png][file:/images/browse-snapshots-actions.png]]

*** Rename snapshot

[[/images/delete-snapshot.png][file:/images/browse-snapshots-rename.png]]

*** Destroy snapshot

[[/images/delete-snapshot.png][file:/images/browse-snapshots-destroy.png]]

*** Clone snapshot

You can destroy snapshots with the {{< fa trash >}} symbol in *"Browse snapshots"*
where you see all snapshots for the selected dataset.
file:/images/browse-snapshots-clone.png

[[/images/delete-snapshot.png][file:/images/delete-snapshot.png]]
{{< hint warning >}}
The new created dataset will only listed if the parent datasets mountpoint is **not** ~none~ or ~legacy~.
{{< /hint >}}
*** Rollback snapshot

file:/images/browse-snapshots-rollback.png

** Download zip-archive

Expand Down Expand Up @@ -577,13 +590,30 @@ Diff context size in the webui.
:export_hugo_section: docs
:END:

** 1.1.0

- add snapshot management functions ([[/docs/zfs-snap-diff/#snapshot-management][see docs]])
- rename
- destroy
- clone
- rollback

- handle keyboard events in input fields
- 'Enter' for 'Submit'
- 'Esc' for 'Cancel' / close modal

- update npm deps

[[https://github.com/j-keck/zfs-snap-diff/compare/v1.0.1...v1.1.0][all commits from v1.0.1...v1.1.0]]


** 1.0.1

- fix destroy snapshot

[[https://github.com/j-keck/zfs-snap-diff/compare/v1.0.0...v1.0.1][all commits from v1.0.0...v1.0.1]]


** 1.0.0

{{< hint info >}}
Expand Down

0 comments on commit 11c4653

Please sign in to comment.