close bug [ 1018450 ] typo.
[nfs-utils.git] / utils / exportfs / exports.man
1 .TH EXPORTS 5 "4 March 2005" "Linux" "Linux File Formats Manual"
2 .SH NAME
3 exports \- NFS file systems being exported (for Kernel based NFS)
4 .SH SYNOPSIS
5 .B /etc/exports
6 .SH DESCRIPTION
7 The file
8 .I /etc/exports
9 serves as the access control list for file systems which may be
10 exported to NFS clients.  It is used by
11 .IR exportfs (8)
12 to give information to
13 .IR mountd (8)
14 and to the kernel based NFS file server daemon
15 .IR nfsd (8).
16 .PP
17 The file format is similar to the SunOS
18 .I exports
19 file. Each line contains an export point and a whitespace-separated list
20 of clients allowed to mount the file system at that point. Each listed
21 client may be immediately followed by a parenthesized, comma-separated
22 list of export options for that client. No whitespace is permitted
23 between a client and its option list.
24 .PP
25 Blank lines are ignored.  A pound sign ("#") introduces a comment to the
26 end of the line. Entries may be continued across newlines using a
27 backslash. If an export name contains spaces it should be quoted using
28 double quotes. You can also specify spaces or other unusual character in
29 the export name using a backslash followed by the character code as three
30 octal digits.
31 .PP
32 .SS Machine Name Formats
33 NFS clients may be specified in a number of ways:
34 .IP "single host
35 This is the most common format. You may specify a host either by an
36 abbreviated name recognized be the resolver, the fully qualified domain
37 name, or an IP address.
38 .IP "netgroups
39 NIS netgroups may be given as
40 .IR @group .
41 Only the host part of each
42 netgroup members is consider in checking for membership.  Empty host
43 parts or those containing a single dash (\-) are ignored.
44 .IP "wildcards
45 Machine names may contain the wildcard characters \fI*\fR and \fI?\fR.
46 This can be used to make the \fIexports\fR file more compact; for instance,
47 \fI*.cs.foo.edu\fR matches all hosts in the domain
48 \fIcs.foo.edu\fR.  As these characters also match the dots in a domain
49 name, the given pattern will also match all hosts within any subdomain
50 of \fIcs.foo.edu\fR.
51 .IP "IP networks
52 You can also export directories to all hosts on an IP (sub-) network
53 simultaneously. This is done by specifying an IP address and netmask pair
54 as
55 .IR address/netmask
56 where the netmask can be specified in dotted-decimal format, or as a
57 contiguous mask length (for example, either `/255.255.252.0' or `/22' appended
58 to the network base address result in identical subnetworks with 10 bits of
59 host). Wildcard characters generally do not work on IP addresses, though they
60 may work by accident when reverse DNS lookups fail.
61 '''.TP
62 '''.B =public
63 '''This is a special ``hostname'' that identifies the given directory name
64 '''as the public root directory (see the section on WebNFS in
65 '''.BR nfsd (8)
66 '''for a discussion of WebNFS and the public root handle). When using this
67 '''convention,
68 '''.B =public
69 '''must be the only entry on this line, and must have no export options
70 '''associated with it. Note that this does
71 '''.I not
72 '''actually export the named directory; you still have to set the exports
73 '''options in a separate entry.
74 '''.PP
75 '''The public root path can also be specified by invoking
76 '''.I nfsd
77 '''with the
78 '''.B \-\-public\-root
79 '''option. Multiple specifications of a public root will be ignored.
80 .PP
81 .SS RPCSEC_GSS security
82 To restrict access to an export using rpcsec_gss security, use the special
83 string "gss/krb5" as the client.  It is not possible to simultaneously require
84 rpcsec_gss and to make requirements on the IP address of the client.
85 .PP
86 .SS General Options
87 .IR exportfs
88 understands the following export options:
89 .TP
90 .IR secure "\*d
91 This option requires that requests originate on an internet port less
92 than IPPORT_RESERVED (1024). This option is on by default. To turn it
93 off, specify
94 .IR insecure .
95 .TP
96 .IR rw
97 Allow both read and write requests on this NFS volume. The
98 default is to disallow any request which changes the filesystem.
99 This can also be made explicit by using
100 the
101 .IR ro " option.
102 .TP
103 .IR async
104 This option allows the NFS server to violate the NFS protocol and
105 reply to requests before any changes made by that request have been
106 committed to stable storage (e.g. disc drive).
107
108 Using this option usually improves performance, but at the cost that
109 an unclean server restart (i.e. a crash) can cause data to be lost or
110 corrupted.
111
112 In releases of nfs-utils upto and including 1.0.0, this option was the
113 default.  In this and future releases,
114 .I sync
115 is the default, and
116 .I async
117 must be explicit requested if needed.
118 To help make system adminstrators aware of this change, 'exportfs'
119 will issue a warning if neither
120 .I sync
121 nor
122 .I async
123 is specified.
124 .TP
125 .IR no_wdelay
126 This option has no effect if
127 .I async
128 is also set.  The NFS server will normally delay committing a write request
129 to disc slightly if it suspects that another related write request may be in
130 progress or may arrive soon.  This allows multiple write requests to
131 be committed to disc with the one operation which can improve
132 performance.  If an NFS server received mainly small unrelated
133 requests, this behaviour could actually reduce performance, so
134 .IR no_wdelay
135 is available to turn it off.
136 The default can be explicitly requested with the
137 .IR wdelay " option.
138 .TP
139 .IR nohide
140 This option is based on the option of the same name provided in IRIX
141 NFS.  Normally, if a server exports two filesystems one of which is
142 mounted on the other, then the client will have to mount both
143 filesystems explicitly to get access to them.  If it just mounts the
144 parent, it will see an empty directory at the place where the other
145 filesystem is mounted.  That filesystem is "hidden".
146
147 Setting the
148 .I nohide
149 option on a filesystem causes it not to be hidden, and an
150 appropriately authorised client will be able to move from the parent to
151 that filesystem without noticing the change.
152
153 However, some NFS clients do not cope well with this situation as, for
154 instance, it is then possible for two files in the one apparent
155 filesystem to have the same inode number.
156
157 The
158 .I nohide
159 option is currently only effective on
160 .I "single host
161 exports.  It does not work reliably with netgroup, subnet, or wildcard
162 exports. 
163
164 This option can be very useful in some situations, but it should be
165 used with due care, and only after confirming that the client system
166 copes with the situation effectively.
167
168 The option can be explicitly disabled with
169 .IR hide .
170 .TP
171 .IR no_subtree_check
172 This option disables subtree checking, which has mild security
173 implications, but can improve reliability in some circumstances.
174
175 If a subdirectory of a filesystem is exported, but the whole
176 filesystem isn't then whenever a NFS request arrives, the server must
177 check not only that the accessed file is in the appropriate filesystem
178 (which is easy) but also that it is in the exported tree (which is
179 harder). This check is called the
180 .IR subtree_check .
181
182 In order to perform this check, the server must include some
183 information about the location of the file in the "filehandle" that is
184 given to the client.  This can cause problems with accessing files that
185 are renamed while a client has them open (though in many simple cases
186 it will still work).
187
188 subtree checking is also used to make sure that files inside
189 directories to which only root has access can only be accessed if the
190 filesystem is exported with
191 .I no_root_squash
192 (see below), even if the file itself allows more general access.
193
194 As a general guide, a home directory filesystem, which is normally
195 exported at the root and may see lots of file renames, should be
196 exported with subtree checking disabled.  A filesystem which is mostly
197 readonly, and at least doesn't see many file renames (e.g. /usr or
198 /var) and for which subdirectories may be exported, should probably be
199 exported with subtree checks enabled.
200
201 The default of having subtree checks enabled, can be explicitly
202 requested with
203 .IR subtree_check .
204
205 .TP
206 .IR insecure_locks
207 .TP
208 .IR no_auth_nlm
209 This option (the two names are synonymous) tells the NFS server not to require authentication of
210 locking requests (i.e. requests which use the NLM protocol).  Normally
211 the NFS server will require a lock request to hold a credential for a
212 user who has read access to the file.  With this flag no access checks
213 will be performed.
214
215 Early NFS client implementations did not send credentials with lock
216 requests, and many current NFS clients still exist which are based on
217 the old implementations.  Use this flag if you find that you can only
218 lock files which are world readable.
219
220 The default behaviour of requiring authentication for NLM requests can
221 be explicitly requested with either of the synonymous
222 .IR auth_nlm ,
223 or
224 .IR secure_locks .
225
226 '''.TP
227 '''.I noaccess
228 '''This makes everything below the directory inaccessible for the named
229 '''client.  This is useful when you want to export a directory hierarchy to
230 '''a client, but exclude certain subdirectories. The client's view of a
231 '''directory flagged with noaccess is very limited; it is allowed to read
232 '''its attributes, and lookup `.' and `..'. These are also the only entries
233 '''returned by a readdir.
234 '''.TP
235 '''.IR link_relative
236 '''Convert absolute symbolic links (where the link contents start with a
237 '''slash) into relative links by prepending the necessary number of ../'s
238 '''to get from the directory containing the link to the root on the
239 '''server.  This has subtle, perhaps questionable, semantics when the file
240 '''hierarchy is not mounted at its root.
241 '''.TP
242 '''.IR link_absolute
243 '''Leave all symbolic link as they are. This is the default operation.
244
245 .TP
246 .IR mountpoint= path
247 .TP
248 .I mp
249 This option makes it possible to only export a directory if it has
250 successfully been mounted.
251 If no path is given (e.g.
252 .IR mountpoint " or " mp )
253 then the export point must also be a mount point.  If it isn't then
254 the export point is not exported.  This allows you to be sure that the
255 directory underneath a mountpoint will never be exported by accident
256 if, for example, the filesystem failed to mount due to a disc error.
257
258 If a path is given (e.g.
259 .IR mountpoint= "/path or " mp= /path)
260 then the nominted path must be a mountpoint for the exportpoint to be
261 exported.
262
263 .TP
264 .IR fsid= num
265 This option forces the filesystem identification portion of the file
266 handle and file attributes used on the wire to be
267 .I num
268 instead of a number derived from the major and minor number of the
269 block device on which the filesystem is mounted.  Any 32 bit number
270 can be used, but it must be unique amongst all the exported filesystems.
271
272 This can be useful for NFS failover, to ensure that both servers of
273 the failover pair use the same NFS file handles for the shared filesystem
274 thus avoiding stale file handles after failover.
275
276 Some Linux filesystems are not mounted on a block device; exporting
277 these via NFS requires the use of the
278 .I fsid
279 option (although that may still not be enough).
280
281 The value  0 has a special meaning when use with NFSv4.  NFSv4 has a
282 concept of a root of the overall exported filesystem. The export point
283 exported with fsid=0 will be used as this root.
284
285 .SS User ID Mapping
286 .PP
287 .I nfsd
288 bases its access control to files on the server machine on the uid and
289 gid provided in each NFS RPC request. The normal behavior a user would
290 expect is that she can access her files on the server just as she would
291 on a normal file system. This requires that the same uids and gids are
292 used on the client and the server machine. This is not always true, nor
293 is it always desirable.
294 .PP
295 Very often, it is not desirable that the root user on a client machine
296 is also treated as root when accessing files on the NFS server. To this
297 end, uid 0 is normally mapped to a different id: the so-called
298 anonymous or
299 .I nobody
300 uid. This mode of operation (called `root squashing') is the default,
301 and can be turned off with
302 .IR no_root_squash .
303 .PP
304 By default,
305 '''.I nfsd
306 '''tries to obtain the anonymous uid and gid by looking up user
307 '''.I nobody
308 '''in the password file at startup time. If it isn't found, a uid and gid
309 .I exportfs
310 chooses a uid and gid
311 of -2 (i.e. 65534) for squashed access. These values can also be overridden by
312 the
313 .IR anonuid " and " anongid
314 options.
315 '''.PP
316 '''In addition to this, 
317 '''.I nfsd
318 '''lets you specify arbitrary uids and gids that should be mapped to user
319 '''nobody as well.
320 Finally, you can map all user requests to the
321 anonymous uid by specifying the
322 .IR all_squash " option.
323 '''.PP 
324 '''For the benefit of installations where uids differ between different
325 '''machines, 
326 '''.I nfsd
327 '''provides several mechanism to dynamically map server uids to client
328 '''uids and vice versa: static mapping files, NIS-based mapping, and
329 '''.IR ugidd -based
330 '''mapping.
331 '''.PP
332 '''.IR ugidd -based
333 '''mapping is enabled with the 
334 '''.I map_daemon
335 '''option, and uses the UGID RPC protocol. For this to work, you have to run
336 '''the
337 '''.IR ugidd (8)
338 '''mapping daemon on the client host. It is the least secure of the three methods,
339 '''because by running
340 '''.IR ugidd ,
341 '''everybody can query the client host for a list of valid user names. You
342 '''can protect yourself by restricting access to
343 '''.I ugidd
344 '''to valid hosts only. This can be done by entering the list of valid
345 '''hosts into the
346 '''.I hosts.allow
347 '''or 
348 '''.I hosts.deny
349 '''file. The service name is
350 '''.IR ugidd .
351 '''For a description of the file's syntax, please read
352 '''.IR hosts_access (5).
353 '''.PP
354 '''Static mapping is enabled by using the
355 '''.I map_static
356 '''option, which takes a file name as an argument that describes the mapping.
357 '''NIS-based mapping queries the client's NIS server to obtain a mapping from
358 '''user and group names on the server host to user and group names on the
359 '''client.
360 .PP
361 Here's the complete list of mapping options:
362 .TP
363 .IR root_squash
364 Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does
365 not apply to any other uids that might be equally sensitive, such as user
366 .IR bin .
367 .TP
368 .IR no_root_squash
369 Turn off root squashing. This option is mainly useful for diskless clients.
370 '''.TP
371 '''.IR squash_uids " and " squash_gids
372 '''This option specifies a list of uids or gids that should be subject to
373 '''anonymous mapping. A valid list of ids looks like this:
374 '''.IP
375 '''.IR squash_uids=0-15,20,25-50
376 '''.IP
377 '''Usually, your squash lists will look a lot simpler.
378 .TP
379 .IR all_squash
380 Map all uids and gids to the anonymous user. Useful for NFS-exported
381 public FTP directories, news spool directories, etc. The opposite option
382 is 
383 .IR no_all_squash ,
384 which is the default setting.
385 '''.TP
386 '''.IR map_daemon
387 '''This option turns on dynamic uid/gid mapping. Each uid in an NFS request
388 '''will be translated to the equivalent server uid, and each uid in an
389 '''NFS reply will be mapped the other way round. This option requires that
390 '''.IR rpc.ugidd (8)
391 '''runs on the client host. The default setting is
392 '''.IR map_identity ,
393 '''which leaves all uids untouched. The normal squash options apply regardless
394 '''of whether dynamic mapping is requested or not.
395 '''.TP
396 '''.IR map_static
397 '''This option enables static mapping. It specifies the name of the file
398 '''that describes the uid/gid mapping, e.g.
399 '''.IP
400 '''.IR map_static=/etc/nfs/foobar.map
401 '''.IP
402 '''The file's format looks like this
403 '''.IP
404 '''.nf
405 '''.ta +3i
406 '''# Mapping for client foobar:
407 '''#    remote     local
408 '''uid  0-99       -       # squash these
409 '''uid  100-500    1000    # map 100-500 to 1000-1400
410 '''gid  0-49       -       # squash these
411 '''gid  50-100     700     # map 50-100 to 700-750
412 '''.fi
413 '''.TP
414 '''.IR map_nis
415 '''This option enables NIS-based uid/gid mapping. For instance, when
416 '''the server encounters the uid 123 on the server, it will obtain the
417 '''login name associated with it, and contact the NFS client's NIS server
418 '''to obtain the uid the client associates with the name.
419 '''.IP
420 '''In order to do this, the NFS server must know the client's NIS domain.
421 '''This is specified as an argument to the
422 '''.I map_nis
423 '''options, e.g.
424 '''.IP
425 '''.I map_nis=foo.com
426 '''.IP
427 '''Note that it may not be sufficient to simply specify the NIS domain
428 '''here; you may have to take additional actions before
429 '''.I nfsd
430 '''is actually able to contact the server. If your distribution uses
431 '''the NYS library, you can specify one or more NIS servers for the
432 '''client's domain in
433 '''.IR /etc/yp.conf .
434 '''If you are using a different NIS library, you may have to obtain a
435 '''special
436 '''.IR ypbind (8)
437 '''daemon that can be configured via
438 '''.IR yp.conf .
439 .TP
440 .IR anonuid " and " anongid
441 These options explicitly set the uid and gid of the anonymous account.
442 This option is primarily useful for PC/NFS clients, where you might want
443 all requests appear to be from one user. As an example, consider the
444 export entry for
445 .B /home/joe
446 in the example section below, which maps all requests to uid 150 (which
447 is supposedly that of user joe).
448 .IP
449 .SH EXAMPLE
450 .PP
451 .nf
452 .ta +3i
453 # sample /etc/exports file
454 /               master(rw) trusty(rw,no_root_squash)
455 /projects       proj*.local.domain(rw)
456 /usr            *.local.domain(ro) @trusted(rw)
457 /home/joe       pc001(rw,all_squash,anonuid=150,anongid=100)
458 /pub            (ro,insecure,all_squash)
459 '''/pub/private    (noaccess)
460 .fi
461 .PP
462 The first line exports the entire filesystem to machines master and trusty.
463 In addition to write access, all uid squashing is turned off for host
464 trusty. The second and third entry show examples for wildcard hostnames
465 and netgroups (this is the entry `@trusted'). The fourth line shows the
466 entry for the PC/NFS client discussed above. Line 5 exports the
467 public FTP directory to every host in the world, executing all requests
468 under the nobody account. The
469 .I insecure 
470 option in this entry also allows clients with NFS implementations that
471 don't use a reserved port for NFS.
472 ''' The last line denies all NFS clients
473 '''access to the private directory.
474 '''.SH CAVEATS
475 '''Unlike other NFS server implementations, this
476 '''.I nfsd
477 '''allows you to export both a directory and a subdirectory thereof to
478 '''the same host, for instance 
479 '''.IR /usr " and " /usr/X11R6 .
480 '''In this case, the mount options of the most specific entry apply. For
481 '''instance, when a user on the client host accesses a file in 
482 '''.IR /usr/X11R6 ,
483 '''the mount options given in the 
484 '''.I /usr/X11R6 
485 '''entry apply. This is also true when the latter is a wildcard or netgroup
486 '''entry.
487 .SH FILES
488 /etc/exports
489 .SH SEE ALSO
490 .BR exportfs (8),
491 .BR netgroup (5),
492 .BR mountd (8),
493 .BR nfsd (8),
494 .BR showmount (8).
495 '''.SH DIAGNOSTICS
496 '''An error parsing the file is reported using syslogd(8) as level NOTICE from
497 '''a DAEMON whenever nfsd(8) or mountd(8) is started up.  Any unknown
498 '''host is reported at that time, but often not all hosts are not yet known
499 '''to named(8) at boot time, thus as hosts are found they are reported
500 '''with the same syslogd(8) parameters.