Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
0c6d7952 | 2 | manpage(rsyncd.conf)(5)(6 Nov 2006)()() |
d90338ce | 3 | manpagename(rsyncd.conf)(configuration file for rsync in daemon mode) |
41059f75 AT |
4 | manpagesynopsis() |
5 | ||
6 | rsyncd.conf | |
7 | ||
8 | manpagedescription() | |
9 | ||
10 | The rsyncd.conf file is the runtime configuration file for rsync when | |
f97c2d4a | 11 | run as an rsync daemon. |
41059f75 AT |
12 | |
13 | The rsyncd.conf file controls authentication, access, logging and | |
14 | available modules. | |
15 | ||
16 | manpagesection(FILE FORMAT) | |
17 | ||
f97c2d4a | 18 | The file consists of modules and parameters. A module begins with the |
41059f75 | 19 | name of the module in square brackets and continues until the next |
0abe148f | 20 | module begins. Modules contain parameters of the form "name = value". |
41059f75 | 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 | ||
f97c2d4a | 25 | Only the first equals sign in a parameter is significant. Whitespace before |
41059f75 AT |
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 | ||
f97c2d4a | 31 | Any line beginning with a hash (#) is ignored, as are lines containing |
41059f75 AT |
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 | |
f97c2d4a | 40 | in string values. |
41059f75 | 41 | |
5315b793 | 42 | manpagesection(LAUNCHING THE RSYNC DAEMON) |
41059f75 | 43 | |
faa82484 | 44 | The rsync daemon is launched by specifying the bf(--daemon) option to |
f97c2d4a | 45 | rsync. |
f5c20813 MP |
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. |
41059f75 AT |
55 | |
56 | When run via inetd you should add a line like this to /etc/services: | |
57 | ||
faa82484 | 58 | verb( rsync 873/tcp) |
41059f75 | 59 | |
e22de162 | 60 | and a single line something like this to /etc/inetd.conf: |
f97c2d4a | 61 | |
faa82484 | 62 | verb( rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon) |
41059f75 | 63 | |
79f118d8 DD |
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. | |
41059f75 | 67 | |
d90338ce | 68 | Note that you should bf(not) send the rsync daemon a HUP signal to force |
30e8c8e1 | 69 | it to reread the tt(rsyncd.conf) file. The file is re-read on each client |
f97c2d4a | 70 | connection. |
41059f75 AT |
71 | |
72 | manpagesection(GLOBAL OPTIONS) | |
73 | ||
74 | The first parameters in the file (before a [module] header) are the | |
f97c2d4a | 75 | global parameters. |
41059f75 AT |
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 | |
5315b793 | 83 | "message of the day" to display to clients on each connect. This |
41059f75 AT |
84 | usually contains site information and any legal notices. The default |
85 | is no motd file. | |
86 | ||
8638dd48 | 87 | dit(bf(pid file)) The "pid file" option tells the rsync daemon to write |
58811a0a | 88 | its process ID to that file. |
37863201 | 89 | |
f7112154 WD |
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 | ||
a6801c39 AT |
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 | |
19826af5 | 101 | slower!). Read the man page for the code(setsockopt()) system call for |
a6801c39 | 102 | details on some of the options you may be able to set. By default no |
5fe3c86f WD |
103 | special socket options are set. These settings are superseded by the |
104 | bf(--sockopts) command-line option. | |
a6801c39 | 105 | |
41059f75 AT |
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 | ||
d90338ce | 122 | dit(bf(path)) The "path" option specifies the directory in the daemon's |
8638dd48 | 123 | filesystem to make available in this module. You must specify this option |
30e8c8e1 | 124 | for each module in tt(rsyncd.conf). |
8638dd48 | 125 | |
d90338ce | 126 | dit(bf(use chroot)) If "use chroot" is true, the rsync daemon will chroot |
8638dd48 DD |
127 | to the "path" before starting the file transfer with the client. This has |
128 | the advantage of extra protection against possible implementation security | |
f97c2d4a | 129 | holes, but it has the disadvantages of requiring super-user privileges, |
1a7f3d99 WD |
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). | |
5dc6e9c9 | 137 | The default for "use chroot" is true. |
41059f75 | 138 | |
cb290916 | 139 | In order to preserve usernames and groupnames, rsync needs to be able to |
d99b4ccf | 140 | use the standard library functions for looking up names and IDs (i.e. |
19826af5 | 141 | code(getpwuid()), code(getgrgid()), code(getpwname()), and code(getgrnam())). This means a |
d99b4ccf WD |
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 | |
faa82484 | 145 | able to copy the IDs, just as if the bf(--numeric-ids) option had been |
d99b4ccf WD |
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 | |
553f9375 | 150 | the list of users and groups. Also, you can protect this information from |
d802ea54 | 151 | being downloaded/uploaded by adding an exclude rule to the rsyncd.conf file |
0abe148f | 152 | (e.g. "bf(exclude = /etc/**)"). Note that having the exclusion affect uploads |
d90338ce | 153 | is a relatively new feature in rsync, so make sure your daemon is |
78bcddcc WD |
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). | |
cb290916 | 160 | |
5e71c444 | 161 | dit(bf(max connections)) The "max connections" option allows you to |
9ef1cc7c DD |
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. | |
5e71c444 | 166 | |
ccd2966d WD |
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 | ||
21611119 WD |
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 | ||
5e71c444 | 195 | dit(bf(lock file)) The "lock file" option specifies the file to use to |
d90338ce | 196 | support the "max connections" option. The rsync daemon uses record |
5e71c444 | 197 | locking on this file to ensure that the max connections limit is not |
f97c2d4a | 198 | exceeded for the modules sharing the lock file. |
9ef1cc7c | 199 | The default is tt(/var/run/rsyncd.lock). |
5e71c444 | 200 | |
41059f75 AT |
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 | |
d90338ce | 204 | be possible if file permissions on the daemon side allow them. The default |
41059f75 AT |
205 | is for all modules to be read only. |
206 | ||
7a92ded3 WD |
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 | |
d90338ce | 210 | will be possible if file permissions on the daemon side allow them. The |
7a92ded3 WD |
211 | default is for this option to be disabled. |
212 | ||
41059f75 AT |
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 | ||
58811a0a | 218 | dit(bf(uid)) The "uid" option specifies the user name or user ID that |
716baed7 DD |
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 | |
2af27ad9 MP |
221 | file permissions are available. The default is uid -2, which is normally |
222 | the user "nobody". | |
41059f75 | 223 | |
58811a0a | 224 | dit(bf(gid)) The "gid" option specifies the group name or group ID that |
716baed7 | 225 | file transfers to and from that module should take place as when the daemon |
2af27ad9 MP |
226 | was run as root. This complements the "uid" option. The default is gid -2, |
227 | which is normally the group "nobody". | |
41059f75 | 228 | |
9439c0cb WD |
229 | dit(bf(fake super)) Setting "fake super = yes" for a module causes the |
230 | daemon side to behave as if the bf(--fake-user) command-line option had | |
231 | been specified. This allows the full attributes of a file to be stored | |
232 | without having to have the daemon actually running as root. | |
233 | ||
dd69b397 | 234 | dit(bf(filter)) The "filter" option allows you to specify a space-separated |
d90338ce | 235 | list of filter rules that the daemon will not allow to be read or written. |
dd69b397 | 236 | This is only superficially equivalent to the client specifying these |
faa82484 | 237 | patterns with the bf(--filter) option. Only one "filter" option may be |
dd69b397 WD |
238 | specified, but it may contain as many rules as you like, including |
239 | merge-file rules. Note that per-directory merge-file rules do not provide | |
faa82484 | 240 | as much protection as global rules, but they can be used to make bf(--delete) |
d90338ce | 241 | work better when a client downloads the daemon's files (if the per-dir |
dd69b397 WD |
242 | merge files are included in the transfer). |
243 | ||
553f9375 | 244 | dit(bf(exclude)) The "exclude" option allows you to specify a |
d90338ce | 245 | space-separated list of patterns that the daemon will not allow to be read |
553f9375 | 246 | or written. This is only superficially equivalent to the client |
faa82484 | 247 | specifying these patterns with the bf(--exclude) option. Only one "exclude" |
553f9375 WD |
248 | option may be specified, but you can use "-" and "+" before patterns to |
249 | specify exclude/include. | |
83fd337d S |
250 | |
251 | Because this exclude list is not passed to the client it only applies on | |
d90338ce WD |
252 | the daemon: that is, it excludes files received by a client when receiving |
253 | from a daemon and files deleted on a daemon when sending to a daemon, but | |
553f9375 | 254 | it doesn't exclude files from being deleted on a client when receiving |
f97c2d4a | 255 | from a daemon. |
8f3a2d54 AT |
256 | |
257 | dit(bf(exclude from)) The "exclude from" option specifies a filename | |
d90338ce | 258 | on the daemon that contains exclude patterns, one per line. |
83fd337d | 259 | This is only superficially equivalent |
faa82484 | 260 | to the client specifying the bf(--exclude-from) option with an equivalent file. |
83fd337d | 261 | See the "exclude" option above. |
8f3a2d54 | 262 | |
553f9375 WD |
263 | dit(bf(include)) The "include" option allows you to specify a |
264 | space-separated list of patterns which rsync should not exclude. This is | |
265 | only superficially equivalent to the client specifying these patterns with | |
d90338ce | 266 | the bf(--include) option because it applies only on the daemon. This is |
553f9375 WD |
267 | useful as it allows you to build up quite complex exclude/include rules. |
268 | Only one "include" option may be specified, but you can use "+" and "-" | |
269 | before patterns to switch include/exclude. See the "exclude" option | |
270 | above. | |
cd64343a DD |
271 | |
272 | dit(bf(include from)) The "include from" option specifies a filename | |
d90338ce | 273 | on the daemon that contains include patterns, one per line. This is |
83fd337d | 274 | only superficially equivalent to the client specifying the |
faa82484 | 275 | bf(--include-from) option with a equivalent file. |
83fd337d | 276 | See the "exclude" option above. |
cd64343a | 277 | |
c094d932 WD |
278 | dit(bf(incoming chmod)) This option allows you to specify a set of |
279 | comma-separated chmod strings that will affect the permissions of all | |
280 | incoming files (files that are being received by the daemon). These | |
44a8e86d WD |
281 | changes happen after all other permission calculations, and this will |
282 | even override destination-default and/or existing permissions when the | |
283 | client does not specify bf(--perms). | |
fa3e4a05 WD |
284 | See the description of the bf(--chmod) rsync option and the bf(chmod)(1) |
285 | manpage for information on the format of this string. | |
c094d932 WD |
286 | |
287 | dit(bf(outgoing chmod)) This option allows you to specify a set of | |
288 | comma-separated chmod strings that will affect the permissions of all | |
289 | outgoing files (files that are being sent out from the daemon). These | |
290 | changes happen first, making the sent permissions appear to be different | |
2243a935 WD |
291 | than those stored in the filesystem itself. For instance, you could |
292 | disable group write permissions on the server while having it appear to | |
293 | be on to the clients. | |
fa3e4a05 WD |
294 | See the description of the bf(--chmod) rsync option and the bf(chmod)(1) |
295 | manpage for information on the format of this string. | |
17af842d | 296 | |
5d78a102 | 297 | dit(bf(auth users)) The "auth users" option specifies a comma and |
553f9375 | 298 | space-separated list of usernames that will be allowed to connect to |
5d78a102 AT |
299 | this module. The usernames do not need to exist on the local |
300 | system. The usernames may also contain shell wildcard characters. If | |
301 | "auth users" is set then the client will be challenged to supply a | |
302 | username and password to connect to the module. A challenge response | |
303 | authentication protocol is used for this exchange. The plain text | |
9aacb4df | 304 | usernames and passwords are stored in the file specified by the |
41059f75 AT |
305 | "secrets file" option. The default is for all users to be able to |
306 | connect without a password (this is called "anonymous rsync"). | |
307 | ||
d90338ce | 308 | See also the "CONNECTING TO AN RSYNC DAEMON OVER A REMOTE SHELL |
19826af5 | 309 | PROGRAM" section in bf(rsync)(1) for information on how handle an |
bef49340 | 310 | rsyncd.conf-level username that differs from the remote-shell-level |
d90338ce | 311 | username when using a remote shell to connect to an rsync daemon. |
bef49340 | 312 | |
41059f75 AT |
313 | dit(bf(secrets file)) The "secrets file" option specifies the name of |
314 | a file that contains the username:password pairs used for | |
315 | authenticating this module. This file is only consulted if the "auth | |
316 | users" option is specified. The file is line based and contains | |
317 | username:password pairs separated by a single colon. Any line starting | |
318 | with a hash (#) is considered a comment and is skipped. The passwords | |
319 | can contain any characters but be warned that many operating systems | |
320 | limit the length of passwords that can be typed at the client end, so | |
f97c2d4a | 321 | you may find that passwords longer than 8 characters don't work. |
41059f75 | 322 | |
3ca8e68f | 323 | There is no default for the "secrets file" option, you must choose a name |
205c27ac DD |
324 | (such as tt(/etc/rsyncd.secrets)). The file must normally not be readable |
325 | by "other"; see "strict modes". | |
3ca8e68f | 326 | |
f97c2d4a | 327 | dit(bf(strict modes)) The "strict modes" option determines whether or not |
3ca8e68f | 328 | the permissions on the secrets file will be checked. If "strict modes" is |
58811a0a | 329 | true, then the secrets file must not be readable by any user ID other |
3ca8e68f DD |
330 | than the one that the rsync daemon is running under. If "strict modes" is |
331 | false, the check is not performed. The default is true. This option | |
332 | was added to accommodate rsync running on the Windows operating system. | |
41059f75 AT |
333 | |
334 | dit(bf(hosts allow)) The "hosts allow" option allows you to specify a | |
335 | list of patterns that are matched against a connecting clients | |
336 | hostname and IP address. If none of the patterns match then the | |
337 | connection is rejected. | |
338 | ||
339 | Each pattern can be in one of five forms: | |
340 | ||
b8a6dae0 | 341 | quote(itemization( |
61ca7d59 DD |
342 | it() a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address |
343 | of the form a:b:c::d:e:f. In this case the incoming machine's IP address | |
bc2b4963 | 344 | must match exactly. |
61ca7d59 DD |
345 | it() an address/mask in the form ipaddr/n where ipaddr is the IP address |
346 | and n is the number of one bits in the netmask. All IP addresses which | |
347 | match the masked IP address will be allowed in. | |
61ca7d59 DD |
348 | it() an address/mask in the form ipaddr/maskaddr where ipaddr is the |
349 | IP address and maskaddr is the netmask in dotted decimal notation for IPv4, | |
350 | or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP | |
351 | addresses which match the masked IP address will be allowed in. | |
41059f75 | 352 | it() a hostname. The hostname as determined by a reverse lookup will |
5315b793 | 353 | be matched (case insensitive) against the pattern. Only an exact |
41059f75 | 354 | match is allowed in. |
41059f75 AT |
355 | it() a hostname pattern using wildcards. These are matched using the |
356 | same rules as normal unix filename matching. If the pattern matches | |
5315b793 | 357 | then the client is allowed in. |
faa82484 | 358 | )) |
41059f75 | 359 | |
61ca7d59 DD |
360 | Note IPv6 link-local addresses can have a scope in the address specification: |
361 | ||
faa82484 WD |
362 | quote( |
363 | tt( fe80::1%link1)nl() | |
364 | tt( fe80::%link1/64)nl() | |
365 | tt( fe80::%link1/ffff:ffff:ffff:ffff::)nl() | |
366 | ) | |
61ca7d59 | 367 | |
41059f75 AT |
368 | You can also combine "hosts allow" with a separate "hosts deny" |
369 | option. If both options are specified then the "hosts allow" option s | |
5315b793 | 370 | checked first and a match results in the client being able to |
41059f75 | 371 | connect. The "hosts deny" option is then checked and a match means |
f97c2d4a | 372 | that the host is rejected. If the host does not match either the |
41059f75 AT |
373 | "hosts allow" or the "hosts deny" patterns then it is allowed to |
374 | connect. | |
375 | ||
376 | The default is no "hosts allow" option, which means all hosts can connect. | |
377 | ||
de2fd20e | 378 | dit(bf(hosts deny)) The "hosts deny" option allows you to specify a |
41059f75 AT |
379 | list of patterns that are matched against a connecting clients |
380 | hostname and IP address. If the pattern matches then the connection is | |
381 | rejected. See the "hosts allow" option for more information. | |
382 | ||
383 | The default is no "hosts deny" option, which means all hosts can connect. | |
384 | ||
cda2ae84 | 385 | dit(bf(ignore errors)) The "ignore errors" option tells rsyncd to |
d90338ce | 386 | ignore I/O errors on the daemon when deciding whether to run the delete |
faa82484 | 387 | phase of the transfer. Normally rsync skips the bf(--delete) step if any |
ae283632 | 388 | I/O errors have occurred in order to prevent disastrous deletion due |
58811a0a | 389 | to a temporary resource shortage or other I/O error. In some cases this |
cda2ae84 | 390 | test is counter productive so you can use this option to turn off this |
f97c2d4a | 391 | behavior. |
cda2ae84 | 392 | |
d90338ce | 393 | dit(bf(ignore nonreadable)) This tells the rsync daemon to completely |
78043d19 AT |
394 | ignore files that are not readable by the user. This is useful for |
395 | public archives that may have some non-readable files among the | |
396 | directories, and the sysadmin doesn't want those files to be seen at all. | |
397 | ||
f97c2d4a | 398 | dit(bf(transfer logging)) The "transfer logging" option enables per-file |
81791cfc | 399 | logging of downloads and uploads in a format somewhat similar to that |
d90338ce | 400 | used by ftp daemons. The daemon always logs the transfer at the end, so |
3b2bebbf WD |
401 | if a transfer is aborted, no mention will be made in the log file. |
402 | ||
403 | If you want to customize the log lines, see the "log format" option. | |
81791cfc AT |
404 | |
405 | dit(bf(log format)) The "log format" option allows you to specify the | |
9e453674 WD |
406 | format used for logging file transfers when transfer logging is enabled. |
407 | The format is a text string containing embedded single-character escape | |
80a24d52 WD |
408 | sequences prefixed with a percent (%) character. An optional numeric |
409 | field width may also be specified between the percent and the escape | |
0abe148f | 410 | letter (e.g. "bf(%-50n %8l %07p)"). |
81791cfc | 411 | |
9e453674 WD |
412 | The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] " |
413 | is always prefixed when using the "log file" option. | |
414 | (A perl script that will summarize this default log format is included | |
415 | in the rsync source code distribution in the "support" subdirectory: | |
416 | rsyncstats.) | |
417 | ||
418 | The single-character escapes that are understood are as follows: | |
81791cfc | 419 | |
b8a6dae0 | 420 | quote(itemization( |
aca5500a | 421 | it() %a the remote IP address |
f97c2d4a | 422 | it() %b the number of bytes actually transferred |
aca5500a WD |
423 | it() %B the permission bits of the file (e.g. rwxrwxrwt) |
424 | it() %c the checksum bytes received for this file (only when sending) | |
425 | it() %f the filename (long form on sender; no trailing "/") | |
426 | it() %G the gid of the file (decimal) or "DEFAULT" | |
427 | it() %h the remote host name | |
527a010f | 428 | it() %i an itemized list of what is being updated |
aca5500a WD |
429 | it() %l the length of the file in bytes |
430 | it() %L the string " -> SYMLINK", " => HARDLINK", or "" (where bf(SYMLINK) or bf(HARDLINK) is a filename) | |
431 | it() %m the module name | |
432 | it() %M the last-modified time of the file | |
433 | it() %n the filename (short form; trailing "/" on dir) | |
434 | it() %o the operation, which is "send", "recv", or "del." (the latter includes the trailing period) | |
435 | it() %p the process ID of this rsync session | |
436 | it() %P the module path | |
437 | it() %t the current date time | |
438 | it() %u the authenticated username or an empty string | |
439 | it() %U the uid of the file (decimal) | |
faa82484 | 440 | )) |
81791cfc | 441 | |
9e453674 WD |
442 | For a list of what the characters mean that are output by "%i", see the |
443 | bf(--itemize-changes) option in the rsync manpage. | |
527a010f | 444 | |
9e453674 | 445 | Note that some of the logged output changes when talking with older |
80a24d52 | 446 | rsync versions. For instance, deleted files were only output as verbose |
8ebdc972 | 447 | messages prior to rsync 2.6.4. |
a85a1514 | 448 | |
81791cfc | 449 | dit(bf(timeout)) The "timeout" option allows you to override the |
58811a0a | 450 | clients choice for I/O timeout for this module. Using this option you |
81791cfc AT |
451 | can ensure that rsync won't wait on a dead client forever. The timeout |
452 | is specified in seconds. A value of zero means no timeout and is the | |
d90338ce | 453 | default. A good choice for anonymous rsync daemons may be 600 (giving |
81791cfc AT |
454 | a 10 minute timeout). |
455 | ||
cd8185f2 | 456 | dit(bf(refuse options)) The "refuse options" option allows you to |
553f9375 | 457 | specify a space-separated list of rsync command line options that will |
d90338ce | 458 | be refused by your rsync daemon. |
1cb0a3ed WD |
459 | You may specify the full option name, its one-letter abbreviation, or a |
460 | wild-card string that matches multiple options. | |
9eef8f0b WD |
461 | For example, this would refuse bf(--checksum) (bf(-c)) and all the various |
462 | delete options: | |
1cb0a3ed | 463 | |
9eef8f0b WD |
464 | quote(tt( refuse options = c delete)) |
465 | ||
466 | The reason the above refuses all delete options is that the options imply | |
467 | bf(--delete), and implied options are refused just like explicit options. | |
e1636830 WD |
468 | As an additional safety feature, the refusal of "delete" also refuses |
469 | bf(remove-sent-files) when the daemon is the sender; if you want the latter | |
470 | without the former, instead refuse "delete-*" -- that refuses all the | |
471 | delete modes without affecting bf(--remove-sent-files). | |
1cb0a3ed | 472 | |
d90338ce | 473 | When an option is refused, the daemon prints an error message and exits. |
f97c2d4a WD |
474 | To prevent all compression when serving files, |
475 | you can use "dont compress = *" (see below) | |
63f0774f DD |
476 | instead of "refuse options = compress" to avoid returning an error to a |
477 | client that requests compression. | |
cd8185f2 | 478 | |
83fff1aa AT |
479 | dit(bf(dont compress)) The "dont compress" option allows you to select |
480 | filenames based on wildcard patterns that should not be compressed | |
f97c2d4a WD |
481 | when pulling files from the daemon (no analogous option exists to |
482 | govern the pushing of files to a daemon). | |
483 | Compression is expensive in terms of CPU usage, so it | |
83fff1aa | 484 | is usually good to not try to compress files that won't compress well, |
f97c2d4a | 485 | such as already compressed files. |
83fff1aa | 486 | |
553f9375 | 487 | The "dont compress" option takes a space-separated list of |
83fff1aa AT |
488 | case-insensitive wildcard patterns. Any source filename matching one |
489 | of the patterns will not be compressed during transfer. | |
490 | ||
faa82484 | 491 | The default setting is tt(*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz) |
83fff1aa | 492 | |
c20936b8 WD |
493 | dit(bf(pre-xfer exec), bf(post-xfer exec)) You may specify a command to be run |
494 | before and/or after the transfer. If the bf(pre-xfer exec) command fails, the | |
495 | transfer is aborted before it begins. | |
496 | ||
37439b36 WD |
497 | The following environment variables will be set, though some are |
498 | specific to the pre-xfer or the post-xfer environment: | |
c20936b8 | 499 | |
b8a6dae0 | 500 | quote(itemization( |
c20936b8 WD |
501 | it() bf(RSYNC_MODULE_NAME): The name of the module being accessed. |
502 | it() bf(RSYNC_MODULE_PATH): The path configured for the module. | |
503 | it() bf(RSYNC_HOST_ADDR): The accessing host's IP address. | |
504 | it() bf(RSYNC_HOST_NAME): The accessing host's name. | |
505 | it() bf(RSYNC_USER_NAME): The accessing user's name (empty if no user). | |
a739128d | 506 | it() bf(RSYNC_PID): A unique number for this transfer. |
37439b36 WD |
507 | it() bf(RSYNC_REQUEST): (pre-xfer only) The module/path info specified |
508 | by the user (note that the user can specify multiple source files, | |
509 | so the request can be something like "mod/path1 mod/path2", etc.). | |
70e98a43 | 510 | it() bf(RSYNC_ARG#): (pre-xfer only) The pre-request arguments are set |
fddf529d WD |
511 | in these numbered values. RSYNC_ARG0 is always "rsyncd", and the last |
512 | value contains a single period. | |
a6333519 WD |
513 | it() bf(RSYNC_EXIT_STATUS): (post-xfer only) the server side's exit value. |
514 | This will be 0 for a successful run, a positive value for an error that the | |
515 | server generated, or a -1 if rsync failed to exit properly. Note that an | |
516 | error that occurs on the client side does not currently get sent to the | |
517 | server side, so this is not the final exit status for the whole transfer. | |
19826af5 | 518 | it() bf(RSYNC_RAW_STATUS): (post-xfer only) the raw exit value from code(waitpid()). |
c20936b8 WD |
519 | )) |
520 | ||
521 | Even though the commands can be associated with a particular module, they | |
522 | are run using the permissions of the user that started the daemon (not the | |
37439b36 | 523 | module's uid/gid setting) without any chroot restrictions. |
c20936b8 | 524 | |
41059f75 AT |
525 | enddit() |
526 | ||
4c3d16be AT |
527 | manpagesection(AUTHENTICATION STRENGTH) |
528 | ||
529 | The authentication protocol used in rsync is a 128 bit MD4 based | |
2b7e1292 WD |
530 | challenge response system. This is fairly weak protection, though (with |
531 | at least one brute-force hash-finding algorithm publicly available), so | |
532 | if you want really top-quality security, then I recommend that you run | |
533 | rsync over ssh. (Yes, a future version of rsync will switch over to a | |
534 | stronger hashing method.) | |
4c3d16be | 535 | |
d90338ce | 536 | Also note that the rsync daemon protocol does not currently provide any |
f39281ae | 537 | encryption of the data that is transferred over the connection. Only |
4c3d16be AT |
538 | authentication is provided. Use ssh as the transport if you want |
539 | encryption. | |
540 | ||
541 | Future versions of rsync may support SSL for better authentication and | |
542 | encryption, but that is still being investigated. | |
543 | ||
41059f75 AT |
544 | manpagesection(EXAMPLES) |
545 | ||
546 | A simple rsyncd.conf file that allow anonymous rsync to a ftp area at | |
e22de162 | 547 | tt(/home/ftp) would be: |
41059f75 AT |
548 | |
549 | verb( | |
550 | [ftp] | |
e22de162 AT |
551 | path = /home/ftp |
552 | comment = ftp export area | |
41059f75 AT |
553 | ) |
554 | ||
41059f75 AT |
555 | A more sophisticated example would be: |
556 | ||
faa82484 WD |
557 | verb( |
558 | uid = nobody | |
559 | gid = nobody | |
560 | use chroot = no | |
561 | max connections = 4 | |
562 | syslog facility = local5 | |
0f621785 | 563 | pid file = /var/run/rsyncd.pid |
41059f75 | 564 | |
faa82484 | 565 | [ftp] |
41059f75 AT |
566 | path = /var/ftp/pub |
567 | comment = whole ftp area (approx 6.1 GB) | |
568 | ||
569 | [sambaftp] | |
570 | path = /var/ftp/pub/samba | |
571 | comment = Samba ftp area (approx 300 MB) | |
572 | ||
573 | [rsyncftp] | |
574 | path = /var/ftp/pub/rsync | |
575 | comment = rsync ftp area (approx 6 MB) | |
f97c2d4a | 576 | |
41059f75 AT |
577 | [sambawww] |
578 | path = /public_html/samba | |
579 | comment = Samba WWW pages (approx 240 MB) | |
580 | ||
581 | [cvs] | |
582 | path = /data/cvs | |
583 | comment = CVS repository (requires authentication) | |
584 | auth users = tridge, susan | |
585 | secrets file = /etc/rsyncd.secrets | |
586 | ) | |
587 | ||
588 | The /etc/rsyncd.secrets file would look something like this: | |
589 | ||
faa82484 WD |
590 | quote( |
591 | tt(tridge:mypass)nl() | |
592 | tt(susan:herpass)nl() | |
593 | ) | |
41059f75 AT |
594 | |
595 | manpagefiles() | |
596 | ||
30e8c8e1 | 597 | /etc/rsyncd.conf or rsyncd.conf |
41059f75 AT |
598 | |
599 | manpageseealso() | |
600 | ||
b8a6dae0 | 601 | bf(rsync)(1) |
41059f75 AT |
602 | |
603 | manpagediagnostics() | |
604 | ||
605 | manpagebugs() | |
606 | ||
41059f75 | 607 | Please report bugs! The rsync bug tracking system is online at |
9e3c856a | 608 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
41059f75 AT |
609 | |
610 | manpagesection(VERSION) | |
d90338ce | 611 | |
0c6d7952 | 612 | This man page is current for version 2.6.9 of rsync. |
41059f75 AT |
613 | |
614 | manpagesection(CREDITS) | |
615 | ||
616 | rsync is distributed under the GNU public license. See the file | |
617 | COPYING for details. | |
618 | ||
619 | The primary ftp site for rsync is | |
9e3c856a | 620 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). |
41059f75 AT |
621 | |
622 | A WEB site is available at | |
9e3c856a | 623 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
41059f75 AT |
624 | |
625 | We would be delighted to hear from you if you like this program. | |
626 | ||
627 | This program uses the zlib compression library written by Jean-loup | |
628 | Gailly and Mark Adler. | |
629 | ||
630 | manpagesection(THANKS) | |
631 | ||
632 | Thanks to Warren Stanley for his original idea and patch for the rsync | |
d90338ce | 633 | daemon. Thanks to Karsten Thygesen for his many suggestions and |
f97c2d4a | 634 | documentation! |
41059f75 AT |
635 | |
636 | manpageauthor() | |
637 | ||
ae283632 WD |
638 | rsync was written by Andrew Tridgell and Paul Mackerras. |
639 | Many people have later contributed to it. | |
41059f75 | 640 | |
ae283632 | 641 | Mailing lists for support and development are available at |
f97c2d4a | 642 | url(http://lists.samba.org)(lists.samba.org) |