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)
10 The rsyncd.conf file is the runtime configuration file for rsync when
11 run with the --daemon option. When run in this way rsync becomes a
12 rsync server listening on TCP port 873. Connections from rsync clients
13 are accepted for either anonymous or authenticated rsync sessions.
15 The rsyncd.conf file controls authentication, access, logging and
18 manpagesection(FILE FORMAT)
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'.
24 The file is line-based - that is, each newline-terminated line represents
25 either a comment, a module name or a parameter.
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.
33 Any line beginning with a hash (#) is ignored, as are lines containing
36 Any line ending in a \ is "continued" on the next line in the
37 customary UNIX fashion.
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
44 manpagesection(LAUNCHING THE RSYNC DAEMON)
46 The rsync daemon is launched by specifying the --daemon option to
47 rsync. The daemon must run with root privileges.
49 You can launch it either via inetd or as a standalone daemon. If run
50 as a daemon then just run the command "rsync --daemon" from a suitable
53 When run via inetd you should add a line like this to /etc/services:
57 and a single line something like this to /etc/inetd.conf:
59 quote(rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon)
61 You will then need to send inetd a HUP signal to tell it to reread its
64 Note that you should not send the rsync server a HUP signal to force
65 it to reread the tt(/etc/rsyncd.conf). The file is re-read on each client
68 manpagesection(GLOBAL OPTIONS)
70 The first parameters in the file (before a [module] header) are the
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.
78 dit(bf(motd file)) The "motd file" option allows you to specify a
79 "message of the day" to display to clients on each connect. This
80 usually contains site information and any legal notices. The default
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.
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
92 exceeded. The default is tt(/var/run/rsyncd.lock).
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
99 dit(bf(pid file)) The "pid file" option tells the rsync daemon to write
100 its process id to that file.
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
110 dit(bf(transfer logging)) The "transfer logging" option enables per-file
111 logging of downloads and uploads in a format somewhat similar to that
112 used by ftp daemons. If you want to customise the log formats look at
113 log_send, log_recv and log_transfer in log.c
115 dit(bf(log format)) The "log format" option allows you to specify the
116 format used for logging file transfers when transfer logging is
117 enabled. The format is a text string containing embedded single
118 character escape sequences prefixed with a percent (%) character.
120 The prefixes that are understood are:
123 it() %h for the remote host name
124 it() %a for the remote IP address
125 it() %l for the length of the file in bytes
126 it() %p for the process id of this rsync session
127 it() %o for the operation, which is either "send" or "recv"
128 it() %f for the filename
129 it() %P for the module path
130 it() %m for the module name
131 it() %t for the current time
132 it() %u for the authenticated username (or the null string)
133 it() %b for the number of bytes actually transferred
134 it() %c when sending files this gives the number of checksum bytes
135 received for this file
138 The default log format is "%o %h [%a] %m (%u) %f %l"
140 A perl script called rsyncstats to summarise this format is included
141 in the rsync source code distribution.
143 dit(bf(socket options)) This option can provide endless fun for people
144 who like to tune their systems to the utmost degree. You can set all
145 sorts of socket options which may make transfers faster (or
146 slower!). Read the man page for the setsockopt() system call for
147 details on some of the options you may be able to set. By default no
148 special socket options are set.
153 manpagesection(MODULE OPTIONS)
155 After the global options you should define a number of modules, each
156 module exports a directory tree as a symbolic name. Modules are
157 exported by specifying a module name in square brackets [module]
158 followed by the options for that module.
162 dit(bf(comment)) The "comment" option specifies a description string
163 that is displayed next to the module name when clients obtain a list
164 of available modules. The default is no comment.
166 dit(bf(path)) The "path" option specifies the directory in the servers
167 filesystem to make available in this module. You must specify this option
168 for each module in tt(/etc/rsyncd.conf).
170 dit(bf(use chroot)) If "use chroot" is true, the rsync server will chroot
171 to the "path" before starting the file transfer with the client. This has
172 the advantage of extra protection against possible implementation security
173 holes, but it has the disadvantages of requiring super-user privileges and
174 of not being able to follow symbolic links outside of the new root path.
175 The default is to use chroot.
177 dit(bf(read only)) The "read only" option determines whether clients
178 will be able to upload files or not. If "read only" is true then any
179 attempted uploads will fail. If "read only" is false then uploads will
180 be possible if file permissions on the server allow them. The default
181 is for all modules to be read only.
183 dit(bf(list)) The "list" option determines if this module should be
184 listed when the client asks for a listing of available modules. By
185 setting this to false you can create hidden modules. The default is
186 for modules to be listable.
188 dit(bf(uid)) The "uid" option specifies the user name or user id that
189 file transfers to and from that module should take place as. In
190 combination with the "gid" option this determines what file
191 permissions are available. The default is the user "nobody".
193 dit(bf(gid)) The "gid" option specifies the group name or group id that
194 file transfers to and from that module should take place as. This
195 complements the "uid" option. The default is the group "nobody".
197 dit(bf(exclude)) The "exclude" option allows you to specify a space
198 separated list of patterns to add to the exclude list. This is
199 equivalent to the client specifying these patterns with the --exclude
200 option. Note that this option is not designed with strong security in
201 mind, it is quite possible that a client may find a way to bypass this
202 exclude list. If you want to absolutely ensure that certain files
203 cannot be accessed then use the uid/gid options in combination with
206 dit(bf(exclude from)) The "exclude from" option specifies a filename
207 on the server that contains exclude patterns, one per line. This is
208 equivalent to the client specifying the --exclude-from option with a
209 equivalent file. See also the note about security for the exclude
212 dit(bf(auth users)) The "auth users" option specifies a comma
213 and space separated list of usernames that will be allowed to connect
214 to this module. The usernames do not need to exist on the local
215 system. If "auth users" is set then the client will be challenged to
216 supply a username and password to connect to the module. A challenge
217 response authentication protocol is used for this exchange. The plain
218 text usernames are passwords are stored in the file specified by the
219 "secrets file" option. The default is for all users to be able to
220 connect without a password (this is called "anonymous rsync").
222 dit(bf(secrets file)) The "secrets file" option specifies the name of
223 a file that contains the username:password pairs used for
224 authenticating this module. This file is only consulted if the "auth
225 users" option is specified. The file is line based and contains
226 username:password pairs separated by a single colon. Any line starting
227 with a hash (#) is considered a comment and is skipped. The passwords
228 can contain any characters but be warned that many operating systems
229 limit the length of passwords that can be typed at the client end, so
230 you may find that passwords longer than 8 characters don't work.
232 bf(You should make sure that the secrets file is not readable by anyone
233 other than the system administrator.) There is no default for the
234 "secrets file" option, you must choose a name (such as
235 tt(/etc/rsyncd.secrets)).
237 dit(bf(hosts allow)) The "hosts allow" option allows you to specify a
238 list of patterns that are matched against a connecting clients
239 hostname and IP address. If none of the patterns match then the
240 connection is rejected.
242 Each pattern can be in one of five forms:
245 it() a dotted decimal IP address. In this case the incoming machines
246 IP address must match exactly.
248 it() a address/mask in the form a.b.c.d/n were n is the number of
249 one bits in in the netmask. All IP addresses which match the masked
250 IP address will be allowed in.
252 it() a address/mask in the form a.b.c.d/e.f.g.h where e.f.g.h is a
253 netmask in dotted decimal notation. All IP addresses which match the masked
254 IP address will be allowed in.
256 it() a hostname. The hostname as determined by a reverse lookup will
257 be matched (case insensitive) against the pattern. Only an exact
260 it() a hostname pattern using wildcards. These are matched using the
261 same rules as normal unix filename matching. If the pattern matches
262 then the client is allowed in.
265 You can also combine "hosts allow" with a separate "hosts deny"
266 option. If both options are specified then the "hosts allow" option s
267 checked first and a match results in the client being able to
268 connect. The "hosts deny" option is then checked and a match means
269 that the host is rejected. If the host does not match either the
270 "hosts allow" or the "hosts deny" patterns then it is allowed to
273 The default is no "hosts allow" option, which means all hosts can connect.
275 dit(bf(hosts deny)) The "hosts deny" option allows you to specify a
276 list of patterns that are matched against a connecting clients
277 hostname and IP address. If the pattern matches then the connection is
278 rejected. See the "hosts allow" option for more information.
280 The default is no "hosts deny" option, which means all hosts can connect.
284 manpagesection(AUTHENTICATION STRENGTH)
286 The authentication protocol used in rsync is a 128 bit MD4 based
287 challenge response system. Although I believe that no one has ever
288 demonstrated a brute-force break of this sort of system you should
289 realise that this is not a "military strength" authentication system.
290 It should be good enough for most purposes but if you want really top
291 quality security then I recommend that you run rsync over ssh.
293 Also note that the rsync server protocol does not currently provide any
294 encryption of the data that is transferred over the link. Only
295 authentication is provided. Use ssh as the transport if you want
298 Future versions of rsync may support SSL for better authentication and
299 encryption, but that is still being investigated.
301 manpagesection(EXAMPLES)
303 A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
304 tt(/home/ftp) would be:
309 comment = ftp export area
313 A more sophisticated example would be:
318 max connections = 4 nl()
319 syslog facility = local5 nl()
320 pid file = /etc/rsyncd.pid
324 comment = whole ftp area (approx 6.1 GB)
327 path = /var/ftp/pub/samba
328 comment = Samba ftp area (approx 300 MB)
331 path = /var/ftp/pub/rsync
332 comment = rsync ftp area (approx 6 MB)
335 path = /public_html/samba
336 comment = Samba WWW pages (approx 240 MB)
340 comment = CVS repository (requires authentication)
341 auth users = tridge, susan
342 secrets file = /etc/rsyncd.secrets
345 The /etc/rsyncd.secrets file would look something like this:
362 The rsync server does not send all types of error messages to the
363 client. this means a client may be mystified as to why a transfer
364 failed. The error will have been logged by syslog on the server.
366 Please report bugs! The rsync bug tracking system is online at
367 url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/)
369 manpagesection(VERSION)
370 This man page is current for version 2.0 of rsync
372 manpagesection(CREDITS)
374 rsync is distributed under the GNU public license. See the file
377 The primary ftp site for rsync is
378 url(ftp://samba.anu.edu.au/pub/rsync)(ftp://samba.anu.edu.au/pub/rsync).
380 A WEB site is available at
381 url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/)
383 We would be delighted to hear from you if you like this program.
385 This program uses the zlib compression library written by Jean-loup
386 Gailly and Mark Adler.
388 manpagesection(THANKS)
390 Thanks to Warren Stanley for his original idea and patch for the rsync
391 server. Thanks to Karsten Thygesen for his many suggestions and
396 rsync was written by Andrew Tridgell and Paul Mackerras. They may be
397 contacted via email at tridge@samba.anu.edu.au and
398 Paul.Mackerras@cs.anu.edu.au