Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
651443a7 | 2 | manpage(rsyncd.conf)(5)(12 Feb 1999)()() |
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 | |
e22de162 | 11 | run with the --daemon option. When run in this way rsync becomes a |
41059f75 AT |
12 | rsync server listening on TCP port 873. Connections from rsync clients |
13 | are accepted for either anonymous or authenticated rsync sessions. | |
14 | ||
15 | The rsyncd.conf file controls authentication, access, logging and | |
16 | available modules. | |
17 | ||
18 | manpagesection(FILE FORMAT) | |
19 | ||
20 | The file consists of modules and parameters. A module begins with the | |
21 | name of the module in square brackets and continues until the next | |
22 | module begins. Modules contain parameters of the form 'name = value'. | |
23 | ||
24 | The file is line-based - that is, each newline-terminated line represents | |
25 | either a comment, a module name or a parameter. | |
26 | ||
27 | Only the first equals sign in a parameter is significant. Whitespace before | |
28 | or after the first equals sign is discarded. Leading, trailing and internal | |
29 | whitespace in module and parameter names is irrelevant. Leading and | |
30 | trailing whitespace in a parameter value is discarded. Internal whitespace | |
31 | within a parameter value is retained verbatim. | |
32 | ||
33 | Any line beginning with a hash (#) is ignored, as are lines containing | |
34 | only whitespace. | |
35 | ||
e22de162 | 36 | Any line ending in a \ is "continued" on the next line in the |
41059f75 AT |
37 | customary UNIX fashion. |
38 | ||
39 | The values following the equals sign in parameters are all either a string | |
40 | (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or | |
41 | true/false. Case is not significant in boolean values, but is preserved | |
42 | in string values. | |
43 | ||
5315b793 | 44 | manpagesection(LAUNCHING THE RSYNC DAEMON) |
41059f75 AT |
45 | |
46 | The rsync daemon is launched by specifying the --daemon option to | |
f5c20813 MP |
47 | rsync. |
48 | ||
49 | The daemon must run with root privileges if you wish to use chroot, to | |
50 | bind to a port numbered under 1024 (as is the default 873), or to set | |
51 | file ownership. Otherwise, it must just have permission to read and | |
52 | write the appropriate data, log, and lock files. | |
41059f75 | 53 | |
14d43f1f | 54 | You can launch it either via inetd or as a stand-alone daemon. If run |
e22de162 | 55 | as a daemon then just run the command "rsync --daemon" from a suitable |
41059f75 AT |
56 | startup script. |
57 | ||
58 | When run via inetd you should add a line like this to /etc/services: | |
59 | ||
e22de162 | 60 | quote(rsync 873/tcp) |
41059f75 | 61 | |
e22de162 | 62 | and a single line something like this to /etc/inetd.conf: |
41059f75 | 63 | |
e22de162 | 64 | quote(rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon) |
41059f75 | 65 | |
79f118d8 DD |
66 | Replace "/usr/bin/rsync" with the path to where you have rsync installed on |
67 | your system. You will then need to send inetd a HUP signal to tell it to | |
68 | reread its config file. | |
41059f75 AT |
69 | |
70 | Note that you should not send the rsync server a HUP signal to force | |
e22de162 | 71 | it to reread the tt(/etc/rsyncd.conf). The file is re-read on each client |
41059f75 AT |
72 | connection. |
73 | ||
74 | manpagesection(GLOBAL OPTIONS) | |
75 | ||
76 | The first parameters in the file (before a [module] header) are the | |
77 | global parameters. | |
78 | ||
79 | You may also include any module parameters in the global part of the | |
80 | config file in which case the supplied value will override the | |
81 | default for that parameter. | |
82 | ||
83 | startdit() | |
84 | dit(bf(motd file)) The "motd file" option allows you to specify a | |
5315b793 | 85 | "message of the day" to display to clients on each connect. This |
41059f75 AT |
86 | usually contains site information and any legal notices. The default |
87 | is no motd file. | |
88 | ||
37863201 AT |
89 | dit(bf(log file)) The "log file" option tells the rsync daemon to log |
90 | messages to that file rather than using syslog. This is particularly | |
91 | useful on systems (such as AIX) where syslog() doesn't work for | |
8638dd48 DD |
92 | chrooted programs. |
93 | ||
94 | dit(bf(pid file)) The "pid file" option tells the rsync daemon to write | |
95 | its process id to that file. | |
37863201 | 96 | |
41059f75 AT |
97 | dit(bf(syslog facility)) The "syslog facility" option allows you to |
98 | specify the syslog facility name to use when logging messages from the | |
99 | rsync server. You may use any standard syslog facility name which is | |
100 | defined on your system. Common names are auth, authpriv, cron, daemon, | |
101 | ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0, | |
102 | local1, local2, local3, local4, local5, local6 and local7. The default | |
103 | is daemon. | |
104 | ||
a6801c39 AT |
105 | dit(bf(socket options)) This option can provide endless fun for people |
106 | who like to tune their systems to the utmost degree. You can set all | |
107 | sorts of socket options which may make transfers faster (or | |
108 | slower!). Read the man page for the setsockopt() system call for | |
109 | details on some of the options you may be able to set. By default no | |
110 | special socket options are set. | |
111 | ||
41059f75 AT |
112 | enddit() |
113 | ||
114 | ||
115 | manpagesection(MODULE OPTIONS) | |
116 | ||
117 | After the global options you should define a number of modules, each | |
118 | module exports a directory tree as a symbolic name. Modules are | |
119 | exported by specifying a module name in square brackets [module] | |
120 | followed by the options for that module. | |
121 | ||
122 | startdit() | |
123 | ||
124 | dit(bf(comment)) The "comment" option specifies a description string | |
125 | that is displayed next to the module name when clients obtain a list | |
126 | of available modules. The default is no comment. | |
127 | ||
128 | dit(bf(path)) The "path" option specifies the directory in the servers | |
8638dd48 DD |
129 | filesystem to make available in this module. You must specify this option |
130 | for each module in tt(/etc/rsyncd.conf). | |
131 | ||
132 | dit(bf(use chroot)) If "use chroot" is true, the rsync server will chroot | |
133 | to the "path" before starting the file transfer with the client. This has | |
134 | the advantage of extra protection against possible implementation security | |
135 | holes, but it has the disadvantages of requiring super-user privileges and | |
5f7ce204 | 136 | of not being able to follow symbolic links outside of the new root path |
6963e540 | 137 | when reading. When "use chroot" is false, for security reasons |
5f7ce204 DD |
138 | symlinks may only be relative paths pointing to other files within the |
139 | root path, and leading slashes are removed from absolute paths. The | |
140 | default for "use chroot" is true. | |
41059f75 | 141 | |
5e71c444 | 142 | dit(bf(max connections)) The "max connections" option allows you to |
9ef1cc7c DD |
143 | specify the maximum number of simultaneous connections you will allow. |
144 | Any clients connecting when the maximum has been reached will receive a | |
145 | message telling them to try later. The default is 0 which means no limit. | |
146 | See also the "lock file" option. | |
5e71c444 AT |
147 | |
148 | dit(bf(lock file)) The "lock file" option specifies the file to use to | |
149 | support the "max connections" option. The rsync server uses record | |
150 | locking on this file to ensure that the max connections limit is not | |
9ef1cc7c DD |
151 | exceeded for the modules sharing the lock file. |
152 | The default is tt(/var/run/rsyncd.lock). | |
5e71c444 | 153 | |
41059f75 AT |
154 | dit(bf(read only)) The "read only" option determines whether clients |
155 | will be able to upload files or not. If "read only" is true then any | |
156 | attempted uploads will fail. If "read only" is false then uploads will | |
157 | be possible if file permissions on the server allow them. The default | |
158 | is for all modules to be read only. | |
159 | ||
160 | dit(bf(list)) The "list" option determines if this module should be | |
161 | listed when the client asks for a listing of available modules. By | |
162 | setting this to false you can create hidden modules. The default is | |
163 | for modules to be listable. | |
164 | ||
165 | dit(bf(uid)) The "uid" option specifies the user name or user id that | |
716baed7 DD |
166 | file transfers to and from that module should take place as when the daemon |
167 | was run as root. In combination with the "gid" option this determines what | |
2af27ad9 MP |
168 | file permissions are available. The default is uid -2, which is normally |
169 | the user "nobody". | |
41059f75 AT |
170 | |
171 | dit(bf(gid)) The "gid" option specifies the group name or group id that | |
716baed7 | 172 | file transfers to and from that module should take place as when the daemon |
2af27ad9 MP |
173 | was run as root. This complements the "uid" option. The default is gid -2, |
174 | which is normally the group "nobody". | |
41059f75 | 175 | |
8f3a2d54 | 176 | dit(bf(exclude)) The "exclude" option allows you to specify a space |
a1e0e45e DD |
177 | separated list of patterns to add to the exclude list. This is equivalent |
178 | to the client specifying these patterns with the --exclude option, except | |
179 | that the exclude list is not passed to the client and thus only applies on | |
7c2d381c DD |
180 | the server: that is, it excludes files received by a client when receiving |
181 | from a server and files deleted on a server when sending to a server, but | |
182 | it doesn't exclude files sent from a client when sending to a server or | |
183 | files deleted on a client when receiving from a server. | |
184 | Only one "exclude" option may be specified, but | |
a1e0e45e | 185 | you can use "-" and "+" before patterns to specify exclude/include. |
651443a7 DD |
186 | |
187 | Note that this option is not designed with strong security in | |
8f3a2d54 AT |
188 | mind, it is quite possible that a client may find a way to bypass this |
189 | exclude list. If you want to absolutely ensure that certain files | |
190 | cannot be accessed then use the uid/gid options in combination with | |
191 | file permissions. | |
192 | ||
193 | dit(bf(exclude from)) The "exclude from" option specifies a filename | |
194 | on the server that contains exclude patterns, one per line. This is | |
195 | equivalent to the client specifying the --exclude-from option with a | |
7c2d381c DD |
196 | equivalent file except that it applies only on the server. See also |
197 | the "exclude" option above. | |
8f3a2d54 | 198 | |
cd64343a DD |
199 | dit(bf(include)) The "include" option allows you to specify a space |
200 | separated list of patterns which rsync should not exclude. This is | |
201 | equivalent to the client specifying these patterns with the --include | |
7c2d381c DD |
202 | option except that it applies only on the server. This is useful as it |
203 | allows you to build up quite complex exclude/include rules. Only one | |
204 | "include" option may be specified, but you can use "+" and "-" before | |
205 | patterns to switch include/exclude. See also the "exclude" option above. | |
cd64343a DD |
206 | |
207 | dit(bf(include from)) The "include from" option specifies a filename | |
208 | on the server that contains include patterns, one per line. This is | |
209 | equivalent to the client specifying the --include-from option with a | |
7c2d381c DD |
210 | equivalent file except that it applies only on the server. See also |
211 | the "exclude" option above. | |
cd64343a | 212 | |
5d78a102 AT |
213 | dit(bf(auth users)) The "auth users" option specifies a comma and |
214 | space separated list of usernames that will be allowed to connect to | |
215 | this module. The usernames do not need to exist on the local | |
216 | system. The usernames may also contain shell wildcard characters. If | |
217 | "auth users" is set then the client will be challenged to supply a | |
218 | username and password to connect to the module. A challenge response | |
219 | authentication protocol is used for this exchange. The plain text | |
220 | usernames are passwords are stored in the file specified by the | |
41059f75 AT |
221 | "secrets file" option. The default is for all users to be able to |
222 | connect without a password (this is called "anonymous rsync"). | |
223 | ||
224 | dit(bf(secrets file)) The "secrets file" option specifies the name of | |
225 | a file that contains the username:password pairs used for | |
226 | authenticating this module. This file is only consulted if the "auth | |
227 | users" option is specified. The file is line based and contains | |
228 | username:password pairs separated by a single colon. Any line starting | |
229 | with a hash (#) is considered a comment and is skipped. The passwords | |
230 | can contain any characters but be warned that many operating systems | |
231 | limit the length of passwords that can be typed at the client end, so | |
232 | you may find that passwords longer than 8 characters don't work. | |
233 | ||
3ca8e68f | 234 | There is no default for the "secrets file" option, you must choose a name |
205c27ac DD |
235 | (such as tt(/etc/rsyncd.secrets)). The file must normally not be readable |
236 | by "other"; see "strict modes". | |
3ca8e68f DD |
237 | |
238 | dit(bf(strict modes)) The "strict modes" option determines whether or not | |
239 | the permissions on the secrets file will be checked. If "strict modes" is | |
240 | true, then the secrets file must not be readable by any user id other | |
241 | than the one that the rsync daemon is running under. If "strict modes" is | |
242 | false, the check is not performed. The default is true. This option | |
243 | was added to accommodate rsync running on the Windows operating system. | |
41059f75 AT |
244 | |
245 | dit(bf(hosts allow)) The "hosts allow" option allows you to specify a | |
246 | list of patterns that are matched against a connecting clients | |
247 | hostname and IP address. If none of the patterns match then the | |
248 | connection is rejected. | |
249 | ||
250 | Each pattern can be in one of five forms: | |
251 | ||
252 | itemize( | |
253 | it() a dotted decimal IP address. In this case the incoming machines | |
254 | IP address must match exactly. | |
255 | ||
256 | it() a address/mask in the form a.b.c.d/n were n is the number of | |
257 | one bits in in the netmask. All IP addresses which match the masked | |
258 | IP address will be allowed in. | |
259 | ||
260 | it() a address/mask in the form a.b.c.d/e.f.g.h where e.f.g.h is a | |
5315b793 | 261 | netmask in dotted decimal notation. All IP addresses which match the masked |
41059f75 AT |
262 | IP address will be allowed in. |
263 | ||
264 | it() a hostname. The hostname as determined by a reverse lookup will | |
5315b793 | 265 | be matched (case insensitive) against the pattern. Only an exact |
41059f75 AT |
266 | match is allowed in. |
267 | ||
268 | it() a hostname pattern using wildcards. These are matched using the | |
269 | same rules as normal unix filename matching. If the pattern matches | |
5315b793 | 270 | then the client is allowed in. |
41059f75 AT |
271 | ) |
272 | ||
273 | You can also combine "hosts allow" with a separate "hosts deny" | |
274 | option. If both options are specified then the "hosts allow" option s | |
5315b793 | 275 | checked first and a match results in the client being able to |
41059f75 AT |
276 | connect. The "hosts deny" option is then checked and a match means |
277 | that the host is rejected. If the host does not match either the | |
278 | "hosts allow" or the "hosts deny" patterns then it is allowed to | |
279 | connect. | |
280 | ||
281 | The default is no "hosts allow" option, which means all hosts can connect. | |
282 | ||
de2fd20e | 283 | dit(bf(hosts deny)) The "hosts deny" option allows you to specify a |
41059f75 AT |
284 | list of patterns that are matched against a connecting clients |
285 | hostname and IP address. If the pattern matches then the connection is | |
286 | rejected. See the "hosts allow" option for more information. | |
287 | ||
288 | The default is no "hosts deny" option, which means all hosts can connect. | |
289 | ||
cda2ae84 AT |
290 | dit(bf(ignore errors)) The "ignore errors" option tells rsyncd to |
291 | ignore IO errors on the server when deciding whether to run the delete | |
292 | phase of the transfer. Normally rsync skips the --delete step if any | |
293 | IO errors have occurred in order to prevent disasterous deletion due | |
294 | to a temporary resource shortage or other IO error. In some cases this | |
295 | test is counter productive so you can use this option to turn off this | |
296 | behaviour. | |
297 | ||
78043d19 AT |
298 | dit(bf(ignore nonreadable)) This tells the rsync server to completely |
299 | ignore files that are not readable by the user. This is useful for | |
300 | public archives that may have some non-readable files among the | |
301 | directories, and the sysadmin doesn't want those files to be seen at all. | |
302 | ||
81791cfc AT |
303 | dit(bf(transfer logging)) The "transfer logging" option enables per-file |
304 | logging of downloads and uploads in a format somewhat similar to that | |
14d43f1f | 305 | used by ftp daemons. If you want to customize the log formats look at |
81791cfc AT |
306 | the log format option. |
307 | ||
308 | dit(bf(log format)) The "log format" option allows you to specify the | |
309 | format used for logging file transfers when transfer logging is | |
310 | enabled. The format is a text string containing embedded single | |
311 | character escape sequences prefixed with a percent (%) character. | |
312 | ||
313 | The prefixes that are understood are: | |
314 | ||
315 | itemize( | |
316 | it() %h for the remote host name | |
317 | it() %a for the remote IP address | |
318 | it() %l for the length of the file in bytes | |
319 | it() %p for the process id of this rsync session | |
320 | it() %o for the operation, which is either "send" or "recv" | |
321 | it() %f for the filename | |
322 | it() %P for the module path | |
323 | it() %m for the module name | |
b882b497 | 324 | it() %t for the current date time |
81791cfc AT |
325 | it() %u for the authenticated username (or the null string) |
326 | it() %b for the number of bytes actually transferred | |
327 | it() %c when sending files this gives the number of checksum bytes | |
328 | received for this file | |
329 | ) | |
330 | ||
b882b497 DD |
331 | The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] " |
332 | is always added to the beginning when using the "log file" option. | |
81791cfc | 333 | |
14d43f1f | 334 | A perl script called rsyncstats to summarize this format is included |
81791cfc AT |
335 | in the rsync source code distribution. |
336 | ||
337 | dit(bf(timeout)) The "timeout" option allows you to override the | |
14d43f1f | 338 | clients choice for IO timeout for this module. Using this option you |
81791cfc AT |
339 | can ensure that rsync won't wait on a dead client forever. The timeout |
340 | is specified in seconds. A value of zero means no timeout and is the | |
341 | default. A good choice for anonymous rsync servers may be 600 (giving | |
342 | a 10 minute timeout). | |
343 | ||
cd8185f2 AT |
344 | dit(bf(refuse options)) The "refuse options" option allows you to |
345 | specify a space separated list of rsync command line options that will | |
63f0774f DD |
346 | be refused by your rsync server. The full names of the options must be |
347 | used (i.e., you must use "checksum" not "c" to disable checksumming). | |
348 | When an option is refused, the server prints an error message and exits. | |
349 | To prevent all compression, you can use "dont compress = *" (see below) | |
350 | instead of "refuse options = compress" to avoid returning an error to a | |
351 | client that requests compression. | |
cd8185f2 | 352 | |
83fff1aa AT |
353 | dit(bf(dont compress)) The "dont compress" option allows you to select |
354 | filenames based on wildcard patterns that should not be compressed | |
355 | during transfer. Compression is expensive in terms of CPU usage so it | |
356 | is usually good to not try to compress files that won't compress well, | |
357 | such as already compressed files. | |
358 | ||
359 | The "dont compress" option takes a space separated list of | |
360 | case-insensitive wildcard patterns. Any source filename matching one | |
361 | of the patterns will not be compressed during transfer. | |
362 | ||
69c65227 | 363 | The default setting is verb(*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz) |
83fff1aa | 364 | |
41059f75 AT |
365 | enddit() |
366 | ||
4c3d16be AT |
367 | manpagesection(AUTHENTICATION STRENGTH) |
368 | ||
369 | The authentication protocol used in rsync is a 128 bit MD4 based | |
370 | challenge response system. Although I believe that no one has ever | |
371 | demonstrated a brute-force break of this sort of system you should | |
14d43f1f | 372 | realize that this is not a "military strength" authentication system. |
4c3d16be AT |
373 | It should be good enough for most purposes but if you want really top |
374 | quality security then I recommend that you run rsync over ssh. | |
375 | ||
376 | Also note that the rsync server protocol does not currently provide any | |
377 | encryption of the data that is transferred over the link. Only | |
378 | authentication is provided. Use ssh as the transport if you want | |
379 | encryption. | |
380 | ||
381 | Future versions of rsync may support SSL for better authentication and | |
382 | encryption, but that is still being investigated. | |
383 | ||
41059f75 AT |
384 | manpagesection(EXAMPLES) |
385 | ||
386 | A simple rsyncd.conf file that allow anonymous rsync to a ftp area at | |
e22de162 | 387 | tt(/home/ftp) would be: |
41059f75 AT |
388 | |
389 | verb( | |
390 | [ftp] | |
e22de162 AT |
391 | path = /home/ftp |
392 | comment = ftp export area | |
41059f75 AT |
393 | ) |
394 | ||
395 | ||
396 | A more sophisticated example would be: | |
397 | ||
e22de162 AT |
398 | uid = nobody nl() |
399 | gid = nobody nl() | |
8638dd48 | 400 | use chroot = no nl() |
e22de162 AT |
401 | max connections = 4 nl() |
402 | syslog facility = local5 nl() | |
0f621785 | 403 | pid file = /var/run/rsyncd.pid |
41059f75 | 404 | |
e22de162 | 405 | verb([ftp] |
41059f75 AT |
406 | path = /var/ftp/pub |
407 | comment = whole ftp area (approx 6.1 GB) | |
408 | ||
409 | [sambaftp] | |
410 | path = /var/ftp/pub/samba | |
411 | comment = Samba ftp area (approx 300 MB) | |
412 | ||
413 | [rsyncftp] | |
414 | path = /var/ftp/pub/rsync | |
415 | comment = rsync ftp area (approx 6 MB) | |
416 | ||
417 | [sambawww] | |
418 | path = /public_html/samba | |
419 | comment = Samba WWW pages (approx 240 MB) | |
420 | ||
421 | [cvs] | |
422 | path = /data/cvs | |
423 | comment = CVS repository (requires authentication) | |
424 | auth users = tridge, susan | |
425 | secrets file = /etc/rsyncd.secrets | |
426 | ) | |
427 | ||
428 | The /etc/rsyncd.secrets file would look something like this: | |
429 | ||
e22de162 | 430 | tridge:mypass nl() |
41059f75 | 431 | susan:herpass |
41059f75 AT |
432 | |
433 | manpagefiles() | |
434 | ||
435 | /etc/rsyncd.conf | |
436 | ||
437 | manpageseealso() | |
438 | ||
439 | rsync(1) | |
440 | ||
441 | manpagediagnostics() | |
442 | ||
443 | manpagebugs() | |
444 | ||
445 | The rsync server does not send all types of error messages to the | |
446 | client. this means a client may be mystified as to why a transfer | |
447 | failed. The error will have been logged by syslog on the server. | |
448 | ||
449 | Please report bugs! The rsync bug tracking system is online at | |
9e3c856a | 450 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
41059f75 AT |
451 | |
452 | manpagesection(VERSION) | |
453 | This man page is current for version 2.0 of rsync | |
454 | ||
455 | manpagesection(CREDITS) | |
456 | ||
457 | rsync is distributed under the GNU public license. See the file | |
458 | COPYING for details. | |
459 | ||
460 | The primary ftp site for rsync is | |
9e3c856a | 461 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). |
41059f75 AT |
462 | |
463 | A WEB site is available at | |
9e3c856a | 464 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
41059f75 AT |
465 | |
466 | We would be delighted to hear from you if you like this program. | |
467 | ||
468 | This program uses the zlib compression library written by Jean-loup | |
469 | Gailly and Mark Adler. | |
470 | ||
471 | manpagesection(THANKS) | |
472 | ||
473 | Thanks to Warren Stanley for his original idea and patch for the rsync | |
474 | server. Thanks to Karsten Thygesen for his many suggestions and | |
475 | documentation! | |
476 | ||
477 | manpageauthor() | |
478 | ||
479 | rsync was written by Andrew Tridgell and Paul Mackerras. They may be | |
9e3c856a | 480 | contacted via email at tridge@samba.org and |
41059f75 AT |
481 | Paul.Mackerras@cs.anu.edu.au |
482 |