Add a new daemon security option: "munge symlinks".
[rsync/rsync.git] / rsyncd.conf.yo
1 mailto(rsync-bugs@samba.org)
2 manpage(rsyncd.conf)(5)(8 Nov 2007)()()
3 manpagename(rsyncd.conf)(configuration file for rsync in daemon mode)
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 as an rsync daemon.
12
13 The rsyncd.conf file controls authentication, access, logging and
14 available modules.
15
16 manpagesection(FILE FORMAT)
17
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".
21
22 The file is line-based -- that is, each newline-terminated line represents
23 either a comment, a module name or a parameter.
24
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.
30
31 Any line beginning with a hash (#) is ignored, as are lines containing
32 only whitespace.
33
34 Any line ending in a \ is "continued" on the next line in the
35 customary UNIX fashion.
36
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
40 in string values.
41
42 manpagesection(LAUNCHING THE RSYNC DAEMON)
43
44 The rsync daemon is launched by specifying the bf(--daemon) option to
45 rsync.
46
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.
51
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.
55
56 When run via inetd you should add a line like this to /etc/services:
57
58 verb(  rsync           873/tcp)
59
60 and a single line something like this to /etc/inetd.conf:
61
62 verb(  rsync   stream  tcp     nowait  root   /usr/bin/rsync rsyncd --daemon)
63
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.
67
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
70 connection.
71
72 manpagesection(GLOBAL OPTIONS)
73
74 The first parameters in the file (before a [module] header) are the
75 global parameters.
76
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.
80
81 startdit()
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
85 is no motd file.
86
87 dit(bf(pid file)) The "pid file" option tells the rsync daemon to write
88 its process ID to that file.  If the file already exists, the rsync
89 daemon will abort rather than overwrite the file.
90
91 dit(bf(port)) You can override the default port the daemon will listen on
92 by specifying this value (defaults to 873).  This is ignored if the daemon
93 is being run by inetd, and is superseded by the bf(--port) command-line option.
94
95 dit(bf(address)) You can override the default IP address the daemon
96 will listen on by specifying this value.  This is ignored if the daemon is
97 being run by inetd, and is superseded by the bf(--address) command-line option.
98
99 dit(bf(socket options)) This option can provide endless fun for people
100 who like to tune their systems to the utmost degree. You can set all
101 sorts of socket options which may make transfers faster (or
102 slower!). Read the man page for the code(setsockopt()) system call for
103 details on some of the options you may be able to set. By default no
104 special socket options are set.  These settings are superseded by the
105 bf(--sockopts) command-line option.
106
107 enddit()
108
109
110 manpagesection(MODULE OPTIONS)
111
112 After the global options you should define a number of modules, each
113 module exports a directory tree as a symbolic name. Modules are
114 exported by specifying a module name in square brackets [module]
115 followed by the options for that module.
116
117 startdit()
118
119 dit(bf(comment)) The "comment" option specifies a description string
120 that is displayed next to the module name when clients obtain a list
121 of available modules. The default is no comment.
122
123 dit(bf(path)) The "path" option specifies the directory in the daemon's
124 filesystem to make available in this module.  You must specify this option
125 for each module in tt(rsyncd.conf).
126
127 dit(bf(use chroot)) If "use chroot" is true, the rsync daemon will chroot
128 to the "path" before starting the file transfer with the client.  This has
129 the advantage of extra protection against possible implementation security
130 holes, but it has the disadvantages of requiring super-user privileges,
131 of not being able to follow symbolic links that are either absolute or outside
132 of the new root path, and of complicating the preservation of usernames and groups
133 (see below).  When "use chroot" is false, rsync will: (1) munge symlinks by
134 default for security reasons (see "munge symlinks" for a way to turn this
135 off, but only if you trust your users), (2) substitute leading slashes in
136 absolute paths with the module's path (so that options such as
137 bf(--backup-dir), bf(--compare-dest), etc. interpret an absolute path as
138 rooted in the module's "path" dir), and (3) trim ".." path elements from
139 args if rsync believes they would escape the chroot.
140 The default for "use chroot" is true, and is the safer choice (especially
141 if the module is not read-only).
142
143 In order to preserve usernames and groupnames, rsync needs to be able to
144 use the standard library functions for looking up names and IDs (i.e.
145 code(getpwuid()), code(getgrgid()), code(getpwname()), and code(getgrnam())).  This means a
146 process in the chroot namespace will need to have access to the resources
147 used by these library functions (traditionally /etc/passwd and
148 /etc/group).  If these resources are not available, rsync will only be
149 able to copy the IDs, just as if the bf(--numeric-ids) option had been
150 specified.
151
152 Note that you are free to setup user/group information in the chroot area
153 differently from your normal system.  For example, you could abbreviate
154 the list of users and groups.  Also, you can protect this information from
155 being downloaded/uploaded by adding an exclude rule to the rsyncd.conf file
156 (e.g. "bf(exclude = /etc/**)").  Note that having the exclusion affect uploads
157 is a relatively new feature in rsync, so make sure your daemon is
158 at least 2.6.3 to effect this.  Also note that it is safest to exclude a
159 directory and all its contents combining the rule "/some/dir/" with the
160 rule "/some/dir/**" just to be sure that rsync will not allow deeper
161 access to some of the excluded files inside the directory (rsync tries to
162 do this automatically, but you might as well specify both to be extra
163 sure).
164
165 dit(bf(munge symlinks))  The "munge symlinks" option tells rsync to modify
166 all incoming symlinks in a way that makes them unusable but recoverable
167 (see below).  This should help protect your files from user trickery when
168 your daemon module is writable.  The default is disabled when "use chroot"
169 is on and enabled when "use chroot" is off.
170
171 If you disable this option on a daemon that is not read-only, there
172 are tricks that a user can play with uploaded symlinks to access
173 daemon-excluded items (if your module has any), and, if "use chroot"
174 is off, rsync can even be tricked into showing or changing data that
175 is outside the module's path (as access-permissions allow).
176
177 The way rsync disables the use of symlinks is to prefix each one with
178 the string "/rsyncd-munged/".  This prevents the links from being used
179 as long as that directory does not exist.  When this option is enabled,
180 rsync will refuse to run if that path is a directory or a symlink to
181 a directory.  When using the "munge symlinks" option in a chroot area,
182 you should add this path to the exclude setting for the module so that
183 the user can't try to create it.
184
185 Note:  rsync makes no attempt to verify that any pre-existing symlinks in
186 the hierarchy are as safe as you want them to be.  If you setup an rsync
187 daemon on a new area or locally add symlinks, you can manually protect your
188 symlinks from being abused by prefixing "/rsyncd-munged/" to the start of
189 every symlink's value.  There is a perl script in the support directory
190 of the source code named "munge-symlinks" that can be used to add or remove
191 this prefix from your symlinks.
192
193 dit(bf(max connections)) The "max connections" option allows you to
194 specify the maximum number of simultaneous connections you will allow.
195 Any clients connecting when the maximum has been reached will receive a
196 message telling them to try later.  The default is 0, which means no limit.
197 A negative value disables the module.
198 See also the "lock file" option.
199
200 dit(bf(log file)) When the "log file" option is set to a non-empty
201 string, the rsync daemon will log messages to the indicated file rather
202 than using syslog. This is particularly useful on systems (such as AIX)
203 where code(syslog()) doesn't work for chrooted programs.  The file is
204 opened before code(chroot()) is called, allowing it to be placed outside
205 the transfer.  If this value is set on a per-module basis instead of
206 globally, the global log will still contain any authorization failures
207 or config-file error messages.
208
209 If the daemon fails to open to specified file, it will fall back to
210 using syslog and output an error about the failure.  (Note that the
211 failure to open the specified log file used to be a fatal error.)
212
213 dit(bf(syslog facility)) The "syslog facility" option allows you to
214 specify the syslog facility name to use when logging messages from the
215 rsync daemon. You may use any standard syslog facility name which is
216 defined on your system. Common names are auth, authpriv, cron, daemon,
217 ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,
218 local1, local2, local3, local4, local5, local6 and local7. The default
219 is daemon.  This setting has no effect if the "log file" setting is a
220 non-empty string (either set in the per-modules settings, or inherited
221 from the global settings).
222
223 dit(bf(max verbosity)) The "max verbosity" option allows you to control
224 the maximum amount of verbose information that you'll allow the daemon to
225 generate (since the information goes into the log file). The default is 1,
226 which allows the client to request one level of verbosity.
227
228 dit(bf(lock file)) The "lock file" option specifies the file to use to
229 support the "max connections" option. The rsync daemon uses record
230 locking on this file to ensure that the max connections limit is not
231 exceeded for the modules sharing the lock file.
232 The default is tt(/var/run/rsyncd.lock).
233
234 dit(bf(read only)) The "read only" option determines whether clients
235 will be able to upload files or not. If "read only" is true then any
236 attempted uploads will fail. If "read only" is false then uploads will
237 be possible if file permissions on the daemon side allow them. The default
238 is for all modules to be read only.
239
240 dit(bf(write only)) The "write only" option determines whether clients
241 will be able to download files or not. If "write only" is true then any
242 attempted downloads will fail. If "write only" is false then downloads
243 will be possible if file permissions on the daemon side allow them.  The
244 default is for this option to be disabled.
245
246 dit(bf(list)) The "list" option determines if this module should be
247 listed when the client asks for a listing of available modules. By
248 setting this to false you can create hidden modules. The default is
249 for modules to be listable.
250
251 dit(bf(uid)) The "uid" option specifies the user name or user ID that
252 file transfers to and from that module should take place as when the daemon
253 was run as root. In combination with the "gid" option this determines what
254 file permissions are available. The default is uid -2, which is normally
255 the user "nobody".
256
257 dit(bf(gid)) The "gid" option specifies the group name or group ID that
258 file transfers to and from that module should take place as when the daemon
259 was run as root. This complements the "uid" option. The default is gid -2,
260 which is normally the group "nobody".
261
262 dit(bf(fake super)) Setting "fake super = yes" for a module causes the
263 daemon side to behave as if the bf(--fake-user) command-line option had
264 been specified.  This allows the full attributes of a file to be stored
265 without having to have the daemon actually running as root.
266
267 dit(bf(filter)) The "filter" option allows you to specify a space-separated
268 list of filter rules that the daemon will not allow to be read or written.
269 This is only superficially equivalent to the client specifying these
270 patterns with the bf(--filter) option.  Only one "filter" option may be
271 specified, but it may contain as many rules as you like, including
272 merge-file rules.  Note that per-directory merge-file rules do not provide
273 as much protection as global rules, but they can be used to make bf(--delete)
274 work better when a client downloads the daemon's files (if the per-dir
275 merge files are included in the transfer).
276
277 dit(bf(exclude)) The "exclude" option allows you to specify a
278 space-separated list of patterns that the daemon will not allow to be read
279 or written.  This is only superficially equivalent to the client
280 specifying these patterns with the bf(--exclude) option.  Only one "exclude"
281 option may be specified, but you can use "-" and "+" before patterns to
282 specify exclude/include.
283
284 Because this exclude list is not passed to the client it only applies on
285 the daemon: that is, it excludes files received by a client when receiving
286 from a daemon and files deleted on a daemon when sending to a daemon, but
287 it doesn't exclude files from being deleted on a client when receiving
288 from a daemon.
289
290 dit(bf(exclude from)) The "exclude from" option specifies a filename
291 on the daemon that contains exclude patterns, one per line.
292 This is only superficially equivalent
293 to the client specifying the bf(--exclude-from) option with an equivalent file.
294 See the "exclude" option above.
295
296 dit(bf(include)) The "include" option allows you to specify a
297 space-separated list of patterns which rsync should not exclude. This is
298 only superficially equivalent to the client specifying these patterns with
299 the bf(--include) option because it applies only on the daemon.  This is
300 useful as it allows you to build up quite complex exclude/include rules.
301 Only one "include" option may be specified, but you can use "+" and "-"
302 before patterns to switch include/exclude.  See the "exclude" option
303 above.
304
305 dit(bf(include from)) The "include from" option specifies a filename
306 on the daemon that contains include patterns, one per line. This is
307 only superficially equivalent to the client specifying the
308 bf(--include-from) option with a equivalent file.
309 See the "exclude" option above.
310
311 dit(bf(incoming chmod)) This option allows you to specify a set of
312 comma-separated chmod strings that will affect the permissions of all
313 incoming files (files that are being received by the daemon).  These
314 changes happen after all other permission calculations, and this will
315 even override destination-default and/or existing permissions when the
316 client does not specify bf(--perms).
317 See the description of the bf(--chmod) rsync option and the bf(chmod)(1)
318 manpage for information on the format of this string.
319
320 dit(bf(outgoing chmod)) This option allows you to specify a set of
321 comma-separated chmod strings that will affect the permissions of all
322 outgoing files (files that are being sent out from the daemon).  These
323 changes happen first, making the sent permissions appear to be different
324 than those stored in the filesystem itself.  For instance, you could
325 disable group write permissions on the server while having it appear to
326 be on to the clients.
327 See the description of the bf(--chmod) rsync option and the bf(chmod)(1)
328 manpage for information on the format of this string.
329
330 dit(bf(auth users)) The "auth users" option specifies a comma and
331 space-separated list of usernames that will be allowed to connect to
332 this module. The usernames do not need to exist on the local
333 system. The usernames may also contain shell wildcard characters. If
334 "auth users" is set then the client will be challenged to supply a
335 username and password to connect to the module. A challenge response
336 authentication protocol is used for this exchange. The plain text
337 usernames and passwords are stored in the file specified by the
338 "secrets file" option. The default is for all users to be able to
339 connect without a password (this is called "anonymous rsync").
340
341 See also the "CONNECTING TO AN RSYNC DAEMON OVER A REMOTE SHELL
342 PROGRAM" section in bf(rsync)(1) for information on how handle an
343 rsyncd.conf-level username that differs from the remote-shell-level
344 username when using a remote shell to connect to an rsync daemon.
345
346 dit(bf(secrets file)) The "secrets file" option specifies the name of
347 a file that contains the username:password pairs used for
348 authenticating this module. This file is only consulted if the "auth
349 users" option is specified. The file is line based and contains
350 username:password pairs separated by a single colon. Any line starting
351 with a hash (#) is considered a comment and is skipped. The passwords
352 can contain any characters but be warned that many operating systems
353 limit the length of passwords that can be typed at the client end, so
354 you may find that passwords longer than 8 characters don't work.
355
356 There is no default for the "secrets file" option, you must choose a name
357 (such as tt(/etc/rsyncd.secrets)).  The file must normally not be readable
358 by "other"; see "strict modes".
359
360 dit(bf(strict modes)) The "strict modes" option determines whether or not
361 the permissions on the secrets file will be checked.  If "strict modes" is
362 true, then the secrets file must not be readable by any user ID other
363 than the one that the rsync daemon is running under.  If "strict modes" is
364 false, the check is not performed.  The default is true.  This option
365 was added to accommodate rsync running on the Windows operating system.
366
367 dit(bf(hosts allow)) The "hosts allow" option allows you to specify a
368 list of patterns that are matched against a connecting clients
369 hostname and IP address. If none of the patterns match then the
370 connection is rejected.
371
372 Each pattern can be in one of five forms:
373
374 quote(itemization(
375   it() a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address
376   of the form a:b:c::d:e:f. In this case the incoming machine's IP address
377   must match exactly.
378   it() an address/mask in the form ipaddr/n where ipaddr is the IP address
379   and n is the number of one bits in the netmask.  All IP addresses which
380   match the masked IP address will be allowed in.
381   it() an address/mask in the form ipaddr/maskaddr where ipaddr is the
382   IP address and maskaddr is the netmask in dotted decimal notation for IPv4,
383   or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP
384   addresses which match the masked IP address will be allowed in.
385   it() a hostname. The hostname as determined by a reverse lookup will
386   be matched (case insensitive) against the pattern. Only an exact
387   match is allowed in.
388   it() a hostname pattern using wildcards. These are matched using the
389   same rules as normal unix filename matching. If the pattern matches
390   then the client is allowed in.
391 ))
392
393 Note IPv6 link-local addresses can have a scope in the address specification:
394
395 quote(
396 tt(    fe80::1%link1)nl()
397 tt(    fe80::%link1/64)nl()
398 tt(    fe80::%link1/ffff:ffff:ffff:ffff::)nl()
399 )
400
401 You can also combine "hosts allow" with a separate "hosts deny"
402 option. If both options are specified then the "hosts allow" option s
403 checked first and a match results in the client being able to
404 connect. The "hosts deny" option is then checked and a match means
405 that the host is rejected. If the host does not match either the
406 "hosts allow" or the "hosts deny" patterns then it is allowed to
407 connect.
408
409 The default is no "hosts allow" option, which means all hosts can connect.
410
411 dit(bf(hosts deny)) The "hosts deny" option allows you to specify a
412 list of patterns that are matched against a connecting clients
413 hostname and IP address. If the pattern matches then the connection is
414 rejected. See the "hosts allow" option for more information.
415
416 The default is no "hosts deny" option, which means all hosts can connect.
417
418 dit(bf(ignore errors)) The "ignore errors" option tells rsyncd to
419 ignore I/O errors on the daemon when deciding whether to run the delete
420 phase of the transfer. Normally rsync skips the bf(--delete) step if any
421 I/O errors have occurred in order to prevent disastrous deletion due
422 to a temporary resource shortage or other I/O error. In some cases this
423 test is counter productive so you can use this option to turn off this
424 behavior.
425
426 dit(bf(ignore nonreadable)) This tells the rsync daemon to completely
427 ignore files that are not readable by the user. This is useful for
428 public archives that may have some non-readable files among the
429 directories, and the sysadmin doesn't want those files to be seen at all.
430
431 dit(bf(transfer logging)) The "transfer logging" option enables per-file
432 logging of downloads and uploads in a format somewhat similar to that
433 used by ftp daemons.  The daemon always logs the transfer at the end, so
434 if a transfer is aborted, no mention will be made in the log file.
435
436 If you want to customize the log lines, see the "log format" option.
437
438 dit(bf(log format)) The "log format" option allows you to specify the
439 format used for logging file transfers when transfer logging is enabled.
440 The format is a text string containing embedded single-character escape
441 sequences prefixed with a percent (%) character.  An optional numeric
442 field width may also be specified between the percent and the escape
443 letter (e.g. "bf(%-50n %8l %07p)").
444
445 The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] "
446 is always prefixed when using the "log file" option.
447 (A perl script that will summarize this default log format is included
448 in the rsync source code distribution in the "support" subdirectory:
449 rsyncstats.)
450
451 The single-character escapes that are understood are as follows:
452
453 quote(itemization(
454   it() %a the remote IP address
455   it() %b the number of bytes actually transferred
456   it() %B the permission bits of the file (e.g. rwxrwxrwt)
457   it() %c the checksum bytes received for this file (only when sending)
458   it() %f the filename (long form on sender; no trailing "/")
459   it() %G the gid of the file (decimal) or "DEFAULT"
460   it() %h the remote host name
461   it() %i an itemized list of what is being updated
462   it() %l the length of the file in bytes
463   it() %L the string " -> SYMLINK", " => HARDLINK", or "" (where bf(SYMLINK) or bf(HARDLINK) is a filename)
464   it() %m the module name
465   it() %M the last-modified time of the file
466   it() %n the filename (short form; trailing "/" on dir)
467   it() %o the operation, which is "send", "recv", or "del." (the latter includes the trailing period)
468   it() %p the process ID of this rsync session
469   it() %P the module path
470   it() %t the current date time
471   it() %u the authenticated username or an empty string
472   it() %U the uid of the file (decimal)
473 ))
474
475 For a list of what the characters mean that are output by "%i", see the
476 bf(--itemize-changes) option in the rsync manpage.
477
478 Note that some of the logged output changes when talking with older
479 rsync versions.  For instance, deleted files were only output as verbose
480 messages prior to rsync 2.6.4.
481
482 dit(bf(timeout)) The "timeout" option allows you to override the
483 clients choice for I/O timeout for this module. Using this option you
484 can ensure that rsync won't wait on a dead client forever. The timeout
485 is specified in seconds. A value of zero means no timeout and is the
486 default. A good choice for anonymous rsync daemons may be 600 (giving
487 a 10 minute timeout).
488
489 dit(bf(refuse options)) The "refuse options" option allows you to
490 specify a space-separated list of rsync command line options that will
491 be refused by your rsync daemon.
492 You may specify the full option name, its one-letter abbreviation, or a
493 wild-card string that matches multiple options.
494 For example, this would refuse bf(--checksum) (bf(-c)) and all the various
495 delete options:
496
497 quote(tt(    refuse options = c delete))
498
499 The reason the above refuses all delete options is that the options imply
500 bf(--delete), and implied options are refused just like explicit options.
501 As an additional safety feature, the refusal of "delete" also refuses
502 bf(remove-sent-files) when the daemon is the sender; if you want the latter
503 without the former, instead refuse "delete-*" -- that refuses all the
504 delete modes without affecting bf(--remove-sent-files).
505
506 When an option is refused, the daemon prints an error message and exits.
507 To prevent all compression when serving files,
508 you can use "dont compress = *" (see below)
509 instead of "refuse options = compress" to avoid returning an error to a
510 client that requests compression.
511
512 dit(bf(dont compress)) The "dont compress" option allows you to select
513 filenames based on wildcard patterns that should not be compressed
514 when pulling files from the daemon (no analogous option exists to
515 govern the pushing of files to a daemon).
516 Compression is expensive in terms of CPU usage, so it
517 is usually good to not try to compress files that won't compress well,
518 such as already compressed files.
519
520 The "dont compress" option takes a space-separated list of
521 case-insensitive wildcard patterns. Any source filename matching one
522 of the patterns will not be compressed during transfer.
523
524 See the bf(--skip-compress) option in the bf(rsync)(1) manpage for the list
525 of file suffixes that are not compressed by default.  Specifying a value
526 for the bf(dont compress) option changes the default when the daemon is
527 the sender.
528
529 dit(bf(pre-xfer exec), bf(post-xfer exec)) You may specify a command to be run
530 before and/or after the transfer.  If the bf(pre-xfer exec) command fails, the
531 transfer is aborted before it begins.
532
533 The following environment variables will be set, though some are
534 specific to the pre-xfer or the post-xfer environment:
535
536 quote(itemization(
537   it() bf(RSYNC_MODULE_NAME): The name of the module being accessed.
538   it() bf(RSYNC_MODULE_PATH): The path configured for the module.
539   it() bf(RSYNC_HOST_ADDR): The accessing host's IP address.
540   it() bf(RSYNC_HOST_NAME): The accessing host's name.
541   it() bf(RSYNC_USER_NAME): The accessing user's name (empty if no user).
542   it() bf(RSYNC_PID): A unique number for this transfer.
543   it() bf(RSYNC_REQUEST): (pre-xfer only) The module/path info specified
544   by the user (note that the user can specify multiple source files,
545   so the request can be something like "mod/path1 mod/path2", etc.).
546   it() bf(RSYNC_ARG#): (pre-xfer only) The pre-request arguments are set
547   in these numbered values. RSYNC_ARG0 is always "rsyncd", and the last
548   value contains a single period.
549   it() bf(RSYNC_EXIT_STATUS): (post-xfer only) the server side's exit value.
550   This will be 0 for a successful run, a positive value for an error that the
551   server generated, or a -1 if rsync failed to exit properly.  Note that an
552   error that occurs on the client side does not currently get sent to the
553   server side, so this is not the final exit status for the whole transfer.
554   it() bf(RSYNC_RAW_STATUS): (post-xfer only) the raw exit value from code(waitpid()).
555 ))
556
557 Even though the commands can be associated with a particular module, they
558 are run using the permissions of the user that started the daemon (not the
559 module's uid/gid setting) without any chroot restrictions.
560
561 enddit()
562
563 manpagesection(AUTHENTICATION STRENGTH)
564
565 The authentication protocol used in rsync is a 128 bit MD4 based
566 challenge response system. This is fairly weak protection, though (with
567 at least one brute-force hash-finding algorithm publicly available), so
568 if you want really top-quality security, then I recommend that you run
569 rsync over ssh.  (Yes, a future version of rsync will switch over to a
570 stronger hashing method.)
571
572 Also note that the rsync daemon protocol does not currently provide any
573 encryption of the data that is transferred over the connection. Only
574 authentication is provided. Use ssh as the transport if you want
575 encryption.
576
577 Future versions of rsync may support SSL for better authentication and
578 encryption, but that is still being investigated.
579
580 manpagesection(EXAMPLES)
581
582 A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
583 tt(/home/ftp) would be:
584
585 verb(
586 [ftp]
587         path = /home/ftp
588         comment = ftp export area
589 )
590
591 A more sophisticated example would be:
592
593 verb(
594 uid = nobody
595 gid = nobody
596 use chroot = no
597 max connections = 4
598 syslog facility = local5
599 pid file = /var/run/rsyncd.pid
600
601 [ftp]
602         path = /var/ftp/pub
603         comment = whole ftp area (approx 6.1 GB)
604
605 [sambaftp]
606         path = /var/ftp/pub/samba
607         comment = Samba ftp area (approx 300 MB)
608
609 [rsyncftp]
610         path = /var/ftp/pub/rsync
611         comment = rsync ftp area (approx 6 MB)
612
613 [sambawww]
614         path = /public_html/samba
615         comment = Samba WWW pages (approx 240 MB)
616
617 [cvs]
618         path = /data/cvs
619         comment = CVS repository (requires authentication)
620         auth users = tridge, susan
621         secrets file = /etc/rsyncd.secrets
622 )
623
624 The /etc/rsyncd.secrets file would look something like this:
625
626 quote(
627 tt(tridge:mypass)nl()
628 tt(susan:herpass)nl()
629 )
630
631 manpagefiles()
632
633 /etc/rsyncd.conf or rsyncd.conf
634
635 manpageseealso()
636
637 bf(rsync)(1)
638
639 manpagediagnostics()
640
641 manpagebugs()
642
643 Please report bugs! The rsync bug tracking system is online at
644 url(http://rsync.samba.org/)(http://rsync.samba.org/)
645
646 manpagesection(VERSION)
647
648 This man page is current for version 3.0.0pre5 of rsync.
649
650 manpagesection(CREDITS)
651
652 rsync is distributed under the GNU public license.  See the file
653 COPYING for details.
654
655 The primary ftp site for rsync is
656 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
657
658 A WEB site is available at
659 url(http://rsync.samba.org/)(http://rsync.samba.org/)
660
661 We would be delighted to hear from you if you like this program.
662
663 This program uses the zlib compression library written by Jean-loup
664 Gailly and Mark Adler.
665
666 manpagesection(THANKS)
667
668 Thanks to Warren Stanley for his original idea and patch for the rsync
669 daemon. Thanks to Karsten Thygesen for his many suggestions and
670 documentation!
671
672 manpageauthor()
673
674 rsync was written by Andrew Tridgell and Paul Mackerras.
675 Many people have later contributed to it.
676
677 Mailing lists for support and development are available at
678 url(http://lists.samba.org)(lists.samba.org)