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