summaryrefslogtreecommitdiff
path: root/sysutils/zrepl/files/pkg-message.in
blob: 2bdeeabd77765c0e8877102b8c38c6b8a9736435 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
------------------------------------------------------------------------
Messages from sysutils/zrepl:

SETUP BEFORE FIRST USE:
- Create the log file /var/log/zrepl.log:
  # service newsyslog restart
- Teach syslogd to redirect facility local0 to the zrepl.log file:
  # service syslogd reload
- Modify the %%PREFIX%%/etc/zrepl/zrepl.yml configuration file
- For remote backups, create the SSH key pair and authorized_keys file
- Enable the zrepl daemon to start automatically at boot:
  # sysrc zrepl_enable="YES"
- Start the zrepl daemon:
  # service zrepl start
  
Documentation: https://zrepl.github.io/
Changelog:     https://zrepl.github.io/master/changelog.html

WARNING - BREAKING CHANGES WITH THE ZREPL 0.1.X RELEASE:
There are a number of breaking changes this release. To ensure zrepl
continues to function correctly, ensure you read the changelog, and then
perform the following on both sides of the replication:
- Stop the zrepl service:    # service zrepl stop
- Upgrade the zrepl package: # pkg upgrade zrepl
- Modify the zrepl config:   # vi %%PREFIX%%/etc/zrepl/zrepl.yml
- Check the configuration:   # service zrepl configtest
- Start the zrepl service:   # service zrepl start
- Monitor the zrepl service: # zrepl status

DANGER - SNAPSHOT PRUNING REQUIRES EXPLICIT KEEP RULES:
For any ZFS snapshot that you want to keep, at least one rule must match. This
is different from previous releases where pruning only affected snapshots with
the configured snapshotting prefix. Make sure that snapshots to be kept or
ignored by zrepl are covered, e.g. by using the regex keep rule.
This also applies to snapshots taken by means other than zrepl (e.g. manually).
------------------------------------------------------------------------