.\" Automatically generated by Podwrapper::Man 1.24.1 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "nbdkit-client 1"
.TH nbdkit-client 1 "2021-01-20" "nbdkit-1.24.1" "NBDKIT"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
nbdkit\-service \- how to mount NBD filesystems on a client machine
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
For \s-1NBD\s0 exports that contain filesystems there are several approaches
to mounting them on a client machine.
.PP
To ensure the nbd kernel module is loaded you may need to do:
.PP
.Vb 1
\& # echo nbd > /etc/modules\-load.d/nbd.conf
.Ve
.PP
This will not take effect until you reboot, so also do:
.PP
.Vb 1
\& # modprobe nbd
.Ve
.SS "Easy mounting at boot time"
.IX Subsection "Easy mounting at boot time"
For simple setups the following method is the easiest way to get an
\&\s-1NBD\s0 filesystem to mount at boot.  Create or edit \fI/etc/rc.local\fR or
\&\fI/etc/rc.d/rc.local\fR:
.PP
.Vb 5
\& #!/bin/sh \-
\& nm\-online
\& modprobe nbd
\& nbd\-client server /dev/nbd0
\& mount /dev/nbd0 /mnt
.Ve
.SS "Mounting using systemd mount points"
.IX Subsection "Mounting using systemd mount points"
You can use systemd mount points to mount \s-1NBD\s0 filesystems at boot
and/or on demand.
.PP
Set up an \fBnbdtab\fR\|(5) mapping.  If \fI/etc/nbdtab\fR doesn't exist, then
create it first.  Add this line:
.PP
.Vb 1
\& nbd0 server / bs=512,persist
.Ve
.PP
As a workaround for
https://github.com/NetworkBlockDevice/nbd/issues/91 you must
currently modify the \fInbd@.service\fR file:
.PP
.Vb 2
\& # cp /usr/lib/systemd/system/nbd@.service /etc/systemd/system/
\& # vi /etc/systemd/system/nbd@.service
.Ve
.PP
and edit or create these settings in the \f(CW\*(C`[Service]\*(C'\fR section:
.PP
.Vb 5
\& [Service]
\& Type=oneshot
\& RemainAfterExit=yes
\& ExecStart=/usr/sbin/nbd\-client %i
\& ExecStop=/usr/sbin/nbd\-client \-d /dev/%i
.Ve
.PP
Finally create a systemd mount file called
\&\fI/etc/systemd/system/mnt.mount\fR:
.PP
.Vb 6
\& [Unit]
\& Requires=nbd@nbd0.service
\& [Mount]
\& What=/dev/nbd0
\& Where=/mnt
\& Type=ext4
.Ve
.PP
You can either reboot now or do:
.PP
.Vb 1
\& # systemctl start mnt.mount
.Ve
.PP
Other systemd services which need this mount point can depend on this
mount unit.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit\-loop\fR\|(1),
\&\fBnbdkit\-service\fR\|(1),
\&\fBnbd\-client\fR\|(8),
\&\fBnbdtab\fR\|(5),
\&\fBsystemd\fR\|(1),
\&\fBsystemd.mount\fR\|(5).
.SH "AUTHORS"
.IX Header "AUTHORS"
Richard W.M. Jones
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2013\-2020 Red Hat Inc.
.SH "LICENSE"
.IX Header "LICENSE"
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
.IP "\(bu" 4
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
.IP "\(bu" 4
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
.IP "\(bu" 4
Neither the name of Red Hat nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
.PP
\&\s-1THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS\s0 ''\s-1AS IS\s0'' \s-1AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\s0 (\s-1INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES\s0; \s-1LOSS OF
USE, DATA, OR PROFITS\s0; \s-1OR BUSINESS INTERRUPTION\s0) \s-1HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT\s0 (\s-1INCLUDING NEGLIGENCE OR OTHERWISE\s0) \s-1ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.\s0