Typo fix by Tom Schmidt
[rsync.git] / rsyncd.conf.yo
1 mailto(rsync-bugs@samba.org)
2 manpage(rsyncd.conf)(5)(12 Feb 1999)()()
3 manpagename(rsyncd.conf)(configuration file for rsync server)
4 manpagesynopsis()
5
6 rsyncd.conf
7
8 manpagedescription()
9
10 The rsyncd.conf file is the runtime configuration file for rsync when
11 run with the --daemon option. When run in this way rsync becomes a
12 rsync server listening on TCP port 873. Connections from rsync clients
13 are accepted for either anonymous or authenticated rsync sessions. 
14
15 The rsyncd.conf file controls authentication, access, logging and
16 available modules.
17
18 manpagesection(FILE FORMAT)
19
20 The file consists of modules and parameters. A module begins with the 
21 name of the module in square brackets and continues until the next
22 module begins. Modules contain parameters of the form 'name = value'.
23
24 The file is line-based - that is, each newline-terminated line represents
25 either a comment, a module name or a parameter.
26
27 Only the first equals sign in a parameter is significant. Whitespace before 
28 or after the first equals sign is discarded. Leading, trailing and internal
29 whitespace in module and parameter names is irrelevant. Leading and
30 trailing whitespace in a parameter value is discarded. Internal whitespace
31 within a parameter value is retained verbatim.
32
33 Any line beginning with a hash (#) is ignored, as are lines containing 
34 only whitespace.
35
36 Any line ending in a \ is "continued" on the next line in the
37 customary UNIX fashion.
38
39 The values following the equals sign in parameters are all either a string
40 (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or
41 true/false. Case is not significant in boolean values, but is preserved
42 in string values. 
43
44 manpagesection(LAUNCHING THE RSYNC DAEMON)
45
46 The rsync daemon is launched by specifying the --daemon option to
47 rsync. 
48
49 The daemon must run with root privileges if you wish to use chroot, to
50 bind to a port numbered under 1024 (as is the default 873), or to set
51 file ownership.  Otherwise, it must just have permission to read and
52 write the appropriate data, log, and lock files.
53
54 You can launch it either via inetd or as a stand-alone daemon. If run
55 as a daemon then just run the command "rsync --daemon" from a suitable
56 startup script.
57
58 When run via inetd you should add a line like this to /etc/services:
59
60 quote(rsync           873/tcp)
61
62 and a single line something like this to /etc/inetd.conf:
63     
64 quote(rsync   stream  tcp     nowait  root   /usr/bin/rsync rsyncd --daemon)
65
66 Replace "/usr/bin/rsync" with the path to where you have rsync installed on
67 your system.  You will then need to send inetd a HUP signal to tell it to
68 reread its config file.
69
70 Note that you should not send the rsync server a HUP signal to force
71 it to reread the tt(/etc/rsyncd.conf). The file is re-read on each client
72 connection. 
73
74 manpagesection(GLOBAL OPTIONS)
75
76 The first parameters in the file (before a [module] header) are the
77 global parameters. 
78
79 You may also include any module parameters in the global part of the
80 config file in which case the supplied value will override the
81 default for that parameter.
82
83 startdit()
84 dit(bf(motd file)) The "motd file" option allows you to specify a
85 "message of the day" to display to clients on each connect. This
86 usually contains site information and any legal notices. The default
87 is no motd file.
88
89 dit(bf(log file)) The "log file" option tells the rsync daemon to log
90 messages to that file rather than using syslog. This is particularly
91 useful on systems (such as AIX) where syslog() doesn't work for
92 chrooted programs.
93
94 dit(bf(pid file)) The "pid file" option tells the rsync daemon to write
95 its process id to that file.
96
97 dit(bf(syslog facility)) The "syslog facility" option allows you to
98 specify the syslog facility name to use when logging messages from the
99 rsync server. You may use any standard syslog facility name which is
100 defined on your system. Common names are auth, authpriv, cron, daemon,
101 ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,
102 local1, local2, local3, local4, local5, local6 and local7. The default
103 is daemon. 
104
105 dit(bf(socket options)) This option can provide endless fun for people
106 who like to tune their systems to the utmost degree. You can set all
107 sorts of socket options which may make transfers faster (or
108 slower!). Read the man page for the setsockopt() system call for
109 details on some of the options you may be able to set. By default no
110 special socket options are set.
111
112 enddit()
113
114
115 manpagesection(MODULE OPTIONS)
116
117 After the global options you should define a number of modules, each
118 module exports a directory tree as a symbolic name. Modules are
119 exported by specifying a module name in square brackets [module]
120 followed by the options for that module.
121
122 startdit()
123
124 dit(bf(comment)) The "comment" option specifies a description string
125 that is displayed next to the module name when clients obtain a list
126 of available modules. The default is no comment.
127
128 dit(bf(path)) The "path" option specifies the directory in the servers
129 filesystem to make available in this module.  You must specify this option
130 for each module in tt(/etc/rsyncd.conf).
131
132 dit(bf(use chroot)) If "use chroot" is true, the rsync server will chroot
133 to the "path" before starting the file transfer with the client.  This has
134 the advantage of extra protection against possible implementation security
135 holes, but it has the disadvantages of requiring super-user privileges and
136 of not being able to follow symbolic links outside of the new root path
137 when reading.  When "use chroot" is false, for security reasons
138 symlinks may only be relative paths pointing to other files within the
139 root path, and leading slashes are removed from absolute paths.  The
140 default for "use chroot" is true.
141
142 dit(bf(max connections)) The "max connections" option allows you to
143 specify the maximum number of simultaneous connections you will allow
144 to this module of your rsync server. Any clients connecting when the
145 maximum has been reached will receive a message telling them to try
146 later.  The default is 0 which means no limit.
147
148 dit(bf(lock file)) The "lock file" option specifies the file to use to
149 support the "max connections" option. The rsync server uses record
150 locking on this file to ensure that the max connections limit is not
151 exceeded. The default is tt(/var/run/rsyncd.lock).
152
153 dit(bf(read only)) The "read only" option determines whether clients
154 will be able to upload files or not. If "read only" is true then any
155 attempted uploads will fail. If "read only" is false then uploads will
156 be possible if file permissions on the server allow them. The default
157 is for all modules to be read only.
158
159 dit(bf(list)) The "list" option determines if this module should be
160 listed when the client asks for a listing of available modules. By
161 setting this to false you can create hidden modules. The default is
162 for modules to be listable.
163
164 dit(bf(uid)) The "uid" option specifies the user name or user id that
165 file transfers to and from that module should take place as when the daemon
166 was run as root. In combination with the "gid" option this determines what
167 file permissions are available. The default is uid -2, which is normally
168 the user "nobody".
169
170 dit(bf(gid)) The "gid" option specifies the group name or group id that
171 file transfers to and from that module should take place as when the daemon
172 was run as root. This complements the "uid" option. The default is gid -2,
173 which is normally the group "nobody".
174
175 dit(bf(exclude)) The "exclude" option allows you to specify a space
176 separated list of patterns to add to the exclude list. This is
177 equivalent to the client specifying these patterns with the --exclude
178 option except that the exclude list is not passed to the client and
179 thus only apply on the server.  Only one "exclude" option may be
180 specified, but you can use "-" and "+" before patterns to specify
181 exclude/include.
182
183 Note that this option is not designed with strong security in
184 mind, it is quite possible that a client may find a way to bypass this
185 exclude list. If you want to absolutely ensure that certain files
186 cannot be accessed then use the uid/gid options in combination with
187 file permissions.
188
189 dit(bf(exclude from)) The "exclude from" option specifies a filename
190 on the server that contains exclude patterns, one per line. This is
191 equivalent to the client specifying the --exclude-from option with a
192 equivalent file except that the resulting exclude patterns are not
193 passed to the client and thus only apply on the server. See also the
194 note about security for the exclude option above.
195
196 dit(bf(include)) The "include" option allows you to specify a space
197 separated list of patterns which rsync should not exclude. This is
198 equivalent to the client specifying these patterns with the --include
199 option.  This is useful as it allows you to build up quite complex
200 exclude/include rules.  Only one "include" option may be specified, but you
201 can use "+" and "-" before patterns to switch include/exclude.
202
203 See the section of exclude patterns in the rsync man page for information
204 on the syntax of this option.
205
206 dit(bf(include from)) The "include from" option specifies a filename
207 on the server that contains include patterns, one per line. This is
208 equivalent to the client specifying the --include-from option with a
209 equivalent file.
210
211 dit(bf(auth users)) The "auth users" option specifies a comma and
212 space separated list of usernames that will be allowed to connect to
213 this module. The usernames do not need to exist on the local
214 system. The usernames may also contain shell wildcard characters. If
215 "auth users" is set then the client will be challenged to supply a
216 username and password to connect to the module. A challenge response
217 authentication protocol is used for this exchange. The plain text
218 usernames are passwords are stored in the file specified by the
219 "secrets file" option. The default is for all users to be able to
220 connect without a password (this is called "anonymous rsync").
221
222 dit(bf(secrets file)) The "secrets file" option specifies the name of
223 a file that contains the username:password pairs used for
224 authenticating this module. This file is only consulted if the "auth
225 users" option is specified. The file is line based and contains
226 username:password pairs separated by a single colon. Any line starting
227 with a hash (#) is considered a comment and is skipped. The passwords
228 can contain any characters but be warned that many operating systems
229 limit the length of passwords that can be typed at the client end, so
230 you may find that passwords longer than 8 characters don't work. 
231
232 There is no default for the "secrets file" option, you must choose a name
233 (such as tt(/etc/rsyncd.secrets)).  The file must normally not be readable
234 by "other"; see "strict modes".
235
236 dit(bf(strict modes)) The "strict modes" option determines whether or not 
237 the permissions on the secrets file will be checked.  If "strict modes" is
238 true, then the secrets file must not be readable by any user id other
239 than the one that the rsync daemon is running under.  If "strict modes" is
240 false, the check is not performed.  The default is true.  This option
241 was added to accommodate rsync running on the Windows operating system.
242
243 dit(bf(hosts allow)) The "hosts allow" option allows you to specify a
244 list of patterns that are matched against a connecting clients
245 hostname and IP address. If none of the patterns match then the
246 connection is rejected.
247
248 Each pattern can be in one of five forms:
249
250 itemize(
251   it() a dotted decimal IP address. In this case the incoming machines
252   IP address must match exactly.
253
254   it() a address/mask in the form a.b.c.d/n were n is the number of
255   one bits in in the netmask. All IP addresses which match the masked
256   IP address will be allowed in.
257
258   it() a address/mask in the form a.b.c.d/e.f.g.h where e.f.g.h is a
259   netmask in dotted decimal notation. All IP addresses which match the masked
260   IP address will be allowed in.
261
262   it() a hostname. The hostname as determined by a reverse lookup will
263   be matched (case insensitive) against the pattern. Only an exact
264   match is allowed in.
265
266   it() a hostname pattern using wildcards. These are matched using the
267   same rules as normal unix filename matching. If the pattern matches
268   then the client is allowed in.
269 )
270
271 You can also combine "hosts allow" with a separate "hosts deny"
272 option. If both options are specified then the "hosts allow" option s
273 checked first and a match results in the client being able to
274 connect. The "hosts deny" option is then checked and a match means
275 that the host is rejected. If the host does not match either the 
276 "hosts allow" or the "hosts deny" patterns then it is allowed to
277 connect.
278
279 The default is no "hosts allow" option, which means all hosts can connect.
280
281 dit(bf(hosts deny)) The "hosts deny" option allows you to specify a
282 list of patterns that are matched against a connecting clients
283 hostname and IP address. If the pattern matches then the connection is
284 rejected. See the "hosts allow" option for more information.
285
286 The default is no "hosts deny" option, which means all hosts can connect.
287
288 dit(bf(ignore errors)) The "ignore errors" option tells rsyncd to
289 ignore IO errors on the server when deciding whether to run the delete
290 phase of the transfer. Normally rsync skips the --delete step if any
291 IO errors have occurred in order to prevent disasterous deletion due
292 to a temporary resource shortage or other IO error. In some cases this
293 test is counter productive so you can use this option to turn off this
294 behaviour. 
295
296 dit(bf(ignore nonreadable)) This tells the rsync server to completely
297 ignore files that are not readable by the user. This is useful for
298 public archives that may have some non-readable files among the
299 directories, and the sysadmin doesn't want those files to be seen at all.
300
301 dit(bf(transfer logging)) The "transfer logging" option enables per-file 
302 logging of downloads and uploads in a format somewhat similar to that
303 used by ftp daemons. If you want to customize the log formats look at
304 the log format option.
305
306 dit(bf(log format)) The "log format" option allows you to specify the
307 format used for logging file transfers when transfer logging is
308 enabled. The format is a text string containing embedded single
309 character escape sequences prefixed with a percent (%) character.
310
311 The prefixes that are understood are:
312
313 itemize(
314   it() %h for the remote host name
315   it() %a for the remote IP address
316   it() %l for the length of the file in bytes
317   it() %p for the process id of this rsync session
318   it() %o for the operation, which is either "send" or "recv"
319   it() %f for the filename
320   it() %P for the module path
321   it() %m for the module name
322   it() %t for the current date time
323   it() %u for the authenticated username (or the null string)
324   it() %b for the number of bytes actually transferred 
325   it() %c when sending files this gives the number of checksum bytes
326     received for this file
327 )
328
329 The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] "
330 is always added to the beginning when using the "log file" option.
331
332 A perl script called rsyncstats to summarize this format is included
333 in the rsync source code distribution.
334
335 dit(bf(timeout)) The "timeout" option allows you to override the
336 clients choice for IO timeout for this module. Using this option you
337 can ensure that rsync won't wait on a dead client forever. The timeout
338 is specified in seconds. A value of zero means no timeout and is the
339 default. A good choice for anonymous rsync servers may be 600 (giving
340 a 10 minute timeout).
341
342 dit(bf(refuse options)) The "refuse options" option allows you to
343 specify a space separated list of rsync command line options that will
344 be refused by your rsync server.  The full names of the options must be
345 used (i.e., you must use "checksum" not "c" to disable checksumming).  
346 When an option is refused, the server prints an error message and exits.
347 To prevent all compression, you can use "dont compress = *" (see below)
348 instead of "refuse options = compress" to avoid returning an error to a
349 client that requests compression.
350
351 dit(bf(dont compress)) The "dont compress" option allows you to select
352 filenames based on wildcard patterns that should not be compressed
353 during transfer. Compression is expensive in terms of CPU usage so it
354 is usually good to not try to compress files that won't compress well,
355 such as already compressed files. 
356
357 The "dont compress" option takes a space separated list of
358 case-insensitive wildcard patterns. Any source filename matching one
359 of the patterns will not be compressed during transfer.
360
361 The default setting is verb(*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz)
362
363 enddit()
364
365 manpagesection(AUTHENTICATION STRENGTH)
366
367 The authentication protocol used in rsync is a 128 bit MD4 based
368 challenge response system. Although I believe that no one has ever
369 demonstrated a brute-force break of this sort of system you should
370 realize that this is not a "military strength" authentication system.
371 It should be good enough for most purposes but if you want really top
372 quality security then I recommend that you run rsync over ssh.
373
374 Also note that the rsync server protocol does not currently provide any
375 encryption of the data that is transferred over the link. Only
376 authentication is provided. Use ssh as the transport if you want
377 encryption.
378
379 Future versions of rsync may support SSL for better authentication and
380 encryption, but that is still being investigated.
381
382 manpagesection(EXAMPLES)
383
384 A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
385 tt(/home/ftp) would be:
386
387 verb(
388 [ftp]
389         path = /home/ftp
390         comment = ftp export area
391 )
392
393
394 A more sophisticated example would be:
395
396 uid = nobody nl()
397 gid = nobody nl()
398 use chroot = no nl()
399 max connections = 4 nl()
400 syslog facility = local5 nl()
401 pid file = /var/run/rsyncd.pid
402
403 verb([ftp]
404         path = /var/ftp/pub
405         comment = whole ftp area (approx 6.1 GB)
406
407 [sambaftp]
408         path = /var/ftp/pub/samba
409         comment = Samba ftp area (approx 300 MB)
410
411 [rsyncftp]
412         path = /var/ftp/pub/rsync
413         comment = rsync ftp area (approx 6 MB)
414         
415 [sambawww]
416         path = /public_html/samba
417         comment = Samba WWW pages (approx 240 MB)
418
419 [cvs]
420         path = /data/cvs
421         comment = CVS repository (requires authentication)
422         auth users = tridge, susan
423         secrets file = /etc/rsyncd.secrets
424 )
425
426 The /etc/rsyncd.secrets file would look something like this:
427
428 tridge:mypass nl()
429 susan:herpass
430
431 manpagefiles()
432
433 /etc/rsyncd.conf
434
435 manpageseealso()
436
437 rsync(1)
438
439 manpagediagnostics()
440
441 manpagebugs()
442
443 The rsync server does not send all types of error messages to the
444 client. this means a client may be mystified as to why a transfer
445 failed. The error will have been logged by syslog on the server.
446
447 Please report bugs! The rsync bug tracking system is online at
448 url(http://rsync.samba.org/)(http://rsync.samba.org/)
449
450 manpagesection(VERSION)
451 This man page is current for version 2.0 of rsync
452
453 manpagesection(CREDITS)
454
455 rsync is distributed under the GNU public license.  See the file
456 COPYING for details.
457
458 The primary ftp site for rsync is
459 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
460
461 A WEB site is available at
462 url(http://rsync.samba.org/)(http://rsync.samba.org/)
463
464 We would be delighted to hear from you if you like this program.
465
466 This program uses the zlib compression library written by Jean-loup
467 Gailly and Mark Adler.
468
469 manpagesection(THANKS)
470
471 Thanks to Warren Stanley for his original idea and patch for the rsync
472 server. Thanks to Karsten Thygesen for his many suggestions and
473 documentation! 
474
475 manpageauthor()
476
477 rsync was written by Andrew Tridgell and Paul Mackerras.  They may be
478 contacted via email at tridge@samba.org and
479 Paul.Mackerras@cs.anu.edu.au
480