source: networking/netprogs/nfs-utils.xml@ 3c7bd00

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 3c7bd00 was 3c7bd00, checked in by DJ Lucas <dj@…>, 8 years ago

Temporary render fix for bootscripts with REV=systemd.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@17430 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 19.4 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY nfs-utils-download-http "&sourceforge-repo;/nfs/nfs-utils-&nfs-utils-version;.tar.bz2">
8 <!ENTITY nfs-utils-download-ftp " ">
9 <!ENTITY nfs-utils-md5sum "9b87d890669eaaec8e97a2b0a35b2665">
10 <!ENTITY nfs-utils-size "776 KB">
11 <!ENTITY nfs-utils-buildsize "14 MB">
12 <!ENTITY nfs-utils-time "0.2 SBU">
13]>
14
15<sect1 id="nfs-utils" xreflabel="nfs-utils-&nfs-utils-version;">
16 <?dbhtml filename="nfs-utils.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>NFS-Utils-&nfs-utils-version;</title>
24
25 <indexterm zone="nfs-utils">
26 <primary sortas="a-Nfs-utils">NFS Utilities</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to NFS Utilities</title>
31
32 <para>The <application>NFS Utilities</application> package contains the
33 userspace server and client tools necessary to use the kernel's NFS
34 abilities. NFS is a protocol that allows sharing file systems over the
35 network.</para>
36
37 &lfs79_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing='compact'>
41 <listitem>
42 <para>Download (HTTP): <ulink url="&nfs-utils-download-http;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download (FTP): <ulink url="&nfs-utils-download-ftp;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download MD5 sum: &nfs-utils-md5sum;</para>
49 </listitem>
50 <listitem>
51 <para>Download size: &nfs-utils-size;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated disk space required: &nfs-utils-buildsize;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated build time: &nfs-utils-time;</para>
58 </listitem>
59 </itemizedlist>
60
61 <bridgehead renderas="sect3">NFS Utilities Dependencies</bridgehead>
62
63 <bridgehead renderas="sect4">Required</bridgehead>
64 <para role="required">
65 <xref linkend="libtirpc"/>
66 </para>
67
68 <bridgehead renderas="sect4">Optional</bridgehead>
69 <para role="optional">
70 <xref linkend="libevent"/>,
71 <xref linkend="sqlite"/> and
72 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libnfsidmap</ulink> (for NFSv4 support),
73 <xref linkend="mitkrb"/> or
74 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>, and
75 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">librpcsecgss</ulink> (for GSS and RPC security support) and
76 <xref linkend="libcap-pam"/>
77 </para>
78
79 <bridgehead renderas="sect4">Required (runtime)</bridgehead>
80 <para role="required">
81 <xref linkend="rpcbind"/>
82 </para>
83
84 <para condition="html" role="usernotes">User Notes:
85 <ulink url="&blfs-wiki;/nfs-utils"/></para>
86
87 </sect2>
88
89 <sect2 role="kernel" id='nfs-utils-kernel'>
90 <title>Kernel Configuration</title>
91
92 <para>Enable the following options in the kernel configuration
93 (choose client and/or server support as appropriate) and recompile the
94 kernel if necessary:</para>
95
96<screen><literal>File systems ---&gt;
97 [*] Network File Systems ---&gt; [CONFIG_NETWORK_FILESYSTEMS]
98 &lt;*/M&gt; NFS client support [CONFIG_NFS_FS]
99 &lt;*/M&gt; NFS server support [CONFIG_NFSD]</literal></screen>
100
101 <para>Select the appropriate sub-options that appear when the above options
102 are selected.</para>
103
104 <note>
105 <para>
106 In BLFS we assume that nfs v3 will be used. If the
107 <emphasis>server</emphasis> offers nfs v4 (for linux, CONFIG_NFSD_V4)
108 then auto-negotiation for v3 will fail and you will need to add
109 <literal>nfsver=3</literal> to the mount options. This also applies
110 if that option is enabled in the <emphasis>client's</emphasis> kernel,
111 for example in a distro trying to mount from a BLFS v3 server.
112 </para>
113 </note>
114
115 <indexterm zone="nfs-utils nfs-utils-kernel">
116 <primary sortas="d-nfs-utils">NFS Utilities</primary>
117 </indexterm>
118
119 </sect2>
120
121 <sect2 role="installation" id='nfs-utils-install'
122 xreflabel='NFS Utilities Installation'>
123 <title>Installation of NFS Utilities</title>
124
125 <para>Before you compile the program, ensure that the <systemitem
126 class="username">nobody</systemitem> user and <systemitem
127 class="groupname">nogroup</systemitem> group have been created as done in
128 the current LFS book. You can add them by running the following commands
129 as the <systemitem class="username">root</systemitem> user:</para>
130
131<screen role="root"><userinput>groupadd -g 99 nogroup &amp;&amp;
132useradd -c "Unprivileged Nobody" -d /dev/null -g nogroup \
133 -s /bin/false -u 99 nobody</userinput></screen>
134
135 <note>
136 <para>The classic uid and gid values are 65534 which is also -2 when
137 interpreted as a signed 16-bit number. These values impact other files
138 on some filesystems that do not have support for sparse files. The
139 <systemitem class="username">nobody</systemitem> and <systemitem
140 class="groupname">nogroup</systemitem> values are relatively arbitrary.
141 The impact on a server is nil if the <filename>exports</filename> file
142 is configured correctly. If it is misconfigured, an
143 <command>ls -l</command> or <command>ps</command> listing will show a
144 uid or gid number of 65534 instead of a name. The client uses <systemitem
145 class="username">nobody</systemitem> only as the user running
146 <command>rpc.statd</command>.</para>
147 </note>
148
149 <para>Install <application>NFS Utilities</application> by running
150 the following commands:</para>
151
152<screen><userinput>./configure --prefix=/usr \
153 --sysconfdir=/etc \
154 --without-tcp-wrappers \
155 --disable-nfsv4 \
156 --disable-gss &amp;&amp;
157make</userinput></screen>
158
159 <para>If your <filename class="directory">/usr</filename> directory
160 is NFS mounted, you should install the executables in
161 <filename class="directory">/sbin</filename> by passing
162 an additional parameter <option>--sbindir=/sbin</option> to the
163 above <command>./configure</command> command.</para>
164
165 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
166
167<!-- dev note: make statduser=$(whoami) DESTDIR=<DESTDIR> install -->
168
169<screen role='root'><userinput>make install &amp;&amp;
170chmod u+w,go+r /sbin/mount.nfs</userinput></screen>
171
172 <para>The tests for this package require that the package be installed and
173 configured as specified below. In addition, the the daemon from <xref
174 linkend="rpcbind"/> needs to be running and the tests need to be run as the
175 <systemitem class="username">root</systemitem> user.</para>
176
177 <para>To test the results, issue, as root: <command>make check</command>.</para>
178
179 </sect2>
180
181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para><parameter>--without-tcp-wrappers</parameter>: This option is
185 needed because TCP Wrappers is not in BLFS.</para>
186
187 <para><parameter>--disable-nfsv4</parameter>: This allows the package to be
188 built when libnfsidmap has not been installed.</para>
189
190 <para><parameter>--disable-gss</parameter>: Disables support for
191 RPCSEC GSS (RPC Security).</para>
192
193 </sect2>
194
195 <sect2 role="configuration">
196 <title>Configuring NFS Utilities</title>
197
198 <sect3 id='nfs-utils-server-config'>
199 <title>Server Configuration</title>
200
201 <para><filename>/etc/exports</filename> contains the exported directories
202 on NFS servers. Refer to the <filename>exports.5</filename> manual page
203 for the syntax of this file. Also refer to the "NFS HowTo" available at
204 <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
205 how to configure the servers and clients in a secure manner. For example,
206 for sharing the <filename class="directory">/home</filename> directory
207 over the local network, the following line may be added:</para>
208
209<screen role="root"><userinput>/home <replaceable>192.168.0.0/24</replaceable>(rw,subtree_check,anonuid=99,anongid=99)</userinput></screen>
210
211 <note><para>Be sure to replace the directory, network address. and prefix above
212 to match your network. The only space in the line above should be between
213 the directory and the network address.</para></note>
214
215 <indexterm zone="nfs-utils nfs-utils-server-config">
216 <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
217 </indexterm>
218
219 <sect4 id="nfs-utils-server-init">
220 <title>Boot Script</title>
221
222 <para>Install the <filename>/etc/rc.d/init.d/nfs-server</filename>
223 init script included in the <xref linkend="bootscripts" revision="sysv"/>
224 <xref linkend="systemd-units" revision="systemd"/> package
225 to start the server at boot.</para>
226
227<screen role="root"><userinput>make install-nfs-server</userinput></screen>
228
229 <indexterm zone="nfs-utils nfs-utils-server-init">
230 <primary sortas="f-nfs-server">nfs-server</primary>
231 </indexterm>
232
233 <para>Now create the <filename>/etc/sysconfig/nfs-server</filename>
234 configuration file:</para>
235
236<screen role="root"><userinput>cat &gt; /etc/sysconfig/nfs-server &lt;&lt; "EOF"
237<literal>PORT="2049"
238PROCESSES="8"
239QUOTAS="no"
240KILLDELAY="10"</literal>
241EOF</userinput></screen>
242
243 <note><para>The above parameters may be optionally placed in
244 <filename>/etc/sysconfig/rc.site</filename>.</para></note>
245
246 <indexterm zone="nfs-utils nfs-utils-server-init">
247 <primary
248 sortas="e-etc-sysconfig-nfs-server">/etc/sysconfig/nfs-server</primary>
249 </indexterm>
250
251 </sect4>
252
253 </sect3>
254
255 <sect3 id='nfs-utils-client-config'>
256 <title>Client Configuration</title>
257
258 <para><filename>/etc/fstab</filename> contains the directories that
259 are to be mounted on the client. Alternately the partitions can be
260 mounted by using the <command>mount</command> command with the proper
261 options. To mount the <filename class="directory">/home</filename>
262 and <filename class="directory">/usr</filename> partitions, add the
263 following to the <filename>/etc/fstab</filename>:</para>
264
265<screen role="root"><userinput><replaceable>&lt;server-name&gt;</replaceable>:/home /home nfs rw,_netdev 0 0
266<replaceable>&lt;server-name&gt;</replaceable>:/usr /usr nfs ro,_netdev 0 0</userinput></screen>
267
268 <para>The options which can be used are specified in <command>man 5 nfs</command>.
269 If both the client and server are running recent versions of linux, most of the
270 options will be negotiated. You can specify either <literal>rw</literal> or
271 <literal>ro</literal>, <literal>_netdev</literal> if the filesystem is to be
272 automatically mounted at boot, or <literal>noauto</literal> (and perhaps
273 <literal>user</literal>) for other filesystems.</para>
274
275 <para>If the fileserver is not running a recent version of linux, you may need to
276 specifiy other options.</para>
277
278 <para>If you are using systemd, you may need to enable autofs v4 in your kernel,
279 and add the option <literal>comment=systemd.automount</literal>. Some machines
280 need this, because systemd tries to mount the external fs&apos;s before the network
281 is up, others do not need it. An alternative is for <systemitem
282 class="username">root</systemitem> to run <command>mount -a</command>.</para>
283
284 <indexterm zone="nfs-utils nfs-utils-client-config">
285 <primary sortas="e-etc-fstab">/etc/fstab</primary>
286 </indexterm>
287
288 <sect4 id="nfs-utils-client-init">
289 <title>Boot Script</title>
290
291 <note><para>The following boot script is not required if the
292 nfs-server script is installed.</para></note>
293
294 <para>Install the <filename>/etc/rc.d/init.d/nfs-client</filename> init
295 script included in the <xref linkend="bootscripts" revision="sysv"/>
296 <xref linkend="systemd-units" revision="systemd"/> package to start
297 the client services at boot.</para>
298
299<screen role="root"><userinput>make install-nfs-client</userinput></screen>
300
301 <indexterm zone="nfs-utils nfs-utils-client-config">
302 <primary sortas="f-nfs-client">nfs-client</primary>
303 </indexterm>
304
305 <para>To automatically mount <systemitem
306 class="filesystem">nfs</systemitem> filesystems, clients will also need
307 to install the <filename>netfs</filename> bootscript as described in
308 <xref linkend="postlfs-config-netfs"/>.</para>
309
310 <indexterm zone="nfs-utils nfs-utils-client-config">
311 <primary sortas="f-netfs">netfs</primary>
312 </indexterm>
313
314 </sect4>
315
316 </sect3>
317
318 </sect2>
319
320 <sect2 role="content">
321 <title>Contents</title>
322 <segmentedlist>
323 <segtitle>Installed Programs</segtitle>
324 <segtitle>Installed Libraries</segtitle>
325 <segtitle>Installed Directories</segtitle>
326
327 <seglistitem>
328 <seg>exportfs, mountstats, mount.nfs, mount.nfs4 (link to mount.nfs),
329 nfsiostat, nfsstat, osd_login, rpc.mountd, rpc.nfsd, rpc.statd, rpcdebug,
330 showmount, sm-notify, start-statd, umount.nfs (link to mount.nfs),
331 and umount.nfs4 (link to mount.nfs)</seg>
332 <seg>None</seg>
333 <seg>/var/lib/nfs</seg>
334 </seglistitem>
335 </segmentedlist>
336
337 <variablelist>
338 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
339 <?dbfo list-presentation="list"?>
340 <?dbhtml list-presentation="table"?>
341
342 <varlistentry id="exportfs">
343 <term><command>exportfs</command></term>
344 <listitem>
345 <para>maintains a list of NFS exported file systems.</para>
346 <indexterm zone="nfs-utils exportfs">
347 <primary sortas="b-exportfs">exportfs</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="mountstats">
353 <term><command>mountstats</command></term>
354 <listitem>
355 <para>displays NFS client per-mount statistics.</para>
356 <indexterm zone="nfs-utils mountstats">
357 <primary sortas="b-mountstats">mountstats</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="mount.nfs">
363 <term><command>mount.nfs</command></term>
364 <listitem>
365 <para>Used to mount a network share using NFS</para>
366 <indexterm zone="nfs-utils mount.nfs">
367 <primary sortas="b-mount.nfs">mount.nfs</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="mount.nfs4">
373 <term><command>mount.nfs4</command></term>
374 <listitem>
375 <para>Used to mount a network share using NFSv4</para>
376 <indexterm zone="nfs-utils mount.nfs4">
377 <primary sortas="b-mount.nfs4">mount.nfs4</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="nfsiostat-nfs-utils">
383 <term><command>nfsiostat</command></term>
384 <listitem>
385 <para>Report input/output statistics for network filesystems.</para>
386 <indexterm zone="nfs-utils nfsiostat-nfs-utils">
387 <primary sortas="b-nfsiostat-nfs-utils">nfsiostat</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="nfsstat">
393 <term><command>nfsstat</command></term>
394 <listitem>
395 <para>displays statistics kept about NFS client and server activity.</para>
396 <indexterm zone="nfs-utils nfsstat">
397 <primary sortas="b-nfsstat">nfsstat</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="osd_login">
403 <term><command>osd_login</command></term>
404 <listitem>
405 <para>is a script that is a part of the autologin feature
406 mandated by the pnfs-objects standard.</para>
407 <indexterm zone="nfs-utils osd_login">
408 <primary sortas="b-osd_login">osd_login</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413
414 <varlistentry id="rpc.mountd">
415 <term><command>rpc.mountd</command></term>
416 <listitem>
417 <para>implements the NFS mount protocol on an NFS server.</para>
418 <indexterm zone="nfs-utils rpc.mountd">
419 <primary sortas="b-rpc.mountd">rpc.mountd</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="rpc.nfsd">
425 <term><command>rpc.nfsd</command></term>
426 <listitem>
427 <para>implements the user level part of the NFS
428 service on the server.</para>
429 <indexterm zone="nfs-utils rpc.nfsd">
430 <primary sortas="b-rpc.nfsd">rpc.nfsd</primary>
431 </indexterm>
432 </listitem>
433 </varlistentry>
434
435 <varlistentry id="rpc.statd">
436 <term><command>rpc.statd</command></term>
437 <listitem>
438 <para>is used by the NFS file locking service. Run on both sides,
439 client as well as server, when you want file locking enabled.</para>
440 <indexterm zone="nfs-utils rpc.statd">
441 <primary sortas="b-rpc.statd">rpc.statd</primary>
442 </indexterm>
443 </listitem>
444 </varlistentry>
445
446 <varlistentry id="rpcdebug">
447 <term><command>rpcdebug</command></term>
448 <listitem>
449 <para>sets or clears the kernel's NFS client and server debug
450 flags.</para>
451 <indexterm zone="nfs-utils rpcdebug">
452 <primary sortas="b-rpcdebug">rpcdebug</primary>
453 </indexterm>
454 </listitem>
455 </varlistentry>
456
457 <varlistentry id="showmount">
458 <term><command>showmount</command></term>
459 <listitem>
460 <para>displays mount information for an NFS server.</para>
461 <indexterm zone="nfs-utils showmount">
462 <primary sortas="b-showmount">showmount</primary>
463 </indexterm>
464 </listitem>
465 </varlistentry>
466
467 <varlistentry id="sm-notify">
468 <term><command>sm-notify</command></term>
469 <listitem>
470 <para>is used to send Network Status Monitor reboot messages.</para>
471 <indexterm zone="nfs-utils sm-notify">
472 <primary sortas="b-sm-notify">sm-notify</primary>
473 </indexterm>
474 </listitem>
475 </varlistentry>
476
477 <varlistentry id="start-statd">
478 <term><command>start-statd</command></term>
479 <listitem>
480 <para>is a script called by nfsmount when mounting a filesystem with
481 locking enabled, if statd does not appear to be running. It can be
482 customised with whatever flags are appropriate for the site.</para>
483 <indexterm zone="nfs-utils start-statd">
484 <primary sortas="b-start-statd">start-statd</primary>
485 </indexterm>
486 </listitem>
487 </varlistentry>
488
489 <varlistentry id="umount.nfs">
490 <term><command>umount.nfs</command></term>
491 <listitem>
492 <para>Used to unmount a network share using NFS</para>
493 <indexterm zone="nfs-utils umount.nfs">
494 <primary sortas="b-umount.nfs">umount.nfs</primary>
495 </indexterm>
496 </listitem>
497 </varlistentry>
498
499 <varlistentry id="umount.nfs4">
500 <term><command>umount.nfs4</command></term>
501 <listitem>
502 <para>Used to unmount a network share using NFSv4</para>
503 <indexterm zone="nfs-utils umount.nfs4">
504 <primary sortas="b-umount.nfs4">umount.nfs4</primary>
505 </indexterm>
506 </listitem>
507 </varlistentry>
508
509 </variablelist>
510
511 </sect2>
512
513</sect1>
Note: See TracBrowser for help on using the repository browser.