source: server/major/nfs-utils.xml@ fce275e

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 fce275e was fce275e, checked in by Randy McMurchy <randy@…>, 16 years ago

Modified all the Sourceforge download URLs to use a newly created entity instead of a hard-coded URL

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