1: mailto(rsync-bugs@samba.org)
2: manpage(rsyncd.conf)(5)(28 Sep 2013)()()
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 bf(beginning) with a hash (#) is ignored, as are lines containing
32: only whitespace. (If a hash occurs after anything other than leading
33: whitespace, it is considered a part of the line's content.)
34:
35: Any line ending in a \ is "continued" on the next line in the
36: customary UNIX fashion.
37:
38: The values following the equals sign in parameters are all either a string
39: (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or
40: true/false. Case is not significant in boolean values, but is preserved
41: in string values.
42:
43: manpagesection(LAUNCHING THE RSYNC DAEMON)
44:
45: The rsync daemon is launched by specifying the bf(--daemon) option to
46: rsync.
47:
48: The daemon must run with root privileges if you wish to use chroot, to
49: bind to a port numbered under 1024 (as is the default 873), or to set
50: file ownership. Otherwise, it must just have permission to read and
51: write the appropriate data, log, and lock files.
52:
53: You can launch it either via inetd, as a stand-alone daemon, or from
54: an rsync client via a remote shell. If run as a stand-alone daemon then
55: just run the command "bf(rsync --daemon)" from a suitable startup script.
56:
57: When run via inetd you should add a line like this to /etc/services:
58:
59: verb( rsync 873/tcp)
60:
61: and a single line something like this to /etc/inetd.conf:
62:
63: verb( rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon)
64:
65: Replace "/usr/bin/rsync" with the path to where you have rsync installed on
66: your system. You will then need to send inetd a HUP signal to tell it to
67: reread its config file.
68:
69: Note that you should bf(not) send the rsync daemon a HUP signal to force
70: it to reread the tt(rsyncd.conf) file. The file is re-read on each client
71: connection.
72:
73: manpagesection(GLOBAL PARAMETERS)
74:
75: The first parameters in the file (before a [module] header) are the
76: global parameters.
77:
78: You may also include any module parameters in the global part of the
79: config file in which case the supplied value will override the
80: default for that parameter.
81:
82: You may use references to environment variables in the values of parameters.
83: String parameters will have %VAR% references expanded as late as possible (when
84: the string is used in the program), allowing for the use of variables that
85: rsync sets at connection time, such as RSYNC_USER_NAME. Non-string parameters
86: (such as true/false settings) are expanded when read from the config file. If
87: a variable does not exist in the environment, or if a sequence of characters is
88: not a valid reference (such as an un-paired percent sign), the raw characters
89: are passed through unchanged. This helps with backward compatibility and
90: safety (e.g. expanding a non-existent %VAR% to an empty string in a path could
91: result in a very unsafe path). The safest way to insert a literal % into a
92: value is to use %%.
93:
94: startdit()
95: dit(bf(motd file)) This parameter allows you to specify a
96: "message of the day" to display to clients on each connect. This
97: usually contains site information and any legal notices. The default
98: is no motd file.
99: This can be overridden by the bf(--dparam=motdfile=FILE)
100: command-line option when starting the daemon.
101:
102: dit(bf(pid file)) This parameter tells the rsync daemon to write
103: its process ID to that file. If the file already exists, the rsync
104: daemon will abort rather than overwrite the file.
105: This can be overridden by the bf(--dparam=pidfile=FILE)
106: command-line option when starting the daemon.
107:
108: dit(bf(port)) You can override the default port the daemon will listen on
109: by specifying this value (defaults to 873). This is ignored if the daemon
110: is being run by inetd, and is superseded by the bf(--port) command-line option.
111:
112: dit(bf(address)) You can override the default IP address the daemon
113: will listen on by specifying this value. This is ignored if the daemon is
114: being run by inetd, and is superseded by the bf(--address) command-line option.
115:
116: dit(bf(socket options)) This parameter can provide endless fun for people
117: who like to tune their systems to the utmost degree. You can set all
118: sorts of socket options which may make transfers faster (or
119: slower!). Read the man page for the code(setsockopt()) system call for
120: details on some of the options you may be able to set. By default no
121: special socket options are set. These settings can also be specified
122: via the bf(--sockopts) command-line option.
123:
124: dit(bf(listen backlog)) You can override the default backlog value when the
125: daemon listens for connections. It defaults to 5.
126:
127: enddit()
128:
129: manpagesection(MODULE PARAMETERS)
130:
131: After the global parameters you should define a number of modules, each
132: module exports a directory tree as a symbolic name. Modules are
133: exported by specifying a module name in square brackets [module]
134: followed by the parameters for that module.
135: The module name cannot contain a slash or a closing square bracket. If the
136: name contains whitespace, each internal sequence of whitespace will be
137: changed into a single space, while leading or trailing whitespace will be
138: discarded.
139:
140: As with GLOBAL PARAMETERS, you may use references to environment variables in
141: the values of parameters. See the GLOBAL PARAMETERS section for more details.
142:
143: startdit()
144:
145: dit(bf(comment)) This parameter specifies a description string
146: that is displayed next to the module name when clients obtain a list
147: of available modules. The default is no comment.
148:
149: dit(bf(path)) This parameter specifies the directory in the daemon's
150: filesystem to make available in this module. You must specify this parameter
151: for each module in tt(rsyncd.conf).
152:
153: You may base the path's value off of an environment variable by surrounding
154: the variable name with percent signs. You can even reference a variable
155: that is set by rsync when the user connects.
156: For example, this would use the authorizing user's name in the path:
157:
158: verb( path = /home/%RSYNC_USER_NAME% )
159:
160: It is fine if the path includes internal spaces -- they will be retained
161: verbatim (which means that you shouldn't try to escape them). If your final
162: directory has a trailing space (and this is somehow not something you wish to
163: fix), append a trailing slash to the path to avoid losing the trailing
164: whitespace.
165:
166: dit(bf(use chroot)) If "use chroot" is true, the rsync daemon will chroot
167: to the "path" before starting the file transfer with the client. This has
168: the advantage of extra protection against possible implementation security
169: holes, but it has the disadvantages of requiring super-user privileges,
170: of not being able to follow symbolic links that are either absolute or outside
171: of the new root path, and of complicating the preservation of users and groups
172: by name (see below).
173:
174: As an additional safety feature, you can specify a dot-dir in the module's
175: "path" to indicate the point where the chroot should occur. This allows rsync
176: to run in a chroot with a non-"/" path for the top of the transfer hierarchy.
177: Doing this guards against unintended library loading (since those absolute
178: paths will not be inside the transfer hierarchy unless you have used an unwise
179: pathname), and lets you setup libraries for the chroot that are outside of the
180: transfer. For example, specifying "/var/rsync/./module1" will chroot to the
181: "/var/rsync" directory and set the inside-chroot path to "/module1". If you
182: had omitted the dot-dir, the chroot would have used the whole path, and the
183: inside-chroot path would have been "/".
184:
185: When "use chroot" is false or the inside-chroot path is not "/", rsync will:
186: (1) munge symlinks by
187: default for security reasons (see "munge symlinks" for a way to turn this
188: off, but only if you trust your users), (2) substitute leading slashes in
189: absolute paths with the module's path (so that options such as
190: bf(--backup-dir), bf(--compare-dest), etc. interpret an absolute path as
191: rooted in the module's "path" dir), and (3) trim ".." path elements from
192: args if rsync believes they would escape the module hierarchy.
193: The default for "use chroot" is true, and is the safer choice (especially
194: if the module is not read-only).
195:
196: When this parameter is enabled, rsync will not attempt to map users and groups
197: by name (by default), but instead copy IDs as though bf(--numeric-ids) had
198: been specified. In order to enable name-mapping, rsync needs to be able to
199: use the standard library functions for looking up names and IDs (i.e.
200: code(getpwuid()), code(getgrgid()), code(getpwname()), and code(getgrnam())).
201: This means the rsync
202: process in the chroot hierarchy will need to have access to the resources
203: used by these library functions (traditionally /etc/passwd and
204: /etc/group, but perhaps additional dynamic libraries as well).
205:
206: If you copy the necessary resources into the module's chroot area, you
207: should protect them through your OS's normal user/group or ACL settings (to
208: prevent the rsync module's user from being able to change them), and then
209: hide them from the user's view via "exclude" (see how in the discussion of
210: that parameter). At that point it will be safe to enable the mapping of users
211: and groups by name using the "numeric ids" daemon parameter (see below).
212:
213: Note also that you are free to setup custom user/group information in the
214: chroot area that is different from your normal system. For example, you
215: could abbreviate the list of users and groups.
216:
217: dit(bf(numeric ids)) Enabling this parameter disables the mapping
218: of users and groups by name for the current daemon module. This prevents
219: the daemon from trying to load any user/group-related files or libraries.
220: This enabling makes the transfer behave as if the client had passed
221: the bf(--numeric-ids) command-line option. By default, this parameter is
222: enabled for chroot modules and disabled for non-chroot modules.
223:
224: A chroot-enabled module should not have this parameter enabled unless you've
225: taken steps to ensure that the module has the necessary resources it needs
226: to translate names, and that it is not possible for a user to change those
227: resources.
228:
229: dit(bf(munge symlinks)) This parameter tells rsync to modify
230: all symlinks in the same way as the (non-daemon-affecting)
231: bf(--munge-links) command-line option (using a method described below).
232: This should help protect your files from user trickery when
233: your daemon module is writable. The default is disabled when "use chroot"
234: is on and the inside-chroot path is "/", otherwise it is enabled.
235:
236: If you disable this parameter on a daemon that is not read-only, there
237: are tricks that a user can play with uploaded symlinks to access
238: daemon-excluded items (if your module has any), and, if "use chroot"
239: is off, rsync can even be tricked into showing or changing data that
240: is outside the module's path (as access-permissions allow).
241:
242: The way rsync disables the use of symlinks is to prefix each one with
243: the string "/rsyncd-munged/". This prevents the links from being used
244: as long as that directory does not exist. When this parameter is enabled,
245: rsync will refuse to run if that path is a directory or a symlink to
246: a directory. When using the "munge symlinks" parameter in a chroot area
247: that has an inside-chroot path of "/", you should add "/rsyncd-munged/"
248: to the exclude setting for the module so that
249: a user can't try to create it.
250:
251: Note: rsync makes no attempt to verify that any pre-existing symlinks in
252: the module's hierarchy are as safe as you want them to be (unless, of
253: course, it just copied in the whole hierarchy). If you setup an rsync
254: daemon on a new area or locally add symlinks, you can manually protect your
255: symlinks from being abused by prefixing "/rsyncd-munged/" to the start of
256: every symlink's value. There is a perl script in the support directory
257: of the source code named "munge-symlinks" that can be used to add or remove
258: this prefix from your symlinks.
259:
260: When this parameter is disabled on a writable module and "use chroot" is off
261: (or the inside-chroot path is not "/"),
262: incoming symlinks will be modified to drop a leading slash and to remove ".."
263: path elements that rsync believes will allow a symlink to escape the module's
264: hierarchy. There are tricky ways to work around this, though, so you had
265: better trust your users if you choose this combination of parameters.
266:
267: dit(bf(charset)) This specifies the name of the character set in which the
268: module's filenames are stored. If the client uses an bf(--iconv) option,
269: the daemon will use the value of the "charset" parameter regardless of the
270: character set the client actually passed. This allows the daemon to
271: support charset conversion in a chroot module without extra files in the
272: chroot area, and also ensures that name-translation is done in a consistent
273: manner. If the "charset" parameter is not set, the bf(--iconv) option is
274: refused, just as if "iconv" had been specified via "refuse options".
275:
276: If you wish to force users to always use bf(--iconv) for a particular
277: module, add "no-iconv" to the "refuse options" parameter. Keep in mind
278: that this will restrict access to your module to very new rsync clients.
279:
280: dit(bf(max connections)) This parameter allows you to
281: specify the maximum number of simultaneous connections you will allow.
282: Any clients connecting when the maximum has been reached will receive a
283: message telling them to try later. The default is 0, which means no limit.
284: A negative value disables the module.
285: See also the "lock file" parameter.
286:
287: dit(bf(log file)) When the "log file" parameter is set to a non-empty
288: string, the rsync daemon will log messages to the indicated file rather
289: than using syslog. This is particularly useful on systems (such as AIX)
290: where code(syslog()) doesn't work for chrooted programs. The file is
291: opened before code(chroot()) is called, allowing it to be placed outside
292: the transfer. If this value is set on a per-module basis instead of
293: globally, the global log will still contain any authorization failures
294: or config-file error messages.
295:
296: If the daemon fails to open the specified file, it will fall back to
297: using syslog and output an error about the failure. (Note that the
298: failure to open the specified log file used to be a fatal error.)
299:
300: This setting can be overridden by using the bf(--log-file=FILE) or
301: bf(--dparam=logfile=FILE) command-line options. The former overrides
302: all the log-file parameters of the daemon and all module settings.
303: The latter sets the daemon's log file and the default for all the
304: modules, which still allows modules to override the default setting.
305:
306: dit(bf(syslog facility)) This parameter allows you to
307: specify the syslog facility name to use when logging messages from the
308: rsync daemon. You may use any standard syslog facility name which is
309: defined on your system. Common names are auth, authpriv, cron, daemon,
310: ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,
311: local1, local2, local3, local4, local5, local6 and local7. The default
312: is daemon. This setting has no effect if the "log file" setting is a
313: non-empty string (either set in the per-modules settings, or inherited
314: from the global settings).
315:
316: dit(bf(max verbosity)) This parameter allows you to control
317: the maximum amount of verbose information that you'll allow the daemon to
318: generate (since the information goes into the log file). The default is 1,
319: which allows the client to request one level of verbosity.
320:
321: dit(bf(lock file)) This parameter specifies the file to use to
322: support the "max connections" parameter. The rsync daemon uses record
323: locking on this file to ensure that the max connections limit is not
324: exceeded for the modules sharing the lock file.
325: The default is tt(/var/run/rsyncd.lock).
326:
327: dit(bf(read only)) This parameter determines whether clients
328: will be able to upload files or not. If "read only" is true then any
329: attempted uploads will fail. If "read only" is false then uploads will
330: be possible if file permissions on the daemon side allow them. The default
331: is for all modules to be read only.
332:
333: Note that "auth users" can override this setting on a per-user basis.
334:
335: dit(bf(write only)) This parameter determines whether clients
336: will be able to download files or not. If "write only" is true then any
337: attempted downloads will fail. If "write only" is false then downloads
338: will be possible if file permissions on the daemon side allow them. The
339: default is for this parameter to be disabled.
340:
341: dit(bf(list)) This parameter determines whether this module is
342: listed when the client asks for a listing of available modules. In addition,
343: if this is false, the daemon will pretend the module does not exist
344: when a client denied by "hosts allow" or "hosts deny" attempts to access it.
345: Realize that if "reverse lookup" is disabled globally but enabled for the
346: module, the resulting reverse lookup to a potentially client-controlled DNS
347: server may still reveal to the client that it hit an existing module.
348: The default is for modules to be listable.
349:
350: dit(bf(uid)) This parameter specifies the user name or user ID that
351: file transfers to and from that module should take place as when the daemon
352: was run as root. In combination with the "gid" parameter this determines what
353: file permissions are available. The default when run by a super-user is to
354: switch to the system's "nobody" user. The default for a non-super-user is to
355: not try to change the user. See also the "gid" parameter.
356:
357: The RSYNC_USER_NAME environment variable may be used to request that rsync run
358: as the authorizing user. For example, if you want a rsync to run as the same
359: user that was received for the rsync authentication, this setup is useful:
360:
361: verb( uid = %RSYNC_USER_NAME%
362: gid = * )
363:
364: dit(bf(gid)) This parameter specifies one or more group names/IDs that will be
365: used when accessing the module. The first one will be the default group, and
366: any extra ones be set as supplemental groups. You may also specify a "*" as
367: the first gid in the list, which will be replaced by all the normal groups for
368: the transfer's user (see "uid"). The default when run by a super-user is to
369: switch to your OS's "nobody" (or perhaps "nogroup") group with no other
370: supplementary groups. The default for a non-super-user is to not change any
371: group attributes (and indeed, your OS may not allow a non-super-user to try to
372: change their group settings).
373:
374: dit(bf(fake super)) Setting "fake super = yes" for a module causes the
375: daemon side to behave as if the bf(--fake-super) command-line option had
376: been specified. This allows the full attributes of a file to be stored
377: without having to have the daemon actually running as root.
378:
379: dit(bf(filter)) The daemon has its own filter chain that determines what files
380: it will let the client access. This chain is not sent to the client and is
381: independent of any filters the client may have specified. Files excluded by
382: the daemon filter chain (bf(daemon-excluded) files) are treated as non-existent
383: if the client tries to pull them, are skipped with an error message if the
384: client tries to push them (triggering exit code 23), and are never deleted from
385: the module. You can use daemon filters to prevent clients from downloading or
386: tampering with private administrative files, such as files you may add to
387: support uid/gid name translations.
388:
389: The daemon filter chain is built from the "filter", "include from", "include",
390: "exclude from", and "exclude" parameters, in that order of priority. Anchored
391: patterns are anchored at the root of the module. To prevent access to an
392: entire subtree, for example, "/secret", you em(must) exclude everything in the
393: subtree; the easiest way to do this is with a triple-star pattern like
394: "/secret/***".
395:
396: The "filter" parameter takes a space-separated list of daemon filter rules,
397: though it is smart enough to know not to split a token at an internal space in
398: a rule (e.g. "- /foo - /bar" is parsed as two rules). You may specify one or
399: more merge-file rules using the normal syntax. Only one "filter" parameter can
400: apply to a given module in the config file, so put all the rules you want in a
401: single parameter. Note that per-directory merge-file rules do not provide as
402: much protection as global rules, but they can be used to make bf(--delete) work
403: better during a client download operation if the per-dir merge files are
404: included in the transfer and the client requests that they be used.
405:
406: dit(bf(exclude)) This parameter takes a space-separated list of daemon
407: exclude patterns. As with the client bf(--exclude) option, patterns can be
408: qualified with "- " or "+ " to explicitly indicate exclude/include. Only one
409: "exclude" parameter can apply to a given module. See the "filter" parameter
410: for a description of how excluded files affect the daemon.
411:
412: dit(bf(include)) Use an "include" to override the effects of the "exclude"
413: parameter. Only one "include" parameter can apply to a given module. See the
414: "filter" parameter for a description of how excluded files affect the daemon.
415:
416: dit(bf(exclude from)) This parameter specifies the name of a file
417: on the daemon that contains daemon exclude patterns, one per line. Only one
418: "exclude from" parameter can apply to a given module; if you have multiple
419: exclude-from files, you can specify them as a merge file in the "filter"
420: parameter. See the "filter" parameter for a description of how excluded files
421: affect the daemon.
422:
423: dit(bf(include from)) Analogue of "exclude from" for a file of daemon include
424: patterns. Only one "include from" parameter can apply to a given module. See
425: the "filter" parameter for a description of how excluded files affect the
426: daemon.
427:
428: dit(bf(incoming chmod)) This parameter allows you to specify a set of
429: comma-separated chmod strings that will affect the permissions of all
430: incoming files (files that are being received by the daemon). These
431: changes happen after all other permission calculations, and this will
432: even override destination-default and/or existing permissions when the
433: client does not specify bf(--perms).
434: See the description of the bf(--chmod) rsync option and the bf(chmod)(1)
435: manpage for information on the format of this string.
436:
437: dit(bf(outgoing chmod)) This parameter allows you to specify a set of
438: comma-separated chmod strings that will affect the permissions of all
439: outgoing files (files that are being sent out from the daemon). These
440: changes happen first, making the sent permissions appear to be different
441: than those stored in the filesystem itself. For instance, you could
442: disable group write permissions on the server while having it appear to
443: be on to the clients.
444: See the description of the bf(--chmod) rsync option and the bf(chmod)(1)
445: manpage for information on the format of this string.
446:
447: dit(bf(auth users)) This parameter specifies a comma and/or space-separated
448: list of authorization rules. In its simplest form, you list the usernames
449: that will be allowed to connect to
450: this module. The usernames do not need to exist on the local
451: system. The rules may contain shell wildcard characters that will be matched
452: against the username provided by the client for authentication. If
453: "auth users" is set then the client will be challenged to supply a
454: username and password to connect to the module. A challenge response
455: authentication protocol is used for this exchange. The plain text
456: usernames and passwords are stored in the file specified by the
457: "secrets file" parameter. The default is for all users to be able to
458: connect without a password (this is called "anonymous rsync").
459:
460: In addition to username matching, you can specify groupname matching via a '@'
461: prefix. When using groupname matching, the authenticating username must be a
462: real user on the system, or it will be assumed to be a member of no groups.
463: For example, specifying "@rsync" will match the authenticating user if the
464: named user is a member of the rsync group.
465:
466: Finally, options may be specified after a colon (:). The options allow you to
467: "deny" a user or a group, set the access to "ro" (read-only), or set the access
468: to "rw" (read/write). Setting an auth-rule-specific ro/rw setting overrides
469: the module's "read only" setting.
470:
471: Be sure to put the rules in the order you want them to be matched, because the
472: checking stops at the first matching user or group, and that is the only auth
473: that is checked. For example:
474:
475: verb( auth users = joe:deny @guest:deny admin:rw @rsync:ro susan joe sam )
476:
477: In the above rule, user joe will be denied access no matter what. Any user
478: that is in the group "guest" is also denied access. The user "admin" gets
479: access in read/write mode, but only if the admin user is not in group "guest"
480: (because the admin user-matching rule would never be reached if the user is in
481: group "guest"). Any other user who is in group "rsync" will get read-only
482: access. Finally, users susan, joe, and sam get the ro/rw setting of the
483: module, but only if the user didn't match an earlier group-matching rule.
484:
485: See the description of the secrets file for how you can have per-user passwords
486: as well as per-group passwords. It also explains how a user can authenticate
487: using their user password or (when applicable) a group password, depending on
488: what rule is being authenticated.
489:
490: See also the section entitled "USING RSYNC-DAEMON FEATURES VIA A REMOTE
491: SHELL CONNECTION" in bf(rsync)(1) for information on how handle an
492: rsyncd.conf-level username that differs from the remote-shell-level
493: username when using a remote shell to connect to an rsync daemon.
494:
495: dit(bf(secrets file)) This parameter specifies the name of a file that contains
496: the username:password and/or @groupname:password pairs used for authenticating
497: this module. This file is only consulted if the "auth users" parameter is
498: specified. The file is line-based and contains one name:password pair per
499: line. Any line has a hash (#) as the very first character on the line is
500: considered a comment and is skipped. The passwords can contain any characters
501: but be warned that many operating systems limit the length of passwords that
502: can be typed at the client end, so you may find that passwords longer than 8
503: characters don't work.
504:
505: The use of group-specific lines are only relevant when the module is being
506: authorized using a matching "@groupname" rule. When that happens, the user
507: can be authorized via either their "username:password" line or the
508: "@groupname:password" line for the group that triggered the authentication.
509:
510: It is up to you what kind of password entries you want to include, either
511: users, groups, or both. The use of group rules in "auth users" does not
512: require that you specify a group password if you do not want to use shared
513: passwords.
514:
515: There is no default for the "secrets file" parameter, you must choose a name
516: (such as tt(/etc/rsyncd.secrets)). The file must normally not be readable
517: by "other"; see "strict modes". If the file is not found or is rejected, no
518: logins for a "user auth" module will be possible.
519:
520: dit(bf(strict modes)) This parameter determines whether or not
521: the permissions on the secrets file will be checked. If "strict modes" is
522: true, then the secrets file must not be readable by any user ID other
523: than the one that the rsync daemon is running under. If "strict modes" is
524: false, the check is not performed. The default is true. This parameter
525: was added to accommodate rsync running on the Windows operating system.
526:
527: dit(bf(hosts allow)) This parameter allows you to specify a
528: list of patterns that are matched against a connecting clients
529: hostname and IP address. If none of the patterns match then the
530: connection is rejected.
531:
532: Each pattern can be in one of five forms:
533:
534: quote(itemization(
535: it() a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address
536: of the form a:b:c::d:e:f. In this case the incoming machine's IP address
537: must match exactly.
538: it() an address/mask in the form ipaddr/n where ipaddr is the IP address
539: and n is the number of one bits in the netmask. All IP addresses which
540: match the masked IP address will be allowed in.
541: it() an address/mask in the form ipaddr/maskaddr where ipaddr is the
542: IP address and maskaddr is the netmask in dotted decimal notation for IPv4,
543: or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP
544: addresses which match the masked IP address will be allowed in.
545: it() a hostname pattern using wildcards. If the hostname of the connecting IP
546: (as determined by a reverse lookup) matches the wildcarded name (using the
547: same rules as normal unix filename matching), the client is allowed in. This
548: only works if "reverse lookup" is enabled (the default).
549: it() a hostname. A plain hostname is matched against the reverse DNS of the
550: connecting IP (if "reverse lookup" is enabled), and/or the IP of the given
551: hostname is matched against the connecting IP (if "forward lookup" is
552: enabled, as it is by default). Any match will be allowed in.
553: ))
554:
555: Note IPv6 link-local addresses can have a scope in the address specification:
556:
557: quote(
558: tt( fe80::1%link1)nl()
559: tt( fe80::%link1/64)nl()
560: tt( fe80::%link1/ffff:ffff:ffff:ffff::)nl()
561: )
562:
563: You can also combine "hosts allow" with a separate "hosts deny"
564: parameter. If both parameters are specified then the "hosts allow" parameter is
565: checked first and a match results in the client being able to
566: connect. The "hosts deny" parameter is then checked and a match means
567: that the host is rejected. If the host does not match either the
568: "hosts allow" or the "hosts deny" patterns then it is allowed to
569: connect.
570:
571: The default is no "hosts allow" parameter, which means all hosts can connect.
572:
573: dit(bf(hosts deny)) This parameter allows you to specify a
574: list of patterns that are matched against a connecting clients
575: hostname and IP address. If the pattern matches then the connection is
576: rejected. See the "hosts allow" parameter for more information.
577:
578: The default is no "hosts deny" parameter, which means all hosts can connect.
579:
580: dit(bf(reverse lookup)) Controls whether the daemon performs a reverse lookup
581: on the client's IP address to determine its hostname, which is used for
582: "hosts allow"/"hosts deny" checks and the "%h" log escape. This is enabled by
583: default, but you may wish to disable it to save time if you know the lookup will
584: not return a useful result, in which case the daemon will use the name
585: "UNDETERMINED" instead.
586:
587: If this parameter is enabled globally (even by default), rsync performs the
588: lookup as soon as a client connects, so disabling it for a module will not
589: avoid the lookup. Thus, you probably want to disable it globally and then
590: enable it for modules that need the information.
591:
592: dit(bf(forward lookup)) Controls whether the daemon performs a forward lookup
593: on any hostname specified in an hosts allow/deny setting. By default this is
594: enabled, allowing the use of an explicit hostname that would not be returned
595: by reverse DNS of the connecting IP.
596:
597: dit(bf(ignore errors)) This parameter tells rsyncd to
598: ignore I/O errors on the daemon when deciding whether to run the delete
599: phase of the transfer. Normally rsync skips the bf(--delete) step if any
600: I/O errors have occurred in order to prevent disastrous deletion due
601: to a temporary resource shortage or other I/O error. In some cases this
602: test is counter productive so you can use this parameter to turn off this
603: behavior.
604:
605: dit(bf(ignore nonreadable)) This tells the rsync daemon to completely
606: ignore files that are not readable by the user. This is useful for
607: public archives that may have some non-readable files among the
608: directories, and the sysadmin doesn't want those files to be seen at all.
609:
610: dit(bf(transfer logging)) This parameter enables per-file
611: logging of downloads and uploads in a format somewhat similar to that
612: used by ftp daemons. The daemon always logs the transfer at the end, so
613: if a transfer is aborted, no mention will be made in the log file.
614:
615: If you want to customize the log lines, see the "log format" parameter.
616:
617: dit(bf(log format)) This parameter allows you to specify the
618: format used for logging file transfers when transfer logging is enabled.
619: The format is a text string containing embedded single-character escape
620: sequences prefixed with a percent (%) character. An optional numeric
621: field width may also be specified between the percent and the escape
622: letter (e.g. "bf(%-50n %8l %07p)").
623: In addition, one or more apostrophes may be specified prior to a numerical
624: escape to indicate that the numerical value should be made more human-readable.
625: The 3 supported levels are the same as for the bf(--human-readable)
626: command-line option, though the default is for human-readability to be off.
627: Each added apostrophe increases the level (e.g. "bf(%''l %'b %f)").
628:
629: The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] "
630: is always prefixed when using the "log file" parameter.
631: (A perl script that will summarize this default log format is included
632: in the rsync source code distribution in the "support" subdirectory:
633: rsyncstats.)
634:
635: The single-character escapes that are understood are as follows:
636:
637: quote(itemization(
638: it() %a the remote IP address (only available for a daemon)
639: it() %b the number of bytes actually transferred
640: it() %B the permission bits of the file (e.g. rwxrwxrwt)
641: it() %c the total size of the block checksums received for the basis file (only when sending)
642: it() %C the full-file MD5 checksum if bf(--checksum) is enabled or a file was transferred (only for protocol 30 or above).
643: it() %f the filename (long form on sender; no trailing "/")
644: it() %G the gid of the file (decimal) or "DEFAULT"
645: it() %h the remote host name (only available for a daemon)
646: it() %i an itemized list of what is being updated
647: it() %l the length of the file in bytes
648: it() %L the string " -> SYMLINK", " => HARDLINK", or "" (where bf(SYMLINK) or bf(HARDLINK) is a filename)
649: it() %m the module name
650: it() %M the last-modified time of the file
651: it() %n the filename (short form; trailing "/" on dir)
652: it() %o the operation, which is "send", "recv", or "del." (the latter includes the trailing period)
653: it() %p the process ID of this rsync session
654: it() %P the module path
655: it() %t the current date time
656: it() %u the authenticated username or an empty string
657: it() %U the uid of the file (decimal)
658: ))
659:
660: For a list of what the characters mean that are output by "%i", see the
661: bf(--itemize-changes) option in the rsync manpage.
662:
663: Note that some of the logged output changes when talking with older
664: rsync versions. For instance, deleted files were only output as verbose
665: messages prior to rsync 2.6.4.
666:
667: dit(bf(timeout)) This parameter allows you to override the
668: clients choice for I/O timeout for this module. Using this parameter you
669: can ensure that rsync won't wait on a dead client forever. The timeout
670: is specified in seconds. A value of zero means no timeout and is the
671: default. A good choice for anonymous rsync daemons may be 600 (giving
672: a 10 minute timeout).
673:
674: dit(bf(refuse options)) This parameter allows you to
675: specify a space-separated list of rsync command line options that will
676: be refused by your rsync daemon.
677: You may specify the full option name, its one-letter abbreviation, or a
678: wild-card string that matches multiple options.
679: For example, this would refuse bf(--checksum) (bf(-c)) and all the various
680: delete options:
681:
682: quote(tt( refuse options = c delete))
683:
684: The reason the above refuses all delete options is that the options imply
685: bf(--delete), and implied options are refused just like explicit options.
686: As an additional safety feature, the refusal of "delete" also refuses
687: bf(remove-source-files) when the daemon is the sender; if you want the latter
688: without the former, instead refuse "delete-*" -- that refuses all the
689: delete modes without affecting bf(--remove-source-files).
690:
691: When an option is refused, the daemon prints an error message and exits.
692: To prevent all compression when serving files,
693: you can use "dont compress = *" (see below)
694: instead of "refuse options = compress" to avoid returning an error to a
695: client that requests compression.
696:
697: dit(bf(dont compress)) This parameter allows you to select
698: filenames based on wildcard patterns that should not be compressed
699: when pulling files from the daemon (no analogous parameter exists to
700: govern the pushing of files to a daemon).
701: Compression is expensive in terms of CPU usage, so it
702: is usually good to not try to compress files that won't compress well,
703: such as already compressed files.
704:
705: The "dont compress" parameter takes a space-separated list of
706: case-insensitive wildcard patterns. Any source filename matching one
707: of the patterns will not be compressed during transfer.
708:
709: See the bf(--skip-compress) parameter in the bf(rsync)(1) manpage for the list
710: of file suffixes that are not compressed by default. Specifying a value
711: for the "dont compress" parameter changes the default when the daemon is
712: the sender.
713:
714: dit(bf(pre-xfer exec), bf(post-xfer exec)) You may specify a command to be run
715: before and/or after the transfer. If the bf(pre-xfer exec) command fails, the
716: transfer is aborted before it begins. Any output from the script on stdout (up
717: to several KB) will be displayed to the user when aborting, but is NOT
718: displayed if the script returns success. Any output from the script on stderr
719: goes to the daemon's stderr, which is typically discarded (though see
720: --no-detatch option for a way to see the stderr output, which can assist with
721: debugging).
722:
723: The following environment variables will be set, though some are
724: specific to the pre-xfer or the post-xfer environment:
725:
726: quote(itemization(
727: it() bf(RSYNC_MODULE_NAME): The name of the module being accessed.
728: it() bf(RSYNC_MODULE_PATH): The path configured for the module.
729: it() bf(RSYNC_HOST_ADDR): The accessing host's IP address.
730: it() bf(RSYNC_HOST_NAME): The accessing host's name.
731: it() bf(RSYNC_USER_NAME): The accessing user's name (empty if no user).
732: it() bf(RSYNC_PID): A unique number for this transfer.
733: it() bf(RSYNC_REQUEST): (pre-xfer only) The module/path info specified
734: by the user. Note that the user can specify multiple source files,
735: so the request can be something like "mod/path1 mod/path2", etc.
736: it() bf(RSYNC_ARG#): (pre-xfer only) The pre-request arguments are set
737: in these numbered values. RSYNC_ARG0 is always "rsyncd", followed by
738: the options that were used in RSYNC_ARG1, and so on. There will be a
739: value of "." indicating that the options are done and the path args
740: are beginning -- these contain similar information to RSYNC_REQUEST,
741: but with values separated and the module name stripped off.
742: it() bf(RSYNC_EXIT_STATUS): (post-xfer only) the server side's exit value.
743: This will be 0 for a successful run, a positive value for an error that the
744: server generated, or a -1 if rsync failed to exit properly. Note that an
745: error that occurs on the client side does not currently get sent to the
746: server side, so this is not the final exit status for the whole transfer.
747: it() bf(RSYNC_RAW_STATUS): (post-xfer only) the raw exit value from code(waitpid()).
748: ))
749:
750: Even though the commands can be associated with a particular module, they
751: are run using the permissions of the user that started the daemon (not the
752: module's uid/gid setting) without any chroot restrictions.
753:
754: enddit()
755:
756: manpagesection(CONFIG DIRECTIVES)
757:
758: There are currently two config directives available that allow a config file to
759: incorporate the contents of other files: bf(&include) and bf(&merge). Both
760: allow a reference to either a file or a directory. They differ in how
761: segregated the file's contents are considered to be.
762:
763: The bf(&include) directive treats each file as more distinct, with each one
764: inheriting the defaults of the parent file, starting the parameter parsing
765: as globals/defaults, and leaving the defaults unchanged for the parsing of
766: the rest of the parent file.
767:
768: The bf(&merge) directive, on the other hand, treats the file's contents as
769: if it were simply inserted in place of the directive, and thus it can set
770: parameters in a module started in another file, can affect the defaults for
771: other files, etc.
772:
773: When an bf(&include) or bf(&merge) directive refers to a directory, it will read
774: in all the bf(*.conf) or bf(*.inc) files (respectively) that are contained inside
775: that directory (without any
776: recursive scanning), with the files sorted into alpha order. So, if you have a
777: directory named "rsyncd.d" with the files "foo.conf", "bar.conf", and
778: "baz.conf" inside it, this directive:
779:
780: verb( &include /path/rsyncd.d )
781:
782: would be the same as this set of directives:
783:
784: verb( &include /path/rsyncd.d/bar.conf
785: &include /path/rsyncd.d/baz.conf
786: &include /path/rsyncd.d/foo.conf )
787:
788: except that it adjusts as files are added and removed from the directory.
789:
790: The advantage of the bf(&include) directive is that you can define one or more
791: modules in a separate file without worrying about unintended side-effects
792: between the self-contained module files.
793:
794: The advantage of the bf(&merge) directive is that you can load config snippets
795: that can be included into multiple module definitions, and you can also set
796: global values that will affect connections (such as bf(motd file)), or globals
797: that will affect other include files.
798:
799: For example, this is a useful /etc/rsyncd.conf file:
800:
801: verb( port = 873
802: log file = /var/log/rsync.log
803: pid file = /var/lock/rsync.lock
804:
805: &merge /etc/rsyncd.d
806: &include /etc/rsyncd.d )
807:
808: This would merge any /etc/rsyncd.d/*.inc files (for global values that should
809: stay in effect), and then include any /etc/rsyncd.d/*.conf files (defining
810: modules without any global-value cross-talk).
811:
812: manpagesection(AUTHENTICATION STRENGTH)
813:
814: The authentication protocol used in rsync is a 128 bit MD4 based
815: challenge response system. This is fairly weak protection, though (with
816: at least one brute-force hash-finding algorithm publicly available), so
817: if you want really top-quality security, then I recommend that you run
818: rsync over ssh. (Yes, a future version of rsync will switch over to a
819: stronger hashing method.)
820:
821: Also note that the rsync daemon protocol does not currently provide any
822: encryption of the data that is transferred over the connection. Only
823: authentication is provided. Use ssh as the transport if you want
824: encryption.
825:
826: Future versions of rsync may support SSL for better authentication and
827: encryption, but that is still being investigated.
828:
829: manpagesection(EXAMPLES)
830:
831: A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
832: tt(/home/ftp) would be:
833:
834: verb(
835: [ftp]
836: path = /home/ftp
837: comment = ftp export area
838: )
839:
840: A more sophisticated example would be:
841:
842: verb(
843: uid = nobody
844: gid = nobody
845: use chroot = yes
846: max connections = 4
847: syslog facility = local5
848: pid file = /var/run/rsyncd.pid
849:
850: [ftp]
851: path = /var/ftp/./pub
852: comment = whole ftp area (approx 6.1 GB)
853:
854: [sambaftp]
855: path = /var/ftp/./pub/samba
856: comment = Samba ftp area (approx 300 MB)
857:
858: [rsyncftp]
859: path = /var/ftp/./pub/rsync
860: comment = rsync ftp area (approx 6 MB)
861:
862: [sambawww]
863: path = /public_html/samba
864: comment = Samba WWW pages (approx 240 MB)
865:
866: [cvs]
867: path = /data/cvs
868: comment = CVS repository (requires authentication)
869: auth users = tridge, susan
870: secrets file = /etc/rsyncd.secrets
871: )
872:
873: The /etc/rsyncd.secrets file would look something like this:
874:
875: quote(
876: tt(tridge:mypass)nl()
877: tt(susan:herpass)nl()
878: )
879:
880: manpagefiles()
881:
882: /etc/rsyncd.conf or rsyncd.conf
883:
884: manpageseealso()
885:
886: bf(rsync)(1)
887:
888: manpagediagnostics()
889:
890: manpagebugs()
891:
892: Please report bugs! The rsync bug tracking system is online at
893: url(http://rsync.samba.org/)(http://rsync.samba.org/)
894:
895: manpagesection(VERSION)
896:
897: This man page is current for version 3.1.0 of rsync.
898:
899: manpagesection(CREDITS)
900:
901: rsync is distributed under the GNU General Public License. See the file
902: COPYING for details.
903:
904: The primary ftp site for rsync is
905: url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
906:
907: A WEB site is available at
908: url(http://rsync.samba.org/)(http://rsync.samba.org/)
909:
910: We would be delighted to hear from you if you like this program.
911:
912: This program uses the zlib compression library written by Jean-loup
913: Gailly and Mark Adler.
914:
915: manpagesection(THANKS)
916:
917: Thanks to Warren Stanley for his original idea and patch for the rsync
918: daemon. Thanks to Karsten Thygesen for his many suggestions and
919: documentation!
920:
921: manpageauthor()
922:
923: rsync was written by Andrew Tridgell and Paul Mackerras.
924: Many people have later contributed to it.
925:
926: Mailing lists for support and development are available at
927: url(http://lists.samba.org)(lists.samba.org)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to rsyncd.conf.yo CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / rsync