embedaddon/rsync/rsyncd.conf.5 - diff

Return to rsyncd.conf.5 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / rsync

Diff for /embedaddon/rsync/rsyncd.conf.5 between versions 1.1.1.1 and 1.1.1.4

version 1.1.1.1, 2012/02/17 15:09:30	version 1.1.1.4, 2021/03/17 00:32:36
Line 1	Line 1
.TH "rsyncd.conf" "5" "23 Sep 2011" "" ""	.TH "rsyncd.conf" "5" "06 Aug 2020" "rsyncd.conf 3.2.3" "User Commands"
	.P
.SH "NAME"	.SH "NAME"
	.P
rsyncd.conf \- configuration file for rsync in daemon mode	rsyncd.conf \- configuration file for rsync in daemon mode
	.P
.SH "SYNOPSIS"	.SH "SYNOPSIS"
	.P
.PP
rsyncd.conf	rsyncd.conf
.PP	.P
.SH "DESCRIPTION"	.SH "DESCRIPTION"
	.P
.PP	The rsyncd.conf file is the runtime configuration file for rsync when run as an
The rsyncd.conf file is the runtime configuration file for rsync when	rsync daemon.
run as an rsync daemon.	.P
.PP	The rsyncd.conf file controls authentication, access, logging and available
The rsyncd.conf file controls authentication, access, logging and	modules.
available modules.	.P
.PP
.SH "FILE FORMAT"	.SH "FILE FORMAT"
	.P
