4e3edc55123b78c424ca853bac1d03741f5a66c3
[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, the
149 .I async 
150 option was the
151 default.  In all releases after 1.0.0,
152 .I sync
153 is the default, and
154 .I async
155 must be explicitly requested if needed.
156 To help make system administrators aware of this change,
157 .B exportfs
158 will issue a warning if neither
159 .I sync
160 nor
161 .I async
162 is specified.
163 .TP
164 .IR no_wdelay
165 This option has no effect if
166 .I async
167 is also set.  The NFS server will normally delay committing a write request
168 to disc slightly if it suspects that another related write request may be in
169 progress or may arrive soon.  This allows multiple write requests to
170 be committed to disc with the one operation which can improve
171 performance.  If an NFS server received mainly small unrelated
172 requests, this behaviour could actually reduce performance, so
173 .IR no_wdelay
174 is available to turn it off.
175 The default can be explicitly requested with the
176 .IR wdelay " option.
177 .TP
178 .IR nohide
179 This option is based on the option of the same name provided in IRIX
180 NFS.  Normally, if a server exports two filesystems one of which is
181 mounted on the other, then the client will have to mount both
182 filesystems explicitly to get access to them.  If it just mounts the
183 parent, it will see an empty directory at the place where the other
184 filesystem is mounted.  That filesystem is "hidden".
185
186 Setting the
187 .I nohide
188 option on a filesystem causes it not to be hidden, and an
189 appropriately authorised client will be able to move from the parent to
190 that filesystem without noticing the change.
191
192 However, some NFS clients do not cope well with this situation as, for
193 instance, it is then possible for two files in the one apparent
194 filesystem to have the same inode number.
195
196 The
197 .I nohide
198 option is currently only effective on
199 .I "single host
200 exports.  It does not work reliably with netgroup, subnet, or wildcard
201 exports.
202
203 This option can be very useful in some situations, but it should be
204 used with due care, and only after confirming that the client system
205 copes with the situation effectively.
206
207 The option can be explicitly disabled with
208 .IR hide .
209 .TP
210 .IR crossmnt
211 This option is similar to
212 .I nohide
213 but it makes it possible for clients to move from the filesystem marked
214 with crossmnt to exported filesystems mounted on it.  Thus when a child
215 filesystem "B" is mounted on a parent "A", setting crossmnt on "A" has
216 the same effect as setting "nohide" on B.
217 .TP
218 .IR no_subtree_check
219 This option disables subtree checking, which has mild security
220 implications, but can improve reliability in some circumstances.
221
222 If a subdirectory of a filesystem is exported, but the whole
223 filesystem isn't then whenever a NFS request arrives, the server must
224 check not only that the accessed file is in the appropriate filesystem
225 (which is easy) but also that it is in the exported tree (which is
226 harder). This check is called the
227 .IR subtree_check .
228
229 In order to perform this check, the server must include some
230 information about the location of the file in the "filehandle" that is
231 given to the client.  This can cause problems with accessing files that
232 are renamed while a client has them open (though in many simple cases
233 it will still work).
234
235 subtree checking is also used to make sure that files inside
236 directories to which only root has access can only be accessed if the
237 filesystem is exported with
238 .I no_root_squash
239 (see below), even if the file itself allows more general access.
240
241 As a general guide, a home directory filesystem, which is normally
242 exported at the root and may see lots of file renames, should be
243 exported with subtree checking disabled.  A filesystem which is mostly
244 readonly, and at least doesn't see many file renames (e.g. /usr or
245 /var) and for which subdirectories may be exported, should probably be
246 exported with subtree checks enabled.
247
248 The default of having subtree checks enabled, can be explicitly
249 requested with
250 .IR subtree_check .
251
252 From release 1.1.0 of nfs-utils onwards, the default will be
253 .I no_subtree_check
254 as subtree_checking tends to cause more problems than it is worth.
255 If you genuinely require subtree checking, you should explicitly put
256 that option in the
257 .B exports
258 file.  If you put neither option,
259 .B exportfs
260 will warn you that the change is pending.
261
262 .TP
263 .IR insecure_locks
264 .TP
265 .IR no_auth_nlm
266 This option (the two names are synonymous) tells the NFS server not to require authentication of
267 locking requests (i.e. requests which use the NLM protocol).  Normally
268 the NFS server will require a lock request to hold a credential for a
269 user who has read access to the file.  With this flag no access checks
270 will be performed.
271
272 Early NFS client implementations did not send credentials with lock
273 requests, and many current NFS clients still exist which are based on
274 the old implementations.  Use this flag if you find that you can only
275 lock files which are world readable.
276
277 The default behaviour of requiring authentication for NLM requests can
278 be explicitly requested with either of the synonymous
279 .IR auth_nlm ,
280 or
281 .IR secure_locks .
282 .TP
283 .IR no_acl
284 On some specially patched kernels, and when exporting filesystems that
285 support ACLs, this option tells
286 .B nfsd
287 not to reveal ACLs to clients, so
288 they will see only a subset of actual permissions on the given file
289 system.  This option is safe for filesystems used by NFSv2 clients and
290 old NFSv3 clients that perform access decisions locally.  Current
291 NFSv3 clients use the ACCESS RPC to perform all access decisions on
292 the server.  Note that the
293 .I no_acl
294 option only has effect on kernels specially patched to support it, and
295 when exporting filesystems with ACL support.  The default is to export
296 with ACL support (i.e. by default,
297 .I no_acl
298 is off).
299
300 '''.TP
301 '''.I noaccess
302 '''This makes everything below the directory inaccessible for the named
303 '''client.  This is useful when you want to export a directory hierarchy to
304 '''a client, but exclude certain subdirectories. The client's view of a
305 '''directory flagged with noaccess is very limited; it is allowed to read
306 '''its attributes, and lookup `.' and `..'. These are also the only entries
307 '''returned by a readdir.
308 '''.TP
309 '''.IR link_relative
310 '''Convert absolute symbolic links (where the link contents start with a
311 '''slash) into relative links by prepending the necessary number of ../'s
312 '''to get from the directory containing the link to the root on the
313 '''server.  This has subtle, perhaps questionable, semantics when the file
314 '''hierarchy is not mounted at its root.
315 '''.TP
316 '''.IR link_absolute
317 '''Leave all symbolic link as they are. This is the default operation.
318
319 .TP
320 .IR mountpoint= path
321 .TP
322 .I mp
323 This option makes it possible to only export a directory if it has
324 successfully been mounted.
325 If no path is given (e.g.
326 .IR mountpoint " or " mp )
327 then the export point must also be a mount point.  If it isn't then
328 the export point is not exported.  This allows you to be sure that the
329 directory underneath a mountpoint will never be exported by accident
330 if, for example, the filesystem failed to mount due to a disc error.
331
332 If a path is given (e.g.
333 .IR mountpoint= "/path or " mp= /path)
334 then the nominated path must be a mountpoint for the exportpoint to be
335 exported.
336
337 .TP
338 .IR fsid= num|root|uuid
339 NFS needs to be able to identify each filesystem that it exports.
340 Normally it will use a UUID for the filesystem (if the filesystem has
341 such a thing) or the device number of the device holding the
342 filesystem (if the filesystem is stored on the device).
343
344 As not all filesystems are stored on devices, and not all filesystems
345 have UUIDs, it is sometimes necessary to explicitly tell NFS how to
346 identify a filesystem.  This is done with the
347 .I fsid=
348 option.
349
350 For NFSv4, there is a distinguished filesystem which is the root of
351 all exported filesystem.  This is specified with
352 .I fsid=root
353 or
354 .I fsid=0
355 both of which mean exactly the same thing.
356
357 Other filesystems can be identified with a small integer, or a UUID
358 which should contain 32 hex digits and arbitrary punctuation.
359
360 Linux kernels version 2.6.20 and earlier do not understand the UUID
361 setting so a small integer must be used if an fsid option needs to be
362 set for such kernels.  Setting both a small number and a UUID is
363 supported so the same configuration can be made to work on old and new
364 kernels alike.
365
366 .TP
367 .IR refer= path@host[+host][:path@host[+host]]
368 A client referencing the export point will be directed to choose from
369 the given list an alternative location for the filesystem.
370 (Note that the server must have a mountpoint here, though a different
371 filesystem is not required; so, for example,
372 .IR "mount --bind" " /path /path"
373 is sufficient.)
374 .TP
375 .IR replicas= path@host[+host][:path@host[+host]]
376 If the client asks for alternative locations for the export point, it
377 will be given this list of alternatives. (Note that actual replication
378 of the filesystem must be handled elsewhere.)
379
380 .SS User ID Mapping
381 .PP
382 .B nfsd
383 bases its access control to files on the server machine on the uid and
384 gid provided in each NFS RPC request. The normal behavior a user would
385 expect is that she can access her files on the server just as she would
386 on a normal file system. This requires that the same uids and gids are
387 used on the client and the server machine. This is not always true, nor
388 is it always desirable.
389 .PP
390 Very often, it is not desirable that the root user on a client machine
391 is also treated as root when accessing files on the NFS server. To this
392 end, uid 0 is normally mapped to a different id: the so-called
393 anonymous or
394 .I nobody
395 uid. This mode of operation (called `root squashing') is the default,
396 and can be turned off with
397 .IR no_root_squash .
398 .PP
399 By default,
400 '''.B nfsd
401 '''tries to obtain the anonymous uid and gid by looking up user
402 '''.I nobody
403 '''in the password file at startup time. If it isn't found, a uid and gid
404 .B exportfs
405 chooses a uid and gid
406 of 65534 for squashed access. These values can also be overridden by
407 the
408 .IR anonuid " and " anongid
409 options.
410 '''.PP
411 '''In addition to this,
412 '''.B nfsd
413 '''lets you specify arbitrary uids and gids that should be mapped to user
414 '''nobody as well.
415 Finally, you can map all user requests to the
416 anonymous uid by specifying the
417 .IR all_squash " option.
418 .PP
419 Here's the complete list of mapping options:
420 .TP
421 .IR root_squash
422 Map requests from uid/gid 0 to the anonymous uid/gid. Note that this does
423 not apply to any other uids or gids that might be equally sensitive, such as
424 user
425 .IR bin
426 or group
427 .IR staff .
428 .TP
429 .IR no_root_squash
430 Turn off root squashing. This option is mainly useful for diskless clients.
431 .TP
432 .IR all_squash
433 Map all uids and gids to the anonymous user. Useful for NFS-exported
434 public FTP directories, news spool directories, etc. The opposite option
435 is
436 .IR no_all_squash ,
437 which is the default setting.
438 .TP
439 .IR anonuid " and " anongid
440 These options explicitly set the uid and gid of the anonymous account.
441 This option is primarily useful for PC/NFS clients, where you might want
442 all requests appear to be from one user. As an example, consider the
443 export entry for
444 .B /home/joe
445 in the example section below, which maps all requests to uid 150 (which
446 is supposedly that of user joe).
447 .IP
448 .SH EXAMPLE
449 .PP
450 .nf
451 .ta +3i
452 # sample /etc/exports file
453 /               master(rw) trusty(rw,no_root_squash)
454 /projects       proj*.local.domain(rw)
455 /usr            *.local.domain(ro) @trusted(rw)
456 /home/joe       pc001(rw,all_squash,anonuid=150,anongid=100)
457 /pub            *(ro,insecure,all_squash)
458 /srv/www        \-sync,rw server @trusted @external(ro)
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 sixth line exports a directory read-write to the machine 'server'
473 as well as the `@trusted' netgroup, and read-only to netgroup `@external',
474 all three mounts with the `sync' option enabled.
475 ''' The last line denies all NFS clients
476 '''access to the private directory.
477 '''.SH CAVEATS
478 '''Unlike other NFS server implementations, this
479 '''.B nfsd
480 '''allows you to export both a directory and a subdirectory thereof to
481 '''the same host, for instance
482 '''.IR /usr " and " /usr/X11R6 .
483 '''In this case, the mount options of the most specific entry apply. For
484 '''instance, when a user on the client host accesses a file in
485 '''.IR /usr/X11R6 ,
486 '''the mount options given in the
487 '''.I /usr/X11R6
488 '''entry apply. This is also true when the latter is a wildcard or netgroup
489 '''entry.
490 .SH FILES
491 /etc/exports
492 .SH SEE ALSO
493 .BR exportfs (8),
494 .BR netgroup (5),
495 .BR mountd (8),
496 .BR nfsd (8),
497 .BR showmount (8).
498 '''.SH DIAGNOSTICS
499 '''An error parsing the file is reported using syslogd(8) as level NOTICE from
500 '''a DAEMON whenever
501 '''.BR nfsd (8)
502 '''or
503 '''.BR mountd (8)
504 '''is started up.  Any unknown
505 '''host is reported at that time, but often not all hosts are not yet known
506 '''to
507 '''.BR named (8)
508 '''at boot time, thus as hosts are found they are reported
509 '''with the same
510 '''.BR syslogd (8)
511 '''parameters.