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