source: networking/netprogs/nfs-utils.xml@ 7d1f411c

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

Added rpcbind-0.2.0
Changed libtirpc to install dynamic libraries in /lib
Partial changes to TeX Live

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@9030 af4574ff-66df-0310-9fd7-8a98e5e911e0

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