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