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