Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
618c8a73 | 2 | manpage(rsyncd.conf)(5)(30 Sep 2004)()() |
41059f75 AT |
3 | manpagename(rsyncd.conf)(configuration file for rsync server) |
4 | manpagesynopsis() | |
5 | ||
6 | rsyncd.conf | |
7 | ||
8 | manpagedescription() | |
9 | ||
10 | The rsyncd.conf file is the runtime configuration file for rsync when | |
04657e42 | 11 | run as an rsync server. |
41059f75 AT |
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 | ||
faa82484 | 22 | The file is line-based -- that is, each newline-terminated line represents |
41059f75 AT |
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 | ||
e22de162 | 34 | Any line ending in a \ is "continued" on the next line in the |
41059f75 AT |
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 | ||
5315b793 | 42 | manpagesection(LAUNCHING THE RSYNC DAEMON) |
41059f75 | 43 | |
faa82484 | 44 | The rsync daemon is launched by specifying the bf(--daemon) option to |
f5c20813 MP |
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. | |
41059f75 | 51 | |
04657e42 DD |
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 | |
faa82484 | 54 | just run the command "bf(rsync --daemon)" from a suitable startup script. |
04657e42 | 55 | If run from an rsync client via a remote shell (by specifying both the |
faa82484 | 56 | bf(--rsh) (bf(-e)) option and server mode with "::" or "rsync://"), the bf(--daemon) |
04657e42 | 57 | option is automatically passed to the remote side. |
41059f75 AT |
58 | |
59 | When run via inetd you should add a line like this to /etc/services: | |
60 | ||
faa82484 | 61 | verb( rsync 873/tcp) |
41059f75 | 62 | |
e22de162 | 63 | and a single line something like this to /etc/inetd.conf: |
41059f75 | 64 | |
faa82484 | 65 | verb( rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon) |
41059f75 | 66 | |
79f118d8 DD |
67 | Replace "/usr/bin/rsync" with the path to where you have rsync installed on |
68 | your system. You will then need to send inetd a HUP signal to tell it to | |
69 | reread its config file. | |
41059f75 AT |
70 | |
71 | Note that you should not send the rsync server a HUP signal to force | |
30e8c8e1 | 72 | it to reread the tt(rsyncd.conf) file. The file is re-read on each client |
41059f75 AT |
73 | connection. |
74 | ||
75 | manpagesection(GLOBAL OPTIONS) | |
76 | ||
77 | The first parameters in the file (before a [module] header) are the | |
78 | global parameters. | |
79 | ||
80 | You may also include any module parameters in the global part of the | |
81 | config file in which case the supplied value will override the | |
82 | default for that parameter. | |
83 | ||
84 | startdit() | |
85 | dit(bf(motd file)) The "motd file" option allows you to specify a | |
5315b793 | 86 | "message of the day" to display to clients on each connect. This |
41059f75 AT |
87 | usually contains site information and any legal notices. The default |
88 | is no motd file. | |
89 | ||
37863201 AT |
90 | dit(bf(log file)) The "log file" option tells the rsync daemon to log |
91 | messages to that file rather than using syslog. This is particularly | |
92 | useful on systems (such as AIX) where syslog() doesn't work for | |
8638dd48 DD |
93 | chrooted programs. |
94 | ||
95 | dit(bf(pid file)) The "pid file" option tells the rsync daemon to write | |
58811a0a | 96 | its process ID to that file. |
37863201 | 97 | |
41059f75 AT |
98 | dit(bf(syslog facility)) The "syslog facility" option allows you to |
99 | specify the syslog facility name to use when logging messages from the | |
100 | rsync server. You may use any standard syslog facility name which is | |
101 | defined on your system. Common names are auth, authpriv, cron, daemon, | |
102 | ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0, | |
103 | local1, local2, local3, local4, local5, local6 and local7. The default | |
104 | is daemon. | |
105 | ||
a6801c39 AT |
106 | dit(bf(socket options)) This option can provide endless fun for people |
107 | who like to tune their systems to the utmost degree. You can set all | |
108 | sorts of socket options which may make transfers faster (or | |
109 | slower!). Read the man page for the setsockopt() system call for | |
110 | details on some of the options you may be able to set. By default no | |
111 | special socket options are set. | |
112 | ||
41059f75 AT |
113 | enddit() |
114 | ||
115 | ||
116 | manpagesection(MODULE OPTIONS) | |
117 | ||
118 | After the global options you should define a number of modules, each | |
119 | module exports a directory tree as a symbolic name. Modules are | |
120 | exported by specifying a module name in square brackets [module] | |
121 | followed by the options for that module. | |
122 | ||
123 | startdit() | |
124 | ||
125 | dit(bf(comment)) The "comment" option specifies a description string | |
126 | that is displayed next to the module name when clients obtain a list | |
127 | of available modules. The default is no comment. | |
128 | ||
129 | dit(bf(path)) The "path" option specifies the directory in the servers | |
8638dd48 | 130 | filesystem to make available in this module. You must specify this option |
30e8c8e1 | 131 | for each module in tt(rsyncd.conf). |
8638dd48 DD |
132 | |
133 | dit(bf(use chroot)) If "use chroot" is true, the rsync server will chroot | |
134 | to the "path" before starting the file transfer with the client. This has | |
135 | the advantage of extra protection against possible implementation security | |
fca9a9b0 | 136 | holes, but it has the disadvantages of requiring super-user privileges, |
553f9375 WD |
137 | of not being able to follow symbolic links that are either absolute or outside |
138 | of the new root path, and of complicating the preservation of usernames and groups | |
cb290916 | 139 | (see below). When "use chroot" is false, for security reasons, |
fca9a9b0 | 140 | symlinks may only be relative paths pointing to other files within the root |
5dc6e9c9 | 141 | path, and leading slashes are removed from most absolute paths (options |
faa82484 | 142 | such as bf(--backup-dir), bf(--compare-dest), etc. interpret an absolute path as |
5dc6e9c9 WD |
143 | rooted in the module's "path" dir, just as if chroot was specified). |
144 | The default for "use chroot" is true. | |
41059f75 | 145 | |
cb290916 | 146 | In order to preserve usernames and groupnames, rsync needs to be able to |
d99b4ccf WD |
147 | use the standard library functions for looking up names and IDs (i.e. |
148 | getpwuid(), getgrgid(), getpwname(), and getgrnam()). This means a | |
149 | process in the chroot namespace will need to have access to the resources | |
150 | used by these library functions (traditionally /etc/passwd and | |
151 | /etc/group). If these resources are not available, rsync will only be | |
faa82484 | 152 | able to copy the IDs, just as if the bf(--numeric-ids) option had been |
d99b4ccf WD |
153 | specified. |
154 | ||
155 | Note that you are free to setup user/group information in the chroot area | |
156 | differently from your normal system. For example, you could abbreviate | |
553f9375 WD |
157 | the list of users and groups. Also, you can protect this information from |
158 | being downloaded/uploaded by adding an exclude rule to the rsync.conf file | |
159 | (e.g. "exclude = /etc/"). Note that having the exclusion affect uploads | |
160 | is a relatively new feature in rsync, so make sure your server is running | |
161 | at least 2.6.3 to effect this. | |
cb290916 | 162 | |
0c56b1ad WD |
163 | dit(bf(port)) You can override the default port the daemon will listen on |
164 | by specifying this value (defaults to 873). This is ignored if the daemon | |
faa82484 | 165 | is being run by inetd, and is superseded by the bf(--port) command-line option. |
0c56b1ad | 166 | |
696a8d61 WD |
167 | dit(bf(address)) You can override the default IP address the daemon |
168 | will listen on by specifying this value. This is ignored if the daemon is | |
faa82484 | 169 | being run by inetd, and is superseded by the bf(--address) command-line option. |
696a8d61 | 170 | |
5e71c444 | 171 | dit(bf(max connections)) The "max connections" option allows you to |
9ef1cc7c DD |
172 | specify the maximum number of simultaneous connections you will allow. |
173 | Any clients connecting when the maximum has been reached will receive a | |
174 | message telling them to try later. The default is 0 which means no limit. | |
175 | See also the "lock file" option. | |
5e71c444 | 176 | |
21611119 WD |
177 | dit(bf(max verbosity)) The "max verbosity" option allows you to control |
178 | the maximum amount of verbose information that you'll allow the daemon to | |
179 | generate (since the information goes into the log file). The default is 1, | |
180 | which allows the client to request one level of verbosity. | |
181 | ||
5e71c444 AT |
182 | dit(bf(lock file)) The "lock file" option specifies the file to use to |
183 | support the "max connections" option. The rsync server uses record | |
184 | locking on this file to ensure that the max connections limit is not | |
9ef1cc7c DD |
185 | exceeded for the modules sharing the lock file. |
186 | The default is tt(/var/run/rsyncd.lock). | |
5e71c444 | 187 | |
41059f75 AT |
188 | dit(bf(read only)) The "read only" option determines whether clients |
189 | will be able to upload files or not. If "read only" is true then any | |
190 | attempted uploads will fail. If "read only" is false then uploads will | |
191 | be possible if file permissions on the server allow them. The default | |
192 | is for all modules to be read only. | |
193 | ||
7a92ded3 WD |
194 | dit(bf(write only)) The "write only" option determines whether clients |
195 | will be able to download files or not. If "write only" is true then any | |
196 | attempted downloads will fail. If "write only" is false then downloads | |
197 | will be possible if file permissions on the server allow them. The | |
198 | default is for this option to be disabled. | |
199 | ||
41059f75 AT |
200 | dit(bf(list)) The "list" option determines if this module should be |
201 | listed when the client asks for a listing of available modules. By | |
202 | setting this to false you can create hidden modules. The default is | |
203 | for modules to be listable. | |
204 | ||
58811a0a | 205 | dit(bf(uid)) The "uid" option specifies the user name or user ID that |
716baed7 DD |
206 | file transfers to and from that module should take place as when the daemon |
207 | was run as root. In combination with the "gid" option this determines what | |
2af27ad9 MP |
208 | file permissions are available. The default is uid -2, which is normally |
209 | the user "nobody". | |
41059f75 | 210 | |
58811a0a | 211 | dit(bf(gid)) The "gid" option specifies the group name or group ID that |
716baed7 | 212 | file transfers to and from that module should take place as when the daemon |
2af27ad9 MP |
213 | was run as root. This complements the "uid" option. The default is gid -2, |
214 | which is normally the group "nobody". | |
41059f75 | 215 | |
dd69b397 WD |
216 | dit(bf(filter)) The "filter" option allows you to specify a space-separated |
217 | list of filter rules that the server will not allow to be read or written. | |
218 | This is only superficially equivalent to the client specifying these | |
faa82484 | 219 | patterns with the bf(--filter) option. Only one "filter" option may be |
dd69b397 WD |
220 | specified, but it may contain as many rules as you like, including |
221 | merge-file rules. Note that per-directory merge-file rules do not provide | |
faa82484 | 222 | as much protection as global rules, but they can be used to make bf(--delete) |
dd69b397 WD |
223 | work better when a client downloads the server's files (if the per-dir |
224 | merge files are included in the transfer). | |
225 | ||
553f9375 WD |
226 | dit(bf(exclude)) The "exclude" option allows you to specify a |
227 | space-separated list of patterns that the server will not allow to be read | |
228 | or written. This is only superficially equivalent to the client | |
faa82484 | 229 | specifying these patterns with the bf(--exclude) option. Only one "exclude" |
553f9375 WD |
230 | option may be specified, but you can use "-" and "+" before patterns to |
231 | specify exclude/include. | |
83fd337d S |
232 | |
233 | Because this exclude list is not passed to the client it only applies on | |
7c2d381c DD |
234 | the server: that is, it excludes files received by a client when receiving |
235 | from a server and files deleted on a server when sending to a server, but | |
553f9375 WD |
236 | it doesn't exclude files from being deleted on a client when receiving |
237 | from a server. | |
8f3a2d54 AT |
238 | |
239 | dit(bf(exclude from)) The "exclude from" option specifies a filename | |
83fd337d S |
240 | on the server that contains exclude patterns, one per line. |
241 | This is only superficially equivalent | |
faa82484 | 242 | to the client specifying the bf(--exclude-from) option with an equivalent file. |
83fd337d | 243 | See the "exclude" option above. |
8f3a2d54 | 244 | |
553f9375 WD |
245 | dit(bf(include)) The "include" option allows you to specify a |
246 | space-separated list of patterns which rsync should not exclude. This is | |
247 | only superficially equivalent to the client specifying these patterns with | |
faa82484 | 248 | the bf(--include) option because it applies only on the server. This is |
553f9375 WD |
249 | useful as it allows you to build up quite complex exclude/include rules. |
250 | Only one "include" option may be specified, but you can use "+" and "-" | |
251 | before patterns to switch include/exclude. See the "exclude" option | |
252 | above. | |
cd64343a DD |
253 | |
254 | dit(bf(include from)) The "include from" option specifies a filename | |
255 | on the server that contains include patterns, one per line. This is | |
83fd337d | 256 | only superficially equivalent to the client specifying the |
faa82484 | 257 | bf(--include-from) option with a equivalent file. |
83fd337d | 258 | See the "exclude" option above. |
cd64343a | 259 | |
5d78a102 | 260 | dit(bf(auth users)) The "auth users" option specifies a comma and |
553f9375 | 261 | space-separated list of usernames that will be allowed to connect to |
5d78a102 AT |
262 | this module. The usernames do not need to exist on the local |
263 | system. The usernames may also contain shell wildcard characters. If | |
264 | "auth users" is set then the client will be challenged to supply a | |
265 | username and password to connect to the module. A challenge response | |
266 | authentication protocol is used for this exchange. The plain text | |
267 | usernames are passwords are stored in the file specified by the | |
41059f75 AT |
268 | "secrets file" option. The default is for all users to be able to |
269 | connect without a password (this is called "anonymous rsync"). | |
270 | ||
bef49340 WD |
271 | See also the bf(CONNECTING TO AN RSYNC SERVER OVER A REMOTE SHELL |
272 | PROGRAM) section in rsync(1) for information on how handle an | |
273 | rsyncd.conf-level username that differs from the remote-shell-level | |
58811a0a | 274 | username when using a remote shell to connect to an rsync server. |
bef49340 | 275 | |
41059f75 AT |
276 | dit(bf(secrets file)) The "secrets file" option specifies the name of |
277 | a file that contains the username:password pairs used for | |
278 | authenticating this module. This file is only consulted if the "auth | |
279 | users" option is specified. The file is line based and contains | |
280 | username:password pairs separated by a single colon. Any line starting | |
281 | with a hash (#) is considered a comment and is skipped. The passwords | |
282 | can contain any characters but be warned that many operating systems | |
283 | limit the length of passwords that can be typed at the client end, so | |
284 | you may find that passwords longer than 8 characters don't work. | |
285 | ||
3ca8e68f | 286 | There is no default for the "secrets file" option, you must choose a name |
205c27ac DD |
287 | (such as tt(/etc/rsyncd.secrets)). The file must normally not be readable |
288 | by "other"; see "strict modes". | |
3ca8e68f DD |
289 | |
290 | dit(bf(strict modes)) The "strict modes" option determines whether or not | |
291 | the permissions on the secrets file will be checked. If "strict modes" is | |
58811a0a | 292 | true, then the secrets file must not be readable by any user ID other |
3ca8e68f DD |
293 | than the one that the rsync daemon is running under. If "strict modes" is |
294 | false, the check is not performed. The default is true. This option | |
295 | was added to accommodate rsync running on the Windows operating system. | |
41059f75 AT |
296 | |
297 | dit(bf(hosts allow)) The "hosts allow" option allows you to specify a | |
298 | list of patterns that are matched against a connecting clients | |
299 | hostname and IP address. If none of the patterns match then the | |
300 | connection is rejected. | |
301 | ||
302 | Each pattern can be in one of five forms: | |
303 | ||
faa82484 | 304 | quote(itemize( |
61ca7d59 DD |
305 | it() a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address |
306 | of the form a:b:c::d:e:f. In this case the incoming machine's IP address | |
bc2b4963 | 307 | must match exactly. |
61ca7d59 DD |
308 | it() an address/mask in the form ipaddr/n where ipaddr is the IP address |
309 | and n is the number of one bits in the netmask. All IP addresses which | |
310 | match the masked IP address will be allowed in. | |
61ca7d59 DD |
311 | it() an address/mask in the form ipaddr/maskaddr where ipaddr is the |
312 | IP address and maskaddr is the netmask in dotted decimal notation for IPv4, | |
313 | or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP | |
314 | addresses which match the masked IP address will be allowed in. | |
41059f75 | 315 | it() a hostname. The hostname as determined by a reverse lookup will |
5315b793 | 316 | be matched (case insensitive) against the pattern. Only an exact |
41059f75 | 317 | match is allowed in. |
41059f75 AT |
318 | it() a hostname pattern using wildcards. These are matched using the |
319 | same rules as normal unix filename matching. If the pattern matches | |
5315b793 | 320 | then the client is allowed in. |
faa82484 | 321 | )) |
41059f75 | 322 | |
61ca7d59 DD |
323 | Note IPv6 link-local addresses can have a scope in the address specification: |
324 | ||
faa82484 WD |
325 | quote( |
326 | tt( fe80::1%link1)nl() | |
327 | tt( fe80::%link1/64)nl() | |
328 | tt( fe80::%link1/ffff:ffff:ffff:ffff::)nl() | |
329 | ) | |
61ca7d59 | 330 | |
41059f75 AT |
331 | You can also combine "hosts allow" with a separate "hosts deny" |
332 | option. If both options are specified then the "hosts allow" option s | |
5315b793 | 333 | checked first and a match results in the client being able to |
41059f75 AT |
334 | connect. The "hosts deny" option is then checked and a match means |
335 | that the host is rejected. If the host does not match either the | |
336 | "hosts allow" or the "hosts deny" patterns then it is allowed to | |
337 | connect. | |
338 | ||
339 | The default is no "hosts allow" option, which means all hosts can connect. | |
340 | ||
de2fd20e | 341 | dit(bf(hosts deny)) The "hosts deny" option allows you to specify a |
41059f75 AT |
342 | list of patterns that are matched against a connecting clients |
343 | hostname and IP address. If the pattern matches then the connection is | |
344 | rejected. See the "hosts allow" option for more information. | |
345 | ||
346 | The default is no "hosts deny" option, which means all hosts can connect. | |
347 | ||
cda2ae84 | 348 | dit(bf(ignore errors)) The "ignore errors" option tells rsyncd to |
58811a0a | 349 | ignore I/O errors on the server when deciding whether to run the delete |
faa82484 | 350 | phase of the transfer. Normally rsync skips the bf(--delete) step if any |
ae283632 | 351 | I/O errors have occurred in order to prevent disastrous deletion due |
58811a0a | 352 | to a temporary resource shortage or other I/O error. In some cases this |
cda2ae84 | 353 | test is counter productive so you can use this option to turn off this |
ae283632 | 354 | behavior. |
cda2ae84 | 355 | |
78043d19 AT |
356 | dit(bf(ignore nonreadable)) This tells the rsync server to completely |
357 | ignore files that are not readable by the user. This is useful for | |
358 | public archives that may have some non-readable files among the | |
359 | directories, and the sysadmin doesn't want those files to be seen at all. | |
360 | ||
81791cfc AT |
361 | dit(bf(transfer logging)) The "transfer logging" option enables per-file |
362 | logging of downloads and uploads in a format somewhat similar to that | |
3b2bebbf WD |
363 | used by ftp daemons. The server always logs the transfer at the end, so |
364 | if a transfer is aborted, no mention will be made in the log file. | |
365 | ||
366 | If you want to customize the log lines, see the "log format" option. | |
81791cfc AT |
367 | |
368 | dit(bf(log format)) The "log format" option allows you to specify the | |
369 | format used for logging file transfers when transfer logging is | |
370 | enabled. The format is a text string containing embedded single | |
371 | character escape sequences prefixed with a percent (%) character. | |
372 | ||
373 | The prefixes that are understood are: | |
374 | ||
faa82484 | 375 | quote(itemize( |
81791cfc AT |
376 | it() %h for the remote host name |
377 | it() %a for the remote IP address | |
378 | it() %l for the length of the file in bytes | |
58811a0a | 379 | it() %p for the process ID of this rsync session |
a85a1514 | 380 | it() %o for the operation, which is "send", "recv", or "del." |
3c54d8a3 | 381 | it() %f for the filename (long form on sender; no trailing "/") |
3b2bebbf | 382 | it() %n for the filename (short form; trailing "/" on dir) |
527a010f | 383 | it() %L either the string " -> SYMLINK" or "" if not a symlink |
81791cfc AT |
384 | it() %P for the module path |
385 | it() %m for the module name | |
b882b497 | 386 | it() %t for the current date time |
81791cfc AT |
387 | it() %u for the authenticated username (or the null string) |
388 | it() %b for the number of bytes actually transferred | |
389 | it() %c when sending files this gives the number of checksum bytes | |
390 | received for this file | |
527a010f | 391 | it() %i an itemized list of what is being updated |
faa82484 | 392 | )) |
81791cfc | 393 | |
3c54d8a3 | 394 | The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] " |
15954da0 | 395 | is always prefixed when using the "log file" option. |
81791cfc | 396 | |
14d43f1f | 397 | A perl script called rsyncstats to summarize this format is included |
3b2bebbf | 398 | in the rsync source code distribution in the "support" subdirectory. |
81791cfc | 399 | |
527a010f WD |
400 | The %i format is a set of cryptic characters that are output as follows: |
401 | ||
a85a1514 | 402 | quote(tt( =Xcstpog ITEM_NAME)) |
527a010f | 403 | |
a85a1514 WD |
404 | The bf(=) is output as either a bf(<) (receive) or a bf(>) (send) if the |
405 | item is being transferred, a bf(.) if only the attributes are being | |
406 | updated, or a bf(=) if the items are identical. Note that when a symlink | |
407 | or a device gets its value changed, that is considered to be a transfer (as | |
408 | opposed to a change in permissions or ownership). | |
15954da0 WD |
409 | |
410 | The bf(X) will be replaced by one of the following: an "f" for a file, a | |
411 | "d" for a dir, an "L" for a symlink, or a "D" for a device. | |
412 | ||
413 | The rest of the letters in the string above are the actual letters that | |
a85a1514 WD |
414 | will be output if the associated attribute for the item is being updated or |
415 | a "." for no change. Three exceptions to this are: (1) a newly created | |
416 | item replaces each letter with a "+", (2) an identical item replaces each | |
417 | letter with a space, and (3) an unknown attribute replaces each letter with | |
418 | a "?" (this happens when talking to an older rsync). | |
419 | ||
420 | The attribute that is associated with each letter is as follows: | |
527a010f WD |
421 | |
422 | quote(itemize( | |
423 | it() A bf(c) means the checksum of the file is different and will be | |
424 | updated by the file transfer (requries bf(--checksum)). | |
425 | it() A bf(s) means the size of the file is different and will be updated | |
426 | by the file transfer. | |
3b2bebbf WD |
427 | it() A bf(t) means the modified time is different and is being updated to |
428 | the server's value (requires bf(--times)). An alternate value of bf(T) | |
429 | means that the time will be set to the transfer time, which happens | |
430 | anytime a symlink is transferred, or when a file or device is transferred | |
431 | without bf(--times). | |
432 | it() A bf(p) means the permissions are different and are being updated to | |
433 | the server's value (requires bf(--perms)). | |
527a010f WD |
434 | it() An bf(o) means the owner is being updated (requires bf(--owner) and |
435 | root privileges). | |
3b2bebbf WD |
436 | it() A bf(g) means the group is being updated (requires bf(--group) and |
437 | the authority to set the requested group). | |
527a010f WD |
438 | )) |
439 | ||
a85a1514 WD |
440 | One other output is possible: when deleting files, each deleted file will |
441 | be logged with the "%i" taking on a value of "deleting". | |
442 | ||
81791cfc | 443 | dit(bf(timeout)) The "timeout" option allows you to override the |
58811a0a | 444 | clients choice for I/O timeout for this module. Using this option you |
81791cfc AT |
445 | can ensure that rsync won't wait on a dead client forever. The timeout |
446 | is specified in seconds. A value of zero means no timeout and is the | |
447 | default. A good choice for anonymous rsync servers may be 600 (giving | |
448 | a 10 minute timeout). | |
449 | ||
cd8185f2 | 450 | dit(bf(refuse options)) The "refuse options" option allows you to |
553f9375 | 451 | specify a space-separated list of rsync command line options that will |
1cb0a3ed WD |
452 | be refused by your rsync server. |
453 | You may specify the full option name, its one-letter abbreviation, or a | |
454 | wild-card string that matches multiple options. | |
9eef8f0b WD |
455 | For example, this would refuse bf(--checksum) (bf(-c)) and all the various |
456 | delete options: | |
1cb0a3ed | 457 | |
9eef8f0b WD |
458 | quote(tt( refuse options = c delete)) |
459 | ||
460 | The reason the above refuses all delete options is that the options imply | |
461 | bf(--delete), and implied options are refused just like explicit options. | |
e1636830 WD |
462 | As an additional safety feature, the refusal of "delete" also refuses |
463 | bf(remove-sent-files) when the daemon is the sender; if you want the latter | |
464 | without the former, instead refuse "delete-*" -- that refuses all the | |
465 | delete modes without affecting bf(--remove-sent-files). | |
1cb0a3ed | 466 | |
63f0774f DD |
467 | When an option is refused, the server prints an error message and exits. |
468 | To prevent all compression, you can use "dont compress = *" (see below) | |
469 | instead of "refuse options = compress" to avoid returning an error to a | |
470 | client that requests compression. | |
cd8185f2 | 471 | |
83fff1aa AT |
472 | dit(bf(dont compress)) The "dont compress" option allows you to select |
473 | filenames based on wildcard patterns that should not be compressed | |
474 | during transfer. Compression is expensive in terms of CPU usage so it | |
475 | is usually good to not try to compress files that won't compress well, | |
476 | such as already compressed files. | |
477 | ||
553f9375 | 478 | The "dont compress" option takes a space-separated list of |
83fff1aa AT |
479 | case-insensitive wildcard patterns. Any source filename matching one |
480 | of the patterns will not be compressed during transfer. | |
481 | ||
faa82484 | 482 | The default setting is tt(*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz) |
83fff1aa | 483 | |
41059f75 AT |
484 | enddit() |
485 | ||
4c3d16be AT |
486 | manpagesection(AUTHENTICATION STRENGTH) |
487 | ||
488 | The authentication protocol used in rsync is a 128 bit MD4 based | |
489 | challenge response system. Although I believe that no one has ever | |
490 | demonstrated a brute-force break of this sort of system you should | |
14d43f1f | 491 | realize that this is not a "military strength" authentication system. |
4c3d16be AT |
492 | It should be good enough for most purposes but if you want really top |
493 | quality security then I recommend that you run rsync over ssh. | |
494 | ||
495 | Also note that the rsync server protocol does not currently provide any | |
f39281ae | 496 | encryption of the data that is transferred over the connection. Only |
4c3d16be AT |
497 | authentication is provided. Use ssh as the transport if you want |
498 | encryption. | |
499 | ||
500 | Future versions of rsync may support SSL for better authentication and | |
501 | encryption, but that is still being investigated. | |
502 | ||
e6f9e388 WD |
503 | manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) |
504 | ||
faa82484 | 505 | If rsync is run with both the bf(--daemon) and bf(--rsh) (bf(-e)) options, it will |
e6f9e388 WD |
506 | spawn an rsync daemon using a remote shell connection. Several |
507 | configuration options will not be available unless the remote user is | |
508 | root (e.g. chroot, setuid/setgid, etc.). There is no need to configure | |
509 | inetd or the services map to include the rsync server port if you run an | |
510 | rsync server only via a remote shell program. | |
511 | ||
512 | ADVANCED: To run an rsync server out of a single-use ssh key, use the | |
513 | "command=em(COMMAND)" syntax in the remote user's authorized_keys entry, | |
514 | where command would be | |
515 | ||
faa82484 | 516 | quote(tt(rsync --server --daemon .)) |
e6f9e388 WD |
517 | |
518 | NOTE: rsync's argument parsing expects the trailing ".", so make sure | |
58811a0a | 519 | that it's there. If you want to use an rsyncd.conf(5)-style |
e6f9e388 | 520 | configuration file other than the default, you can added a |
faa82484 | 521 | bf(--config) option to the em(command): |
e6f9e388 | 522 | |
faa82484 | 523 | quote(tt(rsync --server --daemon --config=em(file) .)) |
e6f9e388 WD |
524 | |
525 | Note that the "--server" here is the internal option that rsync uses to | |
526 | run the remote version of rsync that it communicates with, and thus you | |
faa82484 | 527 | should not be using the bf(--server) option under normal circumstances. |
e6f9e388 | 528 | |
41059f75 AT |
529 | manpagesection(EXAMPLES) |
530 | ||
531 | A simple rsyncd.conf file that allow anonymous rsync to a ftp area at | |
e22de162 | 532 | tt(/home/ftp) would be: |
41059f75 AT |
533 | |
534 | verb( | |
535 | [ftp] | |
e22de162 AT |
536 | path = /home/ftp |
537 | comment = ftp export area | |
41059f75 AT |
538 | ) |
539 | ||
41059f75 AT |
540 | A more sophisticated example would be: |
541 | ||
faa82484 WD |
542 | verb( |
543 | uid = nobody | |
544 | gid = nobody | |
545 | use chroot = no | |
546 | max connections = 4 | |
547 | syslog facility = local5 | |
0f621785 | 548 | pid file = /var/run/rsyncd.pid |
41059f75 | 549 | |
faa82484 | 550 | [ftp] |
41059f75 AT |
551 | path = /var/ftp/pub |
552 | comment = whole ftp area (approx 6.1 GB) | |
553 | ||
554 | [sambaftp] | |
555 | path = /var/ftp/pub/samba | |
556 | comment = Samba ftp area (approx 300 MB) | |
557 | ||
558 | [rsyncftp] | |
559 | path = /var/ftp/pub/rsync | |
560 | comment = rsync ftp area (approx 6 MB) | |
561 | ||
562 | [sambawww] | |
563 | path = /public_html/samba | |
564 | comment = Samba WWW pages (approx 240 MB) | |
565 | ||
566 | [cvs] | |
567 | path = /data/cvs | |
568 | comment = CVS repository (requires authentication) | |
569 | auth users = tridge, susan | |
570 | secrets file = /etc/rsyncd.secrets | |
571 | ) | |
572 | ||
573 | The /etc/rsyncd.secrets file would look something like this: | |
574 | ||
faa82484 WD |
575 | quote( |
576 | tt(tridge:mypass)nl() | |
577 | tt(susan:herpass)nl() | |
578 | ) | |
41059f75 AT |
579 | |
580 | manpagefiles() | |
581 | ||
30e8c8e1 | 582 | /etc/rsyncd.conf or rsyncd.conf |
41059f75 AT |
583 | |
584 | manpageseealso() | |
585 | ||
586 | rsync(1) | |
587 | ||
588 | manpagediagnostics() | |
589 | ||
590 | manpagebugs() | |
591 | ||
592 | The rsync server does not send all types of error messages to the | |
593 | client. this means a client may be mystified as to why a transfer | |
594 | failed. The error will have been logged by syslog on the server. | |
595 | ||
596 | Please report bugs! The rsync bug tracking system is online at | |
9e3c856a | 597 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
41059f75 AT |
598 | |
599 | manpagesection(VERSION) | |
c53217a2 | 600 | This man page is current for version 2.x of rsync. |
41059f75 AT |
601 | |
602 | manpagesection(CREDITS) | |
603 | ||
604 | rsync is distributed under the GNU public license. See the file | |
605 | COPYING for details. | |
606 | ||
607 | The primary ftp site for rsync is | |
9e3c856a | 608 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). |
41059f75 AT |
609 | |
610 | A WEB site is available at | |
9e3c856a | 611 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
41059f75 AT |
612 | |
613 | We would be delighted to hear from you if you like this program. | |
614 | ||
615 | This program uses the zlib compression library written by Jean-loup | |
616 | Gailly and Mark Adler. | |
617 | ||
618 | manpagesection(THANKS) | |
619 | ||
620 | Thanks to Warren Stanley for his original idea and patch for the rsync | |
621 | server. Thanks to Karsten Thygesen for his many suggestions and | |
622 | documentation! | |
623 | ||
624 | manpageauthor() | |
625 | ||
ae283632 WD |
626 | rsync was written by Andrew Tridgell and Paul Mackerras. |
627 | Many people have later contributed to it. | |
41059f75 | 628 | |
ae283632 WD |
629 | Mailing lists for support and development are available at |
630 | url(http://lists.samba.org)(lists.samba.org) |