{ "content": [ { "type": "text", "text": "# rsyncd.conf (man)\n\n## NAME\n\nrsyncd.conf - configuration file for rsync in daemon mode\n\n## SYNOPSIS\n\nrsyncd.conf\nThe online version of this manpage (that includes cross-linking of topics) is available at\nhttps://download.samba.org/pub/rsync/rsyncd.conf.5.\n\n## DESCRIPTION\n\nThe rsyncd.conf file is the runtime configuration file for rsync when run as an rsync daemon.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **FILE FORMAT**\n- **LAUNCHING THE RSYNC DAEMON**\n- **GLOBAL PARAMETERS** (5 subsections)\n- **MODULE PARAMETERS** (40 subsections)\n- **CONFIG DIRECTIVES**\n- **AUTHENTICATION STRENGTH** (1 subsections)\n- **DAEMON CONFIG EXAMPLES**\n- **FILES**\n- **SEE ALSO**\n- **BUGS**\n- **VERSION**\n- **CREDITS**\n- **THANKS**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "rsyncd.conf", "section": "", "mode": "man", "summary": "rsyncd.conf - configuration file for rsync in daemon mode", "synopsis": "rsyncd.conf\nThe online version of this manpage (that includes cross-linking of topics) is available at\nhttps://download.samba.org/pub/rsync/rsyncd.conf.5.", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [ { "name": "rsync", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/rsync/1/json" }, { "name": "rsync-ssl", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/rsync-ssl/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 5, "subsections": [] }, { "name": "DESCRIPTION", "lines": 4, "subsections": [] }, { "name": "FILE FORMAT", "lines": 22, "subsections": [] }, { "name": "LAUNCHING THE RSYNC DAEMON", "lines": 24, "subsections": [] }, { "name": "GLOBAL PARAMETERS", "lines": 17, "subsections": [ { "name": "motd file", "lines": 5 }, { "name": "pid file", "lines": 11 }, { "name": "address", "lines": 4 }, { "name": "socket options", "lines": 6 }, { "name": "listen backlog", "lines": 3 } ] }, { "name": "MODULE PARAMETERS", "lines": 11, "subsections": [ { "name": "comment", "lines": 27 }, { "name": "use chroot", "lines": 53 }, { "name": "daemon chroot", "lines": 7 }, { "name": "proxy protocol", "lines": 19 }, { "name": "name converter", "lines": 16 }, { "name": "numeric ids", "lines": 13 }, { "name": "munge symlinks", "lines": 32 }, { "name": "charset", "lines": 12 }, { "name": "max connections", "lines": 5 }, { "name": "log file", "lines": 16 }, { "name": "syslog facility", "lines": 8 }, { "name": "syslog tag", "lines": 10 }, { "name": "max verbosity", "lines": 11 }, { "name": "lock file", "lines": 5 }, { "name": "read only", "lines": 7 }, { "name": "write only", "lines": 8 }, { "name": "open noatime", "lines": 46 }, { "name": "daemon uid", "lines": 4 }, { "name": "daemon gid", "lines": 4 }, { "name": "fake super", "lines": 29 }, { "name": "exclude", "lines": 5 }, { "name": "include", "lines": 4 }, { "name": "exclude from", "lines": 6 }, { "name": "include from", "lines": 4 }, { "name": "incoming chmod", "lines": 7 }, { "name": "outgoing chmod", "lines": 8 }, { "name": "auth users", "lines": 53 }, { "name": "secrets file", "lines": 23 }, { "name": "strict modes", "lines": 6 }, { "name": "hosts allow", "lines": 46 }, { "name": "hosts deny", "lines": 7 }, { "name": "reverse lookup", "lines": 11 }, { "name": "forward lookup", "lines": 4 }, { "name": "ignore errors", "lines": 6 }, { "name": "ignore nonreadable", "lines": 4 }, { "name": "transfer logging", "lines": 6 }, { "name": "log format", "lines": 71 }, { "name": "timeout", "lines": 6 }, { "name": "refuse options", "lines": 93 }, { "name": "dont compress", "lines": 83 } ] }, { "name": "CONFIG DIRECTIVES", "lines": 48, "subsections": [] }, { "name": "AUTHENTICATION STRENGTH", "lines": 12, "subsections": [ { "name": "SSL/TLS Daemon Setup", "lines": 38 } ] }, { "name": "DAEMON CONFIG EXAMPLES", "lines": 42, "subsections": [] }, { "name": "FILES", "lines": 2, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "BUGS", "lines": 2, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "CREDITS", "lines": 5, "subsections": [] }, { "name": "THANKS", "lines": 3, "subsections": [] }, { "name": "AUTHOR", "lines": 8, "subsections": [] } ], "sections": { "NAME": { "content": "rsyncd.conf - configuration file for rsync in daemon mode\n", "subsections": [] }, "SYNOPSIS": { "content": "rsyncd.conf\n\nThe online version of this manpage (that includes cross-linking of topics) is available at\nhttps://download.samba.org/pub/rsync/rsyncd.conf.5.\n", "subsections": [] }, "DESCRIPTION": { "content": "The rsyncd.conf file is the runtime configuration file for rsync when run as an rsync daemon.\n\nThe rsyncd.conf file controls authentication, access, logging and available modules.\n", "subsections": [] }, "FILE FORMAT": { "content": "The file consists of modules and parameters. A module begins with the name of the module in\nsquare brackets and continues until the next module begins. Modules contain parameters of\nthe form name = value.\n\nThe file is line-based -- that is, each newline-terminated line represents either a comment,\na module name or a parameter.\n\nOnly the first equals sign in a parameter is significant. Whitespace before or after the\nfirst equals sign is discarded. Leading, trailing and internal whitespace in module and pa‐\nrameter names is irrelevant. Leading and trailing whitespace in a parameter value is dis‐\ncarded. Internal whitespace within a parameter value is retained verbatim.\n\nAny line beginning with a hash (#) is ignored, as are lines containing only whitespace. (If a\nhash occurs after anything other than leading whitespace, it is considered a part of the\nline's content.)\n\nAny line ending in a \\ is \"continued\" on the next line in the customary UNIX fashion.\n\nThe values following the equals sign in parameters are all either a string (no quotes needed)\nor a boolean, which may be given as yes/no, 0/1 or true/false. Case is not significant in\nboolean values, but is preserved in string values.\n", "subsections": [] }, "LAUNCHING THE RSYNC DAEMON": { "content": "The rsync daemon is launched by specifying the --daemon option to rsync.\n\nThe daemon must run with root privileges if you wish to use chroot, to bind to a port num‐\nbered under 1024 (as is the default 873), or to set file ownership. Otherwise, it must just\nhave permission to read and write the appropriate data, log, and lock files.\n\nYou can launch it either via inetd, as a stand-alone daemon, or from an rsync client via a\nremote shell. If run as a stand-alone daemon then just run the command \"rsync --daemon\" from\na suitable startup script.\n\nWhen run via inetd you should add a line like this to /etc/services:\n\nrsync 873/tcp\n\nand a single line something like this to /etc/inetd.conf:\n\nrsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon\n\nReplace \"/usr/bin/rsync\" with the path to where you have rsync installed on your system. You\nwill then need to send inetd a HUP signal to tell it to reread its config file.\n\nNote that you should not send the rsync daemon a HUP signal to force it to reread the\nrsyncd.conf file. The file is re-read on each client connection.\n", "subsections": [] }, "GLOBAL PARAMETERS": { "content": "The first parameters in the file (before a [module] header) are the global parameters. Rsync\nalso allows for the use of a \"[global]\" module name to indicate the start of one or more\nglobal-parameter sections (the name must be lower case).\n\nYou may also include any module parameters in the global part of the config file in which\ncase the supplied value will override the default for that parameter.\n\nYou may use references to environment variables in the values of parameters. String parame‐\nters will have %VAR% references expanded as late as possible (when the string is first used\nin the program), allowing for the use of variables that rsync sets at connection time, such\nas RSYNCUSERNAME. Non-string parameters (such as true/false settings) are expanded when\nread from the config file. If a variable does not exist in the environment, or if a sequence\nof characters is not a valid reference (such as an un-paired percent sign), the raw charac‐\nters are passed through unchanged. This helps with backward compatibility and safety (e.g.\nexpanding a non-existent %VAR% to an empty string in a path could result in a very unsafe\npath). The safest way to insert a literal % into a value is to use %%.\n", "subsections": [ { "name": "motd file", "content": "This parameter allows you to specify a \"message of the day\" (MOTD) to display to\nclients on each connect. This usually contains site information and any legal notices.\nThe default is no MOTD file. This can be overridden by the --dparam=motdfile=FILE\ncommand-line option when starting the daemon.\n" }, { "name": "pid file", "content": "This parameter tells the rsync daemon to write its process ID to that file. The rsync\nkeeps the file locked so that it can know when it is safe to overwrite an existing\nfile.\n\nThe filename can be overridden by the --dparam=pidfile=FILE command-line option when\nstarting the daemon.\n\nport You can override the default port the daemon will listen on by specifying this value\n(defaults to 873). This is ignored if the daemon is being run by inetd, and is super‐\nseded by the --port command-line option.\n" }, { "name": "address", "content": "You can override the default IP address the daemon will listen on by specifying this\nvalue. This is ignored if the daemon is being run by inetd, and is superseded by the\n--address command-line option.\n" }, { "name": "socket options", "content": "This parameter can provide endless fun for people who like to tune their systems to\nthe utmost degree. You can set all sorts of socket options which may make transfers\nfaster (or slower!). Read the manpage for the setsockopt() system call for details on\nsome of the options you may be able to set. By default no special socket options are\nset. These settings can also be specified via the --sockopts command-line option.\n" }, { "name": "listen backlog", "content": "You can override the default backlog value when the daemon listens for connections.\nIt defaults to 5.\n" } ] }, "MODULE PARAMETERS": { "content": "After the global parameters you should define a number of modules, each module exports a di‐\nrectory tree as a symbolic name. Modules are exported by specifying a module name in square\nbrackets [module] followed by the parameters for that module. The module name cannot contain\na slash or a closing square bracket. If the name contains whitespace, each internal sequence\nof whitespace will be changed into a single space, while leading or trailing whitespace will\nbe discarded. Also, the name cannot be \"global\" as that exact name indicates that global pa‐\nrameters follow (see above).\n\nAs with GLOBAL PARAMETERS, you may use references to environment variables in the values of\nparameters. See the GLOBAL PARAMETERS section for more details.\n", "subsections": [ { "name": "comment", "content": "This parameter specifies a description string that is displayed next to the module\nname when clients obtain a list of available modules. The default is no comment.\n\npath This parameter specifies the directory in the daemon's filesystem to make available in\nthis module. You must specify this parameter for each module in rsyncd.conf.\n\nIf the value contains a \"/./\" element then the path will be divided at that point into\na chroot dir and an inner-chroot subdir. If use chroot is set to false, though, the\nextraneous dot dir is just cleaned out of the path. An example of this idiom is:\n\npath = /var/rsync/./module1\n\nThis will (when chrooting) chroot to \"/var/rsync\" and set the inside-chroot path to\n\"/module1\".\n\nYou may base the path's value off of an environment variable by surrounding the vari‐\nable name with percent signs. You can even reference a variable that is set by rsync\nwhen the user connects. For example, this would use the authorizing user's name in\nthe path:\n\npath = /home/%RSYNCUSERNAME%\n\nIt is fine if the path includes internal spaces -- they will be retained verbatim\n(which means that you shouldn't try to escape them). If your final directory has a\ntrailing space (and this is somehow not something you wish to fix), append a trailing\nslash to the path to avoid losing the trailing whitespace.\n" }, { "name": "use chroot", "content": "If \"use chroot\" is true, the rsync daemon will chroot to the \"path\" before starting\nthe file transfer with the client. This has the advantage of extra protection against\npossible implementation security holes, but it has the disadvantages of requiring su‐\nper-user privileges, of not being able to follow symbolic links that are either abso‐\nlute or outside of the new root path, and of complicating the preservation of users\nand groups by name (see below).\n\nIf use chroot is not set, it defaults to trying to enable a chroot but allows the dae‐\nmon to continue (after logging a warning) if it fails. The one exception to this is\nwhen a module's path has a \"/./\" chroot divider in it -- this causes an unset value to\nbe treated as true for that module.\n\nPrior to rsync 3.2.7, the default value was \"true\". The new \"unset\" default makes it\neasier to setup an rsync daemon as a non-root user or to run a daemon on a system\nwhere chroot fails. Explicitly setting the value to \"true\" in rsyncd.conf will always\nrequire the chroot to succeed.\n\nIt is also possible to specify a dot-dir in the module's \"path\" to indicate that you\nwant to chdir to the earlier part of the path and then serve files from inside the\nlatter part of the path (with sanitizing and default symlink munging). This can be\nuseful if you need some library dirs inside the chroot (typically for uid & gid\nlookups) but don't want to put the lib dir into the top of the served path (even\nthough they can be hidden with an exclude directive). However, a better choice for a\nmodern rsync setup is to use a name converter\" and try to avoid inner lib dirs alto‐\ngether. See also the daemon chroot parameter, which causes rsync to chroot into its\nown chroot area before doing any path-related chrooting.\n\nIf the daemon is serving the \"/\" dir (either directly or due to being chrooted to the\nmodule's path), rsync does not do any path sanitizing or (default) munging.\n\nWhen it has to limit access to a particular subdir (either due to chroot being dis‐\nabled or having an inside-chroot path set), rsync will munge symlinks (by default) and\nsanitize paths. Those that dislike munged symlinks (and really, really trust their\nusers to not break out of the subdir) can disable the symlink munging via the \"munge\nsymlinks\" parameter.\n\nWhen rsync is sanitizing paths, it trims \"..\" path elements from args that it believes\nwould escape the module hierarchy. It also substitutes leading slashes in absolute\npaths with the module's path (so that options such as --backup-dir & --compare-dest\ninterpret an absolute path as rooted in the module's \"path\" dir).\n\nWhen a chroot is in effect and the \"name converter\" parameter is not set, the \"numeric\nids\" parameter will default to being enabled (disabling name lookups). This means\nthat if you manually setup name-lookup libraries in your chroot (instead of using a\nname converter) that you need to explicitly set numeric ids = false for rsync to do\nname lookups.\n\nIf you copy library resources into the module's chroot area, you should protect them\nthrough your OS's normal user/group or ACL settings (to prevent the rsync module's\nuser from being able to change them), and then hide them from the user's view via \"ex‐\nclude\" (see how in the discussion of that parameter). However, it's easier and safer\nto setup a name converter.\n" }, { "name": "daemon chroot", "content": "This parameter specifies a path to which the daemon will chroot before beginning com‐\nmunication with clients. Module paths (and any \"use chroot\" settings) will then be re‐\nlated to this one. This lets you choose if you want the whole daemon to be chrooted\n(with this setting), just the transfers to be chrooted (with \"use chroot\"), or both.\nKeep in mind that the \"daemon chroot\" area may need various OS/lib/etc files installed\nto allow the daemon to function. By default the daemon runs without any chrooting.\n" }, { "name": "proxy protocol", "content": "When this parameter is enabled, all incoming connections must start with a V1 or V2\nproxy protocol header. If the header is not found, the connection is closed.\n\nSetting this to true requires a proxy server to forward source IP information to\nrsync, allowing you to log proper IP/host info and make use of client-oriented IP re‐\nstrictions. The default of false means that the IP information comes directly from\nthe socket's metadata. If rsync is not behind a proxy, this should be disabled.\n\nCAUTION: using this option can be dangerous if you do not ensure that only the proxy\nis allowed to connect to the rsync port. If any non-proxied connections are allowed\nthrough, the client will be able to use a modified rsync to spoof any remote IP ad‐\ndress that they desire. You can lock this down using something like iptables -uid-\nowner root rules (for strict localhost access), various firewall rules, or you can re‐\nquire password authorization so that any spoofing by users will not grant extra ac‐\ncess.\n\nThis setting is global. If you need some modules to require this and not others, then\nyou will need to setup multiple rsync daemon processes on different ports.\n" }, { "name": "name converter", "content": "This parameter lets you specify a program that will be run by the rsync daemon to do\nuser & group conversions between names & ids. This script is started prior to any ch‐\nroot being setup, and runs as the daemon user (not the transfer user). You can spec‐\nify a fully qualified pathname or a program name that is on the $PATH.\n\nThe program can be used to do normal user & group lookups without having to put any\nextra files into the chroot area of the module or you can do customized conversions.\n\nThe nameconvert program has access to all of the environment variables that are de‐\nscribed in the section on pre-xfer exec. This is useful if you want to customize the\nconversion using information about the module and/or the copy request.\n\nThere is a sample python script in the support dir named \"nameconvert\" that implements\nthe normal user & group lookups. Feel free to customize it or just use it as documen‐\ntation to implement your own.\n" }, { "name": "numeric ids", "content": "Enabling this parameter disables the mapping of users and groups by name for the cur‐\nrent daemon module. This prevents the daemon from trying to load any user/group-re‐\nlated files or libraries. This enabling makes the transfer behave as if the client\nhad passed the --numeric-ids command-line option. By default, this parameter is en‐\nabled for chroot modules and disabled for non-chroot modules. Also keep in mind that\nuid/gid preservation requires the module to be running as root (see \"uid\") or for\n\"fake super\" to be configured.\n\nA chroot-enabled module should not have this parameter set to false unless you're us‐\ning a \"name converter\" program or you've taken steps to ensure that the module has the\nnecessary resources it needs to translate names and that it is not possible for a user\nto change those resources.\n" }, { "name": "munge symlinks", "content": "This parameter tells rsync to modify all symlinks in the same way as the (non-daemon-\naffecting) --munge-links command-line option (using a method described below). This\nshould help protect your files from user trickery when your daemon module is writable.\nThe default is disabled when \"use chroot\" is on with an inside-chroot path of \"/\", OR\nif \"daemon chroot\" is on, otherwise it is enabled.\n\nIf you disable this parameter on a daemon that is not read-only, there are tricks that\na user can play with uploaded symlinks to access daemon-excluded items (if your module\nhas any), and, if \"use chroot\" is off, rsync can even be tricked into showing or\nchanging data that is outside the module's path (as access-permissions allow).\n\nThe way rsync disables the use of symlinks is to prefix each one with the string\n\"/rsyncd-munged/\". This prevents the links from being used as long as that directory\ndoes not exist. When this parameter is enabled, rsync will refuse to run if that path\nis a directory or a symlink to a directory. When using the \"munge symlinks\" parameter\nin a chroot area that has an inside-chroot path of \"/\", you should add \"/rsyncd-\nmunged/\" to the exclude setting for the module so that a user can't try to create it.\n\nNote: rsync makes no attempt to verify that any pre-existing symlinks in the module's\nhierarchy are as safe as you want them to be (unless, of course, it just copied in the\nwhole hierarchy). If you setup an rsync daemon on a new area or locally add symlinks,\nyou can manually protect your symlinks from being abused by prefixing \"/rsyncd-\nmunged/\" to the start of every symlink's value. There is a perl script in the support\ndirectory of the source code named \"munge-symlinks\" that can be used to add or remove\nthis prefix from your symlinks.\n\nWhen this parameter is disabled on a writable module and \"use chroot\" is off (or the\ninside-chroot path is not \"/\"), incoming symlinks will be modified to drop a leading\nslash and to remove \"..\" path elements that rsync believes will allow a symlink to es‐\ncape the module's hierarchy. There are tricky ways to work around this, though, so\nyou had better trust your users if you choose this combination of parameters.\n" }, { "name": "charset", "content": "This specifies the name of the character set in which the module's filenames are\nstored. If the client uses an --iconv option, the daemon will use the value of the\n\"charset\" parameter regardless of the character set the client actually passed. This\nallows the daemon to support charset conversion in a chroot module without extra files\nin the chroot area, and also ensures that name-translation is done in a consistent\nmanner. If the \"charset\" parameter is not set, the --iconv option is refused, just as\nif \"iconv\" had been specified via \"refuse options\".\n\nIf you wish to force users to always use --iconv for a particular module, add \"no-\niconv\" to the \"refuse options\" parameter. Keep in mind that this will restrict access\nto your module to very new rsync clients.\n" }, { "name": "max connections", "content": "This parameter allows you to specify the maximum number of simultaneous connections\nyou will allow. Any clients connecting when the maximum has been reached will receive\na message telling them to try later. The default is 0, which means no limit. A nega‐\ntive value disables the module. See also the \"lock file\" parameter.\n" }, { "name": "log file", "content": "When the \"log file\" parameter is set to a non-empty string, the rsync daemon will log\nmessages to the indicated file rather than using syslog. This is particularly useful\non systems (such as AIX) where syslog() doesn't work for chrooted programs. The file\nis opened before chroot() is called, allowing it to be placed outside the transfer.\nIf this value is set on a per-module basis instead of globally, the global log will\nstill contain any authorization failures or config-file error messages.\n\nIf the daemon fails to open the specified file, it will fall back to using syslog and\noutput an error about the failure. (Note that the failure to open the specified log\nfile used to be a fatal error.)\n\nThis setting can be overridden by using the --log-file=FILE or --dparam=logfile=FILE\ncommand-line options. The former overrides all the log-file parameters of the daemon\nand all module settings. The latter sets the daemon's log file and the default for\nall the modules, which still allows modules to override the default setting.\n" }, { "name": "syslog facility", "content": "This parameter allows you to specify the syslog facility name to use when logging mes‐\nsages from the rsync daemon. You may use any standard syslog facility name which is\ndefined on your system. Common names are auth, authpriv, cron, daemon, ftp, kern, lpr,\nmail, news, security, syslog, user, uucp, local0, local1, local2, local3, local4, lo‐\ncal5, local6 and local7. The default is daemon. This setting has no effect if the\n\"log file\" setting is a non-empty string (either set in the per-modules settings, or\ninherited from the global settings).\n" }, { "name": "syslog tag", "content": "This parameter allows you to specify the syslog tag to use when logging messages from\nthe rsync daemon. The default is \"rsyncd\". This setting has no effect if the \"log\nfile\" setting is a non-empty string (either set in the per-modules settings, or inher‐\nited from the global settings).\n\nFor example, if you wanted each authenticated user's name to be included in the syslog\ntag, you could do something like this:\n\nsyslog tag = rsyncd.%RSYNCUSERNAME%\n" }, { "name": "max verbosity", "content": "This parameter allows you to control the maximum amount of verbose information that\nyou'll allow the daemon to generate (since the information goes into the log file).\nThe default is 1, which allows the client to request one level of verbosity.\n\nThis also affects the user's ability to request higher levels of --info and --debug\nlogging. If the max value is 2, then no info and/or debug value that is higher than\nwhat would be set by -vv will be honored by the daemon in its logging. To see how\nhigh of a verbosity level you need to accept for a particular info/debug level, refer\nto rsync --info=help and rsync --debug=help. For instance, it takes max-verbosity 4\nto be able to output debug TIME2 and FLIST3.\n" }, { "name": "lock file", "content": "This parameter specifies the file to use to support the \"max connections\" parameter.\nThe rsync daemon uses record locking on this file to ensure that the max connections\nlimit is not exceeded for the modules sharing the lock file. The default is\n/var/run/rsyncd.lock.\n" }, { "name": "read only", "content": "This parameter determines whether clients will be able to upload files or not. If\n\"read only\" is true then any attempted uploads will fail. If \"read only\" is false then\nuploads will be possible if file permissions on the daemon side allow them. The de‐\nfault is for all modules to be read only.\n\nNote that \"auth users\" can override this setting on a per-user basis.\n" }, { "name": "write only", "content": "This parameter determines whether clients will be able to download files or not. If\n\"write only\" is true then any attempted downloads will fail. If \"write only\" is false\nthen downloads will be possible if file permissions on the daemon side allow them.\nThe default is for this parameter to be disabled.\n\nHelpful hint: you probably want to specify \"refuse options = delete\" for a write-only\nmodule.\n" }, { "name": "open noatime", "content": "When set to True, this parameter tells the rsync daemon to open files with the ONOAT‐\nIME flag (on systems that support it) to avoid changing the access time of the files\nthat are being transferred. If your OS does not support the ONOATIME flag then rsync\nwill silently ignore this option. Note also that some filesystems are mounted to\navoid updating the atime on read access even without the ONOATIME flag being set.\n\nWhen set to False, this parameters ensures that files on the server are not opened\nwith ONOATIME.\n\nWhen set to Unset (the default) the user controls the setting via --open-noatime.\n\nlist This parameter determines whether this module is listed when the client asks for a\nlisting of available modules. In addition, if this is false, the daemon will pretend\nthe module does not exist when a client denied by \"hosts allow\" or \"hosts deny\" at‐\ntempts to access it. Realize that if \"reverse lookup\" is disabled globally but en‐\nabled for the module, the resulting reverse lookup to a potentially client-controlled\nDNS server may still reveal to the client that it hit an existing module. The default\nis for modules to be listable.\n\nuid This parameter specifies the user name or user ID that file transfers to and from that\nmodule should take place as when the daemon was run as root. In combination with the\n\"gid\" parameter this determines what file permissions are available. The default when\nrun by a super-user is to switch to the system's \"nobody\" user. The default for a\nnon-super-user is to not try to change the user. See also the \"gid\" parameter.\n\nThe RSYNCUSERNAME environment variable may be used to request that rsync run as the\nauthorizing user. For example, if you want a rsync to run as the same user that was\nreceived for the rsync authentication, this setup is useful:\n\nuid = %RSYNCUSERNAME%\ngid = *\n\ngid This parameter specifies one or more group names/IDs that will be used when accessing\nthe module. The first one will be the default group, and any extra ones be set as\nsupplemental groups. You may also specify a \"*\" as the first gid in the list, which\nwill be replaced by all the normal groups for the transfer's user (see \"uid\"). The\ndefault when run by a super-user is to switch to your OS's \"nobody\" (or perhaps\n\"nogroup\") group with no other supplementary groups. The default for a non-super-user\nis to not change any group attributes (and indeed, your OS may not allow a non-super-\nuser to try to change their group settings).\n\nThe specified list is normally split into tokens based on spaces and commas. However,\nif the list starts with a comma, then the list is only split on commas, which allows a\ngroup name to contain a space. In either case any leading and/or trailing whitespace\nis removed from the tokens and empty tokens are ignored.\n" }, { "name": "daemon uid", "content": "This parameter specifies a uid under which the daemon will run. The daemon usually\nruns as user root, and when this is left unset the user is left unchanged. See also\nthe \"uid\" parameter.\n" }, { "name": "daemon gid", "content": "This parameter specifies a gid under which the daemon will run. The daemon usually\nruns as group root, and when this is left unset, the group is left unchanged. See also\nthe \"gid\" parameter.\n" }, { "name": "fake super", "content": "Setting \"fake super = yes\" for a module causes the daemon side to behave as if the\n--fake-super command-line option had been specified. This allows the full attributes\nof a file to be stored without having to have the daemon actually running as root.\n\nfilter The daemon has its own filter chain that determines what files it will let the client\naccess. This chain is not sent to the client and is independent of any filters the\nclient may have specified. Files excluded by the daemon filter chain (daemon-excluded\nfiles) are treated as non-existent if the client tries to pull them, are skipped with\nan error message if the client tries to push them (triggering exit code 23), and are\nnever deleted from the module. You can use daemon filters to prevent clients from\ndownloading or tampering with private administrative files, such as files you may add\nto support uid/gid name translations.\n\nThe daemon filter chain is built from the \"filter\", \"include from\", \"include\", \"ex‐\nclude from\", and \"exclude\" parameters, in that order of priority. Anchored patterns\nare anchored at the root of the module. To prevent access to an entire subtree, for\nexample, \"/secret\", you must exclude everything in the subtree; the easiest way to do\nthis is with a triple-star pattern like \"/secret/*\".\n\nThe \"filter\" parameter takes a space-separated list of daemon filter rules, though it\nis smart enough to know not to split a token at an internal space in a rule (e.g.\n\"- /foo - /bar\" is parsed as two rules). You may specify one or more merge-file\nrules using the normal syntax. Only one \"filter\" parameter can apply to a given mod‐\nule in the config file, so put all the rules you want in a single parameter. Note\nthat per-directory merge-file rules do not provide as much protection as global rules,\nbut they can be used to make --delete work better during a client download operation\nif the per-dir merge files are included in the transfer and the client requests that\nthey be used.\n" }, { "name": "exclude", "content": "This parameter takes a space-separated list of daemon exclude patterns. As with the\nclient --exclude option, patterns can be qualified with \"- \" or \"+ \" to explicitly in‐\ndicate exclude/include. Only one \"exclude\" parameter can apply to a given module.\nSee the \"filter\" parameter for a description of how excluded files affect the daemon.\n" }, { "name": "include", "content": "Use an \"include\" to override the effects of the \"exclude\" parameter. Only one \"in‐\nclude\" parameter can apply to a given module. See the \"filter\" parameter for a de‐\nscription of how excluded files affect the daemon.\n" }, { "name": "exclude from", "content": "This parameter specifies the name of a file on the daemon that contains daemon exclude\npatterns, one per line. Only one \"exclude from\" parameter can apply to a given mod‐\nule; if you have multiple exclude-from files, you can specify them as a merge file in\nthe \"filter\" parameter. See the \"filter\" parameter for a description of how excluded\nfiles affect the daemon.\n" }, { "name": "include from", "content": "Analogue of \"exclude from\" for a file of daemon include patterns. Only one \"include\nfrom\" parameter can apply to a given module. See the \"filter\" parameter for a de‐\nscription of how excluded files affect the daemon.\n" }, { "name": "incoming chmod", "content": "This parameter allows you to specify a set of comma-separated chmod strings that will\naffect the permissions of all incoming files (files that are being received by the\ndaemon). These changes happen after all other permission calculations, and this will\neven override destination-default and/or existing permissions when the client does not\nspecify --perms. See the description of the --chmod rsync option and the chmod(1)\nmanpage for information on the format of this string.\n" }, { "name": "outgoing chmod", "content": "This parameter allows you to specify a set of comma-separated chmod strings that will\naffect the permissions of all outgoing files (files that are being sent out from the\ndaemon). These changes happen first, making the sent permissions appear to be differ‐\nent than those stored in the filesystem itself. For instance, you could disable group\nwrite permissions on the server while having it appear to be on to the clients. See\nthe description of the --chmod rsync option and the chmod(1) manpage for information\non the format of this string.\n" }, { "name": "auth users", "content": "This parameter specifies a comma and/or space-separated list of authorization rules.\nIn its simplest form, you list the usernames that will be allowed to connect to this\nmodule. The usernames do not need to exist on the local system. The rules may contain\nshell wildcard characters that will be matched against the username provided by the\nclient for authentication. If \"auth users\" is set then the client will be challenged\nto supply a username and password to connect to the module. A challenge response au‐\nthentication protocol is used for this exchange. The plain text usernames and pass‐\nwords are stored in the file specified by the \"secrets file\" parameter. The default is\nfor all users to be able to connect without a password (this is called \"anonymous\nrsync\").\n\nIn addition to username matching, you can specify groupname matching via a '@' prefix.\nWhen using groupname matching, the authenticating username must be a real user on the\nsystem, or it will be assumed to be a member of no groups. For example, specifying\n\"@rsync\" will match the authenticating user if the named user is a member of the rsync\ngroup.\n\nFinally, options may be specified after a colon (:). The options allow you to \"deny\"\na user or a group, set the access to \"ro\" (read-only), or set the access to \"rw\"\n(read/write). Setting an auth-rule-specific ro/rw setting overrides the module's\n\"read only\" setting.\n\nBe sure to put the rules in the order you want them to be matched, because the check‐\ning stops at the first matching user or group, and that is the only auth that is\nchecked. For example:\n\nauth users = joe:deny @guest:deny admin:rw @rsync:ro susan joe sam\n\nIn the above rule, user joe will be denied access no matter what. Any user that is in\nthe group \"guest\" is also denied access. The user \"admin\" gets access in read/write\nmode, but only if the admin user is not in group \"guest\" (because the admin user-\nmatching rule would never be reached if the user is in group \"guest\"). Any other user\nwho is in group \"rsync\" will get read-only access. Finally, users susan, joe, and sam\nget the ro/rw setting of the module, but only if the user didn't match an earlier\ngroup-matching rule.\n\nIf you need to specify a user or group name with a space in it, start your list with a\ncomma to indicate that the list should only be split on commas (though leading and\ntrailing whitespace will also be removed, and empty entries are just ignored). For\nexample:\n\nauth users = , joe:deny, @Some Group:deny, admin:rw, @RO Group:ro\n\nSee the description of the secrets file for how you can have per-user passwords as\nwell as per-group passwords. It also explains how a user can authenticate using their\nuser password or (when applicable) a group password, depending on what rule is being\nauthenticated.\n\nSee also the section entitled \"USING RSYNC-DAEMON FEATURES VIA A REMOTE SHELL CONNEC‐\nTION\" in rsync(1) for information on how handle an rsyncd.conf-level username that\ndiffers from the remote-shell-level username when using a remote shell to connect to\nan rsync daemon.\n" }, { "name": "secrets file", "content": "This parameter specifies the name of a file that contains the username:password and/or\n@groupname:password pairs used for authenticating this module. This file is only con‐\nsulted if the \"auth users\" parameter is specified. The file is line-based and con‐\ntains one name:password pair per line. Any line has a hash (#) as the very first\ncharacter on the line is considered a comment and is skipped. The passwords can con‐\ntain any characters but be warned that many operating systems limit the length of\npasswords that can be typed at the client end, so you may find that passwords longer\nthan 8 characters don't work.\n\nThe use of group-specific lines are only relevant when the module is being authorized\nusing a matching \"@groupname\" rule. When that happens, the user can be authorized via\neither their \"username:password\" line or the \"@groupname:password\" line for the group\nthat triggered the authentication.\n\nIt is up to you what kind of password entries you want to include, either users,\ngroups, or both. The use of group rules in \"auth users\" does not require that you\nspecify a group password if you do not want to use shared passwords.\n\nThere is no default for the \"secrets file\" parameter, you must choose a name (such as\n/etc/rsyncd.secrets). The file must normally not be readable by \"other\"; see \"strict\nmodes\". If the file is not found or is rejected, no logins for an \"auth users\" module\nwill be possible.\n" }, { "name": "strict modes", "content": "This parameter determines whether or not the permissions on the secrets file will be\nchecked. If \"strict modes\" is true, then the secrets file must not be readable by any\nuser ID other than the one that the rsync daemon is running under. If \"strict modes\"\nis false, the check is not performed. The default is true. This parameter was added\nto accommodate rsync running on the Windows operating system.\n" }, { "name": "hosts allow", "content": "This parameter allows you to specify a list of comma- and/or whitespace-separated pat‐\nterns that are matched against a connecting client's hostname and IP address. If none\nof the patterns match, then the connection is rejected.\n\nEach pattern can be in one of six forms:\n\no a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address of the\nform a:b:c::d:e:f. In this case the incoming machine's IP address must match\nexactly.\n\no an address/mask in the form ipaddr/n where ipaddr is the IP address and n is\nthe number of one bits in the netmask. All IP addresses which match the masked\nIP address will be allowed in.\n\no an address/mask in the form ipaddr/maskaddr where ipaddr is the IP address and\nmaskaddr is the netmask in dotted decimal notation for IPv4, or similar for\nIPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP addresses which match\nthe masked IP address will be allowed in.\n\no a hostname pattern using wildcards. If the hostname of the connecting IP (as\ndetermined by a reverse lookup) matches the wildcarded name (using the same\nrules as normal Unix filename matching), the client is allowed in. This only\nworks if \"reverse lookup\" is enabled (the default).\n\no a hostname. A plain hostname is matched against the reverse DNS of the connect‐\ning IP (if \"reverse lookup\" is enabled), and/or the IP of the given hostname is\nmatched against the connecting IP (if \"forward lookup\" is enabled, as it is by\ndefault). Any match will be allowed in.\n\no an '@' followed by a netgroup name, which will match if the reverse DNS of the\nconnecting IP is in the specified netgroup.\n\nNote IPv6 link-local addresses can have a scope in the address specification:\n\nfe80::1%link1\nfe80::%link1/64\nfe80::%link1/ffff:ffff:ffff:ffff::\n\nYou can also combine \"hosts allow\" with \"hosts deny\" as a way to add exceptions to\nyour deny list. When both parameters are specified, the \"hosts allow\" parameter is\nchecked first and a match results in the client being able to connect. A non-allowed\nhost is then matched against the \"hosts deny\" list to see if it should be rejected. A\nhost that does not match either list is allowed to connect.\n\nThe default is no \"hosts allow\" parameter, which means all hosts can connect.\n" }, { "name": "hosts deny", "content": "This parameter allows you to specify a list of comma- and/or whitespace-separated pat‐\nterns that are matched against a connecting clients hostname and IP address. If the\npattern matches then the connection is rejected. See the \"hosts allow\" parameter for\nmore information.\n\nThe default is no \"hosts deny\" parameter, which means all hosts can connect.\n" }, { "name": "reverse lookup", "content": "Controls whether the daemon performs a reverse lookup on the client's IP address to\ndetermine its hostname, which is used for \"hosts allow\" & \"hosts deny\" checks and the\n\"%h\" log escape. This is enabled by default, but you may wish to disable it to save\ntime if you know the lookup will not return a useful result, in which case the daemon\nwill use the name \"UNDETERMINED\" instead.\n\nIf this parameter is enabled globally (even by default), rsync performs the lookup as\nsoon as a client connects, so disabling it for a module will not avoid the lookup.\nThus, you probably want to disable it globally and then enable it for modules that\nneed the information.\n" }, { "name": "forward lookup", "content": "Controls whether the daemon performs a forward lookup on any hostname specified in an\nhosts allow/deny setting. By default this is enabled, allowing the use of an explicit\nhostname that would not be returned by reverse DNS of the connecting IP.\n" }, { "name": "ignore errors", "content": "This parameter tells rsyncd to ignore I/O errors on the daemon when deciding whether\nto run the delete phase of the transfer. Normally rsync skips the --delete step if any\nI/O errors have occurred in order to prevent disastrous deletion due to a temporary\nresource shortage or other I/O error. In some cases this test is counter productive so\nyou can use this parameter to turn off this behavior.\n" }, { "name": "ignore nonreadable", "content": "This tells the rsync daemon to completely ignore files that are not readable by the\nuser. This is useful for public archives that may have some non-readable files among\nthe directories, and the sysadmin doesn't want those files to be seen at all.\n" }, { "name": "transfer logging", "content": "This parameter enables per-file logging of downloads and uploads in a format somewhat\nsimilar to that used by ftp daemons. The daemon always logs the transfer at the end,\nso if a transfer is aborted, no mention will be made in the log file.\n\nIf you want to customize the log lines, see the \"log format\" parameter.\n" }, { "name": "log format", "content": "This parameter allows you to specify the format used for logging file transfers when\ntransfer logging is enabled. The format is a text string containing embedded single-\ncharacter escape sequences prefixed with a percent (%) character. An optional numeric\nfield width may also be specified between the percent and the escape letter (e.g.\n\"%-50n %8l %07p\"). In addition, one or more apostrophes may be specified prior to a\nnumerical escape to indicate that the numerical value should be made more human-read‐\nable. The 3 supported levels are the same as for the --human-readable command-line\noption, though the default is for human-readability to be off. Each added apostrophe\nincreases the level (e.g. \"%''l %'b %f\").\n\nThe default log format is \"%o %h [%a] %m (%u) %f %l\", and a \"%t [%p] \" is always pre‐\nfixed when using the \"log file\" parameter. (A perl script that will summarize this\ndefault log format is included in the rsync source code distribution in the \"support\"\nsubdirectory: rsyncstats.)\n\nThe single-character escapes that are understood are as follows:\n\no %a the remote IP address (only available for a daemon)\n\no %b the number of bytes actually transferred\n\no %B the permission bits of the file (e.g. rwxrwxrwt)\n\no %c the total size of the block checksums received for the basis file (only when\nsending)\n\no %C the full-file checksum if it is known for the file. For older rsync proto‐\ncols/versions, the checksum was salted, and is thus not a useful value (and is\nnot displayed when that is the case). For the checksum to output for a file,\neither the --checksum option must be in-effect or the file must have been\ntransferred without a salted checksum being used. See the --checksum-choice\noption for a way to choose the algorithm.\n\no %f the filename (long form on sender; no trailing \"/\")\n\no %G the gid of the file (decimal) or \"DEFAULT\"\n\no %h the remote host name (only available for a daemon)\n\no %i an itemized list of what is being updated\n\no %l the length of the file in bytes\n\no %L the string \" -> SYMLINK\", \" => HARDLINK\", or \"\" (where SYMLINK or HARDLINK\nis a filename)\n\no %m the module name\n\no %M the last-modified time of the file\n\no %n the filename (short form; trailing \"/\" on dir)\n\no %o the operation, which is \"send\", \"recv\", or \"del.\" (the latter includes the\ntrailing period)\n\no %p the process ID of this rsync session\n\no %P the module path\n\no %t the current date time\n\no %u the authenticated username or an empty string\n\no %U the uid of the file (decimal)\n\nFor a list of what the characters mean that are output by \"%i\", see the --itemize-\nchanges option in the rsync manpage.\n\nNote that some of the logged output changes when talking with older rsync versions.\nFor instance, deleted files were only output as verbose messages prior to rsync 2.6.4.\n" }, { "name": "timeout", "content": "This parameter allows you to override the clients choice for I/O timeout for this mod‐\nule. Using this parameter you can ensure that rsync won't wait on a dead client for‐\never. The timeout is specified in seconds. A value of zero means no timeout and is the\ndefault. A good choice for anonymous rsync daemons may be 600 (giving a 10 minute\ntimeout).\n" }, { "name": "refuse options", "content": "This parameter allows you to specify a space-separated list of rsync command-line op‐\ntions that will be refused by your rsync daemon. You may specify the full option\nname, its one-letter abbreviation, or a wild-card string that matches multiple op‐\ntions. Beginning in 3.2.0, you can also negate a match term by starting it with a \"!\".\n\nWhen an option is refused, the daemon prints an error message and exits.\n\nFor example, this would refuse --checksum (-c) and all the various delete options:\n\nrefuse options = c delete\n\nThe reason the above refuses all delete options is that the options imply --delete,\nand implied options are refused just like explicit options.\n\nThe use of a negated match allows you to fine-tune your refusals after a wild-card,\nsuch as this:\n\nrefuse options = delete-* !delete-during\n\nNegated matching can also turn your list of refused options into a list of accepted\noptions. To do this, begin the list with a \"*\" (to refuse all options) and then spec‐\nify one or more negated matches to accept. For example:\n\nrefuse options = * !a !v !compress*\n\nDon't worry that the \"*\" will refuse certain vital options such as --dry-run,\n--server, --no-iconv, --seclude-args, etc. These important options are not matched by\nwild-card, so they must be overridden by their exact name. For instance, if you're\nforcing iconv transfers you could use something like this:\n\nrefuse options = * no-iconv !a !v\n\nAs an additional aid (beginning in 3.2.0), refusing (or \"!refusing\") the \"a\" or \"ar‐\nchive\" option also affects all the options that the --archive option implies (-rdlpt‐‐\ngoD), but only if the option is matched explicitly (not using a wildcard). If you\nwant to do something tricky, you can use \"archive*\" to avoid this side-effect, but\nkeep in mind that no normal rsync client ever sends the actual archive option to the\nserver.\n\nAs an additional safety feature, the refusal of \"delete\" also refuses remove-source-\nfiles when the daemon is the sender; if you want the latter without the former, in‐\nstead refuse \"delete-*\" as that refuses all the delete modes without affecting --re‐‐\nmove-source-files. (Keep in mind that the client's --delete option typically results\nin --delete-during.)\n\nWhen un-refusing delete options, you should either specify \"!delete*\" (to accept all\ndelete options) or specify a limited set that includes \"delete\", such as:\n\nrefuse options = * !a !delete !delete-during\n\n... whereas this accepts any delete option except --delete-after:\n\nrefuse options = * !a !delete* delete-after\n\nA note on refusing \"compress\": it may be better to set the \"dont compress\" daemon pa‐\nrameter to \"*\" and ensure that RSYNCCOMPRESSLIST=zlib is set in the environment of\nthe daemon in order to disable compression silently instead of returning an error that\nforces the client to remove the -z option.\n\nIf you are un-refusing the compress option, you may want to match \"!compress*\" if you\nalso want to allow the --compress-level option.\n\nNote that the \"copy-devices\" & \"write-devices\" options are refused by default, but\nthey can be explicitly accepted with \"!copy-devices\" and/or \"!write-devices\". The op‐\ntions \"log-file\" and \"log-file-format\" are forcibly refused and cannot be accepted.\n\nHere are all the options that are not matched by wild-cards:\n\no --server: Required for rsync to even work.\n\no --rsh, -e: Required to convey compatibility flags to the server.\n\no --out-format: This is required to convey output behavior to a remote receiver.\nWhile rsync passes the older alias --log-format for compatibility reasons, this\noptions should not be confused with --log-file-format.\n\no --sender: Use \"write only\" parameter instead of refusing this.\n\no --dry-run, -n: Who would want to disable this?\n\no --seclude-args, -s: Is the oldest arg-protection method.\n\no --from0, -0: Makes it easier to accept/refuse --files-from without affecting\nthis helpful modifier.\n\no --iconv: This is auto-disabled based on \"charset\" parameter.\n\no --no-iconv: Most transfers use this option.\n\no --checksum-seed: Is a fairly rare, safe option.\n\no --write-devices: Is non-wild but also auto-disabled.\n" }, { "name": "dont compress", "content": "NOTE: This parameter currently has no effect except in one instance: if it is set to\n\"*\" then it minimizes or disables compression for all files (for those that don't want\nto refuse the --compress option completely).\n\nThis parameter allows you to select filenames based on wildcard patterns that should\nnot be compressed when pulling files from the daemon (no analogous parameter exists to\ngovern the pushing of files to a daemon). Compression can be expensive in terms of\nCPU usage, so it is usually good to not try to compress files that won't compress\nwell, such as already compressed files.\n\nThe \"dont compress\" parameter takes a space-separated list of case-insensitive wild‐\ncard patterns. Any source filename matching one of the patterns will be compressed as\nlittle as possible during the transfer. If the compression algorithm has an \"off\"\nlevel, then no compression occurs for those files. If an algorithms has the ability\nto change the level in mid-stream, it will be minimized to reduce the CPU usage as\nmuch as possible.\n\nSee the --skip-compress parameter in the rsync(1) manpage for the list of file suf‐\nfixes that are skipped by default if this parameter is not set.\n\nearly exec, pre-xfer exec, post-xfer exec\nYou may specify a command to be run in the early stages of the connection, or right\nbefore and/or after the transfer. If the early exec or pre-xfer exec command returns\nan error code, the transfer is aborted before it begins. Any output from the pre-\nxfer exec command on stdout (up to several KB) will be displayed to the user when\naborting, but is not displayed if the script returns success. The other programs can‐\nnot send any text to the user. All output except for the pre-xfer exec stdout goes to\nthe corresponding daemon's stdout/stderr, which is typically discarded. See the --no-\ndetatch option for a way to see the daemon's output, which can assist with debugging.\n\nNote that the early exec command runs before any part of the transfer request is known\nexcept for the module name. This helper script can be used to setup a disk mount or\ndecrypt some data into a module dir, but you may need to use lock file and max connec‐‐\ntions to avoid concurrency issues. If the client rsync specified the --early-in‐‐\nput=FILE option, it can send up to about 5K of data to the stdin of the early script.\nThe stdin will otherwise be empty.\n\nNote that the post-xfer exec command is still run even if one of the other scripts re‐\nturns an error code. The pre-xfer exec command will not be run, however, if the\nearly exec command fails.\n\nThe following environment variables will be set, though some are specific to the pre-\nxfer or the post-xfer environment:\n\no RSYNCMODULENAME: The name of the module being accessed.\n\no RSYNCMODULEPATH: The path configured for the module.\n\no RSYNCHOSTADDR: The accessing host's IP address.\n\no RSYNCHOSTNAME: The accessing host's name.\n\no RSYNCUSERNAME: The accessing user's name (empty if no user).\n\no RSYNCPID: A unique number for this transfer.\n\no RSYNCREQUEST: (pre-xfer only) The module/path info specified by the user.\nNote that the user can specify multiple source files, so the request can be\nsomething like \"mod/path1 mod/path2\", etc.\n\no RSYNCARG#: (pre-xfer only) The pre-request arguments are set in these numbered\nvalues. RSYNCARG0 is always \"rsyncd\", followed by the options that were used\nin RSYNCARG1, and so on. There will be a value of \".\" indicating that the\noptions are done and the path args are beginning -- these contain similar in‐\nformation to RSYNCREQUEST, but with values separated and the module name\nstripped off.\n\no RSYNCEXITSTATUS: (post-xfer only) the server side's exit value. This will be\n0 for a successful run, a positive value for an error that the server gener‐\nated, or a -1 if rsync failed to exit properly. Note that an error that occurs\non the client side does not currently get sent to the server side, so this is\nnot the final exit status for the whole transfer.\n\no RSYNCRAWSTATUS: (post-xfer only) the raw exit value from waitpid().\n\nEven though the commands can be associated with a particular module, they are run us‐\ning the permissions of the user that started the daemon (not the module's uid/gid set‐\nting) without any chroot restrictions.\n\nThese settings honor 2 environment variables: use RSYNCSHELL to set a shell to use\nwhen running the command (which otherwise uses your system() call's default shell),\nand use RSYNCNOXFEREXEC to disable both options completely.\n" } ] }, "CONFIG DIRECTIVES": { "content": "There are currently two config directives available that allow a config file to incorporate\nthe contents of other files: &include and &merge. Both allow a reference to either a file\nor a directory. They differ in how segregated the file's contents are considered to be.\n\nThe &include directive treats each file as more distinct, with each one inheriting the de‐\nfaults of the parent file, starting the parameter parsing as globals/defaults, and leaving\nthe defaults unchanged for the parsing of the rest of the parent file.\n\nThe &merge directive, on the other hand, treats the file's contents as if it were simply in‐\nserted in place of the directive, and thus it can set parameters in a module started in an‐\nother file, can affect the defaults for other files, etc.\n\nWhen an &include or &merge directive refers to a directory, it will read in all the *.conf or\n*.inc files (respectively) that are contained inside that directory (without any recursive\nscanning), with the files sorted into alpha order. So, if you have a directory named\n\"rsyncd.d\" with the files \"foo.conf\", \"bar.conf\", and \"baz.conf\" inside it, this directive:\n\n&include /path/rsyncd.d\n\nwould be the same as this set of directives:\n\n&include /path/rsyncd.d/bar.conf\n&include /path/rsyncd.d/baz.conf\n&include /path/rsyncd.d/foo.conf\n\nexcept that it adjusts as files are added and removed from the directory.\n\nThe advantage of the &include directive is that you can define one or more modules in a sepa‐\nrate file without worrying about unintended side-effects between the self-contained module\nfiles.\n\nThe advantage of the &merge directive is that you can load config snippets that can be in‐\ncluded into multiple module definitions, and you can also set global values that will affect\nconnections (such as motd file), or globals that will affect other include files.\n\nFor example, this is a useful /etc/rsyncd.conf file:\n\nport = 873\nlog file = /var/log/rsync.log\npid file = /var/lock/rsync.lock\n\n&merge /etc/rsyncd.d\n&include /etc/rsyncd.d\n\nThis would merge any /etc/rsyncd.d/*.inc files (for global values that should stay in ef‐\nfect), and then include any /etc/rsyncd.d/*.conf files (defining modules without any global-\nvalue cross-talk).\n", "subsections": [] }, "AUTHENTICATION STRENGTH": { "content": "The authentication protocol used in rsync is a 128 bit MD4 based challenge response system.\nThis is fairly weak protection, though (with at least one brute-force hash-finding algorithm\npublicly available), so if you want really top-quality security, then I recommend that you\nrun rsync over ssh. (Yes, a future version of rsync will switch over to a stronger hashing\nmethod.)\n\nAlso note that the rsync daemon protocol does not currently provide any encryption of the\ndata that is transferred over the connection. Only authentication is provided. Use ssh as the\ntransport if you want encryption.\n\nYou can also make use of SSL/TLS encryption if you put rsync behind an SSL proxy.\n", "subsections": [ { "name": "SSL/TLS Daemon Setup", "content": "When setting up an rsync daemon for access via SSL/TLS, you will need to configure a TCP\nproxy (such as haproxy or nginx) as the front-end that handles the encryption.\n\no You should limit the access to the backend-rsyncd port to only allow the proxy to con‐\nnect. If it is on the same host as the proxy, then configuring it to only listen on\nlocalhost is a good idea.\n\no You should consider turning on the proxy protocol rsync-daemon parameter if your proxy\nsupports sending that information. The examples below assume that this is enabled.\n\nAn example haproxy setup is as follows:\n\nfrontend fersync-ssl\nbind :::874 ssl crt /etc/letsencrypt/example.com/combined.pem\nmode tcp\nusebackend bersync\n\nbackend bersync\nmode tcp\nserver local-rsync 127.0.0.1:873 check send-proxy\n\nAn example nginx proxy setup is as follows:\n\nstream {\nserver {\nlisten 874 ssl;\nlisten [::]:874 ssl;\n\nsslcertificate /etc/letsencrypt/example.com/fullchain.pem;\nsslcertificatekey /etc/letsencrypt/example.com/privkey.pem;\n\nproxypass localhost:873;\nproxyprotocol on; # Requires rsyncd.conf \"proxy protocol = true\"\nproxytimeout 1m;\nproxyconnecttimeout 5s;\n}\n}\n" } ] }, "DAEMON CONFIG EXAMPLES": { "content": "A simple rsyncd.conf file that allow anonymous rsync to a ftp area at /home/ftp would be:\n\n[ftp]\npath = /home/ftp\ncomment = ftp export area\n\nA more sophisticated example would be:\n\nuid = nobody\ngid = nobody\nuse chroot = yes\nmax connections = 4\nsyslog facility = local5\npid file = /var/run/rsyncd.pid\n\n[ftp]\npath = /var/ftp/./pub\ncomment = whole ftp area (approx 6.1 GB)\n\n[sambaftp]\npath = /var/ftp/./pub/samba\ncomment = Samba ftp area (approx 300 MB)\n\n[rsyncftp]\npath = /var/ftp/./pub/rsync\ncomment = rsync ftp area (approx 6 MB)\n\n[sambawww]\npath = /publichtml/samba\ncomment = Samba WWW pages (approx 240 MB)\n\n[cvs]\npath = /data/cvs\ncomment = CVS repository (requires authentication)\nauth users = tridge, susan\nsecrets file = /etc/rsyncd.secrets\n\nThe /etc/rsyncd.secrets file would look something like this:\n\ntridge:mypass\nsusan:herpass\n", "subsections": [] }, "FILES": { "content": "/etc/rsyncd.conf or rsyncd.conf\n", "subsections": [] }, "SEE ALSO": { "content": "rsync(1), rsync-ssl(1)\n", "subsections": [] }, "BUGS": { "content": "Please report bugs! The rsync bug tracking system is online at https://rsync.samba.org/.\n", "subsections": [] }, "VERSION": { "content": "This manpage is current for version 3.2.7 of rsync.\n", "subsections": [] }, "CREDITS": { "content": "Rsync is distributed under the GNU General Public License. See the file COPYING for details.\n\nAn rsync web site is available at https://rsync.samba.org/ and its github project is\nhttps://github.com/WayneD/rsync.\n", "subsections": [] }, "THANKS": { "content": "Thanks to Warren Stanley for his original idea and patch for the rsync daemon. Thanks to\nKarsten Thygesen for his many suggestions and documentation!\n", "subsections": [] }, "AUTHOR": { "content": "Rsync was originally written by Andrew Tridgell and Paul Mackerras. Many people have later\ncontributed to it. It is currently maintained by Wayne Davison.\n\nMailing lists for support and development are available at https://lists.samba.org/.\n\n\n\nrsyncd.conf from rsync 3.2.7 20 Oct 2022 rsyncd.conf(5)", "subsections": [] } } } }