README.md
1DESCRIPTION
2 These script were written with the primary intention of being portable and
3 usable on as many systems as possible.
4
5 This is, in practice, usually not possible. But the intention is there.
6 And it is a good one.
7
8 They have been tested successfully on:
9
10 * Debian GNU/Linux Bookworm
11 * Gentoo
12
13SUPPORT
14 If you find that they don't work for your platform, please report this
15 at the OpenZFS issue tracker at https://github.com/openzfs/zfs/issues.
16
17 Please include:
18
19 * Distribution name
20 * Distribution version
21 * Where to find an install CD image
22 * Architecture
23
24 If you have code to share that fixes the problem, that is much better.
25 But please remember to try your best keep portability in mind. If you
26 suspect that what you're writing/modifying won't work on anything else
27 than your distribution, please make sure to put that code in appropriate
28 if/else/fi code.
29
30 It currently MUST be bash (or fully compatible) for this to work.
31
32 If you're making your own distribution and you want the scripts to
33 work on that, the biggest problem you'll (probably) have is the part
34 at the beginning of the "zfs-functions" file which sets up the
35 logging output.
36
37INSTALLING INIT SCRIPT LINKS
38 To setup the init script links in /etc/rc?.d manually on a Debian GNU/Linux
39 (or derived) system, run the following commands (the order is important!):
40
41 update-rc.d zfs-import start 07 S . stop 07 0 1 6 .
42 update-rc.d zfs-load-key start 02 2 3 4 5 . stop 06 0 1 6 .
43 update-rc.d zfs-mount start 02 S . stop 06 0 1 6 .
44 update-rc.d zfs-zed start 07 2 3 4 5 . stop 08 0 1 6 .
45 update-rc.d zfs-share start 27 2 3 4 5 . stop 05 0 1 6 .
46
47 To do the same on RedHat, Fedora and/or CentOS:
48
49 chkconfig zfs-import
50 chkconfig zfs-load-key
51 chkconfig zfs-mount
52 chkconfig zfs-zed
53 chkconfig zfs-share
54
55 On Gentoo:
56
57 rc-update add zfs-import boot
58 rc-update add zfs-load-key boot
59 rc-update add zfs-mount boot
60 rc-update add zfs-zed default
61 rc-update add zfs-share default
62
63 The idea here is to make sure all of the ZFS filesystems, including possibly
64 separate datasets like /var, are mounted before anything else is started.
65
66 Then, ZED, which depends on /var, can be started. It will consume and act
67 on events that occurred before it started. ZED may also play a role in
68 sharing filesystems in the future, so it is important to start before the
69 'share' service.
70
71 Finally, we share filesystems configured with the share\* property.
72