.PP	The file consists of modules and parameters. A module begins with the name of
The file consists of modules and parameters. A module begins with the	the module in square brackets and continues until the next module begins.
name of the module in square brackets and continues until the next	Modules contain parameters of the form \fBname\ =\ value\fP.
module begins. Modules contain parameters of the form \(dq\&name = value\(dq\&.	.P
.PP	The file is line-based\ \-\- that is, each newline-terminated line represents
The file is line\-based \-\- that is, each newline\-terminated line represents
either a comment, a module name or a parameter.	either a comment, a module name or a parameter.
.PP	.P
Only the first equals sign in a parameter is significant. Whitespace before	Only the first equals sign in a parameter is significant. Whitespace before or
or after the first equals sign is discarded. Leading, trailing and internal	after the first equals sign is discarded. Leading, trailing and internal
whitespace in module and parameter names is irrelevant. Leading and	whitespace in module and parameter names is irrelevant. Leading and trailing
trailing whitespace in a parameter value is discarded. Internal whitespace	whitespace in a parameter value is discarded. Internal whitespace within a
within a parameter value is retained verbatim.	parameter value is retained verbatim.
.PP	.P
Any line beginning with a hash (#) is ignored, as are lines containing	Any line \fBbeginning\fP with a hash (\fB#\fP) is ignored, as are lines containing
only whitespace.	only whitespace. (If a hash occurs after anything other than leading
.PP	whitespace, it is considered a part of the line's content.)
Any line ending in a \e is \(dq\&continued\(dq\& on the next line in the	.P
customary UNIX fashion.	Any line ending in a \fB\\\fP is "continued" on the next line in the customary UNIX
.PP	fashion.
The values following the equals sign in parameters are all either a string	.P
(no quotes needed) or a boolean, which may be given as yes/no, 0/1 or	The values following the equals sign in parameters are all either a string (no
true/false. Case is not significant in boolean values, but is preserved	quotes needed) or a boolean, which may be given as yes/no, 0/1 or true/false.
in string values.	Case is not significant in boolean values, but is preserved in string values.
.PP	.P
.SH "LAUNCHING THE RSYNC DAEMON"	.SH "LAUNCHING THE RSYNC DAEMON"
	.P
.PP
The rsync daemon is launched by specifying the \fB\-\-daemon\fP option to	The rsync daemon is launched by specifying the \fB\-\-daemon\fP option to
rsync.	rsync.
.PP	.P
The daemon must run with root privileges if you wish to use chroot, to	The daemon must run with root privileges if you wish to use chroot, to bind to
bind to a port numbered under 1024 (as is the default 873), or to set	a port numbered under 1024 (as is the default 873), or to set file ownership.
file ownership. Otherwise, it must just have permission to read and	Otherwise, it must just have permission to read and write the appropriate data,
write the appropriate data, log, and lock files.	log, and lock files.
.PP	.P
You can launch it either via inetd, as a stand\-alone daemon, or from	You can launch it either via inetd, as a stand-alone daemon, or from an rsync
an rsync client via a remote shell. If run as a stand\-alone daemon then	client via a remote shell. If run as a stand-alone daemon then just run the
just run the command \(dq\&\fBrsync \-\-daemon\fP\(dq\& from a suitable startup script.	command "\fBrsync\ \-\-daemon\fP" from a suitable startup script.
.PP	.P
When run via inetd you should add a line like this to /etc/services:	When run via inetd you should add a line like this to /etc/services:
.PP	.RS 4
.nf	.P
rsync 873/tcp	.nf
.fi	rsync 873/tcp
	.fi
.PP	.RE
	.P
and a single line something like this to /etc/inetd.conf:	and a single line something like this to /etc/inetd.conf:
.PP	.RS 4
.nf	.P
rsync stream tcp nowait root /usr/bin/rsync rsyncd \-\-daemon	.nf
.fi	rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon
	.fi
.PP	.RE
Replace \(dq\&/usr/bin/rsync\(dq\& with the path to where you have rsync installed on	.P
	Replace "/usr/bin/rsync" with the path to where you have rsync installed on
your system. You will then need to send inetd a HUP signal to tell it to	your system. You will then need to send inetd a HUP signal to tell it to
reread its config file.	reread its config file.
.PP	.P
Note that you should \fBnot\fP send the rsync daemon a HUP signal to force	Note that you should \fBnot\fP send the rsync daemon a HUP signal to force it to
it to reread the \f(CWrsyncd.conf\fP file. The file is re\-read on each client	reread the \fBrsyncd.conf\fP file. The file is re-read on each client connection.
connection.	.P
.PP
.SH "GLOBAL PARAMETERS"	.SH "GLOBAL PARAMETERS"
	.P
.PP	The first parameters in the file (before a [module] header) are the global
The first parameters in the file (before a [module] header) are the	parameters. Rsync also allows for the use of a "[global]" module name to
global parameters.	indicate the start of one or more global-parameter sections (the name must be
.PP	lower case).
You may also include any module parameters in the global part of the	.P
config file in which case the supplied value will override the	You may also include any module parameters in the global part of the config
default for that parameter.	file in which case the supplied value will override the default for that
.PP	parameter.
.IP "\fBmotd file\fP"	.P
This parameter allows you to specify a	You may use references to environment variables in the values of parameters.
\(dq\&message of the day\(dq\& to display to clients on each connect. This	String parameters will have %VAR% references expanded as late as possible (when
usually contains site information and any legal notices. The default	the string is first used in the program), allowing for the use of variables
is no motd file.	that rsync sets at connection time, such as RSYNC_USER_NAME. Non-string
.IP	parameters (such as true/false settings) are expanded when read from the config
.IP "\fBpid file\fP"	file. If a variable does not exist in the environment, or if a sequence of
This parameter tells the rsync daemon to write	characters is not a valid reference (such as an un-paired percent sign), the
its process ID to that file. If the file already exists, the rsync	raw characters are passed through unchanged. This helps with backward
daemon will abort rather than overwrite the file.	compatibility and safety (e.g. expanding a non-existent %VAR% to an empty
.IP	string in a path could result in a very unsafe path). The safest way to insert
	a literal % into a value is to use %%.
	.P
	.IP "\fBmotd\ file\fP"
	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 is no motd file. This can be overridden by the
	\fB\-\-dparam=motdfile=FILE\fP command-line option when starting the daemon.
	.IP "\fBpid\ file\fP"
	This parameter tells the rsync daemon to write its process ID to that file.
	The rsync keeps the file locked so that it can know when it is safe to
	overwrite an existing file.
	.IP
	The filename can be overridden by the \fB\-\-dparam=pidfile=FILE\fP command-line
	option when starting the daemon.
.IP "\fBport\fP"	.IP "\fBport\fP"
You can override the default port the daemon will listen on	You can override the default port the daemon will listen on by specifying
by specifying this value (defaults to 873). This is ignored if the daemon	this value (defaults to 873). This is ignored if the daemon is being run
is being run by inetd, and is superseded by the \fB\-\-port\fP command\-line option.	by inetd, and is superseded by the \fB\-\-port\fP command-line option.
.IP
.IP "\fBaddress\fP"	.IP "\fBaddress\fP"
You can override the default IP address the daemon	You can override the default IP address the daemon will listen on by
will listen on by specifying this value. This is ignored if the daemon is	specifying this value. This is ignored if the daemon is being run by
being run by inetd, and is superseded by the \fB\-\-address\fP command\-line option.	inetd, and is superseded by the \fB\-\-address\fP command-line option.
.IP	.IP "\fBsocket\ options\fP"
.IP "\fBsocket options\fP"	This parameter can provide endless fun for people who like to tune their
This parameter can provide endless fun for people	systems to the utmost degree. You can set all sorts of socket options which
who like to tune their systems to the utmost degree. You can set all	may make transfers faster (or slower!). Read the man page for the
sorts of socket options which may make transfers faster (or	\fBsetsockopt()\fP system call for details on some of the options you may be
slower!). Read the man page for the	able to set. By default no special socket options are set. These settings
\f(CWsetsockopt()\fP	can also be specified via the \fB\-\-sockopts\fP command-line option.
system call for	.IP "\fBlisten\ backlog\fP"
details on some of the options you may be able to set. By default no	You can override the default backlog value when the daemon listens for
special socket options are set. These settings can also be specified	connections. It defaults to 5.
via the \fB\-\-sockopts\fP command\-line option.	.IP "\fBuse\ slp\fP"
.IP	You can enable Service Location Protocol support by enabling this global
	parameter. The default is "false".
	.IP "\fBslp\ refresh\fP"
	This parameter is used to determine how long service advertisements are
	valid (measured in seconds), and is only applicable if you have Service
	Location Protocol support compiled in. If this is not set or is set to
	zero, then service advertisements never time out. If this is set to less
	than 120 seconds, then 120 seconds is used. If it is set to more than
	65535, then 65535 is used (which is a limitation of SLP). Using 3600
	(one hour) is a good number if you tend to change your configuration.
	.P
.SH "MODULE PARAMETERS"	.SH "MODULE PARAMETERS"
	.P
.PP	After the global parameters you should define a number of modules, each module
After the global parameters you should define a number of modules, each	exports a directory tree as a symbolic name. Modules are exported by specifying
module exports a directory tree as a symbolic name. Modules are	a module name in square brackets [module] followed by the parameters for that
exported by specifying a module name in square brackets [module]	module. The module name cannot contain a slash or a closing square bracket.
followed by the parameters for that module.	If the name contains whitespace, each internal sequence of whitespace will be
The module name cannot contain a slash or a closing square bracket. If the
name contains whitespace, each internal sequence of whitespace will be
changed into a single space, while leading or trailing whitespace will be	changed into a single space, while leading or trailing whitespace will be
discarded.	discarded. Also, the name cannot be "global" as that exact name indicates that
.PP	global parameters follow (see above).
	.P
	As with GLOBAL PARAMETERS, you may use references to environment variables in
	the values of parameters. See the GLOBAL PARAMETERS section for more details.
	.P
.IP "\fBcomment\fP"	.IP "\fBcomment\fP"
This parameter specifies a description string	This parameter specifies a description string that is displayed next to the
that is displayed next to the module name when clients obtain a list	module name when clients obtain a list of available modules. The default is
of available modules. The default is no comment.	no comment.
.IP
.IP "\fBpath\fP"	.IP "\fBpath\fP"
This parameter specifies the directory in the daemon\(cq\&s	This parameter specifies the directory in the daemon's filesystem to make
filesystem to make available in this module. You must specify this parameter	available in this module. You must specify this parameter for each module
for each module in \f(CWrsyncd.conf\fP.	in \fBrsyncd.conf\fP.
.IP	.IP
It is fine if the path includes internal spaces \-\- they will be retained	You may base the path's value off of an environment variable by surrounding
verbatim (which means that you shouldn\(cq\&t try to escape them). If your final	the variable name with percent signs. You can even reference a variable
directory has a trailing space (and this is somehow not something you wish to	that is set by rsync when the user connects. For example, this would use
fix), append a trailing slash to the path to avoid losing the trailing	the authorizing user's name in the path:
whitespace.	.RS 4
.IP	.IP
.IP "\fBuse chroot\fP"	.nf
If \(dq\&use chroot\(dq\& is true, the rsync daemon will chroot	path = /home/%RSYNC_USER_NAME%
to the \(dq\&path\(dq\& before starting the file transfer with the client. This has	.fi
the advantage of extra protection against possible implementation security	.RE
holes, but it has the disadvantages of requiring super\-user privileges,	.IP
of not being able to follow symbolic links that are either absolute or outside	It is fine if the path includes internal spaces\ \-\- they will be retained
of the new root path, and of complicating the preservation of users and groups	verbatim (which means that you shouldn't try to escape them). If your
by name (see below).	final directory has a trailing space (and this is somehow not something you
.IP	wish to fix), append a trailing slash to the path to avoid losing the
As an additional safety feature, you can specify a dot\-dir in the module\(cq\&s	trailing whitespace.
\(dq\&path\(dq\& to indicate the point where the chroot should occur. This allows rsync	.IP "\fBuse\ chroot\fP"
to run in a chroot with a non\-\(dq\&/\(dq\& path for the top of the transfer hierarchy.	If "use chroot" is true, the rsync daemon will chroot to the "path" before
Doing this guards against unintended library loading (since those absolute	starting the file transfer with the client. This has the advantage of
paths will not be inside the transfer hierarchy unless you have used an unwise	extra protection against possible implementation security holes, but it has
pathname), and lets you setup libraries for the chroot that are outside of the	the disadvantages of requiring super-user privileges, of not being able to
transfer. For example, specifying \(dq\&/var/rsync/./module1\(dq\& will chroot to the	follow symbolic links that are either absolute or outside of the new root
\(dq\&/var/rsync\(dq\& directory and set the inside\-chroot path to \(dq\&/module1\(dq\&. If you	path, and of complicating the preservation of users and groups by name (see
had omitted the dot\-dir, the chroot would have used the whole path, and the	below).
inside\-chroot path would have been \(dq\&/\(dq\&.	.IP
.IP	As an additional safety feature, you can specify a dot-dir in the module's
When \(dq\&use chroot\(dq\& is false or the inside\-chroot path is not \(dq\&/\(dq\&, rsync will:	"path" to indicate the point where the chroot should occur. This allows
(1) munge symlinks by	rsync to run in a chroot with a non-"/" path for the top of the transfer
default for security reasons (see \(dq\&munge symlinks\(dq\& for a way to turn this	hierarchy. Doing this guards against unintended library loading (since
off, but only if you trust your users), (2) substitute leading slashes in	those absolute paths will not be inside the transfer hierarchy unless you
absolute paths with the module\(cq\&s path (so that options such as	have used an unwise pathname), and lets you setup libraries for the chroot
\fB\-\-backup\-dir\fP, \fB\-\-compare\-dest\fP, etc. interpret an absolute path as	that are outside of the transfer. For example, specifying
rooted in the module\(cq\&s \(dq\&path\(dq\& dir), and (3) trim \(dq\&..\(dq\& path elements from	"/var/rsync/./module1" will chroot to the "/var/rsync" directory and set
args if rsync believes they would escape the module hierarchy.	the inside-chroot path to "/module1". If you had omitted the dot-dir, the
The default for \(dq\&use chroot\(dq\& is true, and is the safer choice (especially	chroot would have used the whole path, and the inside-chroot path would
if the module is not read\-only).	have been "/".
.IP	.IP
When this parameter is enabled, rsync will not attempt to map users and groups	When both "use chroot" and "daemon chroot" are false, OR the inside-chroot
by name (by default), but instead copy IDs as though \fB\-\-numeric\-ids\fP had	path of "use chroot" is not "/", rsync will: (1) munge symlinks by default
been specified. In order to enable name\-mapping, rsync needs to be able to	for security reasons (see "munge symlinks" for a way to turn this off, but
use the standard library functions for looking up names and IDs (i.e.	only if you trust your users), (2) substitute leading slashes in absolute
\f(CWgetpwuid()\fP	paths with the module's path (so that options such as \fB\-\-backup-dir\fP,
,	\fB\-\-compare-dest\fP, etc. interpret an absolute path as rooted in the module's
\f(CWgetgrgid()\fP	"path" dir), and (3) trim ".." path elements from args if rsync believes
,	they would escape the module hierarchy. The default for "use chroot" is
\f(CWgetpwname()\fP	true, and is the safer choice (especially if the module is not read-only).
, and	.IP
\f(CWgetgrnam()\fP	When this parameter is enabled \fIand\fP the "name converter" parameter is
).	\fInot\fP set, the "numeric ids" parameter will default to being enabled
This means the rsync	(disabling name lookups). This means that if you manually setup
process in the chroot hierarchy will need to have access to the resources	name-lookup libraries in your chroot (instead of using a name converter)
used by these library functions (traditionally /etc/passwd and	that you need to explicitly set \fBnumeric\ ids\ =\ false\fP for rsync to do name
/etc/group, but perhaps additional dynamic libraries as well).	lookups.
.IP	.IP
If you copy the necessary resources into the module\(cq\&s chroot area, you	If you copy library resources into the module's chroot area, you should
should protect them through your OS\(cq\&s normal user/group or ACL settings (to	protect them through your OS's normal user/group or ACL settings (to
prevent the rsync module\(cq\&s user from being able to change them), and then	prevent the rsync module's user from being able to change them), and then
hide them from the user\(cq\&s view via \(dq\&exclude\(dq\& (see how in the discussion of	hide them from the user's view via "exclude" (see how in the discussion of
that parameter). At that point it will be safe to enable the mapping of users	that parameter). However, it's easier and safer to setup a name converter.
and groups by name using the \(dq\&numeric ids\(dq\& daemon parameter (see below).	.IP "\fBdaemon\ chroot\fP"
.IP	This parameter specifies a path to which the daemon will chroot before
Note also that you are free to setup custom user/group information in the	beginning communication with clients. Module paths (and any "use chroot"
chroot area that is different from your normal system. For example, you	settings) will then be related to this one. This lets you choose if you
could abbreviate the list of users and groups.	want the whole daemon to be chrooted (with this setting), just the
.IP	transfers to be chrooted (with "use chroot"), or both. Keep in mind that
.IP "\fBnumeric ids\fP"	the "daemon chroot" area may need various OS/lib/etc files installed to
Enabling this parameter disables the mapping	allow the daemon to function. By default the daemon runs without any
of users and groups by name for the current daemon module. This prevents	chrooting.
the daemon from trying to load any user/group\-related files or libraries.	.IP "\fBproxy\ protocol\fP"
This enabling makes the transfer behave as if the client had passed	When this parameter is enabled, all incoming connections must start with a
the \fB\-\-numeric\-ids\fP command\-line option. By default, this parameter is	V1 or V2 proxy protocol header. If the header is not found, the connection
enabled for chroot modules and disabled for non\-chroot modules.	is closed.
.IP	.IP
A chroot\-enabled module should not have this parameter enabled unless you\(cq\&ve	Setting this to \fBtrue\fP requires a proxy server to forward source IP
taken steps to ensure that the module has the necessary resources it needs	information to rsync, allowing you to log proper IP/host info and make use
to translate names, and that it is not possible for a user to change those	of client-oriented IP restrictions. The default of \fBfalse\fP means that the
resources.	IP information comes directly from the socket's metadata. If rsync is not
.IP	behind a proxy, this should be disabled.
.IP "\fBmunge symlinks\fP"	.IP
This parameter tells rsync to modify	\fICAUTION\fP: using this option can be dangerous if you do not ensure that
all incoming symlinks in a way that makes them unusable but recoverable	only the proxy is allowed to connect to the rsync port. If any non-proxied
(see below). This should help protect your files from user trickery when	connections are allowed through, the client will be able to use a modified
your daemon module is writable. The default is disabled when \(dq\&use chroot\(dq\&	rsync to spoof any remote IP address that they desire. You can lock this
is on and the inside\-chroot path is \(dq\&/\(dq\&, otherwise it is enabled.	down using something like iptables \fB\-uid-owner\ root\fP rules (for strict
.IP	localhost access), various firewall rules, or you can require password
If you disable this parameter on a daemon that is not read\-only, there	authorization so that any spoofing by users will not grant extra access.
are tricks that a user can play with uploaded symlinks to access	.IP
daemon\-excluded items (if your module has any), and, if \(dq\&use chroot\(dq\&	This setting is global. If you need some modules to require this and not
is off, rsync can even be tricked into showing or changing data that	others, then you will need to setup multiple rsync daemon processes on
is outside the module\(cq\&s path (as access\-permissions allow).	different ports.
.IP	.IP "\fBname\ converter\fP"
The way rsync disables the use of symlinks is to prefix each one with	This parameter lets you specify a program that will be run by the rsync
the string \(dq\&/rsyncd\-munged/\(dq\&. This prevents the links from being used	daemon to do user & group conversions between names & ids. This script
as long as that directory does not exist. When this parameter is enabled,	is started prior to any chroot being setup, and runs as the daemon user
rsync will refuse to run if that path is a directory or a symlink to	(not the transfer user). You can specify a fully qualified pathname or
a directory. When using the \(dq\&munge symlinks\(dq\& parameter in a chroot area	a program name that is on the $PATH.
that has an inside\-chroot path of \(dq\&/\(dq\&, you should add \(dq\&/rsyncd\-munged/\(dq\&	.IP
to the exclude setting for the module so that	The program can be used to do normal user & group lookups without having to
a user can\(cq\&t try to create it.	put any extra files into the chroot area of the module \fIor\fP you can do
.IP	customized conversions.
Note: rsync makes no attempt to verify that any pre\-existing symlinks in	.IP
the module\(cq\&s hierarchy are as safe as you want them to be (unless, of	The nameconvert program has access to all of the environment variables that
	are described in the section on \fBpre-xfer\ exec\fP. This is useful if you
	want to customize the conversion using information about the module and/or
	the copy request.
	.IP
	There is a sample python script in the support dir named "nameconvert" that
	implements the normal user & group lookups. Feel free to customize it or
	just use it as documentation to implement your own.
	.IP "\fBnumeric\ ids\fP"
	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 \fB\-\-numeric-ids\fP
	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.
	.IP
	A chroot-enabled module should not have this parameter set to false unless
	you're using a "name converter" program \fIor\fP 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.
	.IP "\fBmunge\ symlinks\fP"
	This parameter tells rsync to modify all symlinks in the same way as the
	(non-daemon-affecting) \fB\-\-munge-links\fP 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 with an inside-chroot path of "/", OR if "daemon chroot"
	is on, otherwise it is enabled.
	.IP
	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
	daemon-excluded items (if your module has any), and, if "use chroot" is
	off, rsync can even be tricked into showing or changing data that is
	outside the module's path (as access-permissions allow).
	.IP
	The way rsync disables the use of symlinks is to prefix each one with the
	string "/rsyncd-munged/". This prevents the links from being used as long
	as that directory does not exist. When this parameter is enabled, rsync
	will refuse to run if that path is a directory or a symlink to a directory.
	When using the "munge symlinks" parameter in a chroot area that has an
	inside-chroot path of "/", you should add "/rsyncd-munged/" to the exclude
	setting for the module so that a user can't try to create it.
	.IP
	Note: rsync makes no attempt to verify that any pre-existing symlinks in
	the module's hierarchy are as safe as you want them to be (unless, of
course, it just copied in the whole hierarchy). If you setup an rsync	course, it just copied in the whole hierarchy). If you setup an rsync
daemon on a new area or locally add symlinks, you can manually protect your	daemon on a new area or locally add symlinks, you can manually protect your
symlinks from being abused by prefixing \(dq\&/rsyncd\-munged/\(dq\& to the start of	symlinks from being abused by prefixing "/rsyncd-munged/" to the start of
every symlink\(cq\&s value. There is a perl script in the support directory	every symlink's value. There is a perl script in the support directory of
of the source code named \(dq\&munge\-symlinks\(dq\& that can be used to add or remove	the source code named "munge-symlinks" that can be used to add or remove
this prefix from your symlinks.	this prefix from your symlinks.
.IP	.IP
When this parameter is disabled on a writable module and \(dq\&use chroot\(dq\& is off	When this parameter is disabled on a writable module and "use chroot" is
(or the inside\-chroot path is not \(dq\&/\(dq\&),	off (or the inside-chroot path is not "/"), incoming symlinks will be
incoming symlinks will be modified to drop a leading slash and to remove \(dq\&..\(dq\&	modified to drop a leading slash and to remove ".." path elements that
path elements that rsync believes will allow a symlink to escape the module\(cq\&s	rsync believes will allow a symlink to escape the module's hierarchy.
hierarchy. There are tricky ways to work around this, though, so you had	There are tricky ways to work around this, though, so you had better trust
better trust your users if you choose this combination of parameters.	your users if you choose this combination of parameters.
.IP
.IP "\fBcharset\fP"	.IP "\fBcharset\fP"
This specifies the name of the character set in which the	This specifies the name of the character set in which the module's
module\(cq\&s filenames are stored. If the client uses an \fB\-\-iconv\fP option,	filenames are stored. If the client uses an \fB\-\-iconv\fP option, the daemon
the daemon will use the value of the \(dq\&charset\(dq\& parameter regardless of the	will use the value of the "charset" parameter regardless of the character
character set the client actually passed. This allows the daemon to	set the client actually passed. This allows the daemon to support charset
support charset conversion in a chroot module without extra files in the	conversion in a chroot module without extra files in the chroot area, and
chroot area, and also ensures that name\-translation is done in a consistent	also ensures that name-translation is done in a consistent manner. If the
manner. If the \(dq\&charset\(dq\& parameter is not set, the \fB\-\-iconv\fP option is	"charset" parameter is not set, the \fB\-\-iconv\fP option is refused, just as if
refused, just as if \(dq\&iconv\(dq\& had been specified via \(dq\&refuse options\(dq\&.	"iconv" had been specified via "refuse options".
.IP	.IP
If you wish to force users to always use \fB\-\-iconv\fP for a particular	If you wish to force users to always use \fB\-\-iconv\fP for a particular module,
module, add \(dq\&no\-iconv\(dq\& to the \(dq\&refuse options\(dq\& parameter. Keep in mind	add "no-iconv" to the "refuse options" parameter. Keep in mind that this
that this will restrict access to your module to very new rsync clients.	will restrict access to your module to very new rsync clients.
.IP	.IP "\fBmax\ connections\fP"
.IP "\fBmax connections\fP"	This parameter allows you to specify the maximum number of simultaneous
This parameter allows you to	connections you will allow. Any clients connecting when the maximum has
specify the maximum number of simultaneous connections you will allow.	been reached will receive a message telling them to try later. The default
Any clients connecting when the maximum has been reached will receive a	is 0, which means no limit. A negative value disables the module. See
message telling them to try later. The default is 0, which means no limit.	also the "lock file" parameter.
A negative value disables the module.	.IP "\fBlink\ by\ hash\ dir\fP"
See also the \(dq\&lock file\(dq\& parameter.	When the "link by hash dir" parameter is set to a non-empty string,
.IP	received files will be hard linked into \fBDIR\fP, a link farm arranged by
.IP "\fBlog file\fP"	MD5 file hash. See the \fB\-\-link-by-hash\fP option for a full explanation.
When the \(dq\&log file\(dq\& parameter is set to a non\-empty	.IP
string, the rsync daemon will log messages to the indicated file rather	The \fBDIR\fP must be accessible inside any chroot restrictions for the
than using syslog. This is particularly useful on systems (such as AIX)	module, but can exist outside the transfer location if there is an
where	inside-the-chroot path to the module (see "use chroot"). Note that a
\f(CWsyslog()\fP	user-specified option does not allow this outside-the-transfer-area
doesn\(cq\&t work for chrooted programs. The file is	placement.
opened before	.IP
\f(CWchroot()\fP	If this parameter is set, it will disable the \fB\-\-link-by-hash\fP command-line
is called, allowing it to be placed outside	option for copies into the module.
the transfer. If this value is set on a per\-module basis instead of	.P
globally, the global log will still contain any authorization failures	The default is for this parameter to be unset.
or config\-file error messages.	.P
.IP	.IP "\fBlog\ file\fP"
If the daemon fails to open the specified file, it will fall back to	When the "log file" parameter is set to a non-empty string, the rsync
using syslog and output an error about the failure. (Note that the	daemon will log messages to the indicated file rather than using syslog.
failure to open the specified log file used to be a fatal error.)	This is particularly useful on systems (such as AIX) where \fBsyslog()\fP
.IP	doesn't work for chrooted programs. The file is opened before \fBchroot()\fP
.IP "\fBsyslog facility\fP"	is called, allowing it to be placed outside the transfer. If this value is
This parameter allows you to	set on a per-module basis instead of globally, the global log will still
specify the syslog facility name to use when logging messages from the	contain any authorization failures or config-file error messages.
rsync daemon. You may use any standard syslog facility name which is	.IP
defined on your system. Common names are auth, authpriv, cron, daemon,	If the daemon fails to open the specified file, it will fall back to using
ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,	syslog and output an error about the failure. (Note that the failure to
local1, local2, local3, local4, local5, local6 and local7. The default	open the specified log file used to be a fatal error.)
is daemon. This setting has no effect if the \(dq\&log file\(dq\& setting is a	.IP
non\-empty string (either set in the per\-modules settings, or inherited	This setting can be overridden by using the \fB\-\-log-file=FILE\fP or
from the global settings).	\fB\-\-dparam=logfile=FILE\fP command-line options. The former overrides all the
.IP	log-file parameters of the daemon and all module settings. The latter sets
.IP "\fBmax verbosity\fP"	the daemon's log file and the default for all the modules, which still
This parameter allows you to control	allows modules to override the default setting.
the maximum amount of verbose information that you\(cq\&ll allow the daemon to	.IP "\fBsyslog\ facility\fP"
generate (since the information goes into the log file). The default is 1,	This parameter allows you to specify the syslog facility name to use when
which allows the client to request one level of verbosity.	logging messages from the rsync daemon. You may use any standard syslog
.IP	facility name which is defined on your system. Common names are auth,
.IP "\fBlock file\fP"	authpriv, cron, daemon, ftp, kern, lpr, mail, news, security, syslog, user,
This parameter specifies the file to use to	uucp, local0, local1, local2, local3, local4, local5, local6 and local7.
support the \(dq\&max connections\(dq\& parameter. The rsync daemon uses record	The default is daemon. This setting has no effect if the "log file"
locking on this file to ensure that the max connections limit is not	setting is a non-empty string (either set in the per-modules settings, or
exceeded for the modules sharing the lock file.	inherited from the global settings).
The default is \f(CW/var/run/rsyncd.lock\fP.	.IP "\fBsyslog\ tag\fP"
.IP	This parameter allows you to specify the syslog tag to use when logging
.IP "\fBread only\fP"	messages from the rsync daemon. The default is "rsyncd". This setting has
This parameter determines whether clients	no effect if the "log file" setting is a non-empty string (either set in
will be able to upload files or not. If \(dq\&read only\(dq\& is true then any	the per-modules settings, or inherited from the global settings).
attempted uploads will fail. If \(dq\&read only\(dq\& is false then uploads will	.IP
be possible if file permissions on the daemon side allow them. The default	For example, if you wanted each authenticated user's name to be included in
is for all modules to be read only.	the syslog tag, you could do something like this:
.IP	.RS 4
.IP "\fBwrite only\fP"	.IP
This parameter determines whether clients	.nf
will be able to download files or not. If \(dq\&write only\(dq\& is true then any	syslog tag = rsyncd.%RSYNC_USER_NAME%
attempted downloads will fail. If \(dq\&write only\(dq\& is false then downloads	.fi
will be possible if file permissions on the daemon side allow them. The	.RE
default is for this parameter to be disabled.	.IP "\fBmax\ verbosity\fP"
.IP	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.
	.IP
	This also affects the user's ability to request higher levels of \fB\-\-info\fP
	and \fB\-\-debug\fP logging. If the max value is 2, then no info and/or debug
	value that is higher than what would be set by \fB\-vv\fP 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 \fBrsync\ \-\-info=help\fP and
	\fBrsync\ \-\-debug=help\fP. For instance, it takes max-verbosity 4 to be able to
	output debug TIME2 and FLIST3.
	.IP "\fBlock\ file\fP"
	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 exceeded for the modules sharing the lock
	file. The default is \fB/var/run/rsyncd.lock\fP.
	.IP "\fBchecksum\ files\fP"
	This parameter tells rsync to make use of any cached checksum information
	it finds in per-directory .rsyncsums files when the current transfer is
	using the \fB\-\-checksum\fP option. The value can be set to either "lax",
	"strict", "+lax", "+strict", "++lax", "++strict", or +"none". See the
	client's \fB\-\-sumfiles\fP option for what these choices do.
	.IP
	Note also that the client's command-line option, \fB\-\-sumfiles\fP, has no
	effect on a daemon. A daemon will only access checksum files if this
	config option tells it to. You can configure updating of the .rsyncsums
	files even if the module itself is configured to be read-only. See also
	the \fBexclude\fP directive for a way to hide the .rsyncsums files from the
	user.
	.IP "\fBread\ only\fP"
	This parameter determines whether clients will be able to upload files or
	not. If "read only" is true then any attempted uploads will fail. If
	"read only" is false then uploads will be possible if file permissions on
	the daemon side allow them. The default is for all modules to be read only.
	.IP
	Note that "auth users" can override this setting on a per-user basis.
	.IP "\fBwrite\ only\fP"
	This parameter determines whether clients will be able to download files or
	not. If "write only" is true then any attempted downloads will fail. If
	"write only" is false then downloads will be possible if file permissions
	on the daemon side allow them. The default is for this parameter to be
	disabled.
	.IP
	Helpful hint: you probably want to specify "refuse options = delete" for a
	write-only module.
	.IP "\fBopen\ noatime\fP"
	When set to True, this parameter tells the rsync daemon to open files with
	the O_NOATIME flag
	(on systems that support it) to avoid changing the access time of the files
	that are being transferred. If your OS does not support the O_NOATIME flag
	then rsync will silently ignore this option. Note also that some
	filesystems are mounted to avoid updating the atime on read access even
	without the O_NOATIME flag being set.
	.IP
	When set to False, this parameters ensures that files on the server are not
	opened with O_NOATIME.
	.IP
	When set to Unset (the default) the user controls the setting via
	\fB\-\-open-noatime\fP.
.IP "\fBlist\fP"	.IP "\fBlist\fP"
This parameter determines if this module should be	This parameter determines whether this module is listed when the client
listed when the client asks for a listing of available modules. By	asks for a listing of available modules. In addition, if this is false,
setting this to false you can create hidden modules. The default is	the daemon will pretend the module does not exist when a client denied by
	"hosts allow" or "hosts deny" attempts to access it. Realize that if
	"reverse lookup" is disabled globally but enabled for the module, the
	resulting reverse lookup to a potentially client-controlled DNS server may
	still reveal to the client that it hit an existing module. The default is
for modules to be listable.	for modules to be listable.
.IP
.IP "\fBuid\fP"	.IP "\fBuid\fP"
This parameter specifies the user name or user ID that	This parameter specifies the user name or user ID that file transfers to
file transfers to and from that module should take place as when the daemon	and from that module should take place as when the daemon was run as root.
was run as root. In combination with the \(dq\&gid\(dq\& parameter this determines what	In combination with the "gid" parameter this determines what file
file permissions are available. The default is uid \-2, which is normally	permissions are available. The default when run by a super-user is to
the user \(dq\&nobody\(dq\&.	switch to the system's "nobody" user. The default for a non-super-user is
.IP	to not try to change the user. See also the "gid" parameter.
	.IP
	The RSYNC_USER_NAME environment variable may be used to request that rsync
	run as the authorizing user. For example, if you want a rsync to run as
	the same user that was received for the rsync authentication, this setup is
	useful:
	.RS 4
	.IP
	.nf
	uid = %RSYNC_USER_NAME%
	gid = *
	.fi
	.RE
.IP "\fBgid\fP"	.IP "\fBgid\fP"
This parameter specifies the group name or group ID that	This parameter specifies one or more group names/IDs that will be used when
file transfers to and from that module should take place as when the daemon	accessing the module. The first one will be the default group, and any
was run as root. This complements the \(dq\&uid\(dq\& parameter. The default is gid \-2,	extra ones be set as supplemental groups. You may also specify a "\fB*\fP" as
which is normally the group \(dq\&nobody\(dq\&.	the first gid in the list, which will be replaced by all the normal groups
.IP	for the transfer's user (see "uid"). The default when run by a super-user
.IP "\fBfake super\fP"	is to switch to your OS's "nobody" (or perhaps "nogroup") group with no
Setting \(dq\&fake super = yes\(dq\& for a module causes the	other supplementary groups. The default for a non-super-user is to not
daemon side to behave as if the \fB\-\-fake\-super\fP command\-line option had	change any group attributes (and indeed, your OS may not allow a
been specified. This allows the full attributes of a file to be stored	non-super-user to try to change their group settings).
without having to have the daemon actually running as root.	.IP
.IP	The specified list is normally split into tokens based on spaces and
	commas. However, if the list starts with a comma, then the list is only
	split on commas, which allows a group name to contain a space. In either
	case any leading and/or trailing whitespace is removed from the tokens and
	empty tokens are ignored.
	.IP "\fBdaemon\ uid\fP"
	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.
	.IP "\fBdaemon\ gid\fP"
	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.
	.IP "\fBfake\ super\fP"
	Setting "fake super = yes" for a module causes the daemon side to behave as
	if the \fB\-\-fake-super\fP command-line option had been specified. This allows
	the full attributes of a file to be stored without having to have the
	daemon actually running as root.
.IP "\fBfilter\fP"	.IP "\fBfilter\fP"
The daemon has its own filter chain that determines what files	The daemon has its own filter chain that determines what files it will let
it will let the client access. This chain is not sent to the client and is	the client access. This chain is not sent to the client and is independent
independent of any filters the client may have specified. Files excluded by	of any filters the client may have specified. Files excluded by the daemon
the daemon filter chain (\fBdaemon\-excluded\fP files) are treated as non\-existent	filter chain (\fBdaemon-excluded\fP files) are treated as non-existent if the
if the client tries to pull them, are skipped with an error message if the	client tries to pull them, are skipped with an error message if the client
client tries to push them (triggering exit code 23), and are never deleted from	tries to push them (triggering exit code 23), and are never deleted from
the module. You can use daemon filters to prevent clients from downloading or	the module. You can use daemon filters to prevent clients from downloading
tampering with private administrative files, such as files you may add to	or tampering with private administrative files, such as files you may add
support uid/gid name translations.	to support uid/gid name translations.
.IP	.IP
The daemon filter chain is built from the \(dq\&filter\(dq\&, \(dq\&include from\(dq\&, \(dq\&include\(dq\&,	The daemon filter chain is built from the "filter", "include from",
\(dq\&exclude from\(dq\&, and \(dq\&exclude\(dq\& parameters, in that order of priority. Anchored	"include", "exclude from", and "exclude" parameters, in that order of
patterns are anchored at the root of the module. To prevent access to an	priority. Anchored patterns are anchored at the root of the module. To
entire subtree, for example, \(dq\&/secret\(dq\&, you \fImust\fP exclude everything in the	prevent access to an entire subtree, for example, "\fB/secret\fP", you \fBmust\fP
subtree; the easiest way to do this is with a triple\-star pattern like	exclude everything in the subtree; the easiest way to do this is with a
\(dq\&/secret/***\(dq\&.	triple-star pattern like "\fB/secret/***\fP".
.IP	.IP
The \(dq\&filter\(dq\& parameter takes a space\-separated list of daemon filter rules,	The "filter" parameter takes a space-separated list of daemon filter rules,
though it is smart enough to know not to split a token at an internal space in	though it is smart enough to know not to split a token at an internal space
a rule (e.g. \(dq\&\- /foo \- /bar\(dq\& is parsed as two rules). You may specify one or	in a rule (e.g. "\fB\-\ /foo\ \-\ /bar\fP" is parsed as two rules). You may specify
more merge\-file rules using the normal syntax. Only one \(dq\&filter\(dq\& parameter can	one or more merge-file rules using the normal syntax. Only one "filter"
apply to a given module in the config file, so put all the rules you want in a	parameter can apply to a given module in the config file, so put all the
single parameter. Note that per\-directory merge\-file rules do not provide as	rules you want in a single parameter. Note that per-directory merge-file
much protection as global rules, but they can be used to make \fB\-\-delete\fP work	rules do not provide as much protection as global rules, but they can be
better during a client download operation if the per\-dir merge files are	used to make \fB\-\-delete\fP work better during a client download operation if
included in the transfer and the client requests that they be used.	the per-dir merge files are included in the transfer and the client
.IP	requests that they be used.
.IP "\fBexclude\fP"	.IP "\fBexclude\fP"
This parameter takes a space\-separated list of daemon	This parameter takes a space-separated list of daemon exclude patterns. As
exclude patterns. As with the client \fB\-\-exclude\fP option, patterns can be	with the client \fB\-\-exclude\fP option, patterns can be qualified with "\fB\-\fP" or
qualified with \(dq\&\- \(dq\& or \(dq\&+ \(dq\& to explicitly indicate exclude/include. Only one	"\fB+\fP" to explicitly indicate exclude/include. Only one "exclude" parameter
\(dq\&exclude\(dq\& parameter can apply to a given module. See the \(dq\&filter\(dq\& parameter	can apply to a given module. See the "filter" parameter for a description
for a description of how excluded files affect the daemon.	of how excluded files affect the daemon.
.IP
.IP "\fBinclude\fP"	.IP "\fBinclude\fP"
Use an \(dq\&include\(dq\& to override the effects of the \(dq\&exclude\(dq\&	Use an "include" to override the effects of the "exclude" parameter. Only
parameter. Only one \(dq\&include\(dq\& parameter can apply to a given module. See the	one "include" parameter can apply to a given module. See the "filter"
\(dq\&filter\(dq\& parameter for a description of how excluded files affect the daemon.	parameter for a description of how excluded files affect the daemon.
.IP	.IP "\fBexclude\ from\fP"
.IP "\fBexclude from\fP"	This parameter specifies the name of a file on the daemon that contains
This parameter specifies the name of a file	daemon exclude patterns, one per line. Only one "exclude from" parameter
on the daemon that contains daemon exclude patterns, one per line. Only one	can apply to a given module; if you have multiple exclude-from files, you
\(dq\&exclude from\(dq\& parameter can apply to a given module; if you have multiple	can specify them as a merge file in the "filter" parameter. See the
exclude\-from files, you can specify them as a merge file in the \(dq\&filter\(dq\&	"filter" parameter for a description of how excluded files affect the
parameter. See the \(dq\&filter\(dq\& parameter for a description of how excluded files
affect the daemon.
.IP
.IP "\fBinclude from\fP"
Analogue of \(dq\&exclude from\(dq\& for a file of daemon include
patterns. Only one \(dq\&include from\(dq\& parameter can apply to a given module. See
the \(dq\&filter\(dq\& parameter for a description of how excluded files affect the
daemon.	daemon.
.IP	.IP "\fBinclude\ from\fP"
.IP "\fBincoming chmod\fP"	Analogue of "exclude from" for a file of daemon include patterns. Only one
This parameter allows you to specify a set of	"include from" parameter can apply to a given module. See the "filter"
comma\-separated chmod strings that will affect the permissions of all	parameter for a description of how excluded files affect the daemon.
incoming files (files that are being received by the daemon). These	.IP "\fBincoming\ chmod\fP"
changes happen after all other permission calculations, and this will	This parameter allows you to specify a set of comma-separated chmod strings
even override destination\-default and/or existing permissions when the	that will affect the permissions of all incoming files (files that are
client does not specify \fB\-\-perms\fP.	being received by the daemon). These changes happen after all other
	permission calculations, and this will even override destination-default
	and/or existing permissions when the client does not specify \fB\-\-perms\fP.
See the description of the \fB\-\-chmod\fP rsync option and the \fBchmod\fP(1)	See the description of the \fB\-\-chmod\fP rsync option and the \fBchmod\fP(1)
manpage for information on the format of this string.	manpage for information on the format of this string.
.IP	.IP "\fBoutgoing\ chmod\fP"
.IP "\fBoutgoing chmod\fP"	This parameter allows you to specify a set of comma-separated chmod strings
This parameter allows you to specify a set of	that will affect the permissions of all outgoing files (files that are
comma\-separated chmod strings that will affect the permissions of all	being sent out from the daemon). These changes happen first, making the
outgoing files (files that are being sent out from the daemon). These	sent permissions appear to be different than those stored in the filesystem
changes happen first, making the sent permissions appear to be different	itself. For instance, you could disable group write permissions on the
than those stored in the filesystem itself. For instance, you could	server while having it appear to be on to the clients. See the description
disable group write permissions on the server while having it appear to	of the \fB\-\-chmod\fP rsync option and the \fBchmod\fP(1) manpage for information
be on to the clients.	on the format of this string.
See the description of the \fB\-\-chmod\fP rsync option and the \fBchmod\fP(1)	.IP "\fBauth\ users\fP"
manpage for information on the format of this string.	This parameter specifies a comma and/or space-separated list of
.IP	authorization rules. In its simplest form, you list the usernames that
.IP "\fBauth users\fP"	will be allowed to connect to this module. The usernames do not need to
This parameter specifies a comma and	exist on the local system. The rules may contain shell wildcard characters
space\-separated list of usernames that will be allowed to connect to	that will be matched against the username provided by the client for
this module. The usernames do not need to exist on the local	authentication. If "auth users" is set then the client will be challenged
system. The usernames may also contain shell wildcard characters. If	to supply a username and password to connect to the module. A challenge
\(dq\&auth users\(dq\& is set then the client will be challenged to supply a	response authentication protocol is used for this exchange. The plain text
username and password to connect to the module. A challenge response
authentication protocol is used for this exchange. The plain text
usernames and passwords are stored in the file specified by the	usernames and passwords are stored in the file specified by the
\(dq\&secrets file\(dq\& parameter. The default is for all users to be able to	"secrets file" parameter. The default is for all users to be able to
connect without a password (this is called \(dq\&anonymous rsync\(dq\&).	connect without a password (this is called "anonymous rsync").
.IP	.IP
See also the section entitled \(dq\&USING RSYNC\-DAEMON FEATURES VIA A REMOTE	In addition to username matching, you can specify groupname matching via a
SHELL CONNECTION\(dq\& in \fBrsync\fP(1) for information on how handle an	\&'@' prefix. When using groupname matching, the authenticating username
rsyncd.conf\-level username that differs from the remote\-shell\-level	must be a real user on the system, or it will be assumed to be a member of
	no groups. For example, specifying "@rsync" will match the authenticating
	user if the named user is a member of the rsync group.
	.IP
	Finally, options may be specified after a colon (:). The options allow you
	to "deny" a user or a group, set the access to "ro" (read-only), or set the
	access to "rw" (read/write). Setting an auth-rule-specific ro/rw setting
	overrides the module's "read only" setting.
	.IP
	Be sure to put the rules in the order you want them to be matched, because
	the checking stops at the first matching user or group, and that is the
	only auth that is checked. For example:
	.RS 4
	.IP
	.nf
	auth users = joe:deny @guest:deny admin:rw @rsync:ro susan joe sam
	.fi
	.RE
	.IP
	In the above rule, user joe will be denied access no matter what. Any user
	that is in the group "guest" is also denied access. The user "admin" gets
	access in read/write mode, but only if the admin user is not in group
	"guest" (because the admin user-matching rule would never be reached if the
	user is in group "guest"). Any other user who is in group "rsync" will get
	read-only 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.
	.IP
	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:
	.RS 4
	.IP
	.nf
	auth users = , joe:deny, @Some Group:deny, admin:rw, @RO Group:ro
	.fi
	.RE
	.IP
	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 what rule is being authenticated.
	.IP
	See also the section entitled "USING RSYNC-DAEMON FEATURES VIA A REMOTE
	SHELL CONNECTION" in \fBrsync\fP(1) for information on how handle an
	rsyncd.conf-level username that differs from the remote-shell-level
username when using a remote shell to connect to an rsync daemon.	username when using a remote shell to connect to an rsync daemon.
.IP	.IP "\fBsecrets\ file\fP"
.IP "\fBsecrets file\fP"	This parameter specifies the name of a file that contains the
This parameter specifies the name of	username:password and/or @groupname:password pairs used for authenticating
a file that contains the username:password pairs used for	this module. This file is only consulted if the "auth users" parameter is
authenticating this module. This file is only consulted if the \(dq\&auth	specified. The file is line-based and contains one name:password pair per
users\(dq\& parameter is specified. The file is line based and contains	line. Any line has a hash (#) as the very first character on the line is
username:password pairs separated by a single colon. Any line starting	considered a comment and is skipped. The passwords can contain any
with a hash (#) is considered a comment and is skipped. The passwords	characters but be warned that many operating systems limit the length of
can contain any characters but be warned that many operating systems	passwords that can be typed at the client end, so you may find that
limit the length of passwords that can be typed at the client end, so	passwords longer than 8 characters don't work.
you may find that passwords longer than 8 characters don\(cq\&t work.	.IP
.IP	The use of group-specific lines are only relevant when the module is being
There is no default for the \(dq\&secrets file\(dq\& parameter, you must choose a name	authorized using a matching "@groupname" rule. When that happens, the user
(such as \f(CW/etc/rsyncd.secrets\fP). The file must normally not be readable	can be authorized via either their "username:password" line or the
by \(dq\&other\(dq\&; see \(dq\&strict modes\(dq\&.	"@groupname:password" line for the group that triggered the authentication.
.IP	.IP
.IP "\fBstrict modes\fP"	It is up to you what kind of password entries you want to include, either
This parameter determines whether or not	users, groups, or both. The use of group rules in "auth users" does not
the permissions on the secrets file will be checked. If \(dq\&strict modes\(dq\& is	require that you specify a group password if you do not want to use shared
true, then the secrets file must not be readable by any user ID other	passwords.
than the one that the rsync daemon is running under. If \(dq\&strict modes\(dq\& is	.IP
false, the check is not performed. The default is true. This parameter	There is no default for the "secrets file" parameter, you must choose a
was added to accommodate rsync running on the Windows operating system.	name (such as \fB/etc/rsyncd.secrets\fP). The file must normally not be
.IP	readable by "other"; see "strict modes". If the file is not found or is
.IP "\fBhosts allow\fP"	rejected, no logins for a "user auth" module will be possible.
This parameter allows you to specify a	.IP "\fBstrict\ modes\fP"
list of patterns that are matched against a connecting clients	This parameter determines whether or not the permissions on the secrets
hostname and IP address. If none of the patterns match then the	file will be checked. If "strict modes" is true, then the secrets file
	must not be readable by any user ID other than the one that the rsync
	daemon is running under. If "strict modes" is false, the check is not
	performed. The default is true. This parameter was added to accommodate
	rsync running on the Windows operating system.
	.IP "\fBhosts\ allow\fP"
	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.	connection is rejected.
.IP	.IP
Each pattern can be in one of five forms:	Each pattern can be in one of six forms:
.IP	.IP
.RS	.RS
.IP o	.IP o
a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address	a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address of
of the form a:b:c::d:e:f. In this case the incoming machine\(cq\&s IP address	the form a:b:c::d:e:f. In this case the incoming machine's IP address
must match exactly.	must match exactly.
.IP o	.IP o
an address/mask in the form ipaddr/n where ipaddr is the IP address	an address/mask in the form ipaddr/n where ipaddr is the IP address and n
and n is the number of one bits in the netmask. All IP addresses which	is the number of one bits in the netmask. All IP addresses which match
match the masked IP address will be allowed in.	the masked IP address will be allowed in.
.IP o	.IP o
an address/mask in the form ipaddr/maskaddr where ipaddr is the	an address/mask in the form ipaddr/maskaddr where ipaddr is the IP
IP address and maskaddr is the netmask in dotted decimal notation for IPv4,	address and maskaddr is the netmask in dotted decimal notation for IPv4,
or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP	or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP
addresses which match the masked IP address will be allowed in.	addresses which match the masked IP address will be allowed in.
.IP o	.IP o
a hostname. The hostname as determined by a reverse lookup will	a hostname pattern using wildcards. If the hostname of the connecting IP
be matched (case insensitive) against the pattern. Only an exact	(as determined by a reverse lookup) matches the wildcarded name (using
match is allowed in.	the same rules as normal unix filename matching), the client is allowed
.IP o	in. This only works if "reverse lookup" is enabled (the default).
a hostname pattern using wildcards. These are matched using the	.IP o
same rules as normal unix filename matching. If the pattern matches	a hostname. A plain hostname is matched against the reverse DNS of the
then the client is allowed in.	connecting IP (if "reverse lookup" is enabled), and/or the IP of the
	given hostname is matched against the connecting IP (if "forward lookup"
	is enabled, as it is by default). Any match will be allowed in.
	.IP o
	an '@' followed by a netgroup name, which will match if the reverse DNS
	of the connecting IP is in the specified netgroup.
.RE	.RE
	.IP
.IP	Note IPv6 link-local addresses can have a scope in the address
Note IPv6 link\-local addresses can have a scope in the address specification:	specification:
.IP	.RS 4
.RS	.IP
\f(CW fe80::1%link1\fP	.nf
.br	fe80::1%link1
\f(CW fe80::%link1/64\fP	fe80::%link1/64
.br	fe80::%link1/ffff:ffff:ffff:ffff::
\f(CW fe80::%link1/ffff:ffff:ffff:ffff::\fP	.fi
.br
.RE	.RE
	.IP
.IP	You can also combine "hosts allow" with "hosts deny" as a way to add
You can also combine \(dq\&hosts allow\(dq\& with a separate \(dq\&hosts deny\(dq\&	exceptions to your deny list. When both parameters are specified, the
parameter. If both parameters are specified then the \(dq\&hosts allow\(dq\& parameter is	"hosts allow" parameter is checked first and a match results in the client
checked first and a match results in the client being able to	being able to connect. A non-allowed host is then matched against the
connect. The \(dq\&hosts deny\(dq\& parameter is then checked and a match means	"hosts deny" list to see if it should be rejected. A host that does not
that the host is rejected. If the host does not match either the	match either list is allowed to connect.
\(dq\&hosts allow\(dq\& or the \(dq\&hosts deny\(dq\& patterns then it is allowed to	.IP
	The default is no "hosts allow" parameter, which means all hosts can
connect.	connect.
.IP	.IP "\fBhosts\ deny\fP"
The default is no \(dq\&hosts allow\(dq\& parameter, which means all hosts can connect.	This parameter allows you to specify a list of comma- and/or
.IP	whitespace-separated patterns that are matched against a connecting clients
.IP "\fBhosts deny\fP"
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	hostname and IP address. If the pattern matches then the connection is
rejected. See the \(dq\&hosts allow\(dq\& parameter for more information.	rejected. See the "hosts allow" parameter for more information.
.IP	.IP
The default is no \(dq\&hosts deny\(dq\& parameter, which means all hosts can connect.	The default is no "hosts deny" parameter, which means all hosts can
.IP	connect.
.IP "\fBignore errors\fP"	.IP "\fBreverse\ lookup\fP"
This parameter tells rsyncd to	Controls whether the daemon performs a reverse lookup on the client's IP
ignore I/O errors on the daemon when deciding whether to run the delete	address to determine its hostname, which is used for "hosts allow" &
phase of the transfer. Normally rsync skips the \fB\-\-delete\fP step if any	"hosts deny" checks and the "%h" log escape. This is enabled by default,
I/O errors have occurred in order to prevent disastrous deletion due	but you may wish to disable it to save time if you know the lookup will not
to a temporary resource shortage or other I/O error. In some cases this	return a useful result, in which case the daemon will use the name
test is counter productive so you can use this parameter to turn off this	"UNDETERMINED" instead.
behavior.	.IP
.IP	If this parameter is enabled globally (even by default), rsync performs the
.IP "\fBignore nonreadable\fP"	lookup as soon as a client connects, so disabling it for a module will not
This tells the rsync daemon to completely	avoid the lookup. Thus, you probably want to disable it globally and then
ignore files that are not readable by the user. This is useful for	enable it for modules that need the information.
public archives that may have some non\-readable files among the	.IP "\fBforward\ lookup\fP"
directories, and the sysadmin doesn\(cq\&t want those files to be seen at all.	Controls whether the daemon performs a forward lookup on any hostname
.IP	specified in an hosts allow/deny setting. By default this is enabled,
.IP "\fBtransfer logging\fP"	allowing the use of an explicit hostname that would not be returned by
This parameter enables per\-file	reverse DNS of the connecting IP.
logging of downloads and uploads in a format somewhat similar to that	.IP "\fBignore\ errors\fP"
used by ftp daemons. The daemon always logs the transfer at the end, so	This parameter tells rsyncd to ignore I/O errors on the daemon when
if a transfer is aborted, no mention will be made in the log file.	deciding whether to run the delete phase of the transfer. Normally rsync
.IP	skips the \fB\-\-delete\fP step if any I/O errors have occurred in order to
If you want to customize the log lines, see the \(dq\&log format\(dq\& parameter.	prevent disastrous deletion due to a temporary resource shortage or other
.IP	I/O error. In some cases this test is counter productive so you can use
.IP "\fBlog format\fP"	this parameter to turn off this behavior.
This parameter allows you to specify the	.IP "\fBignore\ nonreadable\fP"
format used for logging file transfers when transfer logging is enabled.	This tells the rsync daemon to completely ignore files that are not
The format is a text string containing embedded single\-character escape	readable by the user. This is useful for public archives that may have some
sequences prefixed with a percent (%) character. An optional numeric	non-readable files among the directories, and the sysadmin doesn't want
field width may also be specified between the percent and the escape	those files to be seen at all.
letter (e.g. \(dq\&\fB%\-50n %8l %07p\fP\(dq\&).	.IP "\fBtransfer\ logging\fP"
.IP	This parameter enables per-file logging of downloads and uploads in a
The default log format is \(dq\&%o %h [%a] %m (%u) %f %l\(dq\&, and a \(dq\&%t [%p] \(dq\&	format somewhat similar to that used by ftp daemons. The daemon always
is always prefixed when using the \(dq\&log file\(dq\& parameter.	logs the transfer at the end, so if a transfer is aborted, no mention will
(A perl script that will summarize this default log format is included	be made in the log file.
in the rsync source code distribution in the \(dq\&support\(dq\& subdirectory:	.IP
rsyncstats.)	If you want to customize the log lines, see the "log format" parameter.
.IP	.IP "\fBlog\ format\fP"
The single\-character escapes that are understood are as follows:	This parameter allows you to specify the format used for logging file
.IP	transfers when transfer logging is enabled. The format is a text string
.RS	containing embedded single-character escape sequences prefixed with a
.IP o	percent (%) character. An optional numeric field width may also be
%a the remote IP address	specified between the percent and the escape letter (e.g.
.IP o	"\fB%\-50n\ %8l\ %07p\fP"). In addition, one or more apostrophes may be specified
	prior to a numerical escape to indicate that the numerical value should be
	made more human-readable. The 3 supported levels are the same as for the
	\fB\-\-human-readable\fP command-line option, though the default is for
	human-readability to be off. Each added apostrophe increases the level
	(e.g. "\fB%''l\ %'b\ %f\fP").
	.IP
	The default log format is "\fB%o\ %h\ [%a]\ %m\ (%u)\ %f\ %l\fP", and a "\fB%t\ [%p]\fP"
	is always prefixed when using the "log file" parameter. (A perl script
	that will summarize this default log format is included in the rsync source
	code distribution in the "support" subdirectory: rsyncstats.)
	.IP
	The single-character escapes that are understood are as follows:
	.IP
	.RS
	.IP o
	%a the remote IP address (only available for a daemon)
	.IP o
%b the number of bytes actually transferred	%b the number of bytes actually transferred
.IP o	.IP o
%B the permission bits of the file (e.g. rwxrwxrwt)	%B the permission bits of the file (e.g. rwxrwxrwt)
.IP o	.IP o
%c the total size of the block checksums received for the basis file (only when sending)	%c the total size of the block checksums received for the basis file
.IP o	(only when sending)
%f the filename (long form on sender; no trailing \(dq\&/\(dq\&)	.IP o
.IP o	%C the full-file checksum if it is known for the file. For older rsync
%G the gid of the file (decimal) or \(dq\&DEFAULT\(dq\&	protocols/versions, the checksum was salted, and is thus not a useful
.IP o	value (and is not displayed when that is the case). For the checksum to
%h the remote host name	output for a file, either the \fB\-\-checksum\fP option must be in-effect or
.IP o	the file must have been transferred without a salted checksum being used.
	See the \fB\-\-checksum-choice\fP option for a way to choose the algorithm.
	.IP o
	%f the filename (long form on sender; no trailing "/")
	.IP o
	%G the gid of the file (decimal) or "DEFAULT"
	.IP o
	%h the remote host name (only available for a daemon)
	.IP o
%i an itemized list of what is being updated	%i an itemized list of what is being updated
.IP o	.IP o
%l the length of the file in bytes	%l the length of the file in bytes
.IP o	.IP o
%L the string \(dq\& \-> SYMLINK\(dq\&, \(dq\& => HARDLINK\(dq\&, or \(dq\&\(dq\& (where \fBSYMLINK\fP or \fBHARDLINK\fP is a filename)	%L the string "\fB\->\ SYMLINK\fP", "\fB=>\ HARDLINK\fP", or "" (where \fBSYMLINK\fP
.IP o	or \fBHARDLINK\fP is a filename)
	.IP o
%m the module name	%m the module name
.IP o	.IP o
%M the last\-modified time of the file	%M the last-modified time of the file
.IP o	.IP o
%n the filename (short form; trailing \(dq\&/\(dq\& on dir)	%n the filename (short form; trailing "/" on dir)
.IP o	.IP o
%o the operation, which is \(dq\&send\(dq\&, \(dq\&recv\(dq\&, or \(dq\&del.\(dq\& (the latter includes the trailing period)	%o the operation, which is "send", "recv", or "del." (the latter includes
.IP o	the trailing period)
	.IP o
%p the process ID of this rsync session	%p the process ID of this rsync session
.IP o	.IP o
%P the module path	%P the module path
.IP o	.IP o
%t the current date time	%t the current date time
.IP o	.IP o
%u the authenticated username or an empty string	%u the authenticated username or an empty string
.IP o	.IP o
%U the uid of the file (decimal)	%U the uid of the file (decimal)
.RE	.RE
	.IP
.IP	For a list of what the characters mean that are output by "%i", see the
For a list of what the characters mean that are output by \(dq\&%i\(dq\&, see the	\fB\-\-itemize-changes\fP option in the rsync manpage.
\fB\-\-itemize\-changes\fP option in the rsync manpage.	.IP
.IP	Note that some of the logged output changes when talking with older rsync
Note that some of the logged output changes when talking with older	versions. For instance, deleted files were only output as verbose messages
rsync versions. For instance, deleted files were only output as verbose	prior to rsync 2.6.4.
messages prior to rsync 2.6.4.
.IP
.IP "\fBtimeout\fP"	.IP "\fBtimeout\fP"
This parameter allows you to override the	This parameter allows you to override the clients choice for I/O timeout
clients choice for I/O timeout for this module. Using this parameter you	for this module. Using this parameter you can ensure that rsync won't wait
can ensure that rsync won\(cq\&t wait on a dead client forever. The timeout	on a dead client forever. The timeout is specified in seconds. A value of
is specified in seconds. A value of zero means no timeout and is the	zero means no timeout and is the default. A good choice for anonymous rsync
default. A good choice for anonymous rsync daemons may be 600 (giving	daemons may be 600 (giving a 10 minute timeout).
a 10 minute timeout).	.IP "\fBrefuse\ options\fP"
.IP	This parameter allows you to specify a space-separated list of rsync
.IP "\fBrefuse options\fP"	command-line options that will be refused by your rsync daemon. You may
This parameter allows you to	specify the full option name, its one-letter abbreviation, or a wild-card
specify a space\-separated list of rsync command line options that will	string that matches multiple options. Beginning in 3.2.0, you can also
be refused by your rsync daemon.	negate a match term by starting it with a "!".
You may specify the full option name, its one\-letter abbreviation, or a	.IP
wild\-card string that matches multiple options.	When an option is refused, the daemon prints an error message and exits.
	.IP
For example, this would refuse \fB\-\-checksum\fP (\fB\-c\fP) and all the various	For example, this would refuse \fB\-\-checksum\fP (\fB\-c\fP) and all the various
delete options:	delete options:
.IP	.RS 4
.RS	.IP
\f(CW refuse options = c delete\fP	.nf
	refuse options = c delete
	.fi
.RE	.RE
	.IP
.IP
The reason the above refuses all delete options is that the options imply	The reason the above refuses all delete options is that the options imply
\fB\-\-delete\fP, and implied options are refused just like explicit options.	\fB\-\-delete\fP, and implied options are refused just like explicit options.
As an additional safety feature, the refusal of \(dq\&delete\(dq\& also refuses	.IP
\fBremove\-source\-files\fP when the daemon is the sender; if you want the latter	The use of a negated match allows you to fine-tune your refusals after a
without the former, instead refuse \(dq\&delete\-*\(dq\& \-\- that refuses all the	wild-card, such as this:
delete modes without affecting \fB\-\-remove\-source\-files\fP.	.RS 4
.IP	.IP
When an option is refused, the daemon prints an error message and exits.	.nf
To prevent all compression when serving files,	refuse options = delete-* !delete-during
you can use \(dq\&dont compress = *\(dq\& (see below)	.fi
instead of \(dq\&refuse options = compress\(dq\& to avoid returning an error to a	.RE
client that requests compression.	.IP
.IP	Negated matching can also turn your list of refused options into a list of
.IP "\fBdont compress\fP"	accepted options. To do this, begin the list with a "\fB*\fP" (to refuse all
This parameter allows you to select	options) and then specify one or more negated matches to accept. For
filenames based on wildcard patterns that should not be compressed	example:
when pulling files from the daemon (no analogous parameter exists to	.RS 4
govern the pushing of files to a daemon).	.IP
Compression is expensive in terms of CPU usage, so it	.nf
is usually good to not try to compress files that won\(cq\&t compress well,	refuse options = * !a !v !compress*
such as already compressed files.	.fi
.IP	.RE
The \(dq\&dont compress\(dq\& parameter takes a space\-separated list of	.IP
case\-insensitive wildcard patterns. Any source filename matching one	Don't worry that the "\fB*\fP" will refuse certain vital options such as
of the patterns will not be compressed during transfer.	\fB\-\-dry-run\fP, \fB\-\-server\fP, \fB\-\-no-iconv\fP, \fB\-\-protect-args\fP, etc. These
.IP	important options are not matched by wild-card, so they must be overridden
See the \fB\-\-skip\-compress\fP parameter in the \fBrsync\fP(1) manpage for the list	by their exact name. For instance, if you're forcing iconv transfers you
of file suffixes that are not compressed by default. Specifying a value	could use something like this:
for the \(dq\&dont compress\(dq\& parameter changes the default when the daemon is	.RS 4
the sender.	.IP
.IP	.nf
.IP "\fBpre\-xfer exec\fP, \fBpost\-xfer exec\fP"	refuse options = * no-iconv !a !v
You may specify a command to be run	.fi
before and/or after the transfer. If the \fBpre\-xfer exec\fP command fails, the	.RE
transfer is aborted before it begins.	.IP
.IP	As an additional aid (beginning in 3.2.0), refusing (or "\fB!refusing\fP") the
The following environment variables will be set, though some are	"a" or "archive" option also affects all the options that the \fB\-\-archive\fP
specific to the pre\-xfer or the post\-xfer environment:	option implies (\fB\-rdlptgoD\fP), but only if the option is matched explicitly
.IP	(not using a wildcard). If you want to do something tricky, you can use
.RS	"\fBarchive*\fP" to avoid this side-effect, but keep in mind that no normal
.IP o	rsync client ever sends the actual archive option to the server.
	.IP
	As an additional safety feature, the refusal of "delete" also refuses
	\fBremove-source-files\fP when the daemon is the sender; if you want the latter
	without the former, instead refuse "\fBdelete-*\fP" as that refuses all the
	delete modes without affecting \fB\-\-remove-source-files\fP. (Keep in mind that
	the client's \fB\-\-delete\fP option typically results in \fB\-\-delete-during\fP.)
	.IP
	When un-refusing delete options, you should either specify "\fB!delete*\fP" (to
	accept all delete options) or specify a limited set that includes "delete",
	such as:
	.RS 4
	.IP
	.nf
	refuse options = * !a !delete !delete-during
	.fi
	.RE
	.IP
	\&... whereas this accepts any delete option except \fB\-\-delete-after\fP:
	.RS 4
	.IP
	.nf
	refuse options = * !a !delete* delete-after
	.fi
	.RE
	.IP
	A note on refusing "compress"\ \-\- it is better to set the "dont compress"
	daemon parameter to "\fB*\fP" because that disables compression silently
	instead of returning an error that forces the client to remove the \fB\-z\fP
	option.
	.IP
	If you are un-refusing the compress option, you probably want to match
	"\fB!compress*\fP" so that you also accept the \fB\-\-compress-level\fP option.
	.IP
	Note that the "copy-devices" & "write-devices" options are refused by
	default, but they can be explicitly accepted with "\fB!copy-devices\fP" and/or
	"\fB!write-devices\fP". The options "log-file" and "log-file-format" are
	forcibly refused and cannot be accepted.
	.IP
	Here are all the options that are not matched by wild-cards:
	.IP
	.RS
	.IP o
	\fB\-\-server\fP: Required for rsync to even work.
	.IP o
	\fB\-\-rsh\fP, \fB\-e\fP: Required to convey compatibility flags to the server.
	.IP o
	\fB\-\-out-format\fP: This is required to convey output behavior to a remote
	receiver. While rsync passes the older alias \fB\-\-log-format\fP for
	compatibility reasons, this options should not be confused with
	\fB\-\-log-file-format\fP.
	.IP o
	\fB\-\-sender\fP: Use "write only" parameter instead of refusing this.
	.IP o
	\fB\-\-dry-run\fP, \fB\-n\fP: Who would want to disable this?
	.IP o
	\fB\-\-protect-args\fP, \fB\-s\fP: This actually makes transfers safer.
	.IP o
	\fB\-\-from0\fP, \fB\-0\fP: Makes it easier to accept/refuse \fB\-\-files-from\fP without
	affecting this helpful modifier.
	.IP o
	\fB\-\-iconv\fP: This is auto-disabled based on "charset" parameter.
	.IP o
	\fB\-\-no-iconv\fP: Most transfers use this option.
	.IP o
	\fB\-\-checksum-seed\fP: Is a fairly rare, safe option.
	.IP o
	\fB\-\-write-devices\fP: Is non-wild but also auto-disabled.
	.RE
	.IP "\fBdont\ compress\fP"
	This parameter allows you to select filenames based on wildcard patterns
	that should not be compressed when pulling files from the daemon (no
	analogous parameter exists to govern the pushing of files to a daemon).
	Compression can be expensive in terms of CPU usage, so it is usually good
	to not try to compress files that won't compress well, such as already
	compressed files.
	.IP
	The "dont compress" parameter takes a space-separated list of
	case-insensitive wildcard patterns. Any source filename matching one of the
	patterns will be compressed as little as possible during the transfer. If
	the compression algorithm has an "off" level (such as zlib/zlibx) then no
	compression occurs for those files. Other algorithms have the level
	minimized to reduces the CPU usage as much as possible.
	.IP
	See the \fB\-\-skip-compress\fP parameter in the \fBrsync\fP(1) manpage for the
	list of file suffixes that are not compressed by default. Specifying a
	value for the "dont compress" parameter changes the default when the daemon
	is the sender.
	.IP "\fBearly\ exec\fP, \fBpre-xfer\ exec\fP, \fBpost-xfer\ exec\fP"
	You may specify a command to be run in the early stages of the connection,
	or right before and/or after the transfer. If the \fBearly\ exec\fP or
	\fBpre-xfer\ exec\fP command returns an error code, the transfer is aborted
	before it begins. Any output from the \fBpre-xfer\ exec\fP command on stdout
	(up to several KB) will be displayed to the user when aborting, but is
	\fInot\fP displayed if the script returns success. The other programs cannot
	send any text to the user. All output except for the \fBpre-xfer\ exec\fP
	stdout goes to the corresponding daemon's stdout/stderr, which is typically
	discarded. See the \fB\-\-no-detatch\fP option for a way to see the daemon's
	output, which can assist with debugging.
	.IP
	Note that the \fBearly\ exec\fP command runs before any part of the transfer
	request is known except for the module name. This helper script can be
	used to setup a disk mount or decrypt some data into a module dir, but you
	may need to use \fBlock\ file\fP and \fBmax\ connections\fP to avoid concurrency
	issues. If the client rsync specified the \fB\-\-early-input=FILE\fP option, it
	can send up to about 5K of data to the stdin of the early script. The
	stdin will otherwise be empty.
	.IP
	Note that the \fBpost-xfer\ exec\fP command is still run even if one of the
	other scripts returns an error code. The \fBpre-xfer\ exec\fP command will \fInot\fP
	be run, however, if the \fBearly\ exec\fP command fails.
	.IP
	The following environment variables will be set, though some are specific
	to the pre-xfer or the post-xfer environment:
	.IP
	.RS
	.IP o
\fBRSYNC_MODULE_NAME\fP: The name of the module being accessed.	\fBRSYNC_MODULE_NAME\fP: The name of the module being accessed.
.IP o	.IP o
\fBRSYNC_MODULE_PATH\fP: The path configured for the module.	\fBRSYNC_MODULE_PATH\fP: The path configured for the module.
.IP o	.IP o
\fBRSYNC_HOST_ADDR\fP: The accessing host\(cq\&s IP address.	\fBRSYNC_HOST_ADDR\fP: The accessing host's IP address.
.IP o	.IP o
\fBRSYNC_HOST_NAME\fP: The accessing host\(cq\&s name.	\fBRSYNC_HOST_NAME\fP: The accessing host's name.
.IP o	.IP o
\fBRSYNC_USER_NAME\fP: The accessing user\(cq\&s name (empty if no user).	\fBRSYNC_USER_NAME\fP: The accessing user's name (empty if no user).
.IP o	.IP o
\fBRSYNC_PID\fP: A unique number for this transfer.	\fBRSYNC_PID\fP: A unique number for this transfer.
.IP o	.IP o
\fBRSYNC_REQUEST\fP: (pre\-xfer only) The module/path info specified	\fBRSYNC_REQUEST\fP: (pre-xfer only) The module/path info specified by the
by the user (note that the user can specify multiple source files,	user. Note that the user can specify multiple source files, so the
so the request can be something like \(dq\&mod/path1 mod/path2\(dq\&, etc.).	request can be something like "mod/path1 mod/path2", etc.
.IP o	.IP o
\fBRSYNC_ARG#\fP: (pre\-xfer only) The pre\-request arguments are set	\fBRSYNC_ARG#\fP: (pre-xfer only) The pre-request arguments are set in these
in these numbered values. RSYNC_ARG0 is always \(dq\&rsyncd\(dq\&, and the last	numbered values. RSYNC_ARG0 is always "rsyncd", followed by the options
value contains a single period.	that were used in RSYNC_ARG1, and so on. There will be a value of "."
.IP o	indicating that the options are done and the path args are beginning\ \-\-
\fBRSYNC_EXIT_STATUS\fP: (post\-xfer only) the server side\(cq\&s exit value.	these contain similar information to RSYNC_REQUEST, but with values
This will be 0 for a successful run, a positive value for an error that the	separated and the module name stripped off.
	.IP o
	\fBRSYNC_EXIT_STATUS\fP: (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	server generated, or a \-1 if rsync failed to exit properly. Note that an
error that occurs on the client side does not currently get sent to the	error that occurs on the client side does not currently get sent to the
server side, so this is not the final exit status for the whole transfer.	server side, so this is not the final exit status for the whole transfer.
.IP o	.IP o
\fBRSYNC_RAW_STATUS\fP: (post\-xfer only) the raw exit value from	\fBRSYNC_RAW_STATUS\fP: (post-xfer only) the raw exit value from
\f(CWwaitpid()\fP	\fBwaitpid()\fP.
\&.
.RE	.RE
	.IP
.IP
Even though the commands can be associated with a particular module, they	Even though the commands can be associated with a particular module, they
are run using the permissions of the user that started the daemon (not the	are run using the permissions of the user that started the daemon (not the
module\(cq\&s uid/gid setting) without any chroot restrictions.	module's uid/gid setting) without any chroot restrictions.
.IP	.IP
.SH "AUTHENTICATION STRENGTH"	These settings honor 2 environment variables: use RSYNC_SHELL to set a
	shell to use when running the command (which otherwise uses your
	\fBsystem()\fP call's default shell), and use RSYNC_NO_XFER_EXEC to disable
	both options completely.
	.P
	.SH "CONFIG DIRECTIVES"
	.P
	There are currently two config directives available that allow a config file to
	incorporate the contents of other files: \fB&include\fP and \fB&merge\fP. Both allow
	a reference to either a file or a directory. They differ in how segregated the
	file's contents are considered to be.
	.P
	The \fB&include\fP directive treats each file as more distinct, with each one
	inheriting the defaults of the parent file, starting the parameter parsing as
	globals/defaults, and leaving the defaults unchanged for the parsing of the
	rest of the parent file.
	.P
	The \fB&merge\fP directive, on the other hand, treats the file's contents as if it
	were simply inserted in place of the directive, and thus it can set parameters
	in a module started in another file, can affect the defaults for other files,
	etc.
	.P
	When an \fB&include\fP or \fB&merge\fP directive refers to a directory, it will read in
	all the \fB.conf\fP or \fB.inc\fP files (respectively) that are contained inside that
	directory (without any recursive scanning), with the files sorted into alpha
	order. So, if you have a directory named "rsyncd.d" with the files "foo.conf",
	"bar.conf", and "baz.conf" inside it, this directive:
	.RS 4
	.P
	.nf
	&include /path/rsyncd.d
	.fi
	.RE
	.P
	would be the same as this set of directives:
	.RS 4
	.P
	.nf
	&include /path/rsyncd.d/bar.conf
	&include /path/rsyncd.d/baz.conf
	&include /path/rsyncd.d/foo.conf
	.fi
	.RE
	.P
	except that it adjusts as files are added and removed from the directory.
	.P
	The advantage of the \fB&include\fP directive is that you can define one or more
	modules in a separate file without worrying about unintended side-effects
	between the self-contained module files.
	.P
	The advantage of the \fB&merge\fP directive is that you can load config snippets
	that can be included into multiple module definitions, and you can also set
	global values that will affect connections (such as \fBmotd\ file\fP), or globals
	that will affect other include files.
	.P
	For example, this is a useful /etc/rsyncd.conf file:
	.RS 4
	.P
	.nf
	port = 873
	log file = /var/log/rsync.log
	pid file = /var/lock/rsync.lock

.PP	&merge /etc/rsyncd.d
The authentication protocol used in rsync is a 128 bit MD4 based	&include /etc/rsyncd.d
challenge response system. This is fairly weak protection, though (with	.fi
at least one brute\-force hash\-finding algorithm publicly available), so	.RE
if you want really top\-quality security, then I recommend that you run	.P
rsync over ssh. (Yes, a future version of rsync will switch over to a	This would merge any \fB/etc/rsyncd.d/*.inc\fP files (for global values that should
stronger hashing method.)	stay in effect), and then include any \fB/etc/rsyncd.d/*.conf\fP files (defining
.PP	modules without any global-value cross-talk).
	.P
	.SH "AUTHENTICATION STRENGTH"
	.P
	The authentication protocol used in rsync is a 128 bit MD4 based challenge
	response system. This is fairly weak protection, though (with at least one
	brute-force hash-finding algorithm publicly available), so if you want really
	top-quality security, then I recommend that you run rsync over ssh. (Yes, a
	future version of rsync will switch over to a stronger hashing method.)
	.P
Also note that the rsync daemon protocol does not currently provide any	Also note that the rsync daemon protocol does not currently provide any
encryption of the data that is transferred over the connection. Only	encryption of the data that is transferred over the connection. Only
authentication is provided. Use ssh as the transport if you want	authentication is provided. Use ssh as the transport if you want encryption.
	.P
	You can also make use of SSL/TLS encryption if you put rsync behind an
	SSL proxy.
	.P
	.SH "SSL/TLS Daemon Setup"
	.P
	When setting up an rsync daemon for access via SSL/TLS, you will need to
	configure a proxy (such as haproxy or nginx) as the front-end that handles the
encryption.	encryption.
.PP	.P
Future versions of rsync may support SSL for better authentication and	.IP o
encryption, but that is still being investigated.	You should limit the access to the backend-rsyncd port to only allow the
.PP	proxy to connect. If it is on the same host as the proxy, then configuring
.SH "EXAMPLES"	it to only listen on localhost is a good idea.
	.IP o
	You should consider turning on the \fBproxy\ protocol\fP parameter if your proxy
	supports sending that information. The examples below assume that this is
	enabled.
	.P
	An example haproxy setup is as follows:
	.RS 4
	.P
	.nf
	frontend fe_rsync-ssl
	bind :::874 ssl crt /etc/letsencrypt/example.com/combined.pem
	mode tcp
	use_backend be_rsync

.PP	backend be_rsync
A simple rsyncd.conf file that allow anonymous rsync to a ftp area at	mode tcp
\f(CW/home/ftp\fP would be:	server local-rsync 127.0.0.1:873 check send-proxy
.PP	.fi
.nf	.RE
	.P
	An example nginx proxy setup is as follows:
	.RS 4
	.P
	.nf
	stream {
	server {
	listen 874 ssl;
	listen [::]:874 ssl;

	ssl_certificate /etc/letsencrypt/example.com/fullchain.pem;
	ssl_certificate_key /etc/letsencrypt/example.com/privkey.pem;

	proxy_pass localhost:873;
	proxy_protocol on; # Requires "proxy protocol = true"
	proxy_timeout 1m;
	proxy_connect_timeout 5s;
	}
	}
	.fi
	.RE
	.P
	.SH "EXAMPLES"
	.P
	A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
	\fB/home/ftp\fP would be:
	.RS 4
	.P
	.nf
[ftp]	[ftp]
path = /home/ftp	path = /home/ftp
comment = ftp export area	comment = ftp export area
	.fi
.fi	.RE
	.P
.PP
A more sophisticated example would be:	A more sophisticated example would be:
.PP	.RS 4
.nf	.P
	.nf
uid = nobody	uid = nobody
gid = nobody	gid = nobody
use chroot = yes	use chroot = yes
max connections = 4	max connections = 4
syslog facility = local5	syslog facility = local5
pid file = /var/run/rsyncd.pid	pid file = /var/run/rsyncd.pid
	slp refresh = 3600

[ftp]	[ftp]
path = /var/ftp/./pub	path = /var/ftp/./pub
Line 792 pid file = /var/run/rsyncd.pid	Line 1262 pid file = /var/run/rsyncd.pid
comment = CVS repository (requires authentication)	comment = CVS repository (requires authentication)
auth users = tridge, susan	auth users = tridge, susan
secrets file = /etc/rsyncd.secrets	secrets file = /etc/rsyncd.secrets
	.fi
.fi	.RE
	.P
.PP
The /etc/rsyncd.secrets file would look something like this:	The /etc/rsyncd.secrets file would look something like this:
.PP	.RS 4
.RS	.P
\f(CWtridge:mypass\fP	.nf
.br	tridge:mypass
\f(CWsusan:herpass\fP	susan:herpass
.br	.fi
.RE	.RE
	.P
.PP
.SH "FILES"	.SH "FILES"
	.P
.PP
/etc/rsyncd.conf or rsyncd.conf	/etc/rsyncd.conf or rsyncd.conf
.PP	.P
.SH "SEE ALSO"	.SH "SEE ALSO"
	.P
.PP	\fBrsync\fP(1), \fBrsync-ssl\fP(1)
\fBrsync\fP(1)	.P
.PP
.SH "DIAGNOSTICS"

.PP
.SH "BUGS"	.SH "BUGS"
	.P
.PP
Please report bugs! The rsync bug tracking system is online at	Please report bugs! The rsync bug tracking system is online at
http://rsync.samba.org/	https://rsync.samba.org/.
.PP	.P
.SH "VERSION"	.SH "VERSION"
	.P
.PP	This man page is current for version 3.2.3 of rsync.
This man page is current for version 3.0.9 of rsync.	.P
.PP
.SH "CREDITS"	.SH "CREDITS"
	.P
.PP	rsync is distributed under the GNU General Public License. See the file
rsync is distributed under the GNU public license. See the file
COPYING for details.	COPYING for details.
.PP	.P
The primary ftp site for rsync is	The primary ftp site for rsync is ftp://rsync.samba.org/pub/rsync
ftp://rsync.samba.org/pub/rsync.	.P
.PP	A web site is available at https://rsync.samba.org/.
A WEB site is available at	.P
http://rsync.samba.org/
.PP
We would be delighted to hear from you if you like this program.	We would be delighted to hear from you if you like this program.
.PP	.P
This program uses the zlib compression library written by Jean\-loup	This program uses the zlib compression library written by Jean-loup Gailly and
Gailly and Mark Adler.	Mark Adler.
.PP	.P
.SH "THANKS"	.SH "THANKS"
	.P
.PP	Thanks to Warren Stanley for his original idea and patch for the rsync daemon.
Thanks to Warren Stanley for his original idea and patch for the rsync	Thanks to Karsten Thygesen for his many suggestions and documentation!
daemon. Thanks to Karsten Thygesen for his many suggestions and	.P
documentation!
.PP
.SH "AUTHOR"	.SH "AUTHOR"
	.P
.PP	rsync was written by Andrew Tridgell and Paul Mackerras. Many people have
rsync was written by Andrew Tridgell and Paul Mackerras.	later contributed to it.
Many people have later contributed to it.	.P
.PP
Mailing lists for support and development are available at	Mailing lists for support and development are available at
http://lists.samba.org	https://lists.samba.org/.

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.1.1.1
changed lines
	Added in v.1.1.1.4