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

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 7fdeb26 was 7fdeb26, checked in by Krejzi <krejzi@…>, 12 years ago

remove heimdal kerberos. one kerberos implementation is enough for BLFS

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