1rsyncd.conf(5)                   User Commands                  rsyncd.conf(5)
2
3
4

NAME

6       rsyncd.conf - configuration file for rsync in daemon mode
7

SYNOPSIS

9       rsyncd.conf
10

DESCRIPTION

12       The  rsyncd.conf  file is the runtime configuration file for rsync when
13       run as an rsync daemon.
14
15       The rsyncd.conf  file  controls  authentication,  access,  logging  and
16       available modules.
17

FILE FORMAT

19       The  file  consists of modules and parameters. A module begins with the
20       name of the module in square brackets and continues until the next mod‐
21       ule begins.  Modules contain parameters of the form name = value.
22
23       The  file is line-based -- that is, each newline-terminated line repre‐
24       sents either a comment, a module name or a parameter.
25
26       Only the first equals sign in a parameter  is  significant.  Whitespace
27       before  or  after the first equals sign is discarded. Leading, trailing
28       and internal whitespace in module and parameter  names  is  irrelevant.
29       Leading  and  trailing  whitespace  in  a parameter value is discarded.
30       Internal whitespace within a parameter value is retained verbatim.
31
32       Any line beginning with a hash (#) is ignored, as are lines  containing
33       only  whitespace.  (If  a hash occurs after anything other than leading
34       whitespace, it is considered a part of the line's content.)
35
36       Any line ending in a \ is "continued" on the next line in the customary
37       UNIX fashion.
38
39       The  values  following  the  equals sign in parameters are all either a
40       string (no quotes needed) or a boolean, which may be given  as  yes/no,
41       0/1  or  true/false.  Case is not significant in boolean values, but is
42       preserved in string values.
43

LAUNCHING THE RSYNC DAEMON

45       The rsync daemon is launched  by  specifying  the  --daemon  option  to
46       rsync.
47
48       The  daemon must run with root privileges if you wish to use chroot, to
49       bind to a port numbered under 1024 (as is the default 873), or  to  set
50       file  ownership.   Otherwise,  it must just have permission to read and
51       write the appropriate data, log, and lock files.
52
53       You can launch it either via inetd, as a stand-alone daemon, or from an
54       rsync  client  via a remote shell.  If run as a stand-alone daemon then
55       just run the command "rsync --daemon" from a suitable startup script.
56
57       When run via inetd you should add a line like this to /etc/services:
58
59           rsync           873/tcp
60
61       and a single line something like this to /etc/inetd.conf:
62
63           rsync   stream  tcp     nowait  root   /usr/bin/rsync rsyncd --daemon
64
65       Replace  "/usr/bin/rsync"  with  the  path  to  where  you  have  rsync
66       installed  on your system.  You will then need to send inetd a HUP sig‐
67       nal to tell it to reread its config file.
68
69       Note that you should not send the rsync daemon a HUP signal to force it
70       to reread the rsyncd.conf file. The file is re-read on each client con‐
71       nection.
72

GLOBAL PARAMETERS

74       The first parameters in the file (before a  [module]  header)  are  the
75       global  parameters.  Rsync also allows for the use of a "[global]" mod‐
76       ule name to indicate the start of one or more global-parameter sections
77       (the name must be lower case).
78
79       You  may  also  include any module parameters in the global part of the
80       config file in which case the supplied value will override the  default
81       for that parameter.
82
83       You may use references to environment variables in the values of param‐
84       eters.  String parameters will have %VAR% references expanded  as  late
85       as  possible  (when  the string is first used in the program), allowing
86       for the use of variables that rsync sets at connection  time,  such  as
87       RSYNC_USER_NAME.   Non-string  parameters (such as true/false settings)
88       are expanded when read from the config file.  If a  variable  does  not
89       exist in the environment, or if a sequence of characters is not a valid
90       reference (such as an un-paired percent sign), the raw  characters  are
91       passed  through  unchanged.  This helps with backward compatibility and
92       safety (e.g. expanding a non-existent %VAR% to an  empty  string  in  a
93       path  could  result in a very unsafe path).  The safest way to insert a
94       literal % into a value is to use %%.
95
96       motd file
97              This parameter allows you to specify a "message of the  day"  to
98              display  to  clients on each connect. This usually contains site
99              information and any legal notices. The default is no motd  file.
100              This  can  be  overridden by the --dparam=motdfile=FILE command-
101              line option when starting the daemon.
102
103       pid file
104              This parameter tells the rsync daemon to write its process ID to
105              that  file.  The rsync keeps the file locked so that it can know
106              when it is safe to overwrite an existing file.
107
108              The filename can be overridden by the --dparam=pidfile=FILE com‐
109              mand-line option when starting the daemon.
110
111       port   You  can  override the default port the daemon will listen on by
112              specifying this value (defaults to 873).  This is ignored if the
113              daemon  is  being  run by inetd, and is superseded by the --port
114              command-line option.
115
116       address
117              You can override the default IP address the daemon  will  listen
118              on  by  specifying this value.  This is ignored if the daemon is
119              being run by inetd, and is superseded by the --address  command-
120              line option.
121
122       socket options
123              This  parameter  can  provide endless fun for people who like to
124              tune their systems to the utmost degree. You can set  all  sorts
125              of  socket options which may make transfers faster (or slower!).
126              Read the man page for the setsockopt() system call  for  details
127              on  some  of  the  options you may be able to set. By default no
128              special socket options are set.   These  settings  can  also  be
129              specified via the --sockopts command-line option.
130
131       listen backlog
132              You  can override the default backlog value when the daemon lis‐
133              tens for connections.  It defaults to 5.
134

MODULE PARAMETERS

136       After the global parameters you should define a number of modules, each
137       module  exports  a  directory  tree  as  a  symbolic  name. Modules are
138       exported by specifying a module name in square brackets  [module]  fol‐
139       lowed  by  the parameters for that module.  The module name cannot con‐
140       tain a slash or a closing square bracket.  If the name contains  white‐
141       space, each internal sequence of whitespace will be changed into a sin‐
142       gle space, while leading or  trailing  whitespace  will  be  discarded.
143       Also,  the  name  cannot  be "global" as that exact name indicates that
144       global parameters follow (see above).
145
146       As with GLOBAL PARAMETERS, you may use references to environment  vari‐
147       ables  in  the values of parameters.  See the GLOBAL PARAMETERS section
148       for more details.
149
150       comment
151              This parameter specifies a description string that is  displayed
152              next  to the module name when clients obtain a list of available
153              modules. The default is no comment.
154
155       path   This parameter specifies the directory in the daemon's  filesys‐
156              tem  to  make  available  in this module.  You must specify this
157              parameter for each module in rsyncd.conf.
158
159              You may base the path's value off of an environment variable  by
160              surrounding  the variable name with percent signs.  You can even
161              reference a variable that is set by rsync  when  the  user  con‐
162              nects.   For example, this would use the authorizing user's name
163              in the path:
164
165                  path = /home/%RSYNC_USER_NAME%
166
167              It is fine if the path includes internal spaces -- they will  be
168              retained  verbatim (which means that you shouldn't try to escape
169              them).  If your final directory has a trailing space  (and  this
170              is  somehow  not  something  you wish to fix), append a trailing
171              slash to the path to avoid losing the trailing whitespace.
172
173       use chroot
174              If "use chroot" is true, the rsync daemon  will  chroot  to  the
175              "path"  before starting the file transfer with the client.  This
176              has the advantage of extra protection against possible implemen‐
177              tation security holes, but it has the disadvantages of requiring
178              super-user privileges, of not  being  able  to  follow  symbolic
179              links  that are either absolute or outside of the new root path,
180              and of complicating the preservation of users and groups by name
181              (see below).
182
183              As  an  additional  safety feature, you can specify a dot-dir in
184              the module's "path" to  indicate  the  point  where  the  chroot
185              should  occur.   This  allows  rsync  to  run in a chroot with a
186              non-"/" path for the top of the transfer hierarchy.  Doing  this
187              guards  against unintended library loading (since those absolute
188              paths will not be inside the transfer hierarchy unless you  have
189              used  an  unwise pathname), and lets you setup libraries for the
190              chroot that are outside of the transfer.  For example,  specify‐
191              ing  "/var/rsync/./module1"  will  chroot  to  the  "/var/rsync"
192              directory and set the inside-chroot path to "/module1".  If  you
193              had  omitted  the  dot-dir, the chroot would have used the whole
194              path, and the inside-chroot path would have been "/".
195
196              When both "use chroot" and "daemon chroot"  are  false,  OR  the
197              inside-chroot  path  of "use chroot" is not "/", rsync will: (1)
198              munge symlinks by default for security reasons (see "munge  sym‐
199              links"  for  a  way to turn this off, but only if you trust your
200              users), (2) substitute leading slashes in  absolute  paths  with
201              the  module's path (so that options such as --backup-dir, --com‐
202              pare-dest, etc. interpret an absolute path as rooted in the mod‐
203              ule's  "path" dir), and (3) trim ".." path elements from args if
204              rsync believes they would  escape  the  module  hierarchy.   The
205              default for "use chroot" is true, and is the safer choice (espe‐
206              cially if the module is not read-only).
207
208              When this parameter is enabled and the "name converter"  parame‐
209              ter  is  not  set,  the  "numeric ids" parameter will default to
210              being enabled (disabling name lookups).  This means that if  you
211              manually  setup name-lookup libraries in your chroot (instead of
212              using  a  name  converter)  that  you  need  to  explicitly  set
213              numeric ids = false for rsync to do name lookups.
214
215              If you copy library resources into the module's chroot area, you
216              should protect them through your OS's normal user/group  or  ACL
217              settings  (to prevent the rsync module's user from being able to
218              change them), and then  hide  them  from  the  user's  view  via
219              "exclude"  (see  how in the discussion of that parameter).  How‐
220              ever, it's easier and safer to setup a name converter.
221
222       daemon chroot
223              This parameter specifies a path to which the daemon will  chroot
224              before  beginning  communication with clients. Module paths (and
225              any "use chroot" settings) will then be  related  to  this  one.
226              This lets you choose if you want the whole daemon to be chrooted
227              (with this setting), just the transfers  to  be  chrooted  (with
228              "use  chroot"),  or both.  Keep in mind that the "daemon chroot"
229              area may need various OS/lib/etc files installed  to  allow  the
230              daemon  to  function.   By  default  the daemon runs without any
231              chrooting.
232
233       proxy protocol
234              When this parameter is enabled, all  incoming  connections  must
235              start  with  a V1 or V2 proxy protocol header.  If the header is
236              not found, the connection is closed.
237
238              Setting this to true requires a proxy server to  forward  source
239              IP information to rsync, allowing you to log proper IP/host info
240              and make use of client-oriented IP restrictions.  The default of
241              false  means  that  the  IP  information comes directly from the
242              socket's metadata.  If rsync is not behind a proxy, this  should
243              be disabled.
244
245              CAUTION: using this option can be dangerous if you do not ensure
246              that only the proxy is allowed to connect to the rsync port.  If
247              any non-proxied connections are allowed through, the client will
248              be able to use a modified rsync to spoof any remote  IP  address
249              that  they  desire.  You can lock this down using something like
250              iptables -uid-owner root rules (for  strict  localhost  access),
251              various  firewall  rules, or you can require password authoriza‐
252              tion so that any spoofing by users will not grant extra access.
253
254              This setting is global.  If you need  some  modules  to  require
255              this  and not others, then you will need to setup multiple rsync
256              daemon processes on different ports.
257
258       name converter
259              This parameter lets you specify a program that will  be  run  by
260              the  rsync daemon to do user & group conversions between names &
261              ids.  This script is started prior to any  chroot  being  setup,
262              and  runs  as  the daemon user (not the transfer user).  You can
263              specify a fully qualified pathname or a program name that is  on
264              the $PATH.
265
266              The  program can be used to do normal user & group lookups with‐
267              out having to put any extra files into the chroot  area  of  the
268              module or you can do customized conversions.
269
270              The  nameconvert  program  has  access to all of the environment
271              variables that are described in the  section  on  pre-xfer exec.
272              This  is  useful  if  you want to customize the conversion using
273              information about the module and/or the copy request.
274
275              There is a sample python script in the support dir named  "name‐
276              convert"  that implements the normal user & group lookups.  Feel
277              free to customize it or just use it as documentation  to  imple‐
278              ment your own.
279
280       numeric ids
281              Enabling this parameter disables the mapping of users and groups
282              by name for the current daemon module.  This prevents the daemon
283              from  trying  to load any user/group-related files or libraries.
284              This enabling makes the transfer behave as  if  the  client  had
285              passed  the --numeric-ids command-line option.  By default, this
286              parameter is enabled for chroot modules and  disabled  for  non-
287              chroot  modules.   Also  keep  in mind that uid/gid preservation
288              requires the module to be running as root  (see  "uid")  or  for
289              "fake super" to be configured.
290
291              A  chroot-enabled  module  should not have this parameter set to
292              false unless you're using a "name converter" program  or  you've
293              taken  steps  to  ensure  that  the  module  has  the  necessary
294              resources it needs to translate names and that it is not  possi‐
295              ble for a user to change those resources.
296
297       munge symlinks
298              This  parameter  tells  rsync to modify all symlinks in the same
299              way as  the  (non-daemon-affecting)  --munge-links  command-line
300              option  (using a method described below).  This should help pro‐
301              tect your files from user trickery when your  daemon  module  is
302              writable.   The default is disabled when "use chroot" is on with
303              an inside-chroot path of "/", OR if "daemon chroot" is on,  oth‐
304              erwise it is enabled.
305
306              If you disable this parameter on a daemon that is not read-only,
307              there are tricks that a user can play with uploaded symlinks  to
308              access  daemon-excluded  items (if your module has any), and, if
309              "use chroot" is off, rsync can even be tricked into  showing  or
310              changing  data that is outside the module's path (as access-per‐
311              missions allow).
312
313              The way rsync disables the use of symlinks is to prefix each one
314              with the string "/rsyncd-munged/".  This prevents the links from
315              being used as long as that directory does not exist.  When  this
316              parameter is enabled, rsync will refuse to run if that path is a
317              directory or a symlink to a directory.  When  using  the  "munge
318              symlinks"  parameter  in a chroot area that has an inside-chroot
319              path of "/", you should add  "/rsyncd-munged/"  to  the  exclude
320              setting for the module so that a user can't try to create it.
321
322              Note:   rsync  makes  no attempt to verify that any pre-existing
323              symlinks in the module's hierarchy are as safe as you want  them
324              to  be  (unless,  of course, it just copied in the whole hierar‐
325              chy).  If you setup an rsync daemon on a new area or locally add
326              symlinks,  you  can  manually  protect  your symlinks from being
327              abused by prefixing "/rsyncd-munged/" to the start of every sym‐
328              link's  value.   There is a perl script in the support directory
329              of the source code named "munge-symlinks" that can  be  used  to
330              add or remove this prefix from your symlinks.
331
332              When  this  parameter  is disabled on a writable module and "use
333              chroot" is off (or the inside-chroot path is not "/"),  incoming
334              symlinks  will be modified to drop a leading slash and to remove
335              ".." path elements that rsync believes will allow a  symlink  to
336              escape  the  module's  hierarchy.  There are tricky ways to work
337              around this, though, so you had better trust your users  if  you
338              choose this combination of parameters.
339
340       charset
341              This  specifies  the name of the character set in which the mod‐
342              ule's filenames are stored.   If  the  client  uses  an  --iconv
343              option, the daemon will use the value of the "charset" parameter
344              regardless of the character  set  the  client  actually  passed.
345              This allows the daemon to support charset conversion in a chroot
346              module without extra files in the chroot area, and also  ensures
347              that  name-translation  is  done in a consistent manner.  If the
348              "charset" parameter is not set, the --iconv option  is  refused,
349              just as if "iconv" had been specified via "refuse options".
350
351              If  you wish to force users to always use --iconv for a particu‐
352              lar module, add "no-iconv" to the  "refuse  options"  parameter.
353              Keep  in  mind  that this will restrict access to your module to
354              very new rsync clients.
355
356       max connections
357              This parameter allows you  to  specify  the  maximum  number  of
358              simultaneous connections you will allow.  Any clients connecting
359              when the maximum has been reached will receive a message telling
360              them  to  try later.  The default is 0, which means no limit.  A
361              negative value disables the module.  See also  the  "lock  file"
362              parameter.
363
364       log file
365              When  the "log file" parameter is set to a non-empty string, the
366              rsync daemon will log messages to the indicated file rather than
367              using  syslog.   This is particularly useful on systems (such as
368              AIX) where syslog() doesn't work  for  chrooted  programs.   The
369              file  is  opened  before  chroot()  is called, allowing it to be
370              placed outside the transfer.  If this value is set on a per-mod‐
371              ule basis instead of globally, the global log will still contain
372              any authorization failures or config-file error messages.
373
374              If the daemon fails to open the specified  file,  it  will  fall
375              back  to  using  syslog  and  output an error about the failure.
376              (Note that the failure to open the specified log file used to be
377              a fatal error.)
378
379              This  setting  can be overridden by using the --log-file=FILE or
380              --dparam=logfile=FILE command-line options.   The  former  over‐
381              rides  all  the log-file parameters of the daemon and all module
382              settings.  The latter sets the daemon's log file and the default
383              for  all the modules, which still allows modules to override the
384              default setting.
385
386       syslog facility
387              This parameter allows you to specify the syslog facility name to
388              use when logging messages from the rsync daemon. You may use any
389              standard syslog facility name which is defined on  your  system.
390              Common  names  are auth, authpriv, cron, daemon, ftp, kern, lpr,
391              mail,  news,  security,  syslog,  user,  uucp,  local0,  local1,
392              local2,  local3, local4, local5, local6 and local7.  The default
393              is daemon.  This setting has no effect if the "log file" setting
394              is  a  non-empty string (either set in the per-modules settings,
395              or inherited from the global settings).
396
397       syslog tag
398              This parameter allows you to specify the syslog tag to use  when
399              logging messages from the rsync daemon. The default is "rsyncd".
400              This setting has no effect if the "log file" setting is  a  non-
401              empty  string (either set in the per-modules settings, or inher‐
402              ited from the global settings).
403
404              For example, if you wanted each authenticated user's name to  be
405              included in the syslog tag, you could do something like this:
406
407                  syslog tag = rsyncd.%RSYNC_USER_NAME%
408
409       max verbosity
410              This  parameter allows you to control the maximum amount of ver‐
411              bose information that you'll allow the daemon to generate (since
412              the information goes into the log file). The default is 1, which
413              allows the client to request one level of verbosity.
414
415              This also affects the user's ability to request higher levels of
416              --info and --debug logging.  If the max value is 2, then no info
417              and/or debug value that is higher than what would be set by  -vv
418              will  be  honored by the daemon in its logging.  To see how high
419              of a verbosity  level  you  need  to  accept  for  a  particular
420              info/debug     level,    refer    to    rsync --info=help    and
421              rsync --debug=help.  For instance, it takes max-verbosity  4  to
422              be able to output debug TIME2 and FLIST3.
423
424       lock file
425              This  parameter  specifies  the  file to use to support the "max
426              connections" parameter. The rsync daemon uses record locking  on
427              this  file  to  ensure  that  the  max  connections limit is not
428              exceeded for the modules sharing the lock file.  The default  is
429              /var/run/rsyncd.lock.
430
431       read only
432              This parameter determines whether clients will be able to upload
433              files or not. If "read only" is true then any attempted  uploads
434              will fail. If "read only" is false then uploads will be possible
435              if file permissions on the daemon side allow them.  The  default
436              is for all modules to be read only.
437
438              Note  that  "auth users" can override this setting on a per-user
439              basis.
440
441       write only
442              This parameter determines whether clients will be able to  down‐
443              load  files  or  not. If "write only" is true then any attempted
444              downloads will fail. If "write only"  is  false  then  downloads
445              will  be  possible  if file permissions on the daemon side allow
446              them.  The default is for this parameter to be disabled.
447
448              Helpful hint: you probably want to  specify  "refuse  options  =
449              delete" for a write-only module.
450
451       open noatime
452              When  set to True, this parameter tells the rsync daemon to open
453              files with the O_NOATIME flag (on systems that  support  it)  to
454              avoid  changing  the  access  time  of  the files that are being
455              transferred.  If your OS does not  support  the  O_NOATIME  flag
456              then  rsync  will  silently  ignore this option.  Note also that
457              some filesystems are mounted to avoid updating the atime on read
458              access even without the O_NOATIME flag being set.
459
460              When  set  to  False,  this parameters ensures that files on the
461              server are not opened with O_NOATIME.
462
463              When set to Unset (the default) the user  controls  the  setting
464              via --open-noatime.
465
466       list   This parameter determines whether this module is listed when the
467              client asks for a listing of available modules.  In addition, if
468              this is false, the daemon will pretend the module does not exist
469              when a client denied by "hosts allow" or "hosts  deny"  attempts
470              to  access  it.   Realize  that  if "reverse lookup" is disabled
471              globally but enabled  for  the  module,  the  resulting  reverse
472              lookup  to  a potentially client-controlled DNS server may still
473              reveal to the client  that  it  hit  an  existing  module.   The
474              default is for modules to be listable.
475
476       uid    This  parameter  specifies  the  user  name or user ID that file
477              transfers to and from that module should take place as when  the
478              daemon was run as root.  In combination with the "gid" parameter
479              this determines what file permissions are available. The default
480              when  run  by a super-user is to switch to the system's "nobody"
481              user.  The default for a non-super-user is to not try to  change
482              the user.  See also the "gid" parameter.
483
484              The  RSYNC_USER_NAME environment variable may be used to request
485              that rsync run as the authorizing user.   For  example,  if  you
486              want  a  rsync to run as the same user that was received for the
487              rsync authentication, this setup is useful:
488
489                  uid = %RSYNC_USER_NAME%
490                  gid = *
491
492       gid    This parameter specifies one or more group names/IDs  that  will
493              be  used  when  accessing the module.  The first one will be the
494              default group, and any extra ones be set as supplemental groups.
495              You  may  also specify a "*" as the first gid in the list, which
496              will be replaced by all the normal  groups  for  the  transfer's
497              user  (see  "uid").   The default when run by a super-user is to
498              switch to your OS's "nobody" (or perhaps "nogroup")  group  with
499              no other supplementary groups.  The default for a non-super-user
500              is to not change any group attributes (and indeed, your  OS  may
501              not  allow  a  non-super-user  to try to change their group set‐
502              tings).
503
504              The specified list is normally split into tokens based on spaces
505              and  commas.  However, if the list starts with a comma, then the
506              list is only split on commas, which allows a group name to  con‐
507              tain a space.  In either case any leading and/or trailing white‐
508              space is removed from the tokens and empty tokens are ignored.
509
510       daemon uid
511              This parameter specifies a uid under which the daemon will  run.
512              The  daemon  usually  runs  as  user root, and when this is left
513              unset the user is left unchanged. See also the "uid" parameter.
514
515       daemon gid
516              This parameter specifies a gid under which the daemon will  run.
517              The  daemon  usually  runs  as group root, and when this is left
518              unset, the group is left unchanged. See also the  "gid"  parame‐
519              ter.
520
521       fake super
522              Setting  "fake  super = yes" for a module causes the daemon side
523              to behave as if the --fake-super command-line  option  had  been
524              specified.   This  allows  the  full  attributes of a file to be
525              stored without having to have the  daemon  actually  running  as
526              root.
527
528       filter The  daemon  has its own filter chain that determines what files
529              it will let the client access.  This chain is not  sent  to  the
530              client  and  is  independent  of any filters the client may have
531              specified.  Files excluded by the daemon filter  chain  (daemon-
532              excluded  files) are treated as non-existent if the client tries
533              to pull them, are skipped with an error message  if  the  client
534              tries  to  push  them  (triggering  exit code 23), and are never
535              deleted from the module.  You can use daemon filters to  prevent
536              clients  from  downloading or tampering with private administra‐
537              tive files, such as files you may add to  support  uid/gid  name
538              translations.
539
540              The  daemon  filter  chain  is built from the "filter", "include
541              from", "include", "exclude from", and "exclude"  parameters,  in
542              that  order  of priority.  Anchored patterns are anchored at the
543              root of the module.  To prevent access to an entire subtree, for
544              example,  "/secret", you must exclude everything in the subtree;
545              the easiest way to do this is with a  triple-star  pattern  like
546              "/secret/***".
547
548              The  "filter"  parameter  takes a space-separated list of daemon
549              filter rules, though it is smart enough to know not to  split  a
550              token  at  an  internal space in a rule (e.g. "- /foo - /bar" is
551              parsed as two rules).  You may specify one  or  more  merge-file
552              rules  using the normal syntax.  Only one "filter" parameter can
553              apply to a given module in the config file, so put all the rules
554              you  want in a single parameter.  Note that per-directory merge-
555              file rules do not provide as much protection  as  global  rules,
556              but  they  can  be  used  to  make --delete work better during a
557              client  download  operation  if  the  per-dir  merge  files  are
558              included  in  the  transfer and the client requests that they be
559              used.
560
561       exclude
562              This parameter takes a space-separated list  of  daemon  exclude
563              patterns.   As with the client --exclude option, patterns can be
564              qualified   with   "-"   or   "+"   to    explicitly    indicate
565              exclude/include.   Only  one  "exclude" parameter can apply to a
566              given module.  See the "filter" parameter for a  description  of
567              how excluded files affect the daemon.
568
569       include
570              Use an "include" to override the effects of the "exclude" param‐
571              eter.  Only one "include" parameter can apply to a given module.
572              See  the  "filter"  parameter  for a description of how excluded
573              files affect the daemon.
574
575       exclude from
576              This parameter specifies the name of a file on the  daemon  that
577              contains  daemon  exclude  patterns,  one  per  line.   Only one
578              "exclude from" parameter can apply to a  given  module;  if  you
579              have  multiple  exclude-from  files,  you  can specify them as a
580              merge file in the "filter" parameter.  See the "filter"  parame‐
581              ter for a description of how excluded files affect the daemon.
582
583       include from
584              Analogue  of  "exclude  from"  for a file of daemon include pat‐
585              terns.  Only one "include from" parameter can apply to  a  given
586              module.   See  the  "filter"  parameter for a description of how
587              excluded files affect the daemon.
588
589       incoming chmod
590              This parameter allows you to specify a  set  of  comma-separated
591              chmod  strings  that will affect the permissions of all incoming
592              files (files that are being  received  by  the  daemon).   These
593              changes happen after all other permission calculations, and this
594              will even override destination-default and/or  existing  permis‐
595              sions  when  the  client  does  not  specify  --perms.   See the
596              description of the --chmod rsync option and the chmod(1) manpage
597              for information on the format of this string.
598
599       outgoing chmod
600              This  parameter  allows  you to specify a set of comma-separated
601              chmod strings that will affect the permissions of  all  outgoing
602              files  (files  that  are being sent out from the daemon).  These
603              changes happen first, making the sent permissions appear  to  be
604              different  than  those  stored  in  the  filesystem itself.  For
605              instance, you could  disable  group  write  permissions  on  the
606              server  while having it appear to be on to the clients.  See the
607              description of the --chmod rsync option and the chmod(1) manpage
608              for information on the format of this string.
609
610       auth users
611              This  parameter specifies a comma and/or space-separated list of
612              authorization rules.  In its simplest form, you list  the  user‐
613              names  that will be allowed to connect to this module. The user‐
614              names do not need to exist on the local system.  The  rules  may
615              contain  shell  wildcard characters that will be matched against
616              the username provided by the client for authentication. If "auth
617              users"  is  set  then  the client will be challenged to supply a
618              username and password to connect  to  the  module.  A  challenge
619              response  authentication protocol is used for this exchange. The
620              plain text usernames and passwords are stored in the file speci‐
621              fied  by  the  "secrets  file" parameter. The default is for all
622              users to be able to connect without a password (this  is  called
623              "anonymous rsync").
624
625              In  addition  to  username  matching,  you can specify groupname
626              matching via a '@' prefix.  When using groupname  matching,  the
627              authenticating username must be a real user on the system, or it
628              will be assumed to be a member of no groups.  For example, spec‐
629              ifying  "@rsync" will match the authenticating user if the named
630              user is a member of the rsync group.
631
632              Finally, options may  be  specified  after  a  colon  (:).   The
633              options allow you to "deny" a user or a group, set the access to
634              "ro" (read-only), or set the access to "rw" (read/write).   Set‐
635              ting  an auth-rule-specific ro/rw setting overrides the module's
636              "read only" setting.
637
638              Be sure to put the rules in  the  order  you  want  them  to  be
639              matched,  because  the checking stops at the first matching user
640              or group, and that is the only auth that is checked.  For  exam‐
641              ple:
642
643                  auth users = joe:deny @guest:deny admin:rw @rsync:ro susan joe sam
644
645              In  the  above  rule,  user  joe will be denied access no matter
646              what.  Any user that is in the  group  "guest"  is  also  denied
647              access.   The  user  "admin" gets access in read/write mode, but
648              only if the admin user is not  in  group  "guest"  (because  the
649              admin  user-matching  rule would never be reached if the user is
650              in group "guest").  Any other user who is in group "rsync"  will
651              get  read-only  access.   Finally, users susan, joe, and sam get
652              the ro/rw setting of the module, but only  if  the  user  didn't
653              match an earlier group-matching rule.
654
655              If  you need to specify a user or group name with a space in it,
656              start your list with a comma to indicate that  the  list  should
657              only  be split on commas (though leading and trailing whitespace
658              will also be removed, and empty entries are just ignored).   For
659              example:
660
661                  auth users = , joe:deny, @Some Group:deny, admin:rw, @RO Group:ro
662
663              See  the  description  of  the secrets file for how you can have
664              per-user passwords as well  as  per-group  passwords.   It  also
665              explains  how  a user can authenticate using their user password
666              or (when applicable) a group password, depending on what rule is
667              being authenticated.
668
669              See also the section entitled "USING RSYNC-DAEMON FEATURES VIA A
670              REMOTE SHELL CONNECTION" in rsync(1) for information on how han‐
671              dle  an rsyncd.conf-level username that differs from the remote-
672              shell-level username when using a remote shell to connect to  an
673              rsync daemon.
674
675       secrets file
676              This  parameter  specifies  the name of a file that contains the
677              username:password  and/or  @groupname:password  pairs  used  for
678              authenticating  this  module. This file is only consulted if the
679              "auth users" parameter is specified.  The file is line-based and
680              contains  one  name:password pair per line.  Any line has a hash
681              (#) as the very first character on the line is considered a com‐
682              ment  and  is skipped.  The passwords can contain any characters
683              but be warned that many operating systems limit  the  length  of
684              passwords  that  can be typed at the client end, so you may find
685              that passwords longer than 8 characters don't work.
686
687              The use of group-specific lines are only relevant when the  mod‐
688              ule  is  being  authorized  using  a matching "@groupname" rule.
689              When that happens, the user can be authorized via  either  their
690              "username:password"  line  or the "@groupname:password" line for
691              the group that triggered the authentication.
692
693              It is up to you what  kind  of  password  entries  you  want  to
694              include,  either users, groups, or both.  The use of group rules
695              in "auth users" does not require that you specify a group  pass‐
696              word if you do not want to use shared passwords.
697
698              There  is  no default for the "secrets file" parameter, you must
699              choose a name (such as /etc/rsyncd.secrets).  The file must nor‐
700              mally  not  be  readable by "other"; see "strict modes".  If the
701              file is not found or is rejected, no logins for  a  "user  auth"
702              module will be possible.
703
704       strict modes
705              This  parameter determines whether or not the permissions on the
706              secrets file will be checked.  If "strict modes" is  true,  then
707              the  secrets file must not be readable by any user ID other than
708              the one that the rsync daemon  is  running  under.   If  "strict
709              modes"  is  false,  the  check is not performed.  The default is
710              true.  This parameter was added to accommodate rsync running  on
711              the Windows operating system.
712
713       hosts allow
714              This  parameter  allows  you  to specify a list of comma- and/or
715              whitespace-separated patterns that are matched  against  a  con‐
716              necting  client's  hostname and IP address.  If none of the pat‐
717              terns match, then the connection is rejected.
718
719              Each pattern can be in one of six forms:
720
721              o      a dotted decimal IPv4 address of the form a.b.c.d, or  an
722                     IPv6  address  of the form a:b:c::d:e:f. In this case the
723                     incoming machine's IP address must match exactly.
724
725              o      an address/mask in the form ipaddr/n where ipaddr is  the
726                     IP  address  and  n is the number of one bits in the net‐
727                     mask.  All IP addresses which match the masked IP address
728                     will be allowed in.
729
730              o      an  address/mask in the form ipaddr/maskaddr where ipaddr
731                     is the IP address and maskaddr is the netmask  in  dotted
732                     decimal  notation  for  IPv4,  or  similar for IPv6, e.g.
733                     ffff:ffff:ffff:ffff:: instead of /64.  All  IP  addresses
734                     which match the masked IP address will be allowed in.
735
736              o      a  hostname  pattern  using wildcards. If the hostname of
737                     the connecting IP (as determined  by  a  reverse  lookup)
738                     matches the wildcarded name (using the same rules as nor‐
739                     mal unix filename matching), the client  is  allowed  in.
740                     This  only  works  if  "reverse  lookup"  is enabled (the
741                     default).
742
743              o      a hostname. A  plain  hostname  is  matched  against  the
744                     reverse  DNS of the connecting IP (if "reverse lookup" is
745                     enabled), and/or the IP of the given hostname is  matched
746                     against   the  connecting  IP  (if  "forward  lookup"  is
747                     enabled, as it is by default).  Any match will be allowed
748                     in.
749
750              o      an  '@'  followed by a netgroup name, which will match if
751                     the reverse DNS of the connecting IP is in the  specified
752                     netgroup.
753
754              Note  IPv6  link-local addresses can have a scope in the address
755              specification:
756
757                  fe80::1%link1
758                  fe80::%link1/64
759                  fe80::%link1/ffff:ffff:ffff:ffff::
760
761              You can also combine "hosts allow" with "hosts deny" as a way to
762              add  exceptions  to  your  deny  list.  When both parameters are
763              specified, the "hosts allow" parameter is checked  first  and  a
764              match  results  in  the  client  being  able to connect.  A non-
765              allowed host is then matched against the "hosts  deny"  list  to
766              see if it should be rejected.  A host that does not match either
767              list is allowed to connect.
768
769              The default is no "hosts allow" parameter, which means all hosts
770              can connect.
771
772       hosts deny
773              This  parameter  allows  you  to specify a list of comma- and/or
774              whitespace-separated patterns that are matched  against  a  con‐
775              necting  clients hostname and IP address. If the pattern matches
776              then the connection is rejected. See the "hosts allow" parameter
777              for more information.
778
779              The  default is no "hosts deny" parameter, which means all hosts
780              can connect.
781
782       reverse lookup
783              Controls whether the daemon performs a  reverse  lookup  on  the
784              client's IP address to determine its hostname, which is used for
785              "hosts allow" & "hosts deny" checks and  the  "%h"  log  escape.
786              This  is  enabled  by default, but you may wish to disable it to
787              save time if you know  the  lookup  will  not  return  a  useful
788              result,  in  which  case  the daemon will use the name "UNDETER‐
789              MINED" instead.
790
791              If this parameter is enabled globally (even by  default),  rsync
792              performs  the  lookup as soon as a client connects, so disabling
793              it for a module will not avoid the lookup.  Thus,  you  probably
794              want  to disable it globally and then enable it for modules that
795              need the information.
796
797       forward lookup
798              Controls whether the daemon performs a  forward  lookup  on  any
799              hostname  specified  in an hosts allow/deny setting.  By default
800              this is enabled, allowing the use of an explicit  hostname  that
801              would not be returned by reverse DNS of the connecting IP.
802
803       ignore errors
804              This  parameter  tells rsyncd to ignore I/O errors on the daemon
805              when deciding whether to run the delete phase of  the  transfer.
806              Normally  rsync  skips  the --delete step if any I/O errors have
807              occurred in order to prevent disastrous deletion due to a tempo‐
808              rary  resource  shortage  or other I/O error. In some cases this
809              test is counter productive so you can use this parameter to turn
810              off this behavior.
811
812       ignore nonreadable
813              This  tells the rsync daemon to completely ignore files that are
814              not readable by the user. This is  useful  for  public  archives
815              that may have some non-readable files among the directories, and
816              the sysadmin doesn't want those files to be seen at all.
817
818       transfer logging
819              This parameter enables per-file logging of downloads and uploads
820              in  a  format somewhat similar to that used by ftp daemons.  The
821              daemon always logs the transfer at the end, so if a transfer  is
822              aborted, no mention will be made in the log file.
823
824              If  you  want  to  customize the log lines, see the "log format"
825              parameter.
826
827       log format
828              This parameter allows you to specify the format used for logging
829              file  transfers when transfer logging is enabled.  The format is
830              a  text  string  containing  embedded  single-character   escape
831              sequences  prefixed  with  a percent (%) character.  An optional
832              numeric field width may also be specified  between  the  percent
833              and  the  escape  letter (e.g.  "%-50n %8l %07p").  In addition,
834              one or more apostrophes may be specified prior  to  a  numerical
835              escape  to indicate that the numerical value should be made more
836              human-readable.  The 3 supported levels are the same as for  the
837              --human-readable  command-line option, though the default is for
838              human-readability to be off.  Each  added  apostrophe  increases
839              the level (e.g. "%''l %'b %f").
840
841              The  default  log  format  is  "%o %h [%a] %m (%u) %f %l", and a
842              "%t [%p]" is always prefixed when using the "log  file"  parame‐
843              ter.  (A perl script that will summarize this default log format
844              is included in the rsync source code distribution in  the  "sup‐
845              port" subdirectory: rsyncstats.)
846
847              The single-character escapes that are understood are as follows:
848
849              o      %a the remote IP address (only available for a daemon)
850
851              o      %b the number of bytes actually transferred
852
853              o      %B the permission bits of the file (e.g. rwxrwxrwt)
854
855              o      %c the total size of the block checksums received for the
856                     basis file (only when sending)
857
858              o      %C the full-file checksum if it is known  for  the  file.
859                     For  older  rsync  protocols/versions,  the  checksum was
860                     salted, and is thus not a useful value (and is  not  dis‐
861                     played when that is the case). For the checksum to output
862                     for a file, either the  --checksum  option  must  be  in-
863                     effect  or  the file must have been transferred without a
864                     salted checksum being used.   See  the  --checksum-choice
865                     option for a way to choose the algorithm.
866
867              o      %f the filename (long form on sender; no trailing "/")
868
869              o      %G the gid of the file (decimal) or "DEFAULT"
870
871              o      %h the remote host name (only available for a daemon)
872
873              o      %i an itemized list of what is being updated
874
875              o      %l the length of the file in bytes
876
877              o      %L  the  string "-> SYMLINK", "=> HARDLINK", or "" (where
878                     SYMLINK or HARDLINK is a filename)
879
880              o      %m the module name
881
882              o      %M the last-modified time of the file
883
884              o      %n the filename (short form; trailing "/" on dir)
885
886              o      %o the operation, which is "send", "recv", or "del." (the
887                     latter includes the trailing period)
888
889              o      %p the process ID of this rsync session
890
891              o      %P the module path
892
893              o      %t the current date time
894
895              o      %u the authenticated username or an empty string
896
897              o      %U the uid of the file (decimal)
898
899              For  a list of what the characters mean that are output by "%i",
900              see the --itemize-changes option in the rsync manpage.
901
902              Note that some of the logged output changes  when  talking  with
903              older  rsync  versions.   For  instance, deleted files were only
904              output as verbose messages prior to rsync 2.6.4.
905
906       timeout
907              This parameter allows you to override the clients choice for I/O
908              timeout  for  this  module.  Using this parameter you can ensure
909              that rsync won't wait on a dead client forever. The  timeout  is
910              specified  in  seconds.  A value of zero means no timeout and is
911              the default. A good choice for anonymous rsync  daemons  may  be
912              600 (giving a 10 minute timeout).
913
914       refuse options
915              This  parameter  allows you to specify a space-separated list of
916              rsync command-line options that will be refused  by  your  rsync
917              daemon.   You  may  specify the full option name, its one-letter
918              abbreviation,  or  a  wild-card  string  that  matches  multiple
919              options. Beginning in 3.2.0, you can also negate a match term by
920              starting it with a "!".
921
922              When an option is refused, the daemon prints  an  error  message
923              and exits.
924
925              For example, this would refuse --checksum (-c) and all the vari‐
926              ous delete options:
927
928                  refuse options = c delete
929
930              The reason the above refuses all  delete  options  is  that  the
931              options  imply  --delete,  and  implied options are refused just
932              like explicit options.
933
934              The use of a negated match allows you to fine-tune your refusals
935              after a wild-card, such as this:
936
937                  refuse options = delete-* !delete-during
938
939              Negated matching can also turn your list of refused options into
940              a list of accepted options. To do this, begin the  list  with  a
941              "*" (to refuse all options) and then specify one or more negated
942              matches to accept.  For example:
943
944                  refuse options = * !a !v !compress*
945
946              Don't worry that the "*" will refuse certain vital options  such
947              as  --dry-run,  --server, --no-iconv, --protect-args, etc. These
948              important options are not matched by wild-card, so they must  be
949              overridden by their exact name.  For instance, if you're forcing
950              iconv transfers you could use something like this:
951
952                  refuse options = * no-iconv !a !v
953
954              As an additional aid (beginning in 3.2.0), refusing (or "!refus‐
955              ing")  the "a" or "archive"  option also affects all the options
956              that the --archive option implies (-rdlptgoD), but only  if  the
957              option   is  matched  explicitly  (not using a wildcard). If you
958              want to do something tricky, you can  use  "archive*"  to  avoid
959              this  side-effect,  but keep in mind that no normal rsync client
960              ever sends the actual archive option to the server.
961
962              As an additional safety feature, the refusal  of  "delete"  also
963              refuses  remove-source-files  when  the daemon is the sender; if
964              you  want  the  latter  without  the  former,   instead   refuse
965              "delete-*"  as that refuses all the delete modes without affect‐
966              ing --remove-source-files.  (Keep  in  mind  that  the  client's
967              --delete option typically results in --delete-during.)
968
969              When  un-refusing  delete  options,  you  should  either specify
970              "!delete*" (to accept all delete options) or specify  a  limited
971              set that includes "delete", such as:
972
973                  refuse options = * !a !delete !delete-during
974
975              ...  whereas  this  accepts  any  delete option except --delete-
976              after:
977
978                  refuse options = * !a !delete* delete-after
979
980              A note on refusing "compress" -- it is better to set  the  "dont
981              compress" daemon parameter to "*" because that disables compres‐
982              sion silently instead of returning  an  error  that  forces  the
983              client to remove the -z option.
984
985              If you are un-refusing the compress option, you probably want to
986              match "!compress*" so that you also accept the  --compress-level
987              option.
988
989              Note  that  the  "copy-devices"  &  "write-devices"  options are
990              refused by default, but they can  be  explicitly  accepted  with
991              "!copy-devices" and/or "!write-devices".  The options "log-file"
992              and  "log-file-format"  are  forcibly  refused  and  cannot   be
993              accepted.
994
995              Here are all the options that are not matched by wild-cards:
996
997              o      --server: Required for rsync to even work.
998
999              o      --rsh,  -e: Required to convey compatibility flags to the
1000                     server.
1001
1002              o      --out-format: This is required to convey output  behavior
1003                     to a remote receiver.  While rsync passes the older alias
1004                     --log-format  for  compatibility  reasons,  this  options
1005                     should not be confused with --log-file-format.
1006
1007              o      --sender:  Use "write only" parameter instead of refusing
1008                     this.
1009
1010              o      --dry-run, -n: Who would want to disable this?
1011
1012              o      --protect-args, -s: This actually makes transfers safer.
1013
1014              o      --from0, -0: Makes it easier  to  accept/refuse  --files-
1015                     from without affecting this helpful modifier.
1016
1017              o      --iconv: This is auto-disabled based on "charset" parame‐
1018                     ter.
1019
1020              o      --no-iconv: Most transfers use this option.
1021
1022              o      --checksum-seed: Is a fairly rare, safe option.
1023
1024              o      --write-devices: Is non-wild but also auto-disabled.
1025
1026       dont compress
1027              This parameter allows you to select filenames based on  wildcard
1028              patterns  that  should not be compressed when pulling files from
1029              the daemon (no analogous parameter exists to govern the  pushing
1030              of files to a daemon).  Compression can be expensive in terms of
1031              CPU usage, so it is usually good to not try  to  compress  files
1032              that won't compress well, such as already compressed files.
1033
1034              The  "dont  compress"  parameter takes a space-separated list of
1035              case-insensitive wildcard patterns. Any source filename matching
1036              one  of  the  patterns  will be compressed as little as possible
1037              during the transfer.  If the compression algorithm has an  "off"
1038              level  (such as zlib/zlibx) then no compression occurs for those
1039              files.  Other algorithms have the level minimized to reduces the
1040              CPU usage as much as possible.
1041
1042              See  the  --skip-compress  parameter in the rsync(1) manpage for
1043              the list of file suffixes that are not  compressed  by  default.
1044              Specifying a value for the "dont compress" parameter changes the
1045              default when the daemon is the sender.
1046
1047       early exec, pre-xfer exec, post-xfer exec
1048              You may specify a command to be run in the early stages  of  the
1049              connection,  or  right before and/or after the transfer.  If the
1050              early exec or pre-xfer exec command returns an error  code,  the
1051              transfer  is aborted before it begins.  Any output from the pre-
1052              xfer exec command on stdout (up to several KB) will be displayed
1053              to  the  user  when aborting, but is not displayed if the script
1054              returns success.  The other programs cannot send any text to the
1055              user.   All  output  except for the pre-xfer exec stdout goes to
1056              the corresponding daemon's  stdout/stderr,  which  is  typically
1057              discarded.   See  the  --no-detatch  option for a way to see the
1058              daemon's output, which can assist with debugging.
1059
1060              Note that the early exec command runs before  any  part  of  the
1061              transfer  request  is  known  except  for the module name.  This
1062              helper script can be used to setup a disk mount or decrypt  some
1063              data  into  a  module dir, but you may need to use lock file and
1064              max connections to avoid  concurrency  issues.   If  the  client
1065              rsync specified the --early-input=FILE option, it can send up to
1066              about 5K of data to the stdin of the early  script.   The  stdin
1067              will otherwise be empty.
1068
1069              Note that the post-xfer exec command is still run even if one of
1070              the other scripts returns an error code. The pre-xfer exec  com‐
1071              mand will not be run, however, if the early exec command fails.
1072
1073              The following environment variables will be set, though some are
1074              specific to the pre-xfer or the post-xfer environment:
1075
1076              o      RSYNC_MODULE_NAME: The name of the module being accessed.
1077
1078              o      RSYNC_MODULE_PATH: The path configured for the module.
1079
1080              o      RSYNC_HOST_ADDR: The accessing host's IP address.
1081
1082              o      RSYNC_HOST_NAME: The accessing host's name.
1083
1084              o      RSYNC_USER_NAME: The accessing user's name (empty  if  no
1085                     user).
1086
1087              o      RSYNC_PID: A unique number for this transfer.
1088
1089              o      RSYNC_REQUEST: (pre-xfer only) The module/path info spec‐
1090                     ified by the user.  Note that the user can specify multi‐
1091                     ple  source  files,  so the request can be something like
1092                     "mod/path1 mod/path2", etc.
1093
1094              o      RSYNC_ARG#: (pre-xfer only) The pre-request arguments are
1095                     set  in  these  numbered  values.  RSYNC_ARG0  is  always
1096                     "rsyncd", followed by  the  options  that  were  used  in
1097                     RSYNC_ARG1,  and  so  on.   There  will be a value of "."
1098                     indicating that the options are done and  the  path  args
1099                     are  beginning --  these  contain  similar information to
1100                     RSYNC_REQUEST, but with values separated and  the  module
1101                     name stripped off.
1102
1103              o      RSYNC_EXIT_STATUS:  (post-xfer  only)  the  server side's
1104                     exit value.  This will be 0 for a successful run, a posi‐
1105                     tive  value  for an error that the server generated, or a
1106                     -1 if rsync failed to exit properly.  Note that an  error
1107                     that  occurs  on  the  client side does not currently get
1108                     sent to the server side, so this is not  the  final  exit
1109                     status for the whole transfer.
1110
1111              o      RSYNC_RAW_STATUS:  (post-xfer  only)  the  raw exit value
1112                     from waitpid().
1113
1114              Even though the commands can be  associated  with  a  particular
1115              module,  they  are  run  using  the permissions of the user that
1116              started the daemon (not the module's  uid/gid  setting)  without
1117              any chroot restrictions.
1118
1119              These settings honor 2 environment variables: use RSYNC_SHELL to
1120              set a shell to use when running  the  command  (which  otherwise
1121              uses    your   system()   call's   default   shell),   and   use
1122              RSYNC_NO_XFER_EXEC to disable both options completely.
1123

CONFIG DIRECTIVES

1125       There are currently two config directives available that allow a config
1126       file  to incorporate the contents of other files:  &include and &merge.
1127       Both allow a reference to either a file or a directory.  They differ in
1128       how segregated the file's contents are considered to be.
1129
1130       The &include directive treats each file as more distinct, with each one
1131       inheriting the defaults of the  parent  file,  starting  the  parameter
1132       parsing as globals/defaults, and leaving the defaults unchanged for the
1133       parsing of the rest of the parent file.
1134
1135       The &merge directive, on the other hand, treats the file's contents  as
1136       if  it  were simply inserted in place of the directive, and thus it can
1137       set parameters in a module started in  another  file,  can  affect  the
1138       defaults for other files, etc.
1139
1140       When  an  &include  or  &merge directive refers to a directory, it will
1141       read in all the *.conf or *.inc files (respectively) that are contained
1142       inside  that directory (without any recursive scanning), with the files
1143       sorted into alpha order.  So, if you have a directory named  "rsyncd.d"
1144       with  the  files "foo.conf", "bar.conf", and "baz.conf" inside it, this
1145       directive:
1146
1147           &include /path/rsyncd.d
1148
1149       would be the same as this set of directives:
1150
1151           &include /path/rsyncd.d/bar.conf
1152           &include /path/rsyncd.d/baz.conf
1153           &include /path/rsyncd.d/foo.conf
1154
1155       except that it adjusts as files are added and removed from  the  direc‐
1156       tory.
1157
1158       The  advantage  of the &include directive is that you can define one or
1159       more modules in a separate file without worrying about unintended side-
1160       effects between the self-contained module files.
1161
1162       The advantage of the &merge directive is that you can load config snip‐
1163       pets that can be included into multiple module definitions, and you can
1164       also   set   global  values  that  will  affect  connections  (such  as
1165       motd file), or globals that will affect other include files.
1166
1167       For example, this is a useful /etc/rsyncd.conf file:
1168
1169           port = 873
1170           log file = /var/log/rsync.log
1171           pid file = /var/lock/rsync.lock
1172
1173           &merge /etc/rsyncd.d
1174           &include /etc/rsyncd.d
1175
1176       This would merge any /etc/rsyncd.d/*.inc files (for global values  that
1177       should stay in effect), and then include any /etc/rsyncd.d/*.conf files
1178       (defining modules without any global-value cross-talk).
1179

AUTHENTICATION STRENGTH

1181       The authentication protocol used in rsync is a 128 bit MD4 based  chal‐
1182       lenge  response system. This is fairly weak protection, though (with at
1183       least one brute-force hash-finding algorithm publicly available), so if
1184       you  want  really  top-quality  security, then I recommend that you run
1185       rsync over ssh.  (Yes, a future version of rsync will switch over to  a
1186       stronger hashing method.)
1187
1188       Also note that the rsync daemon protocol does not currently provide any
1189       encryption of the data that is transferred over  the  connection.  Only
1190       authentication  is  provided.  Use  ssh  as  the  transport if you want
1191       encryption.
1192
1193       You can also make use of SSL/TLS encryption if you put rsync behind  an
1194       SSL proxy.
1195

SSL/TLS Daemon Setup

1197       When  setting  up an rsync daemon for access via SSL/TLS, you will need
1198       to configure a proxy (such as haproxy or nginx) as the  front-end  that
1199       handles the encryption.
1200
1201       o      You  should  limit the access to the backend-rsyncd port to only
1202              allow the proxy to connect.  If it is on the same  host  as  the
1203              proxy, then configuring it to only listen on localhost is a good
1204              idea.
1205
1206       o      You should consider turning on the proxy protocol  parameter  if
1207              your  proxy  supports  sending  that  information.  The examples
1208              below assume that this is enabled.
1209
1210       An example haproxy setup is as follows:
1211
1212           frontend fe_rsync-ssl
1213              bind :::874 ssl crt /etc/letsencrypt/example.com/combined.pem
1214              mode tcp
1215              use_backend be_rsync
1216
1217           backend be_rsync
1218              mode tcp
1219              server local-rsync 127.0.0.1:873 check send-proxy
1220
1221       An example nginx proxy setup is as follows:
1222
1223           stream {
1224              server {
1225                  listen 874 ssl;
1226                  listen [::]:874 ssl;
1227
1228                  ssl_certificate /etc/letsencrypt/example.com/fullchain.pem;
1229                  ssl_certificate_key /etc/letsencrypt/example.com/privkey.pem;
1230
1231                  proxy_pass localhost:873;
1232                  proxy_protocol on; # Requires "proxy protocol = true"
1233                  proxy_timeout 1m;
1234                  proxy_connect_timeout 5s;
1235              }
1236           }
1237

EXAMPLES

1239       A simple rsyncd.conf file that allow anonymous rsync to a ftp  area  at
1240       /home/ftp would be:
1241
1242           [ftp]
1243                   path = /home/ftp
1244                   comment = ftp export area
1245
1246       A more sophisticated example would be:
1247
1248           uid = nobody
1249           gid = nobody
1250           use chroot = yes
1251           max connections = 4
1252           syslog facility = local5
1253           pid file = /var/run/rsyncd.pid
1254
1255           [ftp]
1256                   path = /var/ftp/./pub
1257                   comment = whole ftp area (approx 6.1 GB)
1258
1259           [sambaftp]
1260                   path = /var/ftp/./pub/samba
1261                   comment = Samba ftp area (approx 300 MB)
1262
1263           [rsyncftp]
1264                   path = /var/ftp/./pub/rsync
1265                   comment = rsync ftp area (approx 6 MB)
1266
1267           [sambawww]
1268                   path = /public_html/samba
1269                   comment = Samba WWW pages (approx 240 MB)
1270
1271           [cvs]
1272                   path = /data/cvs
1273                   comment = CVS repository (requires authentication)
1274                   auth users = tridge, susan
1275                   secrets file = /etc/rsyncd.secrets
1276
1277       The /etc/rsyncd.secrets file would look something like this:
1278
1279           tridge:mypass
1280           susan:herpass
1281

FILES

1283       /etc/rsyncd.conf or rsyncd.conf
1284

SEE ALSO

1286       rsync(1), rsync-ssl(1)
1287

BUGS

1289       Please  report  bugs!  The  rsync  bug  tracking  system  is  online at
1290       https://rsync.samba.org/.
1291

VERSION

1293       This man page is current for version 3.2.3 of rsync.
1294

CREDITS

1296       rsync is distributed under the GNU General  Public  License.   See  the
1297       file COPYING for details.
1298
1299       The primary ftp site for rsync is ftp://rsync.samba.org/pub/rsync
1300
1301       A web site is available at https://rsync.samba.org/.
1302
1303       We would be delighted to hear from you if you like this program.
1304
1305       This  program  uses  the  zlib compression library written by Jean-loup
1306       Gailly and Mark Adler.
1307

THANKS

1309       Thanks to Warren Stanley for his original idea and patch for the  rsync
1310       daemon.   Thanks to Karsten Thygesen for his many suggestions and docu‐
1311       mentation!
1312

AUTHOR

1314       rsync was written by Andrew Tridgell and Paul Mackerras.   Many  people
1315       have later contributed to it.
1316
1317       Mailing   lists   for   support   and   development  are  available  at
1318       https://lists.samba.org/.
1319
1320
1321
1322rsyncd.conf 3.2.3                 06 Aug 2020                   rsyncd.conf(5)
Impressum