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