source: networking/netprogs/nfs-utils.xml@ f628f3a

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since f628f3a was f628f3a, checked in by Bruce Dubbs <bdubbs@…>, 12 years ago

Added option to build without TCP-Wrappers to NFS-Utils.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@9788 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 17.7 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 "8395ac770720b83c5c469f88306d7765">
10 <!ENTITY nfs-utils-size "688 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 Utilities-&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 Utilities-&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 &lfs70_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"/> and
66 <xref linkend="pkgconfig"/>
67 </para>
68
69 <para role="required">
70 <xref linkend="rpcbind"/> (Runtime dependency)
71 </para>
72
73 <bridgehead renderas="sect4">Optional</bridgehead>
74 <para role="optional">
75 <xref linkend="tcpwrappers"/>
76 </para>
77
78 <bridgehead renderas="sect4">Optional for NFSv4 Support</bridgehead>
79 <para role="optional">
80 <ulink url="http://www.monkey.org/~provos/libevent/">libevent</ulink> and
81 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libnfsidmap</ulink>
82 </para>
83
84 <bridgehead renderas="sect4">Optional for GSS (RPC Security) Support</bridgehead>
85 <para role="optional">
86 <xref linkend="mitkrb"/> or
87 <xref linkend="heimdal"/> or
88 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">libgssapi</ulink>, and
89 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">librpcsecgss</ulink>
90 </para>
91
92 <bridgehead renderas="sect4">Optional for SPKM-3 Support</bridgehead>
93 <para>
94 <ulink url="http://www.citi.umich.edu/projects/nfsv4/linux/">SPKM-3</ulink>
95 </para>
96
97 <para condition="html" role="usernotes">User Notes:
98 <ulink url="&blfs-wiki;/nfs-utils"/></para>
99
100 </sect2>
101
102 <sect2 role="kernel" id='nfs-utils-kernel'>
103 <title>Kernel Configuration</title>
104
105 <para>Enable the following options in the kernel configuration
106 and recompile the kernel if necessary:</para>
107
108<screen><literal>File systems:
109 Network File Systems:
110 NFS File System Support: M or Y
111 NFS Server Support: M or Y</literal></screen>
112
113 <para>Select the appropriate sub-options that appear when the above options
114 are selected.</para>
115
116 <indexterm zone="nfs-utils nfs-utils-kernel">
117 <primary sortas="d-nfs-utils">NFS Utilities</primary>
118 </indexterm>
119
120 </sect2>
121
122 <sect2 role="installation" id='nfs-utils-install'
123 xreflabel='NFS Utilities Installation'>
124 <title>Installation of NFS Utilities</title>
125
126 <para>Before you compile the program, ensure that the
127 <systemitem class="username">nobody</systemitem> user and
128 <systemitem class="groupname">nogroup</systemitem> group have been
129 created. You can add them by running the following commands as the
130 <systemitem class="username">root</systemitem> user:</para>
131
132<screen role="root"><userinput>groupadd -g 99 nogroup &amp;&amp;
133useradd -c "Unprivileged Nobody" -d /dev/null -g nogroup \
134 -s /bin/false -u 99 nobody</userinput></screen>
135
136 <note>
137 <para>The classic uid and gid values are 65534 which is also -2 when
138 interpreted as a signed 16-bit number. These values impact other files
139 on some filesystems that do not have support for sparse files. The
140 <systemitem class="username">nobody</systemitem> and <systemitem
141 class="groupname">nogroup</systemitem> values are relatively arbitrary.
142 The impact on a server is nil if the <filename>exports</filename> file
143 is configured correctly. If it is misconfigured, an
144 <command>ls -l</command> or <command>ps</command> listing will show a
145 uid or gid number of 65534 instead of a name. The client uses <systemitem
146 class="username">nobody</systemitem> only as the user running
147 <command>rpc.statd</command>.</para>
148 </note>
149
150 <para>Install <application>NFS Utilities</application> by running
151 the following commands:</para>
152
153<screen><userinput>LIBS=-lpthread ./configure --prefix=/usr \
154 --sysconfdir=/etc \
155 --without-tcp-wrappers \
156 --disable-nfsv4 \
157 --disable-nfsv41 \
158 --disable-gss &amp;&amp;
159make</userinput></screen>
160
161 <para>If your <filename class="directory">/usr</filename> directory
162 is NFS mounted, you should install the executables in
163 <filename class="directory">/sbin</filename> by passing
164 an additional parameter <option>--sbindir=/sbin</option> to the
165 above <command>./configure</command> command.</para>
166
167 <para>This package does not come with a test suite.</para>
168
169 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
170
171<screen role='root'><userinput>make install</userinput></screen>
172
173 </sect2>
174
175 <sect2 role="commands">
176 <title>Command Explanations</title>
177
178 <para><parameter>--disable-nfsv4</parameter> and
179 <parameter>--disable-nfsv41</parameter>: Disables support
180 for NFS version 4 and version 4.1.</para>
181
182 <para><parameter>--disable-gss</parameter>: Disables support for
183 RPCSEC GSS (RPC Security).</para>
184
185 <para><parameter>--without-tcp-wrappers</parameter>: This option is
186 only needed if the optional <xref linkend="tcpwrappers"/> is not installed.</para>
187
188 </sect2>
189
190 <sect2 role="configuration">
191 <title>Configuring NFS Utilities</title>
192
193 <sect3 id='nfs-utils-server-config'>
194 <title>Server Configuration</title>
195
196 <para><filename>/etc/exports</filename> contains the exported directories
197 on NFS servers. Refer to the <filename>exports.5</filename> manual page
198 for the syntax of this file. Also refer to the "NFS HowTo" available at
199 <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
200 how to configure the servers and clients in a secure manner. For example,
201 for sharing the <filename class="directory">/home</filename> directory
202 over the local network, the following line may be added:</para>
203
204<screen role="root"><userinput>/home <replaceable>&lt;192.168.0.0/24&gt;</replaceable>(rw,subtree_check,anonuid=99,anongid=99)</userinput></screen>
205
206 <indexterm zone="nfs-utils nfs-utils-server-config">
207 <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
208 </indexterm>
209
210 <sect4 id="nfs-utils-server-init">
211 <title>Boot Script</title>
212
213 <para>Install the <filename>/etc/rc.d/init.d/nfs-server</filename>
214 init script included in the <xref linkend="bootscripts"/> package
215 to start the server at boot.</para>
216
217<screen role="root"><userinput>make install-nfs-server</userinput></screen>
218
219 <indexterm zone="nfs-utils nfs-utils-server-init">
220 <primary sortas="f-nfs-server">nfs-server</primary>
221 </indexterm>
222
223 <para>Now create the <filename>/etc/sysconfig/nfs-server</filename>
224 configuration file:</para>
225
226<screen role="root"><userinput>cat &gt; /etc/sysconfig/nfs-server &lt;&lt; "EOF"
227<literal>PORT="2049"
228PROCESSES="8"
229QUOTAS="no"
230KILLDELAY="10"</literal>
231EOF</userinput></screen>
232
233 <note><para>The above parameters may be optionally placed in
234 <filename>/etc/sysconfig/rc.site</filename>.</para></note>
235
236 <indexterm zone="nfs-utils nfs-utils-server-init">
237 <primary
238 sortas="e-etc-sysconfig-nfs-server">/etc/sysconfig/nfs-server</primary>
239 </indexterm>
240
241 </sect4>
242
243 <sect4 id="nfs-utils-server-wrappers-support">
244 <title>tcpwrappers Configuration</title>
245
246 <para>If you have <xref linkend="tcpwrappers"/> installed and there
247 is a restrictive <filename>/etc/hosts.deny</filename> file, ensure you
248 have an entry in the <filename>/etc/hosts.allow</filename> file for access
249 from the rpcbind daemon. See the man page in section 5 for hosts_access for
250 details on creating appropriate rules.</para>
251
252 </sect4>
253
254 </sect3>
255
256 <sect3 id='nfs-utils-client-config'>
257 <title>Client Configuration</title>
258
259 <para><filename>/etc/fstab</filename> contains the directories that
260 are to be mounted on the client. Alternately the partitions can be
261 mounted by using the <command>mount</command> command with the proper
262 options. To mount the <filename class="directory">/home</filename>
263 and <filename class="directory">/usr</filename> partitions, add the
264 following to the <filename>/etc/fstab</filename>:</para>
265
266<screen role="root"><userinput><replaceable>&lt;server-name&gt;</replaceable>:/home /home nfs rw,_netdev,rsize=8192,wsize=8192 0 0
267<replaceable>&lt;server-name&gt;</replaceable>:/usr /usr nfs ro,_netdev,rsize=8192 0 0</userinput></screen>
268
269 <indexterm zone="nfs-utils nfs-utils-client-config">
270 <primary sortas="e-etc-fstab">/etc/fstab</primary>
271 </indexterm>
272
273 <sect4 id="nfs-utils-client-init">
274 <title>Boot Script</title>
275
276 <note><para>The following boot script is not required if the
277 nfs-server script is installed.</para></note>
278
279 <para>Install the <filename>/etc/rc.d/init.d/nfs-client</filename> init
280 script included in the <xref linkend="bootscripts"/> package to start
281 the client services at boot.</para>
282
283<screen role="root"><userinput>make install-nfs-client</userinput></screen>
284
285 <indexterm zone="nfs-utils nfs-utils-client-config">
286 <primary sortas="f-nfs-client">nfs-client</primary>
287 </indexterm>
288
289 <para>To automatically mount <systemitem
290 class="filesystem">nfs</systemitem> filesystems, clients will also need
291 to install the <filename>netfs</filename> bootscript as described in
292 <xref linkend="postlfs-config-netfs"/>.</para>
293
294 <indexterm zone="nfs-utils nfs-utils-client-config">
295 <primary sortas="f-netfs">netfs</primary>
296 </indexterm>
297
298 </sect4>
299
300 </sect3>
301
302 </sect2>
303
304 <sect2 role="content">
305 <title>Contents</title>
306 <segmentedlist>
307 <segtitle>Installed Programs</segtitle>
308 <segtitle>Installed Libraries</segtitle>
309 <segtitle>Installed Directories</segtitle>
310
311 <seglistitem>
312 <seg>exportfs, mountstats, mount.nfs, mount.nfs4 (link to mount.nfs),
313 nfsiostat, nfsstat, rpc.mountd, rpc.nfsd, rpc.statd, rpcdebug,
314 showmount, sm-notify, start-statd, umount.nfs (link to mount.nfs),
315 and umount.nfs4 (link to mount.nfs)</seg>
316 <seg>None</seg>
317 <seg>/var/lib/nfs</seg>
318 </seglistitem>
319 </segmentedlist>
320
321 <variablelist>
322 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
323 <?dbfo list-presentation="list"?>
324 <?dbhtml list-presentation="table"?>
325
326 <varlistentry id="exportfs">
327 <term><command>exportfs</command></term>
328 <listitem>
329 <para>maintains a list of NFS exported file systems.</para>
330 <indexterm zone="nfs-utils exportfs">
331 <primary sortas="b-exportfs">exportfs</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="mountstats">
337 <term><command>mountstats</command></term>
338 <listitem>
339 <para>displays NFS client per-mount statistics.</para>
340 <indexterm zone="nfs-utils mountstats">
341 <primary sortas="b-mountstats">mountstats</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="mountnfs">
347 <term><command>mount.nfs</command></term>
348 <listitem>
349 <para>Used to mount a network share using NFS</para>
350 <indexterm zone="nfs-utils mountnfs">
351 <primary sortas="b-mountnfs">mount.nfs</primary>
352 </indexterm>
353 </listitem>
354 </varlistentry>
355
356 <varlistentry id="mountnfs4">
357 <term><command>mount.nfs4</command></term>
358 <listitem>
359 <para>Used to mount a network share using NFSv4</para>
360 <indexterm zone="nfs-utils mountnfs4">
361 <primary sortas="b-mountnfs4">mount.nfs4</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="nfsiostat-nfs-utils">
367 <term><command>nfsiostat</command></term>
368 <listitem>
369 <para>Report input/output statistics for network filesystems.</para>
370 <indexterm zone="nfs-utils nfsiostat-nfs-utils">
371 <primary sortas="b-nfsiostat-nfs-utils">nfsiostat</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="nfsstat">
377 <term><command>nfsstat</command></term>
378 <listitem>
379 <para>displays statistics kept about NFS client and server activity.</para>
380 <indexterm zone="nfs-utils nfsstat">
381 <primary sortas="b-nfsstat">nfsstat</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="rpcmountd">
387 <term><command>rpc.mountd</command></term>
388 <listitem>
389 <para>implements the NFS mount protocol on an NFS server.</para>
390 <indexterm zone="nfs-utils rpcmountd">
391 <primary sortas="b-rpcmountd">rpc.mountd</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="rpcnfsd">
397 <term><command>rpc.nfsd</command></term>
398 <listitem>
399 <para>implements the user level part of the NFS
400 service on the server.</para>
401 <indexterm zone="nfs-utils rpcnfsd">
402 <primary sortas="b-rpcnfsd">rpc.nfsd</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="rpcstatd">
408 <term><command>rpc.statd</command></term>
409 <listitem>
410 <para>is used by the NFS file locking service. Run on both sides,
411 client as well as server, when you want file locking enabled.</para>
412 <indexterm zone="nfs-utils rpcstatd">
413 <primary sortas="b-rpcstatd">rpc.statd</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="rpcdebug">
419 <term><command>rpcdebug</command></term>
420 <listitem>
421 <para>sets or clears the kernel's NFS client and server debug
422 flags.</para>
423 <indexterm zone="nfs-utils rpcdebug">
424 <primary sortas="b-rpcdebug">rpcdebug</primary>
425 </indexterm>
426 </listitem>
427 </varlistentry>
428
429 <varlistentry id="showmount">
430 <term><command>showmount</command></term>
431 <listitem>
432 <para>displays mount information for an NFS server.</para>
433 <indexterm zone="nfs-utils showmount">
434 <primary sortas="b-showmount">showmount</primary>
435 </indexterm>
436 </listitem>
437 </varlistentry>
438
439 <varlistentry id="sm-notify">
440 <term><command>sm-notify</command></term>
441 <listitem>
442 <para>is used to send Network Status Monitor reboot messages.</para>
443 <indexterm zone="nfs-utils sm-notify">
444 <primary sortas="b-sm-notify">sm-notify</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="start-statd">
450 <term><command>start-statd</command></term>
451 <listitem>
452 <para>is a script called by nfsmount when mounting a filesystem with
453 locking enabled, if statd does not appear to be running. It can be
454 customised with whatever flags are appropriate for the site.</para>
455 <indexterm zone="nfs-utils start-statd">
456 <primary sortas="b-start-statd">start-statd</primary>
457 </indexterm>
458 </listitem>
459 </varlistentry>
460
461 <varlistentry id="umountnfs">
462 <term><command>umount.nfs</command></term>
463 <listitem>
464 <para>Used to unmount a network share using NFS</para>
465 <indexterm zone="nfs-utils umountnfs">
466 <primary sortas="b-umountnfs">umount.nfs</primary>
467 </indexterm>
468 </listitem>
469 </varlistentry>
470
471 <varlistentry id="umountnfs4">
472 <term><command>umount.nfs4</command></term>
473 <listitem>
474 <para>Used to unmount a network share using NFSv4</para>
475 <indexterm zone="nfs-utils umountnfs4">
476 <primary sortas="b-umountnfs4">umount.nfs4</primary>
477 </indexterm>
478 </listitem>
479 </varlistentry>
480
481 </variablelist>
482
483 </sect2>
484
485</sect1>
Note: See TracBrowser for help on using the repository browser.