1 mailto(rsync-bugs@samba.org)
2 manpage(rsyncd.conf)(5)(28 Jul 2005)()()
3 manpagename(rsyncd.conf)(configuration file for rsync in daemon mode)
10 The rsyncd.conf file is the runtime configuration file for rsync when
11 run as an rsync daemon.
13 The rsyncd.conf file controls authentication, access, logging and
16 manpagesection(FILE FORMAT)
18 The file consists of modules and parameters. A module begins with the
19 name of the module in square brackets and continues until the next
20 module begins. Modules contain parameters of the form 'name = value'.
22 The file is line-based -- that is, each newline-terminated line represents
23 either a comment, a module name or a parameter.
25 Only the first equals sign in a parameter is significant. Whitespace before
26 or after the first equals sign is discarded. Leading, trailing and internal
27 whitespace in module and parameter names is irrelevant. Leading and
28 trailing whitespace in a parameter value is discarded. Internal whitespace
29 within a parameter value is retained verbatim.
31 Any line beginning with a hash (#) is ignored, as are lines containing
34 Any line ending in a \ is "continued" on the next line in the
35 customary UNIX fashion.
37 The values following the equals sign in parameters are all either a string
38 (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or
39 true/false. Case is not significant in boolean values, but is preserved
42 manpagesection(LAUNCHING THE RSYNC DAEMON)
44 The rsync daemon is launched by specifying the bf(--daemon) option to
47 The daemon must run with root privileges if you wish to use chroot, to
48 bind to a port numbered under 1024 (as is the default 873), or to set
49 file ownership. Otherwise, it must just have permission to read and
50 write the appropriate data, log, and lock files.
52 You can launch it either via inetd, as a stand-alone daemon, or from
53 an rsync client via a remote shell. If run as a stand-alone daemon then
54 just run the command "bf(rsync --daemon)" from a suitable startup script.
56 When run via inetd you should add a line like this to /etc/services:
60 and a single line something like this to /etc/inetd.conf:
62 verb( rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon)
64 Replace "/usr/bin/rsync" with the path to where you have rsync installed on
65 your system. You will then need to send inetd a HUP signal to tell it to
66 reread its config file.
68 Note that you should bf(not) send the rsync daemon a HUP signal to force
69 it to reread the tt(rsyncd.conf) file. The file is re-read on each client
72 manpagesection(GLOBAL OPTIONS)
74 The first parameters in the file (before a [module] header) are the
77 You may also include any module parameters in the global part of the
78 config file in which case the supplied value will override the
79 default for that parameter.
82 dit(bf(motd file)) The "motd file" option allows you to specify a
83 "message of the day" to display to clients on each connect. This
84 usually contains site information and any legal notices. The default
87 dit(bf(log file)) The "log file" option tells the rsync daemon to log
88 messages to that file rather than using syslog. This is particularly
89 useful on systems (such as AIX) where syslog() doesn't work for
90 chrooted programs. If the daemon fails to open to specified file, it
91 will fall back to using syslog and output an error about the failure.
92 (Note that a failure to open the specified log file used to be a fatal
95 dit(bf(pid file)) The "pid file" option tells the rsync daemon to write
96 its process ID to that file.
98 dit(bf(syslog facility)) The "syslog facility" option allows you to
99 specify the syslog facility name to use when logging messages from the
100 rsync daemon. You may use any standard syslog facility name which is
101 defined on your system. Common names are auth, authpriv, cron, daemon,
102 ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,
103 local1, local2, local3, local4, local5, local6 and local7. The default
106 dit(bf(port)) You can override the default port the daemon will listen on
107 by specifying this value (defaults to 873). This is ignored if the daemon
108 is being run by inetd, and is superseded by the bf(--port) command-line option.
110 dit(bf(address)) You can override the default IP address the daemon
111 will listen on by specifying this value. This is ignored if the daemon is
112 being run by inetd, and is superseded by the bf(--address) command-line option.
114 dit(bf(socket options)) This option can provide endless fun for people
115 who like to tune their systems to the utmost degree. You can set all
116 sorts of socket options which may make transfers faster (or
117 slower!). Read the man page for the setsockopt() system call for
118 details on some of the options you may be able to set. By default no
119 special socket options are set. These settings are superseded by the
120 bf(--sockopts) command-line option.
125 manpagesection(MODULE OPTIONS)
127 After the global options you should define a number of modules, each
128 module exports a directory tree as a symbolic name. Modules are
129 exported by specifying a module name in square brackets [module]
130 followed by the options for that module.
134 dit(bf(comment)) The "comment" option specifies a description string
135 that is displayed next to the module name when clients obtain a list
136 of available modules. The default is no comment.
138 dit(bf(path)) The "path" option specifies the directory in the daemon's
139 filesystem to make available in this module. You must specify this option
140 for each module in tt(rsyncd.conf).
142 dit(bf(use chroot)) If "use chroot" is true, the rsync daemon will chroot
143 to the "path" before starting the file transfer with the client. This has
144 the advantage of extra protection against possible implementation security
145 holes, but it has the disadvantages of requiring super-user privileges,
146 of not being able to follow symbolic links that are either absolute or outside
147 of the new root path, and of complicating the preservation of usernames and groups
148 (see below). When "use chroot" is false, for security reasons,
149 symlinks may only be relative paths pointing to other files within the root
150 path, and leading slashes are removed from most absolute paths (options
151 such as bf(--backup-dir), bf(--compare-dest), etc. interpret an absolute path as
152 rooted in the module's "path" dir, just as if chroot was specified).
153 The default for "use chroot" is true.
155 In order to preserve usernames and groupnames, rsync needs to be able to
156 use the standard library functions for looking up names and IDs (i.e.
157 getpwuid(), getgrgid(), getpwname(), and getgrnam()). This means a
158 process in the chroot namespace will need to have access to the resources
159 used by these library functions (traditionally /etc/passwd and
160 /etc/group). If these resources are not available, rsync will only be
161 able to copy the IDs, just as if the bf(--numeric-ids) option had been
164 Note that you are free to setup user/group information in the chroot area
165 differently from your normal system. For example, you could abbreviate
166 the list of users and groups. Also, you can protect this information from
167 being downloaded/uploaded by adding an exclude rule to the rsyncd.conf file
168 (e.g. "exclude = /etc/**"). Note that having the exclusion affect uploads
169 is a relatively new feature in rsync, so make sure your daemon is
170 at least 2.6.3 to effect this. Also note that it is safest to exclude a
171 directory and all its contents combining the rule "/some/dir/" with the
172 rule "/some/dir/**" just to be sure that rsync will not allow deeper
173 access to some of the excluded files inside the directory (rsync tries to
174 do this automatically, but you might as well specify both to be extra
177 dit(bf(max connections)) The "max connections" option allows you to
178 specify the maximum number of simultaneous connections you will allow.
179 Any clients connecting when the maximum has been reached will receive a
180 message telling them to try later. The default is 0 which means no limit.
181 See also the "lock file" option.
183 dit(bf(max verbosity)) The "max verbosity" option allows you to control
184 the maximum amount of verbose information that you'll allow the daemon to
185 generate (since the information goes into the log file). The default is 1,
186 which allows the client to request one level of verbosity.
188 dit(bf(lock file)) The "lock file" option specifies the file to use to
189 support the "max connections" option. The rsync daemon uses record
190 locking on this file to ensure that the max connections limit is not
191 exceeded for the modules sharing the lock file.
192 The default is tt(/var/run/rsyncd.lock).
194 dit(bf(read only)) The "read only" option determines whether clients
195 will be able to upload files or not. If "read only" is true then any
196 attempted uploads will fail. If "read only" is false then uploads will
197 be possible if file permissions on the daemon side allow them. The default
198 is for all modules to be read only.
200 dit(bf(write only)) The "write only" option determines whether clients
201 will be able to download files or not. If "write only" is true then any
202 attempted downloads will fail. If "write only" is false then downloads
203 will be possible if file permissions on the daemon side allow them. The
204 default is for this option to be disabled.
206 dit(bf(list)) The "list" option determines if this module should be
207 listed when the client asks for a listing of available modules. By
208 setting this to false you can create hidden modules. The default is
209 for modules to be listable.
211 dit(bf(uid)) The "uid" option specifies the user name or user ID that
212 file transfers to and from that module should take place as when the daemon
213 was run as root. In combination with the "gid" option this determines what
214 file permissions are available. The default is uid -2, which is normally
217 dit(bf(gid)) The "gid" option specifies the group name or group ID that
218 file transfers to and from that module should take place as when the daemon
219 was run as root. This complements the "uid" option. The default is gid -2,
220 which is normally the group "nobody".
222 dit(bf(filter)) The "filter" option allows you to specify a space-separated
223 list of filter rules that the daemon will not allow to be read or written.
224 This is only superficially equivalent to the client specifying these
225 patterns with the bf(--filter) option. Only one "filter" option may be
226 specified, but it may contain as many rules as you like, including
227 merge-file rules. Note that per-directory merge-file rules do not provide
228 as much protection as global rules, but they can be used to make bf(--delete)
229 work better when a client downloads the daemon's files (if the per-dir
230 merge files are included in the transfer).
232 dit(bf(exclude)) The "exclude" option allows you to specify a
233 space-separated list of patterns that the daemon will not allow to be read
234 or written. This is only superficially equivalent to the client
235 specifying these patterns with the bf(--exclude) option. Only one "exclude"
236 option may be specified, but you can use "-" and "+" before patterns to
237 specify exclude/include.
239 Because this exclude list is not passed to the client it only applies on
240 the daemon: that is, it excludes files received by a client when receiving
241 from a daemon and files deleted on a daemon when sending to a daemon, but
242 it doesn't exclude files from being deleted on a client when receiving
245 dit(bf(exclude from)) The "exclude from" option specifies a filename
246 on the daemon that contains exclude patterns, one per line.
247 This is only superficially equivalent
248 to the client specifying the bf(--exclude-from) option with an equivalent file.
249 See the "exclude" option above.
251 dit(bf(include)) The "include" option allows you to specify a
252 space-separated list of patterns which rsync should not exclude. This is
253 only superficially equivalent to the client specifying these patterns with
254 the bf(--include) option because it applies only on the daemon. This is
255 useful as it allows you to build up quite complex exclude/include rules.
256 Only one "include" option may be specified, but you can use "+" and "-"
257 before patterns to switch include/exclude. See the "exclude" option
260 dit(bf(include from)) The "include from" option specifies a filename
261 on the daemon that contains include patterns, one per line. This is
262 only superficially equivalent to the client specifying the
263 bf(--include-from) option with a equivalent file.
264 See the "exclude" option above.
266 dit(bf(incoming chmod)) This option allows you to specify a chmod string
267 that will affect the permissions of all incoming files (files that are
268 being copied to the daemon). These changes happen last, giving you the
269 final word on what the permissions should look like in the repository. See
270 the description of the bf(--chmod) rsync option and the bf(chmod) manpage
271 for information on the format of this string.
273 dit(bf(auth users)) The "auth users" option specifies a comma and
274 space-separated list of usernames that will be allowed to connect to
275 this module. The usernames do not need to exist on the local
276 system. The usernames may also contain shell wildcard characters. If
277 "auth users" is set then the client will be challenged to supply a
278 username and password to connect to the module. A challenge response
279 authentication protocol is used for this exchange. The plain text
280 usernames and passwords are stored in the file specified by the
281 "secrets file" option. The default is for all users to be able to
282 connect without a password (this is called "anonymous rsync").
284 See also the "CONNECTING TO AN RSYNC DAEMON OVER A REMOTE SHELL
285 PROGRAM" section in rsync(1) for information on how handle an
286 rsyncd.conf-level username that differs from the remote-shell-level
287 username when using a remote shell to connect to an rsync daemon.
289 dit(bf(secrets file)) The "secrets file" option specifies the name of
290 a file that contains the username:password pairs used for
291 authenticating this module. This file is only consulted if the "auth
292 users" option is specified. The file is line based and contains
293 username:password pairs separated by a single colon. Any line starting
294 with a hash (#) is considered a comment and is skipped. The passwords
295 can contain any characters but be warned that many operating systems
296 limit the length of passwords that can be typed at the client end, so
297 you may find that passwords longer than 8 characters don't work.
299 There is no default for the "secrets file" option, you must choose a name
300 (such as tt(/etc/rsyncd.secrets)). The file must normally not be readable
301 by "other"; see "strict modes".
303 dit(bf(strict modes)) The "strict modes" option determines whether or not
304 the permissions on the secrets file will be checked. If "strict modes" is
305 true, then the secrets file must not be readable by any user ID other
306 than the one that the rsync daemon is running under. If "strict modes" is
307 false, the check is not performed. The default is true. This option
308 was added to accommodate rsync running on the Windows operating system.
310 dit(bf(hosts allow)) The "hosts allow" option allows you to specify a
311 list of patterns that are matched against a connecting clients
312 hostname and IP address. If none of the patterns match then the
313 connection is rejected.
315 Each pattern can be in one of five forms:
318 it() a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address
319 of the form a:b:c::d:e:f. In this case the incoming machine's IP address
321 it() an address/mask in the form ipaddr/n where ipaddr is the IP address
322 and n is the number of one bits in the netmask. All IP addresses which
323 match the masked IP address will be allowed in.
324 it() an address/mask in the form ipaddr/maskaddr where ipaddr is the
325 IP address and maskaddr is the netmask in dotted decimal notation for IPv4,
326 or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP
327 addresses which match the masked IP address will be allowed in.
328 it() a hostname. The hostname as determined by a reverse lookup will
329 be matched (case insensitive) against the pattern. Only an exact
331 it() a hostname pattern using wildcards. These are matched using the
332 same rules as normal unix filename matching. If the pattern matches
333 then the client is allowed in.
336 Note IPv6 link-local addresses can have a scope in the address specification:
339 tt( fe80::1%link1)nl()
340 tt( fe80::%link1/64)nl()
341 tt( fe80::%link1/ffff:ffff:ffff:ffff::)nl()
344 You can also combine "hosts allow" with a separate "hosts deny"
345 option. If both options are specified then the "hosts allow" option s
346 checked first and a match results in the client being able to
347 connect. The "hosts deny" option is then checked and a match means
348 that the host is rejected. If the host does not match either the
349 "hosts allow" or the "hosts deny" patterns then it is allowed to
352 The default is no "hosts allow" option, which means all hosts can connect.
354 dit(bf(hosts deny)) The "hosts deny" option allows you to specify a
355 list of patterns that are matched against a connecting clients
356 hostname and IP address. If the pattern matches then the connection is
357 rejected. See the "hosts allow" option for more information.
359 The default is no "hosts deny" option, which means all hosts can connect.
361 dit(bf(ignore errors)) The "ignore errors" option tells rsyncd to
362 ignore I/O errors on the daemon when deciding whether to run the delete
363 phase of the transfer. Normally rsync skips the bf(--delete) step if any
364 I/O errors have occurred in order to prevent disastrous deletion due
365 to a temporary resource shortage or other I/O error. In some cases this
366 test is counter productive so you can use this option to turn off this
369 dit(bf(ignore nonreadable)) This tells the rsync daemon to completely
370 ignore files that are not readable by the user. This is useful for
371 public archives that may have some non-readable files among the
372 directories, and the sysadmin doesn't want those files to be seen at all.
374 dit(bf(transfer logging)) The "transfer logging" option enables per-file
375 logging of downloads and uploads in a format somewhat similar to that
376 used by ftp daemons. The daemon always logs the transfer at the end, so
377 if a transfer is aborted, no mention will be made in the log file.
379 If you want to customize the log lines, see the "log format" option.
381 dit(bf(log format)) The "log format" option allows you to specify the
382 format used for logging file transfers when transfer logging is enabled.
383 The format is a text string containing embedded single-character escape
384 sequences prefixed with a percent (%) character. An optional numeric
385 field width may also be specified between the percent and the escape
386 letter (e.g. "%-50n %8l %07p").
388 The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] "
389 is always prefixed when using the "log file" option.
390 (A perl script that will summarize this default log format is included
391 in the rsync source code distribution in the "support" subdirectory:
394 The single-character escapes that are understood are as follows:
397 it() %h for the remote host name
398 it() %a for the remote IP address
399 it() %l for the length of the file in bytes
400 it() %p for the process ID of this rsync session
401 it() %o for the operation, which is "send", "recv", or "del."
402 (the latter includes the trailing period)
403 it() %f for the filename (long form on sender; no trailing "/")
404 it() %n for the filename (short form; trailing "/" on dir)
405 it() %L either the string " -> SYMLINK", or " => HARDLINK" or an
406 empty string (where bf(SYMLINK) or bf(HARDLINK) is a filename)
407 it() %P for the module path
408 it() %m for the module name
409 it() %t for the current date time
410 it() %u for the authenticated username (or the null string)
411 it() %b for the number of bytes actually transferred
412 it() %c when sending files this gives the number of checksum bytes
413 received for this file
414 it() %i an itemized list of what is being updated
417 For a list of what the characters mean that are output by "%i", see the
418 bf(--itemize-changes) option in the rsync manpage.
420 Note that some of the logged output changes when talking with older
421 rsync versions. For instance, deleted files were only output as verbose
422 messages prior to rsync 2.6.4.
424 dit(bf(timeout)) The "timeout" option allows you to override the
425 clients choice for I/O timeout for this module. Using this option you
426 can ensure that rsync won't wait on a dead client forever. The timeout
427 is specified in seconds. A value of zero means no timeout and is the
428 default. A good choice for anonymous rsync daemons may be 600 (giving
429 a 10 minute timeout).
431 dit(bf(refuse options)) The "refuse options" option allows you to
432 specify a space-separated list of rsync command line options that will
433 be refused by your rsync daemon.
434 You may specify the full option name, its one-letter abbreviation, or a
435 wild-card string that matches multiple options.
436 For example, this would refuse bf(--checksum) (bf(-c)) and all the various
439 quote(tt( refuse options = c delete))
441 The reason the above refuses all delete options is that the options imply
442 bf(--delete), and implied options are refused just like explicit options.
443 As an additional safety feature, the refusal of "delete" also refuses
444 bf(remove-sent-files) when the daemon is the sender; if you want the latter
445 without the former, instead refuse "delete-*" -- that refuses all the
446 delete modes without affecting bf(--remove-sent-files).
448 When an option is refused, the daemon prints an error message and exits.
449 To prevent all compression, you can use "dont compress = *" (see below)
450 instead of "refuse options = compress" to avoid returning an error to a
451 client that requests compression.
453 dit(bf(dont compress)) The "dont compress" option allows you to select
454 filenames based on wildcard patterns that should not be compressed
455 during transfer. Compression is expensive in terms of CPU usage so it
456 is usually good to not try to compress files that won't compress well,
457 such as already compressed files.
459 The "dont compress" option takes a space-separated list of
460 case-insensitive wildcard patterns. Any source filename matching one
461 of the patterns will not be compressed during transfer.
463 The default setting is tt(*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz)
465 dit(bf(pre-xfer exec), bf(post-xfer exec)) You may specify a command to be run
466 before and/or after the transfer. If the bf(pre-xfer exec) command fails, the
467 transfer is aborted before it begins.
469 The following environment variables will be set, though some are
470 specific to the pre-xfer or the post-xfer environment:
473 it() bf(RSYNC_MODULE_NAME): The name of the module being accessed.
474 it() bf(RSYNC_MODULE_PATH): The path configured for the module.
475 it() bf(RSYNC_HOST_ADDR): The accessing host's IP address.
476 it() bf(RSYNC_HOST_NAME): The accessing host's name.
477 it() bf(RSYNC_USER_NAME): The accessing user's name (empty if no user).
478 it() bf(RSYNC_REQUEST): (pre-xfer only) The module/path info specified
479 by the user (note that the user can specify multiple source files,
480 so the request can be something like "mod/path1 mod/path2", etc.).
481 it() bf(RSYNC_ARG#): (pre-xfer only) The pre-request arguments are set
482 in these numbered values. RSYNC_ARG0 is always "rsyncd", and the last
483 value contains a single period.
484 it() bf(RSYNC_EXIT_STATUS): (post-xfer only) rsync's exit value. This will be 0 for a
485 successful run, a positive value for an error that rsync returned
486 (e.g. 23=partial xfer), or a -1 if rsync failed to exit properly.
487 it() bf(RSYNC_RAW_STATUS): (post-xfer only) the raw exit value from waitpid().
490 Even though the commands can be associated with a particular module, they
491 are run using the permissions of the user that started the daemon (not the
492 module's uid/gid setting) without any chroot restrictions.
496 manpagesection(AUTHENTICATION STRENGTH)
498 The authentication protocol used in rsync is a 128 bit MD4 based
499 challenge response system. This is fairly weak protection, though (with
500 at least one brute-force hash-finding algorithm publicly available), so
501 if you want really top-quality security, then I recommend that you run
502 rsync over ssh. (Yes, a future version of rsync will switch over to a
503 stronger hashing method.)
505 Also note that the rsync daemon protocol does not currently provide any
506 encryption of the data that is transferred over the connection. Only
507 authentication is provided. Use ssh as the transport if you want
510 Future versions of rsync may support SSL for better authentication and
511 encryption, but that is still being investigated.
513 manpagesection(EXAMPLES)
515 A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
516 tt(/home/ftp) would be:
521 comment = ftp export area
524 A more sophisticated example would be:
531 syslog facility = local5
532 pid file = /var/run/rsyncd.pid
536 comment = whole ftp area (approx 6.1 GB)
539 path = /var/ftp/pub/samba
540 comment = Samba ftp area (approx 300 MB)
543 path = /var/ftp/pub/rsync
544 comment = rsync ftp area (approx 6 MB)
547 path = /public_html/samba
548 comment = Samba WWW pages (approx 240 MB)
552 comment = CVS repository (requires authentication)
553 auth users = tridge, susan
554 secrets file = /etc/rsyncd.secrets
557 The /etc/rsyncd.secrets file would look something like this:
560 tt(tridge:mypass)nl()
561 tt(susan:herpass)nl()
566 /etc/rsyncd.conf or rsyncd.conf
576 Please report bugs! The rsync bug tracking system is online at
577 url(http://rsync.samba.org/)(http://rsync.samba.org/)
579 manpagesection(VERSION)
581 This man page is current for version 2.6.6 of rsync.
583 manpagesection(CREDITS)
585 rsync is distributed under the GNU public license. See the file
588 The primary ftp site for rsync is
589 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
591 A WEB site is available at
592 url(http://rsync.samba.org/)(http://rsync.samba.org/)
594 We would be delighted to hear from you if you like this program.
596 This program uses the zlib compression library written by Jean-loup
597 Gailly and Mark Adler.
599 manpagesection(THANKS)
601 Thanks to Warren Stanley for his original idea and patch for the rsync
602 daemon. Thanks to Karsten Thygesen for his many suggestions and
607 rsync was written by Andrew Tridgell and Paul Mackerras.
608 Many people have later contributed to it.
610 Mailing lists for support and development are available at
611 url(http://lists.samba.org)(lists.samba.org)