Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
4cb6197b | 2 | manpage(rsyncd.conf)(5)(1 Mar 2008)()() |
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 |
306847ea WD |
88 | its process ID to that file. If the file already exists, the rsync |
89 | daemon will abort rather than overwrite the file. | |
37863201 | 90 | |
f7112154 WD |
91 | dit(bf(port)) You can override the default port the daemon will listen on |
92 | by specifying this value (defaults to 873). This is ignored if the daemon | |
93 | is being run by inetd, and is superseded by the bf(--port) command-line option. | |
94 | ||
95 | dit(bf(address)) You can override the default IP address the daemon | |
96 | will listen on by specifying this value. This is ignored if the daemon is | |
97 | being run by inetd, and is superseded by the bf(--address) command-line option. | |
98 | ||
a6801c39 AT |
99 | dit(bf(socket options)) This option can provide endless fun for people |
100 | who like to tune their systems to the utmost degree. You can set all | |
101 | sorts of socket options which may make transfers faster (or | |
19826af5 | 102 | slower!). Read the man page for the code(setsockopt()) system call for |
a6801c39 | 103 | details on some of the options you may be able to set. By default no |
5fe3c86f WD |
104 | special socket options are set. These settings are superseded by the |
105 | bf(--sockopts) command-line option. | |
a6801c39 | 106 | |
41059f75 AT |
107 | enddit() |
108 | ||
109 | ||
110 | manpagesection(MODULE OPTIONS) | |
111 | ||
112 | After the global options you should define a number of modules, each | |
113 | module exports a directory tree as a symbolic name. Modules are | |
114 | exported by specifying a module name in square brackets [module] | |
115 | followed by the options for that module. | |
ec8637f3 WD |
116 | The module name cannot contain a slash or a closing square bracket. If the |
117 | name contains whitespace, each internal sequence of whitespace will be | |
118 | changed into a single space, while leading or trailing whitespace will be | |
119 | discarded. | |
41059f75 AT |
120 | |
121 | startdit() | |
122 | ||
123 | dit(bf(comment)) The "comment" option specifies a description string | |
124 | that is displayed next to the module name when clients obtain a list | |
125 | of available modules. The default is no comment. | |
126 | ||
d90338ce | 127 | dit(bf(path)) The "path" option specifies the directory in the daemon's |
8638dd48 | 128 | filesystem to make available in this module. You must specify this option |
30e8c8e1 | 129 | for each module in tt(rsyncd.conf). |
8638dd48 | 130 | |
d90338ce | 131 | dit(bf(use chroot)) If "use chroot" is true, the rsync daemon will chroot |
8638dd48 DD |
132 | to the "path" before starting the file transfer with the client. This has |
133 | the advantage of extra protection against possible implementation security | |
f97c2d4a | 134 | holes, but it has the disadvantages of requiring super-user privileges, |
1a7f3d99 | 135 | of not being able to follow symbolic links that are either absolute or outside |
0b52f94d WD |
136 | of the new root path, and of complicating the preservation of users and groups |
137 | by name (see below). | |
2fe1feea WD |
138 | |
139 | As an additional safety feature, you can specify a dot-dir in the module's | |
140 | "path" to indicate the point where the chroot should occur. This allows rsync | |
141 | to run in a chroot with a non-"/" path for the top of the transfer hierarchy. | |
142 | Doing this guards against unintended library loading (since those absolute | |
143 | paths will not be inside the transfer hierarchy unless you have used an unwise | |
144 | pathname), and lets you setup libraries for the chroot that are outside of the | |
145 | transfer. For example, specifying "/var/rsync/./module1" will chroot to the | |
146 | "/var/rsync" directory and set the inside-chroot path to "/module1". If you | |
147 | had omitted the dot-dir, the chroot would have used the whole path, and the | |
148 | inside-chroot path would have been "/". | |
149 | ||
150 | When "use chroot" is false or the inside-chroot path is not "/", rsync will: | |
151 | (1) munge symlinks by | |
9585b276 WD |
152 | default for security reasons (see "munge symlinks" for a way to turn this |
153 | off, but only if you trust your users), (2) substitute leading slashes in | |
154 | absolute paths with the module's path (so that options such as | |
155 | bf(--backup-dir), bf(--compare-dest), etc. interpret an absolute path as | |
156 | rooted in the module's "path" dir), and (3) trim ".." path elements from | |
2fe1feea | 157 | args if rsync believes they would escape the module hierarchy. |
9585b276 WD |
158 | The default for "use chroot" is true, and is the safer choice (especially |
159 | if the module is not read-only). | |
41059f75 | 160 | |
0b52f94d WD |
161 | When this option is enabled, rsync will not attempt to map users and groups |
162 | by name (by default), but instead copy IDs as though bf(--numeric-ids) had | |
163 | been specified. In order to enable name-mapping, rsync needs to be able to | |
d99b4ccf | 164 | use the standard library functions for looking up names and IDs (i.e. |
0b52f94d WD |
165 | code(getpwuid()), code(getgrgid()), code(getpwname()), and code(getgrnam())). |
166 | This means the rsync | |
167 | process in the chroot hierarchy will need to have access to the resources | |
d99b4ccf | 168 | used by these library functions (traditionally /etc/passwd and |
0b52f94d WD |
169 | /etc/group, but perhaps additional dynamic libraries as well). |
170 | ||
171 | If you copy the necessary resources into the module's chroot area, you | |
172 | should protect them through your OS's normal user/group or ACL settings (to | |
173 | prevent the rsync module's user from being able to change them), and then | |
174 | hide them from the user's view via "exclude" (see how in the discussion of | |
175 | that option). At that point it will be safe to enable the mapping of users | |
176 | and groups by name using the "numeric ids" daemon option (see below). | |
177 | ||
178 | Note also that you are free to setup custom user/group information in the | |
179 | chroot area that is different from your normal system. For example, you | |
180 | could abbreviate the list of users and groups. | |
181 | ||
182 | dit(bf(numeric ids)) Enabling the "numeric ids" option disables the mapping | |
183 | of users and groups by name for the current daemon module. This prevents | |
184 | the daemon from trying to load any user/group-related files or libraries. | |
185 | Enabling this option makes the transfer behave as if the client had passed | |
186 | the bf(--numeric-ids) command-line option. By default, this parameter is | |
187 | enabled for chroot modules and disabled for non-chroot modules. | |
188 | ||
189 | A chroot-enabled module should not have this option enabled unless you've | |
190 | taken steps to ensure that the module has the necessary resources it needs | |
191 | to translate names, and that it is not possible for a user to change those | |
192 | resources. | |
cb290916 | 193 | |
9585b276 WD |
194 | dit(bf(munge symlinks)) The "munge symlinks" option tells rsync to modify |
195 | all incoming symlinks in a way that makes them unusable but recoverable | |
196 | (see below). This should help protect your files from user trickery when | |
197 | your daemon module is writable. The default is disabled when "use chroot" | |
2fe1feea | 198 | is on and the inside-chroot path is "/", otherwise it is enabled. |
9585b276 WD |
199 | |
200 | If you disable this option on a daemon that is not read-only, there | |
201 | are tricks that a user can play with uploaded symlinks to access | |
202 | daemon-excluded items (if your module has any), and, if "use chroot" | |
203 | is off, rsync can even be tricked into showing or changing data that | |
204 | is outside the module's path (as access-permissions allow). | |
205 | ||
206 | The way rsync disables the use of symlinks is to prefix each one with | |
207 | the string "/rsyncd-munged/". This prevents the links from being used | |
208 | as long as that directory does not exist. When this option is enabled, | |
209 | rsync will refuse to run if that path is a directory or a symlink to | |
2fe1feea WD |
210 | a directory. When using the "munge symlinks" option in a chroot area |
211 | that has an inside-chroot path of "/", you should add "/rsyncd-munged/" | |
212 | to the exclude setting for the module so that | |
5288be3a | 213 | a user can't try to create it. |
9585b276 WD |
214 | |
215 | Note: rsync makes no attempt to verify that any pre-existing symlinks in | |
216 | the hierarchy are as safe as you want them to be. If you setup an rsync | |
217 | daemon on a new area or locally add symlinks, you can manually protect your | |
218 | symlinks from being abused by prefixing "/rsyncd-munged/" to the start of | |
219 | every symlink's value. There is a perl script in the support directory | |
220 | of the source code named "munge-symlinks" that can be used to add or remove | |
221 | this prefix from your symlinks. | |
222 | ||
2fe1feea WD |
223 | When this option is disabled on a writable module and "use chroot" is off |
224 | (or the inside-chroot path is not "/"), | |
ef3f14e6 WD |
225 | incoming symlinks will be modified to drop a leading slash and to remove ".." |
226 | path elements that rsync believes will allow a symlink to escape the module's | |
227 | hierarchy. There are tricky ways to work around this, though, so you had | |
228 | better trust your users if you choose this combination of options. | |
229 | ||
0b52f94d WD |
230 | dit(bf(charset)) This specifies the name of the character set in which the |
231 | module's filenames are stored. If the client uses an bf(--iconv) option, | |
232 | the daemon will use the value of the "charset" parameter regardless of the | |
233 | character set the client actually passed. This allows the daemon to | |
234 | support charset conversion in a chroot module without extra files in the | |
235 | chroot area, and also ensures that name-translation is done in a consistent | |
236 | manner. If the "charset" parameter is not set, the bf(--iconv) option is | |
237 | refused, just as if "iconv" had been specified via "refuse options". | |
238 | ||
239 | If you wish to force users to always use bf(--iconv) for a particular | |
240 | module, add "no-iconv" to the "refuse options" parameter. Keep in mind | |
241 | that this will restrict access to your module to very new rsync clients. | |
242 | ||
5e71c444 | 243 | dit(bf(max connections)) The "max connections" option allows you to |
9ef1cc7c DD |
244 | specify the maximum number of simultaneous connections you will allow. |
245 | Any clients connecting when the maximum has been reached will receive a | |
3170b209 WD |
246 | message telling them to try later. The default is 0, which means no limit. |
247 | A negative value disables the module. | |
9ef1cc7c | 248 | See also the "lock file" option. |
5e71c444 | 249 | |
ccd2966d WD |
250 | dit(bf(log file)) When the "log file" option is set to a non-empty |
251 | string, the rsync daemon will log messages to the indicated file rather | |
252 | than using syslog. This is particularly useful on systems (such as AIX) | |
253 | where code(syslog()) doesn't work for chrooted programs. The file is | |
254 | opened before code(chroot()) is called, allowing it to be placed outside | |
255 | the transfer. If this value is set on a per-module basis instead of | |
256 | globally, the global log will still contain any authorization failures | |
257 | or config-file error messages. | |
258 | ||
259 | If the daemon fails to open to specified file, it will fall back to | |
260 | using syslog and output an error about the failure. (Note that the | |
261 | failure to open the specified log file used to be a fatal error.) | |
262 | ||
263 | dit(bf(syslog facility)) The "syslog facility" option allows you to | |
264 | specify the syslog facility name to use when logging messages from the | |
265 | rsync daemon. You may use any standard syslog facility name which is | |
266 | defined on your system. Common names are auth, authpriv, cron, daemon, | |
267 | ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0, | |
268 | local1, local2, local3, local4, local5, local6 and local7. The default | |
269 | is daemon. This setting has no effect if the "log file" setting is a | |
270 | non-empty string (either set in the per-modules settings, or inherited | |
271 | from the global settings). | |
272 | ||
21611119 WD |
273 | dit(bf(max verbosity)) The "max verbosity" option allows you to control |
274 | the maximum amount of verbose information that you'll allow the daemon to | |
275 | generate (since the information goes into the log file). The default is 1, | |
276 | which allows the client to request one level of verbosity. | |
277 | ||
5e71c444 | 278 | dit(bf(lock file)) The "lock file" option specifies the file to use to |
d90338ce | 279 | support the "max connections" option. The rsync daemon uses record |
5e71c444 | 280 | locking on this file to ensure that the max connections limit is not |
f97c2d4a | 281 | exceeded for the modules sharing the lock file. |
9ef1cc7c | 282 | The default is tt(/var/run/rsyncd.lock). |
5e71c444 | 283 | |
41059f75 AT |
284 | dit(bf(read only)) The "read only" option determines whether clients |
285 | will be able to upload files or not. If "read only" is true then any | |
286 | attempted uploads will fail. If "read only" is false then uploads will | |
d90338ce | 287 | be possible if file permissions on the daemon side allow them. The default |
41059f75 AT |
288 | is for all modules to be read only. |
289 | ||
7a92ded3 WD |
290 | dit(bf(write only)) The "write only" option determines whether clients |
291 | will be able to download files or not. If "write only" is true then any | |
292 | attempted downloads will fail. If "write only" is false then downloads | |
d90338ce | 293 | will be possible if file permissions on the daemon side allow them. The |
7a92ded3 WD |
294 | default is for this option to be disabled. |
295 | ||
41059f75 AT |
296 | dit(bf(list)) The "list" option determines if this module should be |
297 | listed when the client asks for a listing of available modules. By | |
298 | setting this to false you can create hidden modules. The default is | |
299 | for modules to be listable. | |
300 | ||
58811a0a | 301 | dit(bf(uid)) The "uid" option specifies the user name or user ID that |
716baed7 DD |
302 | file transfers to and from that module should take place as when the daemon |
303 | was run as root. In combination with the "gid" option this determines what | |
2af27ad9 MP |
304 | file permissions are available. The default is uid -2, which is normally |
305 | the user "nobody". | |
41059f75 | 306 | |
58811a0a | 307 | dit(bf(gid)) The "gid" option specifies the group name or group ID that |
716baed7 | 308 | file transfers to and from that module should take place as when the daemon |
2af27ad9 MP |
309 | was run as root. This complements the "uid" option. The default is gid -2, |
310 | which is normally the group "nobody". | |
41059f75 | 311 | |
9439c0cb WD |
312 | dit(bf(fake super)) Setting "fake super = yes" for a module causes the |
313 | daemon side to behave as if the bf(--fake-user) command-line option had | |
314 | been specified. This allows the full attributes of a file to be stored | |
315 | without having to have the daemon actually running as root. | |
316 | ||
f28bf7f4 WD |
317 | dit(bf(filter)) The daemon has its own filter chain that determines what files |
318 | it will let the client access. This chain is not sent to the client and is | |
319 | independent of any filters the client may have specified. Files excluded by | |
320 | the daemon filter chain (bf(daemon-excluded) files) are treated as non-existent | |
321 | if the client tries to pull them, are skipped with an error message if the | |
322 | client tries to push them (triggering exit code 23), and are never deleted from | |
323 | the module. You can use daemon filters to prevent clients from downloading or | |
324 | tampering with private administrative files, such as files you may add to | |
325 | support uid/gid name translations. Only one "filter" parameter can apply to a | |
326 | given module in the config file, so put all the rules you want in a single | |
327 | parameter. | |
328 | ||
329 | The daemon filter chain is built from the "filter", "include from", "include", | |
330 | "exclude from", and "exclude" parameters, in that order of priority. Anchored | |
331 | patterns are anchored at the root of the module. To prevent access to an | |
332 | entire subtree, for example, "/secret", you em(must) exclude everything in the | |
333 | subtree; the easiest way to do this is with a triple-star pattern like | |
334 | "/secret/***". | |
335 | ||
336 | The "filter" parameter takes a space-separated list of daemon filter rules, | |
337 | though it is smart enough to know not to split a token at an internal space in | |
338 | a rule (e.g. "- /foo - /bar" is parsed as two rules). You may specify one or | |
339 | more merge-file rules using the normal syntax. Note that per-directory | |
340 | merge-file rules do not provide as much protection as global rules, but they | |
341 | can be used to make bf(--delete) work better during a client download operation | |
342 | if the per-dir merge files are included in the transfer and the client requests | |
343 | that they be used. | |
344 | ||
345 | dit(bf(exclude)) The "exclude" parameter takes a space-separated list of daemon | |
346 | exclude patterns. As with the client bf(--exclude) option, patterns can be | |
347 | qualified with "- " or "+ " to explicitly indicate exclude/include. Only one | |
348 | "exclude" parameter can apply to a given module. See the "filter" parameter | |
349 | for a description of how excluded files affect the daemon. | |
350 | ||
351 | dit(bf(include)) Use an "include" to override the effects of the "exclude" | |
352 | parameter. Only one "include" parameter can apply to a given module. See the | |
353 | "filter" parameter for a description of how excluded files affect the daemon. | |
354 | ||
355 | dit(bf(exclude from)) The "exclude from" parameter specifies the name of a file | |
356 | on the daemon that contains daemon exclude patterns, one per line. Only one | |
357 | "exclude from" parameter can apply to a given module; if you have multiple | |
358 | exclude-from files, you can specify them as a merge file in the "filter" | |
359 | parameter. See the "filter" parameter for a description of how excluded files | |
360 | affect the daemon. | |
361 | ||
362 | dit(bf(include from)) Analogue of "exclude from" for a file of daemon include | |
363 | patterns. Only one "include from" parameter can apply to a given module. See | |
364 | the "filter" parameter for a description of how excluded files affect the | |
365 | daemon. | |
cd64343a | 366 | |
c094d932 WD |
367 | dit(bf(incoming chmod)) This option allows you to specify a set of |
368 | comma-separated chmod strings that will affect the permissions of all | |
369 | incoming files (files that are being received by the daemon). These | |
44a8e86d WD |
370 | changes happen after all other permission calculations, and this will |
371 | even override destination-default and/or existing permissions when the | |
372 | client does not specify bf(--perms). | |
fa3e4a05 WD |
373 | See the description of the bf(--chmod) rsync option and the bf(chmod)(1) |
374 | manpage for information on the format of this string. | |
c094d932 WD |
375 | |
376 | dit(bf(outgoing chmod)) This option allows you to specify a set of | |
377 | comma-separated chmod strings that will affect the permissions of all | |
378 | outgoing files (files that are being sent out from the daemon). These | |
379 | changes happen first, making the sent permissions appear to be different | |
2243a935 WD |
380 | than those stored in the filesystem itself. For instance, you could |
381 | disable group write permissions on the server while having it appear to | |
382 | be on to the clients. | |
fa3e4a05 WD |
383 | See the description of the bf(--chmod) rsync option and the bf(chmod)(1) |
384 | manpage for information on the format of this string. | |
17af842d | 385 | |
5d78a102 | 386 | dit(bf(auth users)) The "auth users" option specifies a comma and |
553f9375 | 387 | space-separated list of usernames that will be allowed to connect to |
5d78a102 AT |
388 | this module. The usernames do not need to exist on the local |
389 | system. The usernames may also contain shell wildcard characters. If | |
390 | "auth users" is set then the client will be challenged to supply a | |
391 | username and password to connect to the module. A challenge response | |
392 | authentication protocol is used for this exchange. The plain text | |
9aacb4df | 393 | usernames and passwords are stored in the file specified by the |
41059f75 AT |
394 | "secrets file" option. The default is for all users to be able to |
395 | connect without a password (this is called "anonymous rsync"). | |
396 | ||
d90338ce | 397 | See also the "CONNECTING TO AN RSYNC DAEMON OVER A REMOTE SHELL |
19826af5 | 398 | PROGRAM" section in bf(rsync)(1) for information on how handle an |
bef49340 | 399 | rsyncd.conf-level username that differs from the remote-shell-level |
d90338ce | 400 | username when using a remote shell to connect to an rsync daemon. |
bef49340 | 401 | |
41059f75 AT |
402 | dit(bf(secrets file)) The "secrets file" option specifies the name of |
403 | a file that contains the username:password pairs used for | |
404 | authenticating this module. This file is only consulted if the "auth | |
405 | users" option is specified. The file is line based and contains | |
406 | username:password pairs separated by a single colon. Any line starting | |
407 | with a hash (#) is considered a comment and is skipped. The passwords | |
408 | can contain any characters but be warned that many operating systems | |
409 | limit the length of passwords that can be typed at the client end, so | |
f97c2d4a | 410 | you may find that passwords longer than 8 characters don't work. |
41059f75 | 411 | |
3ca8e68f | 412 | There is no default for the "secrets file" option, you must choose a name |
205c27ac DD |
413 | (such as tt(/etc/rsyncd.secrets)). The file must normally not be readable |
414 | by "other"; see "strict modes". | |
3ca8e68f | 415 | |
f97c2d4a | 416 | dit(bf(strict modes)) The "strict modes" option determines whether or not |
3ca8e68f | 417 | the permissions on the secrets file will be checked. If "strict modes" is |
58811a0a | 418 | true, then the secrets file must not be readable by any user ID other |
3ca8e68f DD |
419 | than the one that the rsync daemon is running under. If "strict modes" is |
420 | false, the check is not performed. The default is true. This option | |
421 | was added to accommodate rsync running on the Windows operating system. | |
41059f75 AT |
422 | |
423 | dit(bf(hosts allow)) The "hosts allow" option allows you to specify a | |
424 | list of patterns that are matched against a connecting clients | |
425 | hostname and IP address. If none of the patterns match then the | |
426 | connection is rejected. | |
427 | ||
428 | Each pattern can be in one of five forms: | |
429 | ||
b8a6dae0 | 430 | quote(itemization( |
61ca7d59 DD |
431 | it() a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address |
432 | of the form a:b:c::d:e:f. In this case the incoming machine's IP address | |
bc2b4963 | 433 | must match exactly. |
61ca7d59 DD |
434 | it() an address/mask in the form ipaddr/n where ipaddr is the IP address |
435 | and n is the number of one bits in the netmask. All IP addresses which | |
436 | match the masked IP address will be allowed in. | |
61ca7d59 DD |
437 | it() an address/mask in the form ipaddr/maskaddr where ipaddr is the |
438 | IP address and maskaddr is the netmask in dotted decimal notation for IPv4, | |
439 | or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP | |
440 | addresses which match the masked IP address will be allowed in. | |
41059f75 | 441 | it() a hostname. The hostname as determined by a reverse lookup will |
5315b793 | 442 | be matched (case insensitive) against the pattern. Only an exact |
41059f75 | 443 | match is allowed in. |
41059f75 AT |
444 | it() a hostname pattern using wildcards. These are matched using the |
445 | same rules as normal unix filename matching. If the pattern matches | |
5315b793 | 446 | then the client is allowed in. |
faa82484 | 447 | )) |
41059f75 | 448 | |
61ca7d59 DD |
449 | Note IPv6 link-local addresses can have a scope in the address specification: |
450 | ||
faa82484 WD |
451 | quote( |
452 | tt( fe80::1%link1)nl() | |
453 | tt( fe80::%link1/64)nl() | |
454 | tt( fe80::%link1/ffff:ffff:ffff:ffff::)nl() | |
455 | ) | |
61ca7d59 | 456 | |
41059f75 | 457 | You can also combine "hosts allow" with a separate "hosts deny" |
df476bfc | 458 | option. If both options are specified then the "hosts allow" option is |
5315b793 | 459 | checked first and a match results in the client being able to |
41059f75 | 460 | connect. The "hosts deny" option is then checked and a match means |
f97c2d4a | 461 | that the host is rejected. If the host does not match either the |
41059f75 AT |
462 | "hosts allow" or the "hosts deny" patterns then it is allowed to |
463 | connect. | |
464 | ||
465 | The default is no "hosts allow" option, which means all hosts can connect. | |
466 | ||
de2fd20e | 467 | dit(bf(hosts deny)) The "hosts deny" option allows you to specify a |
41059f75 AT |
468 | list of patterns that are matched against a connecting clients |
469 | hostname and IP address. If the pattern matches then the connection is | |
470 | rejected. See the "hosts allow" option for more information. | |
471 | ||
472 | The default is no "hosts deny" option, which means all hosts can connect. | |
473 | ||
cda2ae84 | 474 | dit(bf(ignore errors)) The "ignore errors" option tells rsyncd to |
d90338ce | 475 | ignore I/O errors on the daemon when deciding whether to run the delete |
faa82484 | 476 | phase of the transfer. Normally rsync skips the bf(--delete) step if any |
ae283632 | 477 | I/O errors have occurred in order to prevent disastrous deletion due |
58811a0a | 478 | to a temporary resource shortage or other I/O error. In some cases this |
cda2ae84 | 479 | test is counter productive so you can use this option to turn off this |
f97c2d4a | 480 | behavior. |
cda2ae84 | 481 | |
d90338ce | 482 | dit(bf(ignore nonreadable)) This tells the rsync daemon to completely |
78043d19 AT |
483 | ignore files that are not readable by the user. This is useful for |
484 | public archives that may have some non-readable files among the | |
485 | directories, and the sysadmin doesn't want those files to be seen at all. | |
486 | ||
f97c2d4a | 487 | dit(bf(transfer logging)) The "transfer logging" option enables per-file |
81791cfc | 488 | logging of downloads and uploads in a format somewhat similar to that |
d90338ce | 489 | used by ftp daemons. The daemon always logs the transfer at the end, so |
3b2bebbf WD |
490 | if a transfer is aborted, no mention will be made in the log file. |
491 | ||
492 | If you want to customize the log lines, see the "log format" option. | |
81791cfc AT |
493 | |
494 | dit(bf(log format)) The "log format" option allows you to specify the | |
9e453674 WD |
495 | format used for logging file transfers when transfer logging is enabled. |
496 | The format is a text string containing embedded single-character escape | |
80a24d52 WD |
497 | sequences prefixed with a percent (%) character. An optional numeric |
498 | field width may also be specified between the percent and the escape | |
0abe148f | 499 | letter (e.g. "bf(%-50n %8l %07p)"). |
81791cfc | 500 | |
9e453674 WD |
501 | The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] " |
502 | is always prefixed when using the "log file" option. | |
503 | (A perl script that will summarize this default log format is included | |
504 | in the rsync source code distribution in the "support" subdirectory: | |
505 | rsyncstats.) | |
506 | ||
507 | The single-character escapes that are understood are as follows: | |
81791cfc | 508 | |
b8a6dae0 | 509 | quote(itemization( |
aca5500a | 510 | it() %a the remote IP address |
f97c2d4a | 511 | it() %b the number of bytes actually transferred |
aca5500a WD |
512 | it() %B the permission bits of the file (e.g. rwxrwxrwt) |
513 | it() %c the checksum bytes received for this file (only when sending) | |
514 | it() %f the filename (long form on sender; no trailing "/") | |
515 | it() %G the gid of the file (decimal) or "DEFAULT" | |
516 | it() %h the remote host name | |
527a010f | 517 | it() %i an itemized list of what is being updated |
aca5500a WD |
518 | it() %l the length of the file in bytes |
519 | it() %L the string " -> SYMLINK", " => HARDLINK", or "" (where bf(SYMLINK) or bf(HARDLINK) is a filename) | |
520 | it() %m the module name | |
521 | it() %M the last-modified time of the file | |
522 | it() %n the filename (short form; trailing "/" on dir) | |
523 | it() %o the operation, which is "send", "recv", or "del." (the latter includes the trailing period) | |
524 | it() %p the process ID of this rsync session | |
525 | it() %P the module path | |
526 | it() %t the current date time | |
527 | it() %u the authenticated username or an empty string | |
528 | it() %U the uid of the file (decimal) | |
faa82484 | 529 | )) |
81791cfc | 530 | |
9e453674 WD |
531 | For a list of what the characters mean that are output by "%i", see the |
532 | bf(--itemize-changes) option in the rsync manpage. | |
527a010f | 533 | |
9e453674 | 534 | Note that some of the logged output changes when talking with older |
80a24d52 | 535 | rsync versions. For instance, deleted files were only output as verbose |
8ebdc972 | 536 | messages prior to rsync 2.6.4. |
a85a1514 | 537 | |
81791cfc | 538 | dit(bf(timeout)) The "timeout" option allows you to override the |
58811a0a | 539 | clients choice for I/O timeout for this module. Using this option you |
81791cfc AT |
540 | can ensure that rsync won't wait on a dead client forever. The timeout |
541 | is specified in seconds. A value of zero means no timeout and is the | |
d90338ce | 542 | default. A good choice for anonymous rsync daemons may be 600 (giving |
81791cfc AT |
543 | a 10 minute timeout). |
544 | ||
cd8185f2 | 545 | dit(bf(refuse options)) The "refuse options" option allows you to |
553f9375 | 546 | specify a space-separated list of rsync command line options that will |
d90338ce | 547 | be refused by your rsync daemon. |
1cb0a3ed WD |
548 | You may specify the full option name, its one-letter abbreviation, or a |
549 | wild-card string that matches multiple options. | |
9eef8f0b WD |
550 | For example, this would refuse bf(--checksum) (bf(-c)) and all the various |
551 | delete options: | |
1cb0a3ed | 552 | |
9eef8f0b WD |
553 | quote(tt( refuse options = c delete)) |
554 | ||
555 | The reason the above refuses all delete options is that the options imply | |
556 | bf(--delete), and implied options are refused just like explicit options. | |
e1636830 | 557 | As an additional safety feature, the refusal of "delete" also refuses |
0b52f94d | 558 | bf(remove-source-files) when the daemon is the sender; if you want the latter |
e1636830 | 559 | without the former, instead refuse "delete-*" -- that refuses all the |
0b52f94d | 560 | delete modes without affecting bf(--remove-source-files). |
1cb0a3ed | 561 | |
d90338ce | 562 | When an option is refused, the daemon prints an error message and exits. |
f97c2d4a WD |
563 | To prevent all compression when serving files, |
564 | you can use "dont compress = *" (see below) | |
63f0774f DD |
565 | instead of "refuse options = compress" to avoid returning an error to a |
566 | client that requests compression. | |
cd8185f2 | 567 | |
83fff1aa AT |
568 | dit(bf(dont compress)) The "dont compress" option allows you to select |
569 | filenames based on wildcard patterns that should not be compressed | |
f97c2d4a WD |
570 | when pulling files from the daemon (no analogous option exists to |
571 | govern the pushing of files to a daemon). | |
572 | Compression is expensive in terms of CPU usage, so it | |
83fff1aa | 573 | is usually good to not try to compress files that won't compress well, |
f97c2d4a | 574 | such as already compressed files. |
83fff1aa | 575 | |
553f9375 | 576 | The "dont compress" option takes a space-separated list of |
83fff1aa AT |
577 | case-insensitive wildcard patterns. Any source filename matching one |
578 | of the patterns will not be compressed during transfer. | |
579 | ||
34ca58d4 WD |
580 | See the bf(--skip-compress) option in the bf(rsync)(1) manpage for the list |
581 | of file suffixes that are not compressed by default. Specifying a value | |
0b52f94d | 582 | for the "dont compress" option changes the default when the daemon is |
34ca58d4 | 583 | the sender. |
83fff1aa | 584 | |
c20936b8 WD |
585 | dit(bf(pre-xfer exec), bf(post-xfer exec)) You may specify a command to be run |
586 | before and/or after the transfer. If the bf(pre-xfer exec) command fails, the | |
587 | transfer is aborted before it begins. | |
588 | ||
37439b36 WD |
589 | The following environment variables will be set, though some are |
590 | specific to the pre-xfer or the post-xfer environment: | |
c20936b8 | 591 | |
b8a6dae0 | 592 | quote(itemization( |
c20936b8 WD |
593 | it() bf(RSYNC_MODULE_NAME): The name of the module being accessed. |
594 | it() bf(RSYNC_MODULE_PATH): The path configured for the module. | |
595 | it() bf(RSYNC_HOST_ADDR): The accessing host's IP address. | |
596 | it() bf(RSYNC_HOST_NAME): The accessing host's name. | |
597 | it() bf(RSYNC_USER_NAME): The accessing user's name (empty if no user). | |
a739128d | 598 | it() bf(RSYNC_PID): A unique number for this transfer. |
37439b36 WD |
599 | it() bf(RSYNC_REQUEST): (pre-xfer only) The module/path info specified |
600 | by the user (note that the user can specify multiple source files, | |
601 | so the request can be something like "mod/path1 mod/path2", etc.). | |
70e98a43 | 602 | it() bf(RSYNC_ARG#): (pre-xfer only) The pre-request arguments are set |
fddf529d WD |
603 | in these numbered values. RSYNC_ARG0 is always "rsyncd", and the last |
604 | value contains a single period. | |
a6333519 WD |
605 | it() bf(RSYNC_EXIT_STATUS): (post-xfer only) the server side's exit value. |
606 | This will be 0 for a successful run, a positive value for an error that the | |
607 | server generated, or a -1 if rsync failed to exit properly. Note that an | |
608 | error that occurs on the client side does not currently get sent to the | |
609 | server side, so this is not the final exit status for the whole transfer. | |
19826af5 | 610 | it() bf(RSYNC_RAW_STATUS): (post-xfer only) the raw exit value from code(waitpid()). |
c20936b8 WD |
611 | )) |
612 | ||
613 | Even though the commands can be associated with a particular module, they | |
614 | are run using the permissions of the user that started the daemon (not the | |
37439b36 | 615 | module's uid/gid setting) without any chroot restrictions. |
c20936b8 | 616 | |
41059f75 AT |
617 | enddit() |
618 | ||
4c3d16be AT |
619 | manpagesection(AUTHENTICATION STRENGTH) |
620 | ||
621 | The authentication protocol used in rsync is a 128 bit MD4 based | |
2b7e1292 WD |
622 | challenge response system. This is fairly weak protection, though (with |
623 | at least one brute-force hash-finding algorithm publicly available), so | |
624 | if you want really top-quality security, then I recommend that you run | |
625 | rsync over ssh. (Yes, a future version of rsync will switch over to a | |
626 | stronger hashing method.) | |
4c3d16be | 627 | |
d90338ce | 628 | Also note that the rsync daemon protocol does not currently provide any |
f39281ae | 629 | encryption of the data that is transferred over the connection. Only |
4c3d16be AT |
630 | authentication is provided. Use ssh as the transport if you want |
631 | encryption. | |
632 | ||
633 | Future versions of rsync may support SSL for better authentication and | |
634 | encryption, but that is still being investigated. | |
635 | ||
41059f75 AT |
636 | manpagesection(EXAMPLES) |
637 | ||
638 | A simple rsyncd.conf file that allow anonymous rsync to a ftp area at | |
e22de162 | 639 | tt(/home/ftp) would be: |
41059f75 AT |
640 | |
641 | verb( | |
642 | [ftp] | |
e22de162 AT |
643 | path = /home/ftp |
644 | comment = ftp export area | |
41059f75 AT |
645 | ) |
646 | ||
41059f75 AT |
647 | A more sophisticated example would be: |
648 | ||
faa82484 WD |
649 | verb( |
650 | uid = nobody | |
651 | gid = nobody | |
2fe1feea | 652 | use chroot = yes |
faa82484 WD |
653 | max connections = 4 |
654 | syslog facility = local5 | |
0f621785 | 655 | pid file = /var/run/rsyncd.pid |
41059f75 | 656 | |
faa82484 | 657 | [ftp] |
2fe1feea | 658 | path = /var/ftp/./pub |
41059f75 AT |
659 | comment = whole ftp area (approx 6.1 GB) |
660 | ||
661 | [sambaftp] | |
2fe1feea | 662 | path = /var/ftp/./pub/samba |
41059f75 AT |
663 | comment = Samba ftp area (approx 300 MB) |
664 | ||
665 | [rsyncftp] | |
2fe1feea | 666 | path = /var/ftp/./pub/rsync |
41059f75 | 667 | comment = rsync ftp area (approx 6 MB) |
f97c2d4a | 668 | |
41059f75 AT |
669 | [sambawww] |
670 | path = /public_html/samba | |
671 | comment = Samba WWW pages (approx 240 MB) | |
672 | ||
673 | [cvs] | |
674 | path = /data/cvs | |
675 | comment = CVS repository (requires authentication) | |
676 | auth users = tridge, susan | |
677 | secrets file = /etc/rsyncd.secrets | |
678 | ) | |
679 | ||
680 | The /etc/rsyncd.secrets file would look something like this: | |
681 | ||
faa82484 WD |
682 | quote( |
683 | tt(tridge:mypass)nl() | |
684 | tt(susan:herpass)nl() | |
685 | ) | |
41059f75 AT |
686 | |
687 | manpagefiles() | |
688 | ||
30e8c8e1 | 689 | /etc/rsyncd.conf or rsyncd.conf |
41059f75 AT |
690 | |
691 | manpageseealso() | |
692 | ||
b8a6dae0 | 693 | bf(rsync)(1) |
41059f75 AT |
694 | |
695 | manpagediagnostics() | |
696 | ||
697 | manpagebugs() | |
698 | ||
41059f75 | 699 | Please report bugs! The rsync bug tracking system is online at |
9e3c856a | 700 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
41059f75 AT |
701 | |
702 | manpagesection(VERSION) | |
d90338ce | 703 | |
4cb6197b | 704 | This man page is current for version 3.0.0 of rsync. |
41059f75 AT |
705 | |
706 | manpagesection(CREDITS) | |
707 | ||
708 | rsync is distributed under the GNU public license. See the file | |
709 | COPYING for details. | |
710 | ||
711 | The primary ftp site for rsync is | |
9e3c856a | 712 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). |
41059f75 AT |
713 | |
714 | A WEB site is available at | |
9e3c856a | 715 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
41059f75 AT |
716 | |
717 | We would be delighted to hear from you if you like this program. | |
718 | ||
719 | This program uses the zlib compression library written by Jean-loup | |
720 | Gailly and Mark Adler. | |
721 | ||
722 | manpagesection(THANKS) | |
723 | ||
724 | Thanks to Warren Stanley for his original idea and patch for the rsync | |
d90338ce | 725 | daemon. Thanks to Karsten Thygesen for his many suggestions and |
f97c2d4a | 726 | documentation! |
41059f75 AT |
727 | |
728 | manpageauthor() | |
729 | ||
ae283632 WD |
730 | rsync was written by Andrew Tridgell and Paul Mackerras. |
731 | Many people have later contributed to it. | |
41059f75 | 732 | |
ae283632 | 733 | Mailing lists for support and development are available at |
f97c2d4a | 734 | url(http://lists.samba.org)(lists.samba.org) |