mailto(rsync-bugs@samba.org)
-manpage(rsyncd.conf)(5)(29 Jun 2008)()()
+manpage(rsyncd.conf)(5)(28 Jan 2018)()()
manpagename(rsyncd.conf)(configuration file for rsync in daemon mode)
manpagesynopsis()
trailing whitespace in a parameter value is discarded. Internal whitespace
within a parameter value is retained verbatim.
-Any line beginning with a hash (#) is ignored, as are lines containing
-only whitespace.
+Any line bf(beginning) with a hash (#) is ignored, as are lines containing
+only whitespace. (If a hash occurs after anything other than leading
+whitespace, it is considered a part of the line's content.)
Any line ending in a \ is "continued" on the next line in the
customary UNIX fashion.
The first parameters in the file (before a [module] header) are the
global parameters.
+Rsync also allows for the use of a "[global]" module name to indicate the
+start of one or more global-parameter sections (the name must be lower case).
You may also include any module parameters in the global part of the
config file in which case the supplied value will override the
result in a very unsafe path). The safest way to insert a literal % into a
value is to use %%.
-startdit()
+description(
+
dit(bf(motd file)) This parameter allows you to specify a
"message of the day" to display to clients on each connect. This
usually contains site information and any legal notices. The default
dit(bf(listen backlog)) You can override the default backlog value when the
daemon listens for connections. It defaults to 5.
-enddit()
+)
manpagesection(MODULE PARAMETERS)
name contains whitespace, each internal sequence of whitespace will be
changed into a single space, while leading or trailing whitespace will be
discarded.
+Also, the name cannot be "global" as that exact name indicates that
+global parameters follow (see above).
As with GLOBAL PARAMETERS, you may use references to environment variables in
the values of parameters. See the GLOBAL PARAMETERS section for more details.
-startdit()
+description(
dit(bf(comment)) This parameter specifies a description string
that is displayed next to the module name when clients obtain a list
verb( path = /home/%RSYNC_USER_NAME% )
+It is fine if the path includes internal spaces -- they will be retained
+verbatim (which means that you shouldn't try to escape them). If your final
+directory has a trailing space (and this is somehow not something you wish to
+fix), append a trailing slash to the path to avoid losing the trailing
+whitespace.
+
dit(bf(use chroot)) If "use chroot" is true, the rsync daemon will chroot
to the "path" before starting the file transfer with the client. This has
the advantage of extra protection against possible implementation security
had omitted the dot-dir, the chroot would have used the whole path, and the
inside-chroot path would have been "/".
-When "use chroot" is false or the inside-chroot path is not "/", rsync will:
-(1) munge symlinks by
+When both "use chroot" and "daemon chroot" are false, OR the inside-chroot path
+of "use chroot" is not "/", rsync will: (1) munge symlinks by
default for security reasons (see "munge symlinks" for a way to turn this
off, but only if you trust your users), (2) substitute leading slashes in
absolute paths with the module's path (so that options such as
The default for "use chroot" is true, and is the safer choice (especially
if the module is not read-only).
-When this parameter is enabled, rsync will not attempt to map users and groups
-by name (by default), but instead copy IDs as though bf(--numeric-ids) had
-been specified. In order to enable name-mapping, rsync needs to be able to
-use the standard library functions for looking up names and IDs (i.e.
-code(getpwuid()), code(getgrgid()), code(getpwname()), and code(getgrnam())).
-This means the rsync
-process in the chroot hierarchy will need to have access to the resources
-used by these library functions (traditionally /etc/passwd and
-/etc/group, but perhaps additional dynamic libraries as well).
-
-If you copy the necessary resources into the module's chroot area, you
+When this parameter is enabled, the "numeric-ids" option will also default to
+being enabled (disabling name lookups). See below for what a chroot needs in
+order for name lookups to succeed.
+
+If you copy library resources into the module's chroot area, you
should protect them through your OS's normal user/group or ACL settings (to
prevent the rsync module's user from being able to change them), and then
hide them from the user's view via "exclude" (see how in the discussion of
chroot area that is different from your normal system. For example, you
could abbreviate the list of users and groups.
+dit(bf(daemon chroot)) This parameter specifies a path to which the daemon will
+chroot before beginning communication with clients. Module paths (and any "use
+chroot" settings) will then be related to this one. This lets you choose if you
+want the whole daemon to be chrooted (with this setting), just the transfers to
+be chrooted (with "use chroot"), or both. Keep in mind that the "daemon chroot"
+area may need various OS/lib/etc files installed to allow the daemon to function.
+By default the daemon runs without any chrooting.
+
dit(bf(numeric ids)) Enabling this parameter disables the mapping
of users and groups by name for the current daemon module. This prevents
the daemon from trying to load any user/group-related files or libraries.
This enabling makes the transfer behave as if the client had passed
the bf(--numeric-ids) command-line option. By default, this parameter is
enabled for chroot modules and disabled for non-chroot modules.
+Also keep in mind that uid/gid preservation requires the module to be
+running as root (see "uid") or for "fake super" to be configured.
A chroot-enabled module should not have this parameter enabled unless you've
taken steps to ensure that the module has the necessary resources it needs
to translate names, and that it is not possible for a user to change those
-resources.
+resources. That includes being the code being able to call functions like
+code(getpwuid()), code(getgrgid()), code(getpwname()), and code(getgrnam()).
+You should test what libraries and config files are required for your OS
+and get those setup before starting to test name mapping in rsync.
dit(bf(munge symlinks)) This parameter tells rsync to modify
all symlinks in the same way as the (non-daemon-affecting)
bf(--munge-links) command-line option (using a method described below).
This should help protect your files from user trickery when
your daemon module is writable. The default is disabled when "use chroot"
-is on and the inside-chroot path is "/", otherwise it is enabled.
+is on with an inside-chroot path of "/", OR if "daemon chroot" is on,
+otherwise it is enabled.
If you disable this parameter on a daemon that is not read-only, there
are tricks that a user can play with uploaded symlinks to access
non-empty string (either set in the per-modules settings, or inherited
from the global settings).
+dit(bf(syslog tag)) This parameter allows you to specify the syslog
+tag to use when logging messages from the rsync daemon. The default is
+"rsyncd". This setting has no effect if the "log file" setting is a
+non-empty string (either set in the per-modules settings, or inherited
+from the global settings).
+
+For example, if you wanted each authenticated user's name to be
+included in the syslog tag, you could do something like this:
+
+verb( syslog tag = rsyncd.%RSYNC_USER_NAME%)
+
dit(bf(max verbosity)) This parameter allows you to control
the maximum amount of verbose information that you'll allow the daemon to
generate (since the information goes into the log file). The default is 1,
which allows the client to request one level of verbosity.
+This also affects the user's ability to request higher levels of bf(--info) and
+bf(--debug) logging. If the max value is 2, then no info and/or debug value
+that is higher than what would be set by bf(-vv) will be honored by the daemon
+in its logging. To see how high of a verbosity level you need to accept for a
+particular info/debug level, refer to "rsync --info=help" and "rsync --debug=help".
+For instance, it takes max-verbosity 4 to be able to output debug TIME2 and FLIST3.
+
dit(bf(lock file)) This parameter specifies the file to use to
support the "max connections" parameter. The rsync daemon uses record
locking on this file to ensure that the max connections limit is not
will be possible if file permissions on the daemon side allow them. The
default is for this parameter to be disabled.
+Helpful hint: you probably want to specify "refuse options = delete" for a
+write-only module.
+
+)
+description(
+
dit(bf(list)) This parameter determines whether this module is
listed when the client asks for a listing of available modules. In addition,
if this is false, the daemon will pretend the module does not exist
group attributes (and indeed, your OS may not allow a non-super-user to try to
change their group settings).
+dit(bf(daemon uid)) This parameter specifies a uid under which the daemon will
+run. The daemon usually runs as user root, and when this is left unset the user
+is left unchanged. See also the "uid" parameter.
+
+dit(bf(daemon gid)) This parameter specifies a gid under which the daemon will
+run. The daemon usually runs as group root, and when this is left unset, the
+group is left unchanged. See also the "gid" parameter.
+
dit(bf(fake super)) Setting "fake super = yes" for a module causes the
daemon side to behave as if the bf(--fake-super) command-line option had
been specified. This allows the full attributes of a file to be stored
access. Finally, users susan, joe, and sam get the ro/rw setting of the
module, but only if the user didn't match an earlier group-matching rule.
+If you need to specify a user or group name with a space in it, start your list
+with a comma to indicate that the list should only be split on commas (though
+leading and trailing whitespace will also be removed, and empty entries are
+just ignored). For example:
+
+verb( auth users = , joe:deny, @Some Group:deny, admin:rw, @RO Group:ro )
+
See the description of the secrets file for how you can have per-user passwords
as well as per-group passwords. It also explains how a user can authenticate
using their user password or (when applicable) a group password, depending on
false, the check is not performed. The default is true. This parameter
was added to accommodate rsync running on the Windows operating system.
-dit(bf(hosts allow)) This parameter allows you to specify a
-list of patterns that are matched against a connecting clients
-hostname and IP address. If none of the patterns match then the
+)
+description(
+
+dit(bf(hosts allow)) This parameter allows you to specify a list of comma-
+and/or whitespace-separated patterns that are matched against a connecting
+client's hostname and IP address. If none of the patterns match, then the
connection is rejected.
Each pattern can be in one of five forms:
The default is no "hosts allow" parameter, which means all hosts can connect.
-dit(bf(hosts deny)) This parameter allows you to specify a
-list of patterns that are matched against a connecting clients
-hostname and IP address. If the pattern matches then the connection is
+dit(bf(hosts deny)) This parameter allows you to specify a list of comma-
+and/or whitespace-separated patterns that are matched against a connecting
+clients hostname and IP address. If the pattern matches then the connection is
rejected. See the "hosts allow" parameter for more information.
The default is no "hosts deny" parameter, which means all hosts can connect.
The single-character escapes that are understood are as follows:
quote(itemization(
- it() %a the remote IP address
+ it() %a the remote IP address (only available for a daemon)
it() %b the number of bytes actually transferred
it() %B the permission bits of the file (e.g. rwxrwxrwt)
it() %c the total size of the block checksums received for the basis file (only when sending)
- it() %C the full-file MD5 checksum if bf(--checksum) is enabled or a file was transferred (only for protocol 30 or above).
+ it() %C the full-file checksum if it is known for the file. For older rsync protocols/versions, the checksum was salted, and is thus not a useful value (and is not displayed when that is the case). For the checksum to output for a file, either the bf(--checksum) option must be in-effect or the file must have been transferred without a salted checksum being used. See the bf(--checksum-choice) option for a way to choose the algorithm.
it() %f the filename (long form on sender; no trailing "/")
it() %G the gid of the file (decimal) or "DEFAULT"
- it() %h the remote host name
+ it() %h the remote host name (only available for a daemon)
it() %i an itemized list of what is being updated
it() %l the length of the file in bytes
it() %L the string " -> SYMLINK", " => HARDLINK", or "" (where bf(SYMLINK) or bf(HARDLINK) is a filename)
rsync versions. For instance, deleted files were only output as verbose
messages prior to rsync 2.6.4.
+)
+description(
+
dit(bf(timeout)) This parameter allows you to override the
clients choice for I/O timeout for this module. Using this parameter you
can ensure that rsync won't wait on a dead client forever. The timeout
for the "dont compress" parameter changes the default when the daemon is
the sender.
+)
+description(
+
dit(bf(pre-xfer exec), bf(post-xfer exec)) You may specify a command to be run
before and/or after the transfer. If the bf(pre-xfer exec) command fails, the
-transfer is aborted before it begins.
+transfer is aborted before it begins. Any output from the script on stdout (up
+to several KB) will be displayed to the user when aborting, but is NOT
+displayed if the script returns success. Any output from the script on stderr
+goes to the daemon's stderr, which is typically discarded (though see
+--no-detatch option for a way to see the stderr output, which can assist with
+debugging).
The following environment variables will be set, though some are
specific to the pre-xfer or the post-xfer environment:
it() bf(RSYNC_USER_NAME): The accessing user's name (empty if no user).
it() bf(RSYNC_PID): A unique number for this transfer.
it() bf(RSYNC_REQUEST): (pre-xfer only) The module/path info specified
- by the user (note that the user can specify multiple source files,
- so the request can be something like "mod/path1 mod/path2", etc.).
+ by the user. Note that the user can specify multiple source files,
+ so the request can be something like "mod/path1 mod/path2", etc.
it() bf(RSYNC_ARG#): (pre-xfer only) The pre-request arguments are set
- in these numbered values. RSYNC_ARG0 is always "rsyncd", and the last
- value contains a single period.
+ in these numbered values. RSYNC_ARG0 is always "rsyncd", followed by
+ the options that were used in RSYNC_ARG1, and so on. There will be a
+ value of "." indicating that the options are done and the path args
+ are beginning -- these contain similar information to RSYNC_REQUEST,
+ but with values separated and the module name stripped off.
it() bf(RSYNC_EXIT_STATUS): (post-xfer only) the server side's exit value.
This will be 0 for a successful run, a positive value for an error that the
server generated, or a -1 if rsync failed to exit properly. Note that an
are run using the permissions of the user that started the daemon (not the
module's uid/gid setting) without any chroot restrictions.
-enddit()
+These settings honor 2 environment variables: use RSYNC_SHELL to set a shell to
+use when running the command (which otherwise uses your system() call's default
+shell), and use RSYNC_NO_XFER_EXEC to disable both options completely.
+
+)
manpagesection(CONFIG DIRECTIVES)
manpagesection(VERSION)
-This man page is current for version 3.0.3 of rsync.
+This man page is current for version 3.1.3 of rsync.
manpagesection(CREDITS)
-rsync is distributed under the GNU public license. See the file
+rsync is distributed under the GNU General Public License. See the file
COPYING for details.
The primary ftp site for rsync is
git.samba.org / rsync.git / blobdiff