Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oetiker committed Oct 12, 2015
1 parent 55b62e4 commit 55f6496
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 32 deletions.
2 changes: 1 addition & 1 deletion COPYRIGHT
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ znapzend - A ZFS backup system
Copyright by Dominik Hassler, Tobias Oetiker and the other people listed
in the AUTHORS file.

2014-12-16
2015-10-12

All rights reserved.

Expand Down
38 changes: 11 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ZnapZend 0.14.0
ZnapZend 0.14.1
===============

[![Build Status](https://travis-ci.org/oetiker/znapzend.svg?branch=master)](https://travis-ci.org/oetiker/znapzend)
Expand All @@ -11,34 +11,18 @@ snapshots as well as remote copies by thining them out as time progresses.
The ZnapZend configuration is stored as properties in the ZFS filesystem
itself.

Zetup Zimple
------------

There are two ways to get going with znapzend. The way of the real sysadmin
(as described below) or you can take the simple way out and download our
prebuilt release. It comes with all the perlmodules required for running
znapzend with a copy of perl as old as 5.10.1:

```sh
wget https://github.com/oetiker/znapzend/releases/download/v0.14.0/znapzend-prebuilt-0.14.0.tar.gz
tar zxvf znapzend-prebuilt-0.14.0.tar.gz
cp -rp znapzend-prebuilt-0.14.0 /opt/znapzend-0.14.0
```

Read on in the [Configuration](#configuration) Section.

Zetup for Power Admins
----------------------
Zetup Inztructionz
------------------

On the other hand if you are the proud owner of a properly setup unix box
with all the tools and trimmings for building stuff, follow these zimple
inztructionz below to get a custom made copy of znapzend.

```sh
wget https://github.com/oetiker/znapzend/releases/download/v0.14.0/znapzend-0.14.0.tar.gz
tar zxvf znapzend-0.14.0.tar.gz
cd znapzend-0.14.0
./configure --prefix=/opt/znapzend-0.14.0
wget https://github.com/oetiker/znapzend/releases/download/v0.14.1/znapzend-0.14.1.tar.gz
tar zxvf znapzend-0.14.1.tar.gz
cd znapzend-0.14.1
./configure --prefix=/opt/znapzend-0.14.1
```

If configure finds anything noteworthy, it will tell you about it. If any
Expand All @@ -64,19 +48,19 @@ The [znapzend](doc/znapzend.pod) demon is responsible for doing the actual backu
To see if your configuration is any good, run znapzend in noaction mode first.

```sh
/opt/znapzend-0.14.0/bin/znapzend --noaction --debug
/opt/znapzend-0.14.1/bin/znapzend --noaction --debug
```

If you don't want to wait for the scheduler to actually schedule work, you can also force immediate action by calling

```sh
/opt/znapzend-0.14.0/bin/znapzend --noaction --debug --runonce=<src_dataset>
/opt/znapzend-0.14.1/bin/znapzend --noaction --debug --runonce=<src_dataset>
```

then when you are happy with what you got, start it in daemon mode.

```sh
/opt/znapzend-0.14.0/bin/znapzend --daemonize
/opt/znapzend-0.14.1/bin/znapzend --daemonize
```

Best is to integrate znapzend into your system startup sequence, but you can also
Expand Down Expand Up @@ -117,4 +101,4 @@ And if you have a contribution, please send a pull request.
Enjoy!

Dominik Hassler & Tobi Oetiker
2014-12-16
2015-10-12
11 changes: 7 additions & 4 deletions doc/znapzendzetup.pod
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,12 @@ where 'command' is one of the following:
=head1 DESCRIPTION

Use znapzendsetup to configure your backup tasks. The cli is modled after
the zfs commandline. Below a few notes on main commands.
the zfs commandline.

After modifying the configuration, send a HUP signal to your znapzend daemon
for it to re-read the configuration.

Below a few notes on main commands.

=head2 B<create>

Expand Down Expand Up @@ -82,9 +87,7 @@ To keep one copy every two days for 10 years:
In a minimal setup, you just specify a plan for the B<SRC> fileset. This
will cause snapshots to be taken and destroyed according to the plan. You
can then add one or several destinations (B<DST>) both local (preferably on
a different pool) or remote. Please be aware that only lower-case-letters
are allowed for the (B<DST>) names (eg. in case you want to name the (B<DST>)
like a mixed-case named pool you might have).
a different pool) or remote.

When adding multiple B<DST> entries, each will get labled for later
identification, optionally you can specify your own label.
Expand Down

0 comments on commit 55f6496

Please sign in to comment.