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