Commit | Line | Data |
---|---|---|
41059f75 AT |
1 | mailto(rsync-bugs@samba.anu.edu.au) |
2 | manpage(rsyncd.conf)(5)(13 May 1998)()() | |
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 | |
5315b793 | 47 | rsync. The daemon must run with root privileges. |
41059f75 AT |
48 | |
49 | You can launch it either via inetd or as a standalone daemon. If run | |
e22de162 | 50 | as a daemon then just run the command "rsync --daemon" from a suitable |
41059f75 AT |
51 | startup script. |
52 | ||
53 | When run via inetd you should add a line like this to /etc/services: | |
54 | ||
e22de162 | 55 | quote(rsync 873/tcp) |
41059f75 | 56 | |
e22de162 | 57 | and a single line something like this to /etc/inetd.conf: |
41059f75 | 58 | |
e22de162 | 59 | quote(rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon) |
41059f75 AT |
60 | |
61 | You will then need to send inetd a HUP signal to tell it to reread its | |
62 | config file. | |
63 | ||
64 | Note that you should not send the rsync server a HUP signal to force | |
e22de162 | 65 | it to reread the tt(/etc/rsyncd.conf). The file is re-read on each client |
41059f75 AT |
66 | connection. |
67 | ||
68 | manpagesection(GLOBAL OPTIONS) | |
69 | ||
70 | The first parameters in the file (before a [module] header) are the | |
71 | global parameters. | |
72 | ||
73 | You may also include any module parameters in the global part of the | |
74 | config file in which case the supplied value will override the | |
75 | default for that parameter. | |
76 | ||
77 | startdit() | |
78 | dit(bf(motd file)) The "motd file" option allows you to specify a | |
5315b793 | 79 | "message of the day" to display to clients on each connect. This |
41059f75 AT |
80 | usually contains site information and any legal notices. The default |
81 | is no motd file. | |
82 | ||
83 | dit(bf(max connections)) The "max connections" option allows you to | |
84 | specify the maximum number of simultaneous connections you will allow | |
85 | to your rsync server. Any clients connecting when the maximum has | |
86 | been reached will receive a message telling them to try later. | |
87 | The default is 0 which means no limit. | |
88 | ||
89 | dit(bf(lock file)) The "lock file" option specifies the file to use to | |
90 | support the "max connections" option. The rsync server uses record | |
91 | locking on this file to ensure that the max connections limit is not | |
e22de162 | 92 | exceeded. The default is tt(/var/run/rsyncd.lock). |
41059f75 | 93 | |
37863201 AT |
94 | dit(bf(log file)) The "log file" option tells the rsync daemon to log |
95 | messages to that file rather than using syslog. This is particularly | |
96 | useful on systems (such as AIX) where syslog() doesn't work for | |
8638dd48 DD |
97 | chrooted programs. |
98 | ||
99 | dit(bf(pid file)) The "pid file" option tells the rsync daemon to write | |
100 | its process id to that file. | |
37863201 | 101 | |
41059f75 AT |
102 | dit(bf(syslog facility)) The "syslog facility" option allows you to |
103 | specify the syslog facility name to use when logging messages from the | |
104 | rsync server. You may use any standard syslog facility name which is | |
105 | defined on your system. Common names are auth, authpriv, cron, daemon, | |
106 | ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0, | |
107 | local1, local2, local3, local4, local5, local6 and local7. The default | |
108 | is daemon. | |
109 | ||
a6801c39 AT |
110 | dit(bf(socket options)) This option can provide endless fun for people |
111 | who like to tune their systems to the utmost degree. You can set all | |
112 | sorts of socket options which may make transfers faster (or | |
113 | slower!). Read the man page for the setsockopt() system call for | |
114 | details on some of the options you may be able to set. By default no | |
115 | special socket options are set. | |
116 | ||
41059f75 AT |
117 | enddit() |
118 | ||
119 | ||
120 | manpagesection(MODULE OPTIONS) | |
121 | ||
122 | After the global options you should define a number of modules, each | |
123 | module exports a directory tree as a symbolic name. Modules are | |
124 | exported by specifying a module name in square brackets [module] | |
125 | followed by the options for that module. | |
126 | ||
127 | startdit() | |
128 | ||
129 | dit(bf(comment)) The "comment" option specifies a description string | |
130 | that is displayed next to the module name when clients obtain a list | |
131 | of available modules. The default is no comment. | |
132 | ||
133 | dit(bf(path)) The "path" option specifies the directory in the servers | |
8638dd48 DD |
134 | filesystem to make available in this module. You must specify this option |
135 | for each module in tt(/etc/rsyncd.conf). | |
136 | ||
137 | dit(bf(use chroot)) If "use chroot" is true, the rsync server will chroot | |
138 | to the "path" before starting the file transfer with the client. This has | |
139 | the advantage of extra protection against possible implementation security | |
140 | holes, but it has the disadvantages of requiring super-user privileges and | |
141 | of not being able to follow symbolic links outside of the new root path. | |
142 | The default is to use chroot. | |
41059f75 AT |
143 | |
144 | dit(bf(read only)) The "read only" option determines whether clients | |
145 | will be able to upload files or not. If "read only" is true then any | |
146 | attempted uploads will fail. If "read only" is false then uploads will | |
147 | be possible if file permissions on the server allow them. The default | |
148 | is for all modules to be read only. | |
149 | ||
150 | dit(bf(list)) The "list" option determines if this module should be | |
151 | listed when the client asks for a listing of available modules. By | |
152 | setting this to false you can create hidden modules. The default is | |
153 | for modules to be listable. | |
154 | ||
155 | dit(bf(uid)) The "uid" option specifies the user name or user id that | |
156 | file transfers to and from that module should take place as. In | |
157 | combination with the "gid" option this determines what file | |
158 | permissions are available. The default is the user "nobody". | |
159 | ||
160 | dit(bf(gid)) The "gid" option specifies the group name or group id that | |
161 | file transfers to and from that module should take place as. This | |
162 | complements the "uid" option. The default is the group "nobody". | |
163 | ||
8f3a2d54 AT |
164 | dit(bf(exclude)) The "exclude" option allows you to specify a space |
165 | separated list of patterns to add to the exclude list. This is | |
166 | equivalent to the client specifying these patterns with the --exclude | |
167 | option. Note that this option is not designed with strong security in | |
168 | mind, it is quite possible that a client may find a way to bypass this | |
169 | exclude list. If you want to absolutely ensure that certain files | |
170 | cannot be accessed then use the uid/gid options in combination with | |
171 | file permissions. | |
172 | ||
173 | dit(bf(exclude from)) The "exclude from" option specifies a filename | |
174 | on the server that contains exclude patterns, one per line. This is | |
175 | equivalent to the client specifying the --exclude-from option with a | |
176 | equivalent file. See also the note about security for the exclude | |
177 | option above. | |
178 | ||
41059f75 AT |
179 | dit(bf(auth users)) The "auth users" option specifies a comma |
180 | and space separated list of usernames that will be allowed to connect | |
181 | to this module. The usernames do not need to exist on the local | |
182 | system. If "auth users" is set then the client will be challenged to | |
183 | supply a username and password to connect to the module. A challenge | |
184 | response authentication protocol is used for this exchange. The plain | |
185 | text usernames are passwords are stored in the file specified by the | |
186 | "secrets file" option. The default is for all users to be able to | |
187 | connect without a password (this is called "anonymous rsync"). | |
188 | ||
189 | dit(bf(secrets file)) The "secrets file" option specifies the name of | |
190 | a file that contains the username:password pairs used for | |
191 | authenticating this module. This file is only consulted if the "auth | |
192 | users" option is specified. The file is line based and contains | |
193 | username:password pairs separated by a single colon. Any line starting | |
194 | with a hash (#) is considered a comment and is skipped. The passwords | |
195 | can contain any characters but be warned that many operating systems | |
196 | limit the length of passwords that can be typed at the client end, so | |
197 | you may find that passwords longer than 8 characters don't work. | |
198 | ||
199 | bf(You should make sure that the secrets file is not readable by anyone | |
200 | other than the system administrator.) There is no default for the | |
201 | "secrets file" option, you must choose a name (such as | |
e22de162 | 202 | tt(/etc/rsyncd.secrets)). |
41059f75 AT |
203 | |
204 | dit(bf(hosts allow)) The "hosts allow" option allows you to specify a | |
205 | list of patterns that are matched against a connecting clients | |
206 | hostname and IP address. If none of the patterns match then the | |
207 | connection is rejected. | |
208 | ||
209 | Each pattern can be in one of five forms: | |
210 | ||
211 | itemize( | |
212 | it() a dotted decimal IP address. In this case the incoming machines | |
213 | IP address must match exactly. | |
214 | ||
215 | it() a address/mask in the form a.b.c.d/n were n is the number of | |
216 | one bits in in the netmask. All IP addresses which match the masked | |
217 | IP address will be allowed in. | |
218 | ||
219 | it() a address/mask in the form a.b.c.d/e.f.g.h where e.f.g.h is a | |
5315b793 | 220 | netmask in dotted decimal notation. All IP addresses which match the masked |
41059f75 AT |
221 | IP address will be allowed in. |
222 | ||
223 | it() a hostname. The hostname as determined by a reverse lookup will | |
5315b793 | 224 | be matched (case insensitive) against the pattern. Only an exact |
41059f75 AT |
225 | match is allowed in. |
226 | ||
227 | it() a hostname pattern using wildcards. These are matched using the | |
228 | same rules as normal unix filename matching. If the pattern matches | |
5315b793 | 229 | then the client is allowed in. |
41059f75 AT |
230 | ) |
231 | ||
232 | You can also combine "hosts allow" with a separate "hosts deny" | |
233 | option. If both options are specified then the "hosts allow" option s | |
5315b793 | 234 | checked first and a match results in the client being able to |
41059f75 AT |
235 | connect. The "hosts deny" option is then checked and a match means |
236 | that the host is rejected. If the host does not match either the | |
237 | "hosts allow" or the "hosts deny" patterns then it is allowed to | |
238 | connect. | |
239 | ||
240 | The default is no "hosts allow" option, which means all hosts can connect. | |
241 | ||
de2fd20e | 242 | dit(bf(hosts deny)) The "hosts deny" option allows you to specify a |
41059f75 AT |
243 | list of patterns that are matched against a connecting clients |
244 | hostname and IP address. If the pattern matches then the connection is | |
245 | rejected. See the "hosts allow" option for more information. | |
246 | ||
247 | The default is no "hosts deny" option, which means all hosts can connect. | |
248 | ||
81791cfc AT |
249 | dit(bf(transfer logging)) The "transfer logging" option enables per-file |
250 | logging of downloads and uploads in a format somewhat similar to that | |
251 | used by ftp daemons. If you want to customise the log formats look at | |
252 | the log format option. | |
253 | ||
254 | dit(bf(log format)) The "log format" option allows you to specify the | |
255 | format used for logging file transfers when transfer logging is | |
256 | enabled. The format is a text string containing embedded single | |
257 | character escape sequences prefixed with a percent (%) character. | |
258 | ||
259 | The prefixes that are understood are: | |
260 | ||
261 | itemize( | |
262 | it() %h for the remote host name | |
263 | it() %a for the remote IP address | |
264 | it() %l for the length of the file in bytes | |
265 | it() %p for the process id of this rsync session | |
266 | it() %o for the operation, which is either "send" or "recv" | |
267 | it() %f for the filename | |
268 | it() %P for the module path | |
269 | it() %m for the module name | |
270 | it() %t for the current time | |
271 | it() %u for the authenticated username (or the null string) | |
272 | it() %b for the number of bytes actually transferred | |
273 | it() %c when sending files this gives the number of checksum bytes | |
274 | received for this file | |
275 | ) | |
276 | ||
277 | The default log format is "%o %h [%a] %m (%u) %f %l" | |
278 | ||
279 | A perl script called rsyncstats to summarise this format is included | |
280 | in the rsync source code distribution. | |
281 | ||
282 | dit(bf(timeout)) The "timeout" option allows you to override the | |
283 | clients choice for IO timoeut for this module. Using this option you | |
284 | can ensure that rsync won't wait on a dead client forever. The timeout | |
285 | is specified in seconds. A value of zero means no timeout and is the | |
286 | default. A good choice for anonymous rsync servers may be 600 (giving | |
287 | a 10 minute timeout). | |
288 | ||
41059f75 AT |
289 | enddit() |
290 | ||
4c3d16be AT |
291 | manpagesection(AUTHENTICATION STRENGTH) |
292 | ||
293 | The authentication protocol used in rsync is a 128 bit MD4 based | |
294 | challenge response system. Although I believe that no one has ever | |
295 | demonstrated a brute-force break of this sort of system you should | |
296 | realise that this is not a "military strength" authentication system. | |
297 | It should be good enough for most purposes but if you want really top | |
298 | quality security then I recommend that you run rsync over ssh. | |
299 | ||
300 | Also note that the rsync server protocol does not currently provide any | |
301 | encryption of the data that is transferred over the link. Only | |
302 | authentication is provided. Use ssh as the transport if you want | |
303 | encryption. | |
304 | ||
305 | Future versions of rsync may support SSL for better authentication and | |
306 | encryption, but that is still being investigated. | |
307 | ||
41059f75 AT |
308 | manpagesection(EXAMPLES) |
309 | ||
310 | A simple rsyncd.conf file that allow anonymous rsync to a ftp area at | |
e22de162 | 311 | tt(/home/ftp) would be: |
41059f75 AT |
312 | |
313 | verb( | |
314 | [ftp] | |
e22de162 AT |
315 | path = /home/ftp |
316 | comment = ftp export area | |
41059f75 AT |
317 | ) |
318 | ||
319 | ||
320 | A more sophisticated example would be: | |
321 | ||
e22de162 AT |
322 | uid = nobody nl() |
323 | gid = nobody nl() | |
8638dd48 | 324 | use chroot = no nl() |
e22de162 AT |
325 | max connections = 4 nl() |
326 | syslog facility = local5 nl() | |
8638dd48 | 327 | pid file = /etc/rsyncd.pid |
41059f75 | 328 | |
e22de162 | 329 | verb([ftp] |
41059f75 AT |
330 | path = /var/ftp/pub |
331 | comment = whole ftp area (approx 6.1 GB) | |
332 | ||
333 | [sambaftp] | |
334 | path = /var/ftp/pub/samba | |
335 | comment = Samba ftp area (approx 300 MB) | |
336 | ||
337 | [rsyncftp] | |
338 | path = /var/ftp/pub/rsync | |
339 | comment = rsync ftp area (approx 6 MB) | |
340 | ||
341 | [sambawww] | |
342 | path = /public_html/samba | |
343 | comment = Samba WWW pages (approx 240 MB) | |
344 | ||
345 | [cvs] | |
346 | path = /data/cvs | |
347 | comment = CVS repository (requires authentication) | |
348 | auth users = tridge, susan | |
349 | secrets file = /etc/rsyncd.secrets | |
350 | ) | |
351 | ||
352 | The /etc/rsyncd.secrets file would look something like this: | |
353 | ||
e22de162 | 354 | tridge:mypass nl() |
41059f75 | 355 | susan:herpass |
41059f75 AT |
356 | |
357 | manpagefiles() | |
358 | ||
359 | /etc/rsyncd.conf | |
360 | ||
361 | manpageseealso() | |
362 | ||
363 | rsync(1) | |
364 | ||
365 | manpagediagnostics() | |
366 | ||
367 | manpagebugs() | |
368 | ||
369 | The rsync server does not send all types of error messages to the | |
370 | client. this means a client may be mystified as to why a transfer | |
371 | failed. The error will have been logged by syslog on the server. | |
372 | ||
373 | Please report bugs! The rsync bug tracking system is online at | |
374 | url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/) | |
375 | ||
376 | manpagesection(VERSION) | |
377 | This man page is current for version 2.0 of rsync | |
378 | ||
379 | manpagesection(CREDITS) | |
380 | ||
381 | rsync is distributed under the GNU public license. See the file | |
382 | COPYING for details. | |
383 | ||
384 | The primary ftp site for rsync is | |
385 | url(ftp://samba.anu.edu.au/pub/rsync)(ftp://samba.anu.edu.au/pub/rsync). | |
386 | ||
387 | A WEB site is available at | |
388 | url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/) | |
389 | ||
390 | We would be delighted to hear from you if you like this program. | |
391 | ||
392 | This program uses the zlib compression library written by Jean-loup | |
393 | Gailly and Mark Adler. | |
394 | ||
395 | manpagesection(THANKS) | |
396 | ||
397 | Thanks to Warren Stanley for his original idea and patch for the rsync | |
398 | server. Thanks to Karsten Thygesen for his many suggestions and | |
399 | documentation! | |
400 | ||
401 | manpageauthor() | |
402 | ||
403 | rsync was written by Andrew Tridgell and Paul Mackerras. They may be | |
404 | contacted via email at tridge@samba.anu.edu.au and | |
405 | Paul.Mackerras@cs.anu.edu.au | |
406 |