| 1 | mailto(rsync-bugs@samba.org) |
| 2 | manpage(rsyncd.conf)(5)(26 Oct 2006)()() |
| 3 | manpagename(rsyncd.conf)(configuration file for rsync in daemon mode) |
| 4 | manpagesynopsis() |
| 5 | |
| 6 | rsyncd.conf |
| 7 | |
| 8 | manpagedescription() |
| 9 | |
| 10 | The rsyncd.conf file is the runtime configuration file for rsync when |
| 11 | run as an rsync daemon. |
| 12 | |
| 13 | The rsyncd.conf file controls authentication, access, logging and |
| 14 | available modules. |
| 15 | |
| 16 | manpagesection(FILE FORMAT) |
| 17 | |
| 18 | The file consists of modules and parameters. A module begins with the |
| 19 | name of the module in square brackets and continues until the next |
| 20 | module begins. Modules contain parameters of the form 'name = value'. |
| 21 | |
| 22 | The file is line-based -- that is, each newline-terminated line represents |
| 23 | either a comment, a module name or a parameter. |
| 24 | |
| 25 | Only the first equals sign in a parameter is significant. Whitespace before |
| 26 | or after the first equals sign is discarded. Leading, trailing and internal |
| 27 | whitespace in module and parameter names is irrelevant. Leading and |
| 28 | trailing whitespace in a parameter value is discarded. Internal whitespace |
| 29 | within a parameter value is retained verbatim. |
| 30 | |
| 31 | Any line beginning with a hash (#) is ignored, as are lines containing |
| 32 | only whitespace. |
| 33 | |
| 34 | Any line ending in a \ is "continued" on the next line in the |
| 35 | customary UNIX fashion. |
| 36 | |
| 37 | The values following the equals sign in parameters are all either a string |
| 38 | (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or |
| 39 | true/false. Case is not significant in boolean values, but is preserved |
| 40 | in string values. |
| 41 | |
| 42 | manpagesection(LAUNCHING THE RSYNC DAEMON) |
| 43 | |
| 44 | The rsync daemon is launched by specifying the bf(--daemon) option to |
| 45 | rsync. |
| 46 | |
| 47 | The daemon must run with root privileges if you wish to use chroot, to |
| 48 | bind to a port numbered under 1024 (as is the default 873), or to set |
| 49 | file ownership. Otherwise, it must just have permission to read and |
| 50 | write the appropriate data, log, and lock files. |
| 51 | |
| 52 | You can launch it either via inetd, as a stand-alone daemon, or from |
| 53 | an rsync client via a remote shell. If run as a stand-alone daemon then |
| 54 | just run the command "bf(rsync --daemon)" from a suitable startup script. |
| 55 | |
| 56 | When run via inetd you should add a line like this to /etc/services: |
| 57 | |
| 58 | verb( rsync 873/tcp) |
| 59 | |
| 60 | and a single line something like this to /etc/inetd.conf: |
| 61 | |
| 62 | verb( rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon) |
| 63 | |
| 64 | Replace "/usr/bin/rsync" with the path to where you have rsync installed on |
| 65 | your system. You will then need to send inetd a HUP signal to tell it to |
| 66 | reread its config file. |
| 67 | |
| 68 | Note that you should bf(not) send the rsync daemon a HUP signal to force |
| 69 | it to reread the tt(rsyncd.conf) file. The file is re-read on each client |
| 70 | connection. |
| 71 | |
| 72 | manpagesection(GLOBAL OPTIONS) |
| 73 | |
| 74 | The first parameters in the file (before a [module] header) are the |
| 75 | global parameters. |
| 76 | |
| 77 | You may also include any module parameters in the global part of the |
| 78 | config file in which case the supplied value will override the |
| 79 | default for that parameter. |
| 80 | |
| 81 | startdit() |
| 82 | dit(bf(motd file)) The "motd file" option allows you to specify a |
| 83 | "message of the day" to display to clients on each connect. This |
| 84 | usually contains site information and any legal notices. The default |
| 85 | is no motd file. |
| 86 | |
| 87 | dit(bf(pid file)) The "pid file" option tells the rsync daemon to write |
| 88 | its process ID to that file. |
| 89 | |
| 90 | dit(bf(port)) You can override the default port the daemon will listen on |
| 91 | by specifying this value (defaults to 873). This is ignored if the daemon |
| 92 | is being run by inetd, and is superseded by the bf(--port) command-line option. |
| 93 | |
| 94 | dit(bf(address)) You can override the default IP address the daemon |
| 95 | will listen on by specifying this value. This is ignored if the daemon is |
| 96 | being run by inetd, and is superseded by the bf(--address) command-line option. |
| 97 | |
| 98 | dit(bf(socket options)) This option can provide endless fun for people |
| 99 | who like to tune their systems to the utmost degree. You can set all |
| 100 | sorts of socket options which may make transfers faster (or |
| 101 | slower!). Read the man page for the code(setsockopt()) system call for |
| 102 | details on some of the options you may be able to set. By default no |
| 103 | special socket options are set. These settings are superseded by the |
| 104 | bf(--sockopts) command-line option. |
| 105 | |
| 106 | enddit() |
| 107 | |
| 108 | |
| 109 | manpagesection(MODULE OPTIONS) |
| 110 | |
| 111 | After the global options you should define a number of modules, each |
| 112 | module exports a directory tree as a symbolic name. Modules are |
| 113 | exported by specifying a module name in square brackets [module] |
| 114 | followed by the options for that module. |
| 115 | |
| 116 | startdit() |
| 117 | |
| 118 | dit(bf(comment)) The "comment" option specifies a description string |
| 119 | that is displayed next to the module name when clients obtain a list |
| 120 | of available modules. The default is no comment. |
| 121 | |
| 122 | dit(bf(path)) The "path" option specifies the directory in the daemon's |
| 123 | filesystem to make available in this module. You must specify this option |
| 124 | for each module in tt(rsyncd.conf). |
| 125 | |
| 126 | dit(bf(use chroot)) If "use chroot" is true, the rsync daemon will chroot |
| 127 | to the "path" before starting the file transfer with the client. This has |
| 128 | the advantage of extra protection against possible implementation security |
| 129 | holes, but it has the disadvantages of requiring super-user privileges, |
| 130 | of not being able to follow symbolic links that are either absolute or outside |
| 131 | of the new root path, and of complicating the preservation of usernames and groups |
| 132 | (see below). When "use chroot" is false, for security reasons, |
| 133 | symlinks may only be relative paths pointing to other files within the root |
| 134 | path, and leading slashes are removed from most absolute paths (options |
| 135 | such as bf(--backup-dir), bf(--compare-dest), etc. interpret an absolute path as |
| 136 | rooted in the module's "path" dir, just as if chroot was specified). |
| 137 | The default for "use chroot" is true. |
| 138 | |
| 139 | In order to preserve usernames and groupnames, rsync needs to be able to |
| 140 | use the standard library functions for looking up names and IDs (i.e. |
| 141 | code(getpwuid()), code(getgrgid()), code(getpwname()), and code(getgrnam())). This means a |
| 142 | process in the chroot namespace will need to have access to the resources |
| 143 | used by these library functions (traditionally /etc/passwd and |
| 144 | /etc/group). If these resources are not available, rsync will only be |
| 145 | able to copy the IDs, just as if the bf(--numeric-ids) option had been |
| 146 | specified. |
| 147 | |
| 148 | Note that you are free to setup user/group information in the chroot area |
| 149 | differently from your normal system. For example, you could abbreviate |
| 150 | the list of users and groups. Also, you can protect this information from |
| 151 | being downloaded/uploaded by adding an exclude rule to the rsyncd.conf file |
| 152 | (e.g. "exclude = /etc/**"). Note that having the exclusion affect uploads |
| 153 | is a relatively new feature in rsync, so make sure your daemon is |
| 154 | at least 2.6.3 to effect this. Also note that it is safest to exclude a |
| 155 | directory and all its contents combining the rule "/some/dir/" with the |
| 156 | rule "/some/dir/**" just to be sure that rsync will not allow deeper |
| 157 | access to some of the excluded files inside the directory (rsync tries to |
| 158 | do this automatically, but you might as well specify both to be extra |
| 159 | sure). |
| 160 | |
| 161 | dit(bf(max connections)) The "max connections" option allows you to |
| 162 | specify the maximum number of simultaneous connections you will allow. |
| 163 | Any clients connecting when the maximum has been reached will receive a |
| 164 | message telling them to try later. The default is 0 which means no limit. |
| 165 | See also the "lock file" option. |
| 166 | |
| 167 | dit(bf(log file)) When the "log file" option is set to a non-empty |
| 168 | string, the rsync daemon will log messages to the indicated file rather |
| 169 | than using syslog. This is particularly useful on systems (such as AIX) |
| 170 | where code(syslog()) doesn't work for chrooted programs. The file is |
| 171 | opened before code(chroot()) is called, allowing it to be placed outside |
| 172 | the transfer. If this value is set on a per-module basis instead of |
| 173 | globally, the global log will still contain any authorization failures |
| 174 | or config-file error messages. |
| 175 | |
| 176 | If the daemon fails to open to specified file, it will fall back to |
| 177 | using syslog and output an error about the failure. (Note that the |
| 178 | failure to open the specified log file used to be a fatal error.) |
| 179 | |
| 180 | dit(bf(syslog facility)) The "syslog facility" option allows you to |
| 181 | specify the syslog facility name to use when logging messages from the |
| 182 | rsync daemon. You may use any standard syslog facility name which is |
| 183 | defined on your system. Common names are auth, authpriv, cron, daemon, |
| 184 | ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0, |
| 185 | local1, local2, local3, local4, local5, local6 and local7. The default |
| 186 | is daemon. This setting has no effect if the "log file" setting is a |
| 187 | non-empty string (either set in the per-modules settings, or inherited |
| 188 | from the global settings). |
| 189 | |
| 190 | dit(bf(max verbosity)) The "max verbosity" option allows you to control |
| 191 | the maximum amount of verbose information that you'll allow the daemon to |
| 192 | generate (since the information goes into the log file). The default is 1, |
| 193 | which allows the client to request one level of verbosity. |
| 194 | |
| 195 | dit(bf(lock file)) The "lock file" option specifies the file to use to |
| 196 | support the "max connections" option. The rsync daemon uses record |
| 197 | locking on this file to ensure that the max connections limit is not |
| 198 | exceeded for the modules sharing the lock file. |
| 199 | The default is tt(/var/run/rsyncd.lock). |
| 200 | |
| 201 | dit(bf(read only)) The "read only" option determines whether clients |
| 202 | will be able to upload files or not. If "read only" is true then any |
| 203 | attempted uploads will fail. If "read only" is false then uploads will |
| 204 | be possible if file permissions on the daemon side allow them. The default |
| 205 | is for all modules to be read only. |
| 206 | |
| 207 | dit(bf(write only)) The "write only" option determines whether clients |
| 208 | will be able to download files or not. If "write only" is true then any |
| 209 | attempted downloads will fail. If "write only" is false then downloads |
| 210 | will be possible if file permissions on the daemon side allow them. The |
| 211 | default is for this option to be disabled. |
| 212 | |
| 213 | dit(bf(list)) The "list" option determines if this module should be |
| 214 | listed when the client asks for a listing of available modules. By |
| 215 | setting this to false you can create hidden modules. The default is |
| 216 | for modules to be listable. |
| 217 | |
| 218 | dit(bf(uid)) The "uid" option specifies the user name or user ID that |
| 219 | file transfers to and from that module should take place as when the daemon |
| 220 | was run as root. In combination with the "gid" option this determines what |
| 221 | file permissions are available. The default is uid -2, which is normally |
| 222 | the user "nobody". |
| 223 | |
| 224 | dit(bf(gid)) The "gid" option specifies the group name or group ID that |
| 225 | file transfers to and from that module should take place as when the daemon |
| 226 | was run as root. This complements the "uid" option. The default is gid -2, |
| 227 | which is normally the group "nobody". |
| 228 | |
| 229 | dit(bf(filter)) The "filter" option allows you to specify a space-separated |
| 230 | list of filter rules that the daemon will not allow to be read or written. |
| 231 | This is only superficially equivalent to the client specifying these |
| 232 | patterns with the bf(--filter) option. Only one "filter" option may be |
| 233 | specified, but it may contain as many rules as you like, including |
| 234 | merge-file rules. Note that per-directory merge-file rules do not provide |
| 235 | as much protection as global rules, but they can be used to make bf(--delete) |
| 236 | work better when a client downloads the daemon's files (if the per-dir |
| 237 | merge files are included in the transfer). |
| 238 | |
| 239 | dit(bf(exclude)) The "exclude" option allows you to specify a |
| 240 | space-separated list of patterns that the daemon will not allow to be read |
| 241 | or written. This is only superficially equivalent to the client |
| 242 | specifying these patterns with the bf(--exclude) option. Only one "exclude" |
| 243 | option may be specified, but you can use "-" and "+" before patterns to |
| 244 | specify exclude/include. |
| 245 | |
| 246 | Because this exclude list is not passed to the client it only applies on |
| 247 | the daemon: that is, it excludes files received by a client when receiving |
| 248 | from a daemon and files deleted on a daemon when sending to a daemon, but |
| 249 | it doesn't exclude files from being deleted on a client when receiving |
| 250 | from a daemon. |
| 251 | |
| 252 | dit(bf(exclude from)) The "exclude from" option specifies a filename |
| 253 | on the daemon that contains exclude patterns, one per line. |
| 254 | This is only superficially equivalent |
| 255 | to the client specifying the bf(--exclude-from) option with an equivalent file. |
| 256 | See the "exclude" option above. |
| 257 | |
| 258 | dit(bf(include)) The "include" option allows you to specify a |
| 259 | space-separated list of patterns which rsync should not exclude. This is |
| 260 | only superficially equivalent to the client specifying these patterns with |
| 261 | the bf(--include) option because it applies only on the daemon. This is |
| 262 | useful as it allows you to build up quite complex exclude/include rules. |
| 263 | Only one "include" option may be specified, but you can use "+" and "-" |
| 264 | before patterns to switch include/exclude. See the "exclude" option |
| 265 | above. |
| 266 | |
| 267 | dit(bf(include from)) The "include from" option specifies a filename |
| 268 | on the daemon that contains include patterns, one per line. This is |
| 269 | only superficially equivalent to the client specifying the |
| 270 | bf(--include-from) option with a equivalent file. |
| 271 | See the "exclude" option above. |
| 272 | |
| 273 | dit(bf(incoming chmod)) This option allows you to specify a set of |
| 274 | comma-separated chmod strings that will affect the permissions of all |
| 275 | incoming files (files that are being received by the daemon). These |
| 276 | changes happen after all other permission calculations, and this will |
| 277 | even override destination-default and/or existing permissions when the |
| 278 | client does not specify bf(--perms). |
| 279 | See the description of the bf(--chmod) rsync option and the bf(chmod)(1) |
| 280 | manpage for information on the format of this string. |
| 281 | |
| 282 | dit(bf(outgoing chmod)) This option allows you to specify a set of |
| 283 | comma-separated chmod strings that will affect the permissions of all |
| 284 | outgoing files (files that are being sent out from the daemon). These |
| 285 | changes happen first, making the sent permissions appear to be different |
| 286 | than those stored in the filesystem itself. For instance, you could |
| 287 | disable group write permissions on the server while having it appear to |
| 288 | be on to the clients. |
| 289 | See the description of the bf(--chmod) rsync option and the bf(chmod)(1) |
| 290 | manpage for information on the format of this string. |
| 291 | |
| 292 | dit(bf(auth users)) The "auth users" option specifies a comma and |
| 293 | space-separated list of usernames that will be allowed to connect to |
| 294 | this module. The usernames do not need to exist on the local |
| 295 | system. The usernames may also contain shell wildcard characters. If |
| 296 | "auth users" is set then the client will be challenged to supply a |
| 297 | username and password to connect to the module. A challenge response |
| 298 | authentication protocol is used for this exchange. The plain text |
| 299 | usernames and passwords are stored in the file specified by the |
| 300 | "secrets file" option. The default is for all users to be able to |
| 301 | connect without a password (this is called "anonymous rsync"). |
| 302 | |
| 303 | See also the "CONNECTING TO AN RSYNC DAEMON OVER A REMOTE SHELL |
| 304 | PROGRAM" section in bf(rsync)(1) for information on how handle an |
| 305 | rsyncd.conf-level username that differs from the remote-shell-level |
| 306 | username when using a remote shell to connect to an rsync daemon. |
| 307 | |
| 308 | dit(bf(secrets file)) The "secrets file" option specifies the name of |
| 309 | a file that contains the username:password pairs used for |
| 310 | authenticating this module. This file is only consulted if the "auth |
| 311 | users" option is specified. The file is line based and contains |
| 312 | username:password pairs separated by a single colon. Any line starting |
| 313 | with a hash (#) is considered a comment and is skipped. The passwords |
| 314 | can contain any characters but be warned that many operating systems |
| 315 | limit the length of passwords that can be typed at the client end, so |
| 316 | you may find that passwords longer than 8 characters don't work. |
| 317 | |
| 318 | There is no default for the "secrets file" option, you must choose a name |
| 319 | (such as tt(/etc/rsyncd.secrets)). The file must normally not be readable |
| 320 | by "other"; see "strict modes". |
| 321 | |
| 322 | dit(bf(strict modes)) The "strict modes" option determines whether or not |
| 323 | the permissions on the secrets file will be checked. If "strict modes" is |
| 324 | true, then the secrets file must not be readable by any user ID other |
| 325 | than the one that the rsync daemon is running under. If "strict modes" is |
| 326 | false, the check is not performed. The default is true. This option |
| 327 | was added to accommodate rsync running on the Windows operating system. |
| 328 | |
| 329 | dit(bf(hosts allow)) The "hosts allow" option allows you to specify a |
| 330 | list of patterns that are matched against a connecting clients |
| 331 | hostname and IP address. If none of the patterns match then the |
| 332 | connection is rejected. |
| 333 | |
| 334 | Each pattern can be in one of five forms: |
| 335 | |
| 336 | quote(itemization( |
| 337 | it() a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address |
| 338 | of the form a:b:c::d:e:f. In this case the incoming machine's IP address |
| 339 | must match exactly. |
| 340 | it() an address/mask in the form ipaddr/n where ipaddr is the IP address |
| 341 | and n is the number of one bits in the netmask. All IP addresses which |
| 342 | match the masked IP address will be allowed in. |
| 343 | it() an address/mask in the form ipaddr/maskaddr where ipaddr is the |
| 344 | IP address and maskaddr is the netmask in dotted decimal notation for IPv4, |
| 345 | or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP |
| 346 | addresses which match the masked IP address will be allowed in. |
| 347 | it() a hostname. The hostname as determined by a reverse lookup will |
| 348 | be matched (case insensitive) against the pattern. Only an exact |
| 349 | match is allowed in. |
| 350 | it() a hostname pattern using wildcards. These are matched using the |
| 351 | same rules as normal unix filename matching. If the pattern matches |
| 352 | then the client is allowed in. |
| 353 | )) |
| 354 | |
| 355 | Note IPv6 link-local addresses can have a scope in the address specification: |
| 356 | |
| 357 | quote( |
| 358 | tt( fe80::1%link1)nl() |
| 359 | tt( fe80::%link1/64)nl() |
| 360 | tt( fe80::%link1/ffff:ffff:ffff:ffff::)nl() |
| 361 | ) |
| 362 | |
| 363 | You can also combine "hosts allow" with a separate "hosts deny" |
| 364 | option. If both options are specified then the "hosts allow" option s |
| 365 | checked first and a match results in the client being able to |
| 366 | connect. The "hosts deny" option is then checked and a match means |
| 367 | that the host is rejected. If the host does not match either the |
| 368 | "hosts allow" or the "hosts deny" patterns then it is allowed to |
| 369 | connect. |
| 370 | |
| 371 | The default is no "hosts allow" option, which means all hosts can connect. |
| 372 | |
| 373 | dit(bf(hosts deny)) The "hosts deny" option allows you to specify a |
| 374 | list of patterns that are matched against a connecting clients |
| 375 | hostname and IP address. If the pattern matches then the connection is |
| 376 | rejected. See the "hosts allow" option for more information. |
| 377 | |
| 378 | The default is no "hosts deny" option, which means all hosts can connect. |
| 379 | |
| 380 | dit(bf(ignore errors)) The "ignore errors" option tells rsyncd to |
| 381 | ignore I/O errors on the daemon when deciding whether to run the delete |
| 382 | phase of the transfer. Normally rsync skips the bf(--delete) step if any |
| 383 | I/O errors have occurred in order to prevent disastrous deletion due |
| 384 | to a temporary resource shortage or other I/O error. In some cases this |
| 385 | test is counter productive so you can use this option to turn off this |
| 386 | behavior. |
| 387 | |
| 388 | dit(bf(ignore nonreadable)) This tells the rsync daemon to completely |
| 389 | ignore files that are not readable by the user. This is useful for |
| 390 | public archives that may have some non-readable files among the |
| 391 | directories, and the sysadmin doesn't want those files to be seen at all. |
| 392 | |
| 393 | dit(bf(transfer logging)) The "transfer logging" option enables per-file |
| 394 | logging of downloads and uploads in a format somewhat similar to that |
| 395 | used by ftp daemons. The daemon always logs the transfer at the end, so |
| 396 | if a transfer is aborted, no mention will be made in the log file. |
| 397 | |
| 398 | If you want to customize the log lines, see the "log format" option. |
| 399 | |
| 400 | dit(bf(log format)) The "log format" option allows you to specify the |
| 401 | format used for logging file transfers when transfer logging is enabled. |
| 402 | The format is a text string containing embedded single-character escape |
| 403 | sequences prefixed with a percent (%) character. An optional numeric |
| 404 | field width may also be specified between the percent and the escape |
| 405 | letter (e.g. "%-50n %8l %07p"). |
| 406 | |
| 407 | The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] " |
| 408 | is always prefixed when using the "log file" option. |
| 409 | (A perl script that will summarize this default log format is included |
| 410 | in the rsync source code distribution in the "support" subdirectory: |
| 411 | rsyncstats.) |
| 412 | |
| 413 | The single-character escapes that are understood are as follows: |
| 414 | |
| 415 | quote(itemization( |
| 416 | it() %a the remote IP address |
| 417 | it() %b the number of bytes actually transferred |
| 418 | it() %B the permission bits of the file (e.g. rwxrwxrwt) |
| 419 | it() %c the checksum bytes received for this file (only when sending) |
| 420 | it() %f the filename (long form on sender; no trailing "/") |
| 421 | it() %G the gid of the file (decimal) or "DEFAULT" |
| 422 | it() %h the remote host name |
| 423 | it() %i an itemized list of what is being updated |
| 424 | it() %l the length of the file in bytes |
| 425 | it() %L the string " -> SYMLINK", " => HARDLINK", or "" (where bf(SYMLINK) or bf(HARDLINK) is a filename) |
| 426 | it() %m the module name |
| 427 | it() %M the last-modified time of the file |
| 428 | it() %n the filename (short form; trailing "/" on dir) |
| 429 | it() %o the operation, which is "send", "recv", or "del." (the latter includes the trailing period) |
| 430 | it() %p the process ID of this rsync session |
| 431 | it() %P the module path |
| 432 | it() %t the current date time |
| 433 | it() %u the authenticated username or an empty string |
| 434 | it() %U the uid of the file (decimal) |
| 435 | )) |
| 436 | |
| 437 | For a list of what the characters mean that are output by "%i", see the |
| 438 | bf(--itemize-changes) option in the rsync manpage. |
| 439 | |
| 440 | Note that some of the logged output changes when talking with older |
| 441 | rsync versions. For instance, deleted files were only output as verbose |
| 442 | messages prior to rsync 2.6.4. |
| 443 | |
| 444 | dit(bf(timeout)) The "timeout" option allows you to override the |
| 445 | clients choice for I/O timeout for this module. Using this option you |
| 446 | can ensure that rsync won't wait on a dead client forever. The timeout |
| 447 | is specified in seconds. A value of zero means no timeout and is the |
| 448 | default. A good choice for anonymous rsync daemons may be 600 (giving |
| 449 | a 10 minute timeout). |
| 450 | |
| 451 | dit(bf(refuse options)) The "refuse options" option allows you to |
| 452 | specify a space-separated list of rsync command line options that will |
| 453 | be refused by your rsync daemon. |
| 454 | You may specify the full option name, its one-letter abbreviation, or a |
| 455 | wild-card string that matches multiple options. |
| 456 | For example, this would refuse bf(--checksum) (bf(-c)) and all the various |
| 457 | delete options: |
| 458 | |
| 459 | quote(tt( refuse options = c delete)) |
| 460 | |
| 461 | The reason the above refuses all delete options is that the options imply |
| 462 | bf(--delete), and implied options are refused just like explicit options. |
| 463 | As an additional safety feature, the refusal of "delete" also refuses |
| 464 | bf(remove-sent-files) when the daemon is the sender; if you want the latter |
| 465 | without the former, instead refuse "delete-*" -- that refuses all the |
| 466 | delete modes without affecting bf(--remove-sent-files). |
| 467 | |
| 468 | When an option is refused, the daemon prints an error message and exits. |
| 469 | To prevent all compression when serving files, |
| 470 | you can use "dont compress = *" (see below) |
| 471 | instead of "refuse options = compress" to avoid returning an error to a |
| 472 | client that requests compression. |
| 473 | |
| 474 | dit(bf(dont compress)) The "dont compress" option allows you to select |
| 475 | filenames based on wildcard patterns that should not be compressed |
| 476 | when pulling files from the daemon (no analogous option exists to |
| 477 | govern the pushing of files to a daemon). |
| 478 | Compression is expensive in terms of CPU usage, so it |
| 479 | is usually good to not try to compress files that won't compress well, |
| 480 | such as already compressed files. |
| 481 | |
| 482 | The "dont compress" option takes a space-separated list of |
| 483 | case-insensitive wildcard patterns. Any source filename matching one |
| 484 | of the patterns will not be compressed during transfer. |
| 485 | |
| 486 | The default setting is tt(*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz) |
| 487 | |
| 488 | dit(bf(pre-xfer exec), bf(post-xfer exec)) You may specify a command to be run |
| 489 | before and/or after the transfer. If the bf(pre-xfer exec) command fails, the |
| 490 | transfer is aborted before it begins. |
| 491 | |
| 492 | The following environment variables will be set, though some are |
| 493 | specific to the pre-xfer or the post-xfer environment: |
| 494 | |
| 495 | quote(itemization( |
| 496 | it() bf(RSYNC_MODULE_NAME): The name of the module being accessed. |
| 497 | it() bf(RSYNC_MODULE_PATH): The path configured for the module. |
| 498 | it() bf(RSYNC_HOST_ADDR): The accessing host's IP address. |
| 499 | it() bf(RSYNC_HOST_NAME): The accessing host's name. |
| 500 | it() bf(RSYNC_USER_NAME): The accessing user's name (empty if no user). |
| 501 | it() bf(RSYNC_PID): A unique number for this transfer. |
| 502 | it() bf(RSYNC_REQUEST): (pre-xfer only) The module/path info specified |
| 503 | by the user (note that the user can specify multiple source files, |
| 504 | so the request can be something like "mod/path1 mod/path2", etc.). |
| 505 | it() bf(RSYNC_ARG#): (pre-xfer only) The pre-request arguments are set |
| 506 | in these numbered values. RSYNC_ARG0 is always "rsyncd", and the last |
| 507 | value contains a single period. |
| 508 | it() bf(RSYNC_EXIT_STATUS): (post-xfer only) the server side's exit value. |
| 509 | This will be 0 for a successful run, a positive value for an error that the |
| 510 | server generated, or a -1 if rsync failed to exit properly. Note that an |
| 511 | error that occurs on the client side does not currently get sent to the |
| 512 | server side, so this is not the final exit status for the whole transfer. |
| 513 | it() bf(RSYNC_RAW_STATUS): (post-xfer only) the raw exit value from code(waitpid()). |
| 514 | )) |
| 515 | |
| 516 | Even though the commands can be associated with a particular module, they |
| 517 | are run using the permissions of the user that started the daemon (not the |
| 518 | module's uid/gid setting) without any chroot restrictions. |
| 519 | |
| 520 | enddit() |
| 521 | |
| 522 | manpagesection(AUTHENTICATION STRENGTH) |
| 523 | |
| 524 | The authentication protocol used in rsync is a 128 bit MD4 based |
| 525 | challenge response system. This is fairly weak protection, though (with |
| 526 | at least one brute-force hash-finding algorithm publicly available), so |
| 527 | if you want really top-quality security, then I recommend that you run |
| 528 | rsync over ssh. (Yes, a future version of rsync will switch over to a |
| 529 | stronger hashing method.) |
| 530 | |
| 531 | Also note that the rsync daemon protocol does not currently provide any |
| 532 | encryption of the data that is transferred over the connection. Only |
| 533 | authentication is provided. Use ssh as the transport if you want |
| 534 | encryption. |
| 535 | |
| 536 | Future versions of rsync may support SSL for better authentication and |
| 537 | encryption, but that is still being investigated. |
| 538 | |
| 539 | manpagesection(EXAMPLES) |
| 540 | |
| 541 | A simple rsyncd.conf file that allow anonymous rsync to a ftp area at |
| 542 | tt(/home/ftp) would be: |
| 543 | |
| 544 | verb( |
| 545 | [ftp] |
| 546 | path = /home/ftp |
| 547 | comment = ftp export area |
| 548 | ) |
| 549 | |
| 550 | A more sophisticated example would be: |
| 551 | |
| 552 | verb( |
| 553 | uid = nobody |
| 554 | gid = nobody |
| 555 | use chroot = no |
| 556 | max connections = 4 |
| 557 | syslog facility = local5 |
| 558 | pid file = /var/run/rsyncd.pid |
| 559 | |
| 560 | [ftp] |
| 561 | path = /var/ftp/pub |
| 562 | comment = whole ftp area (approx 6.1 GB) |
| 563 | |
| 564 | [sambaftp] |
| 565 | path = /var/ftp/pub/samba |
| 566 | comment = Samba ftp area (approx 300 MB) |
| 567 | |
| 568 | [rsyncftp] |
| 569 | path = /var/ftp/pub/rsync |
| 570 | comment = rsync ftp area (approx 6 MB) |
| 571 | |
| 572 | [sambawww] |
| 573 | path = /public_html/samba |
| 574 | comment = Samba WWW pages (approx 240 MB) |
| 575 | |
| 576 | [cvs] |
| 577 | path = /data/cvs |
| 578 | comment = CVS repository (requires authentication) |
| 579 | auth users = tridge, susan |
| 580 | secrets file = /etc/rsyncd.secrets |
| 581 | ) |
| 582 | |
| 583 | The /etc/rsyncd.secrets file would look something like this: |
| 584 | |
| 585 | quote( |
| 586 | tt(tridge:mypass)nl() |
| 587 | tt(susan:herpass)nl() |
| 588 | ) |
| 589 | |
| 590 | manpagefiles() |
| 591 | |
| 592 | /etc/rsyncd.conf or rsyncd.conf |
| 593 | |
| 594 | manpageseealso() |
| 595 | |
| 596 | bf(rsync)(1) |
| 597 | |
| 598 | manpagediagnostics() |
| 599 | |
| 600 | manpagebugs() |
| 601 | |
| 602 | Please report bugs! The rsync bug tracking system is online at |
| 603 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
| 604 | |
| 605 | manpagesection(VERSION) |
| 606 | |
| 607 | This man page is current for version 2.6.9pre3 of rsync. |
| 608 | |
| 609 | manpagesection(CREDITS) |
| 610 | |
| 611 | rsync is distributed under the GNU public license. See the file |
| 612 | COPYING for details. |
| 613 | |
| 614 | The primary ftp site for rsync is |
| 615 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). |
| 616 | |
| 617 | A WEB site is available at |
| 618 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
| 619 | |
| 620 | We would be delighted to hear from you if you like this program. |
| 621 | |
| 622 | This program uses the zlib compression library written by Jean-loup |
| 623 | Gailly and Mark Adler. |
| 624 | |
| 625 | manpagesection(THANKS) |
| 626 | |
| 627 | Thanks to Warren Stanley for his original idea and patch for the rsync |
| 628 | daemon. Thanks to Karsten Thygesen for his many suggestions and |
| 629 | documentation! |
| 630 | |
| 631 | manpageauthor() |
| 632 | |
| 633 | rsync was written by Andrew Tridgell and Paul Mackerras. |
| 634 | Many people have later contributed to it. |
| 635 | |
| 636 | Mailing lists for support and development are available at |
| 637 | url(http://lists.samba.org)(lists.samba.org) |