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