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

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 ed6a289c was ed6a289c, checked in by Bruce Dubbs <bdubbs@…>, 12 years ago

Updated nfs related bootscripts.
Removed portmap in favor of rpcbind.
Updated instructions for rpcbind and nfs-utils.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@9048 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 17.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 "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>./configure --prefix=/usr \
154 --sysconfdir=/etc \
155 --disable-nfsv4 \
156 --disable-nfsv41 \
157 --disable-gss &amp;&amp;
158make</userinput></screen>
159
160 <para>If your <filename class="directory">/usr</filename> directory
161 is NFS mounted, you should install the executables in
162 <filename class="directory">/sbin</filename> by passing
163 an additional parameter <option>--sbindir=/sbin</option> to the
164 above <command>./configure</command> command.</para>
165
166 <para>This package does not come with a test suite.</para>
167
168 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
169
170<screen role='root'><userinput>make install</userinput></screen>
171
172 </sect2>
173
174 <sect2 role="commands">
175 <title>Command Explanations</title>
176
177 <para><parameter>--disable-nfsv4</parameter> and
178 <parameter>--disable-nfsv41</parameter>: Disables support
179 for NFS version 4 and version 4.1.</para>
180
181 <para><parameter>--disable-gss</parameter>: Disables support for
182 RPCSEC GSS (RPC Security).</para>
183
184 </sect2>
185
186 <sect2 role="configuration">
187 <title>Configuring NFS Utilities</title>
188
189 <sect3 id='nfs-utils-server-config'>
190 <title>Server Configuration</title>
191
192 <para><filename>/etc/exports</filename> contains the exported directories
193 on NFS servers. Refer to the <filename>exports.5</filename> manual page
194 for the syntax of this file. Also refer to the "NFS HowTo" available at
195 <ulink url="http://nfs.sourceforge.net/nfs-howto/"/> for information on
196 how to configure the servers and clients in a secure manner. For example,
197 for sharing the <filename class="directory">/home</filename> directory
198 over the local network, the following line may be added:</para>
199
200<screen role="root"><userinput>/home <replaceable>&lt;192.168.0.0/24&gt;</replaceable>(rw,subtree_check,anonuid=99,anongid=99)</userinput></screen>
201
202 <indexterm zone="nfs-utils nfs-utils-server-config">
203 <primary sortas="e-etc-exportfs">/etc/exportfs</primary>
204 </indexterm>
205
206 <sect4 id="nfs-utils-server-init">
207 <title>Boot Script</title>
208
209 <para>Install the <filename>/etc/rc.d/init.d/nfs-server</filename>
210 init script included in the <xref linkend="bootscripts"/> package
211 to start the server at boot.</para>
212
213<screen role="root"><userinput>make install-nfs-server</userinput></screen>
214
215 <indexterm zone="nfs-utils nfs-utils-server-init">
216 <primary sortas="f-nfs-server">nfs-server</primary>
217 </indexterm>
218
219 <para>Now create the <filename>/etc/sysconfig/nfs-server</filename>
220 configuration file:</para>
221
222<screen role="root"><userinput>cat &gt; /etc/sysconfig/nfs-server &lt;&lt; "EOF"
223<literal>PORT="2049"
224PROCESSES="8"
225QUOTAS="no"
226KILLDELAY="10"</literal>
227EOF</userinput></screen>
228
229 <note><para>The above parameters may be optionally placed in
230 <filename>/etc/sysconfig/rc.site</filename>.</para></note>
231
232 <indexterm zone="nfs-utils nfs-utils-server-init">
233 <primary
234 sortas="e-etc-sysconfig-nfs-server">/etc/sysconfig/nfs-server</primary>
235 </indexterm>
236
237 </sect4>
238
239 <sect4 id="nfs-utils-server-wrappers-support">
240 <title>tcpwrappers Configuration</title>
241
242 <para>If you have <xref linkend="tcpwrappers"/> installed and there
243 is a restrictive <filename>/etc/hosts.deny</filename> file, ensure you
244 have an entry in the <filename>/etc/hosts.allow</filename> file for access
245 from the rpcbind daemon. See the man page in section 5 for hosts_access for
246 details on creating appropriate rules.</para>
247
248 </sect4>
249
250 </sect3>
251
252 <sect3 id='nfs-utils-client-config'>
253 <title>Client Configuration</title>
254
255 <para><filename>/etc/fstab</filename> contains the directories that
256 are to be mounted on the client. Alternately the partitions can be
257 mounted by using the <command>mount</command> command with the proper
258 options. To mount the <filename class="directory">/home</filename>
259 and <filename class="directory">/usr</filename> partitions, add the
260 following to the <filename>/etc/fstab</filename>:</para>
261
262<screen role="root"><userinput><replaceable>&lt;server-name&gt;</replaceable>:/home /home nfs rw,_netdev,rsize=8192,wsize=8192 0 0
263<replaceable>&lt;server-name&gt;</replaceable>:/usr /usr nfs ro,_netdev,rsize=8192 0 0</userinput></screen>
264
265 <indexterm zone="nfs-utils nfs-utils-client-config">
266 <primary sortas="e-etc-fstab">/etc/fstab</primary>
267 </indexterm>
268
269 <sect4 id="nfs-utils-client-init">
270 <title>Boot Script</title>
271
272 <note><para>The following boot script is not required if the
273 nfs-server script is installed.</para></note>
274
275 <para>Install the <filename>/etc/rc.d/init.d/nfs-client</filename> init
276 script included in the <xref linkend="bootscripts"/> package to start
277 the client services at boot.</para>
278
279<screen role="root"><userinput>make install-nfs-client</userinput></screen>
280
281 <indexterm zone="nfs-utils nfs-utils-client-config">
282 <primary sortas="f-nfs-client">nfs-client</primary>
283 </indexterm>
284
285 <para>To automatically mount <systemitem
286 class="filesystem">nfs</systemitem> filesystems, clients will also need
287 to install the <filename>netfs</filename> bootscript as described in
288 <xref linkend="postlfs-config-netfs"/>.</para>
289
290 <indexterm zone="nfs-utils nfs-utils-client-config">
291 <primary sortas="f-netfs">netfs</primary>
292 </indexterm>
293
294 </sect4>
295
296 </sect3>
297
298 </sect2>
299
300 <sect2 role="content">
301 <title>Contents</title>
302 <segmentedlist>
303 <segtitle>Installed Programs</segtitle>
304 <segtitle>Installed Libraries</segtitle>
305 <segtitle>Installed Directories</segtitle>
306
307 <seglistitem>
308 <seg>exportfs, mountstats, mount.nfs, mount.nfs4 (link to mount.nfs),
309 nfsiostat, nfsstat, rpc.mountd, rpc.nfsd, rpc.statd, rpcdebug,
310 showmount, sm-notify, start-statd, umount.nfs (link to mount.nfs),
311 and umount.nfs4 (link to mount.nfs)</seg>
312 <seg>None</seg>
313 <seg>/var/lib/nfs</seg>
314 </seglistitem>
315 </segmentedlist>
316
317 <variablelist>
318 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
319 <?dbfo list-presentation="list"?>
320 <?dbhtml list-presentation="table"?>
321
322 <varlistentry id="exportfs">
323 <term><command>exportfs</command></term>
324 <listitem>
325 <para>maintains a list of NFS exported file systems.</para>
326 <indexterm zone="nfs-utils exportfs">
327 <primary sortas="b-exportfs">exportfs</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="mountstats">
333 <term><command>mountstats</command></term>
334 <listitem>
335 <para>displays NFS client per-mount statistics.</para>
336 <indexterm zone="nfs-utils mountstats">
337 <primary sortas="b-mountstats">mountstats</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="mountnfs">
343 <term><command>mount.nfs</command></term>
344 <listitem>
345 <para>Used to mount a network share using NFS</para>
346 <indexterm zone="nfs-utils mountnfs">
347 <primary sortas="b-mountnfs">mount.nfs</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="mountnfs4">
353 <term><command>mount.nfs4</command></term>
354 <listitem>
355 <para>Used to mount a network share using NFSv4</para>
356 <indexterm zone="nfs-utils mountnfs4">
357 <primary sortas="b-mountnfs4">mount.nfs4</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="nfsiostat-nfs-utils">
363 <term><command>nfsiostat</command></term>
364 <listitem>
365 <para>Report input/output statistics for network filesystems.</para>
366 <indexterm zone="nfs-utils nfsiostat-nfs-utils">
367 <primary sortas="b-nfsiostat-nfs-utils">nfsiostat</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="nfsstat">
373 <term><command>nfsstat</command></term>
374 <listitem>
375 <para>displays statistics kept about NFS client and server activity.</para>
376 <indexterm zone="nfs-utils nfsstat">
377 <primary sortas="b-nfsstat">nfsstat</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="rpcmountd">
383 <term><command>rpc.mountd</command></term>
384 <listitem>
385 <para>implements the NFS mount protocol on an NFS server.</para>
386 <indexterm zone="nfs-utils rpcmountd">
387 <primary sortas="b-rpcmountd">rpc.mountd</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="rpcnfsd">
393 <term><command>rpc.nfsd</command></term>
394 <listitem>
395 <para>implements the user level part of the NFS
396 service on the server.</para>
397 <indexterm zone="nfs-utils rpcnfsd">
398 <primary sortas="b-rpcnfsd">rpc.nfsd</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402
403 <varlistentry id="rpcstatd">
404 <term><command>rpc.statd</command></term>
405 <listitem>
406 <para>is used by the NFS file locking service. Run on both sides,
407 client as well as server, when you want file locking enabled.</para>
408 <indexterm zone="nfs-utils rpcstatd">
409 <primary sortas="b-rpcstatd">rpc.statd</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="rpcdebug">
415 <term><command>rpcdebug</command></term>
416 <listitem>
417 <para>sets or clears the kernel's NFS client and server debug
418 flags.</para>
419 <indexterm zone="nfs-utils rpcdebug">
420 <primary sortas="b-rpcdebug">rpcdebug</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424
425 <varlistentry id="showmount">
426 <term><command>showmount</command></term>
427 <listitem>
428 <para>displays mount information for an NFS server.</para>
429 <indexterm zone="nfs-utils showmount">
430 <primary sortas="b-showmount">showmount</primary>
431 </indexterm>
432 </listitem>
433 </varlistentry>
434
435 <varlistentry id="sm-notify">
436 <term><command>sm-notify</command></term>
437 <listitem>
438 <para>is used to send Network Status Monitor reboot messages.</para>
439 <indexterm zone="nfs-utils sm-notify">
440 <primary sortas="b-sm-notify">sm-notify</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="start-statd">
446 <term><command>start-statd</command></term>
447 <listitem>
448 <para>is a script called by nfsmount when mounting a filesystem with
449 locking enabled, if statd does not appear to be running. It can be
450 customised with whatever flags are appropriate for the site.</para>
451 <indexterm zone="nfs-utils start-statd">
452 <primary sortas="b-start-statd">start-statd</primary>
453 </indexterm>
454 </listitem>
455 </varlistentry>
456
457 <varlistentry id="umountnfs">
458 <term><command>umount.nfs</command></term>
459 <listitem>
460 <para>Used to unmount a network share using NFS</para>
461 <indexterm zone="nfs-utils umountnfs">
462 <primary sortas="b-umountnfs">umount.nfs</primary>
463 </indexterm>
464 </listitem>
465 </varlistentry>
466
467 <varlistentry id="umountnfs4">
468 <term><command>umount.nfs4</command></term>
469 <listitem>
470 <para>Used to unmount a network share using NFSv4</para>
471 <indexterm zone="nfs-utils umountnfs4">
472 <primary sortas="b-umountnfs4">umount.nfs4</primary>
473 </indexterm>
474 </listitem>
475 </varlistentry>
476
477 </variablelist>
478
479 </sect2>
480
481</sect1>
Note: See TracBrowser for help on using the repository browser.