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(syslog facility)) The "syslog facility" option allows you to
95 specify the syslog facility name to use when logging messages from the
96 rsync server. You may use any standard syslog facility name which is
97 defined on your system. Common names are auth, authpriv, cron, daemon,
98 ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,
99 local1, local2, local3, local4, local5, local6 and local7. The default
102 dit(bf(socket options)) This option can provide endless fun for people
103 who like to tune their systems to the utmost degree. You can set all
104 sorts of socket options which may make transfers faster (or
105 slower!). Read the man page for the setsockopt() system call for
106 details on some of the options you may be able to set. By default no
107 special socket options are set.
112 manpagesection(MODULE OPTIONS)
114 After the global options you should define a number of modules, each
115 module exports a directory tree as a symbolic name. Modules are
116 exported by specifying a module name in square brackets [module]
117 followed by the options for that module.
121 dit(bf(comment)) The "comment" option specifies a description string
122 that is displayed next to the module name when clients obtain a list
123 of available modules. The default is no comment.
125 dit(bf(path)) The "path" option specifies the directory in the servers
126 filesystem to make available in this module. The rsync server will
127 chroot to this path before starting the file transfer with the
128 client. You must specify this option for each module in tt(/etc/rsyncd.conf).
130 dit(bf(read only)) The "read only" option determines whether clients
131 will be able to upload files or not. If "read only" is true then any
132 attempted uploads will fail. If "read only" is false then uploads will
133 be possible if file permissions on the server allow them. The default
134 is for all modules to be read only.
136 dit(bf(list)) The "list" option determines if this module should be
137 listed when the client asks for a listing of available modules. By
138 setting this to false you can create hidden modules. The default is
139 for modules to be listable.
141 dit(bf(uid)) The "uid" option specifies the user name or user id that
142 file transfers to and from that module should take place as. In
143 combination with the "gid" option this determines what file
144 permissions are available. The default is the user "nobody".
146 dit(bf(gid)) The "gid" option specifies the group name or group id that
147 file transfers to and from that module should take place as. This
148 complements the "uid" option. The default is the group "nobody".
150 dit(bf(exclude)) The "exclude" option allows you to specify a space
151 separated list of patterns to add to the exclude list. This is
152 equivalent to the client specifying these patterns with the --exclude
153 option. Note that this option is not designed with strong security in
154 mind, it is quite possible that a client may find a way to bypass this
155 exclude list. If you want to absolutely ensure that certain files
156 cannot be accessed then use the uid/gid options in combination with
159 dit(bf(exclude from)) The "exclude from" option specifies a filename
160 on the server that contains exclude patterns, one per line. This is
161 equivalent to the client specifying the --exclude-from option with a
162 equivalent file. See also the note about security for the exclude
165 dit(bf(auth users)) The "auth users" option specifies a comma
166 and space separated list of usernames that will be allowed to connect
167 to this module. The usernames do not need to exist on the local
168 system. If "auth users" is set then the client will be challenged to
169 supply a username and password to connect to the module. A challenge
170 response authentication protocol is used for this exchange. The plain
171 text usernames are passwords are stored in the file specified by the
172 "secrets file" option. The default is for all users to be able to
173 connect without a password (this is called "anonymous rsync").
175 dit(bf(secrets file)) The "secrets file" option specifies the name of
176 a file that contains the username:password pairs used for
177 authenticating this module. This file is only consulted if the "auth
178 users" option is specified. The file is line based and contains
179 username:password pairs separated by a single colon. Any line starting
180 with a hash (#) is considered a comment and is skipped. The passwords
181 can contain any characters but be warned that many operating systems
182 limit the length of passwords that can be typed at the client end, so
183 you may find that passwords longer than 8 characters don't work.
185 bf(You should make sure that the secrets file is not readable by anyone
186 other than the system administrator.) There is no default for the
187 "secrets file" option, you must choose a name (such as
188 tt(/etc/rsyncd.secrets)).
190 dit(bf(hosts allow)) The "hosts allow" option allows you to specify a
191 list of patterns that are matched against a connecting clients
192 hostname and IP address. If none of the patterns match then the
193 connection is rejected.
195 Each pattern can be in one of five forms:
198 it() a dotted decimal IP address. In this case the incoming machines
199 IP address must match exactly.
201 it() a address/mask in the form a.b.c.d/n were n is the number of
202 one bits in in the netmask. All IP addresses which match the masked
203 IP address will be allowed in.
205 it() a address/mask in the form a.b.c.d/e.f.g.h where e.f.g.h is a
206 netmask in dotted decimal notation. All IP addresses which match the masked
207 IP address will be allowed in.
209 it() a hostname. The hostname as determined by a reverse lookup will
210 be matched (case insensitive) against the pattern. Only an exact
213 it() a hostname pattern using wildcards. These are matched using the
214 same rules as normal unix filename matching. If the pattern matches
215 then the client is allowed in.
218 You can also combine "hosts allow" with a separate "hosts deny"
219 option. If both options are specified then the "hosts allow" option s
220 checked first and a match results in the client being able to
221 connect. The "hosts deny" option is then checked and a match means
222 that the host is rejected. If the host does not match either the
223 "hosts allow" or the "hosts deny" patterns then it is allowed to
226 The default is no "hosts allow" option, which means all hosts can connect.
228 dit(bf(hosts deny)) The "hosts deny" option allows you to specify a
229 list of patterns that are matched against a connecting clients
230 hostname and IP address. If the pattern matches then the connection is
231 rejected. See the "hosts allow" option for more information.
233 The default is no "hosts deny" option, which means all hosts can connect.
237 manpagesection(AUTHENTICATION STRENGTH)
239 The authentication protocol used in rsync is a 128 bit MD4 based
240 challenge response system. Although I believe that no one has ever
241 demonstrated a brute-force break of this sort of system you should
242 realise that this is not a "military strength" authentication system.
243 It should be good enough for most purposes but if you want really top
244 quality security then I recommend that you run rsync over ssh.
246 Also note that the rsync server protocol does not currently provide any
247 encryption of the data that is transferred over the link. Only
248 authentication is provided. Use ssh as the transport if you want
251 Future versions of rsync may support SSL for better authentication and
252 encryption, but that is still being investigated.
254 manpagesection(EXAMPLES)
256 A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
257 tt(/home/ftp) would be:
262 comment = ftp export area
266 A more sophisticated example would be:
270 max connections = 4 nl()
271 syslog facility = local5 nl()
275 comment = whole ftp area (approx 6.1 GB)
278 path = /var/ftp/pub/samba
279 comment = Samba ftp area (approx 300 MB)
282 path = /var/ftp/pub/rsync
283 comment = rsync ftp area (approx 6 MB)
286 path = /public_html/samba
287 comment = Samba WWW pages (approx 240 MB)
291 comment = CVS repository (requires authentication)
292 auth users = tridge, susan
293 secrets file = /etc/rsyncd.secrets
296 The /etc/rsyncd.secrets file would look something like this:
313 The rsync server does not send all types of error messages to the
314 client. this means a client may be mystified as to why a transfer
315 failed. The error will have been logged by syslog on the server.
317 Please report bugs! The rsync bug tracking system is online at
318 url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/)
320 manpagesection(VERSION)
321 This man page is current for version 2.0 of rsync
323 manpagesection(CREDITS)
325 rsync is distributed under the GNU public license. See the file
328 The primary ftp site for rsync is
329 url(ftp://samba.anu.edu.au/pub/rsync)(ftp://samba.anu.edu.au/pub/rsync).
331 A WEB site is available at
332 url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/)
334 We would be delighted to hear from you if you like this program.
336 This program uses the zlib compression library written by Jean-loup
337 Gailly and Mark Adler.
339 manpagesection(THANKS)
341 Thanks to Warren Stanley for his original idea and patch for the rsync
342 server. Thanks to Karsten Thygesen for his many suggestions and
347 rsync was written by Andrew Tridgell and Paul Mackerras. They may be
348 contacted via email at tridge@samba.anu.edu.au and
349 Paul.Mackerras@cs.anu.edu.au