rsyncd.conf.yo

   1 mailto(rsync-bugs@samba.anu.edu.au)
   2 manpage(rsyncd.conf)(5)(13 May 1998)()()
   3 manpagename(rsyncd.conf)(configuration file for rsync server)
   4 manpagesynopsis()
   5
   6 rsyncd.conf
   7
   8 manpagedescription()
   9
  10 The rsyncd.conf file is the runtime configuration file for rsync when
  11 run with the -daemon option. When run in this way rsync becomes a
  12 rsync server listening on TCP port 873. Connections from rsync clients
  13 are accepted for either anonymous or authenticated rsync sessions.
  14
  15 The rsyncd.conf file controls authentication, access, logging and
  16 available modules.
  17
  18 manpagesection(FILE FORMAT)
  19
  20 The file consists of modules and parameters. A module begins with the
  21 name of the module in square brackets and continues until the next
  22 module begins. Modules contain parameters of the form 'name = value'.
  23
  24 The file is line-based - that is, each newline-terminated line represents
  25 either a comment, a module name or a parameter.
  26
  27 Only the first equals sign in a parameter is significant. Whitespace before
  28 or after the first equals sign is discarded. Leading, trailing and internal
  29 whitespace in module and parameter names is irrelevant. Leading and
  30 trailing whitespace in a parameter value is discarded. Internal whitespace
  31 within a parameter value is retained verbatim.
  32
  33 Any line beginning with a hash (#) is ignored, as are lines containing
  34 only whitespace.
  35
  36 Any line ending in a \e is "continued" on the next line in the
  37 customary UNIX fashion.
  38
  39 The values following the equals sign in parameters are all either a string
  40 (no quotes needed) or a boolean, which may be given as yes/no, 0/1 or
  41 true/false. Case is not significant in boolean values, but is preserved
  42 in string values.
  43
  44 manpagesection(LAUNCHING THE RSYNC DAEMON)
  45
  46 The rsync daemon is launched by specifying the --daemon option to
  47 rsync. The daemon must run with root privileges.
  48
  49 You can launch it either via inetd or as a standalone daemon. If run
  50 as a daemon then just run the command "rsync -daemon" from a suitable
  51 startup script.
  52
  53 When run via inetd you should add a line like this to /etc/services:
  54
  55      rsync           873/tcp
  56
  57 and a line something like this to /etc/inetd.conf:
  58
  59     rsync   stream  tcp     nowait  root   /usr/bin/rsync rsyncd --daemon
  60
  61 You will then need to send inetd a HUP signal to tell it to reread its
  62 config file.
  63
  64 Note that you should not send the rsync server a HUP signal to force
  65 it to reread the /etc/rsyncd.conf. The file is re-read on each client
  66 connection.
  67
  68 manpagesection(GLOBAL OPTIONS)
  69
  70 The first parameters in the file (before a [module] header) are the
  71 global parameters.
  72
  73 You may also include any module parameters in the global part of the
  74 config file in which case the supplied value will override the
  75 default for that parameter.
  76
  77 startdit()
  78 dit(bf(motd file)) The "motd file" option allows you to specify a
  79 "message of the day" to display to clients on each connect. This
  80 usually contains site information and any legal notices. The default
  81 is no motd file.
  82
  83 dit(bf(max connections)) The "max connections" option allows you to
  84 specify the maximum number of simultaneous connections you will allow
  85 to your rsync server. Any clients connecting when the maximum has
  86 been reached will receive a message telling them to try later.
  87 The default is 0 which means no limit.
  88
  89 dit(bf(lock file)) The "lock file" option specifies the file to use to
  90 support the "max connections" option. The rsync server uses record
  91 locking on this file to ensure that the max connections limit is not
  92 exceeded. The default is /var/run/rsyncd.lock
  93
  94 dit(bf(syslog facility)) The "syslog facility" option allows you to
  95 specify the syslog facility name to use when logging messages from the
  96 rsync server. You may use any standard syslog facility name which is
  97 defined on your system. Common names are auth, authpriv, cron, daemon,
  98 ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,
  99 local1, local2, local3, local4, local5, local6 and local7. The default
 100 is daemon.
 101
 102 enddit()
 103
 104
 105 manpagesection(MODULE OPTIONS)
 106
 107 After the global options you should define a number of modules, each
 108 module exports a directory tree as a symbolic name. Modules are
 109 exported by specifying a module name in square brackets [module]
 110 followed by the options for that module.
 111
 112 startdit()
 113
 114 dit(bf(comment)) The "comment" option specifies a description string
 115 that is displayed next to the module name when clients obtain a list
 116 of available modules. The default is no comment.
 117
 118 dit(bf(path)) The "path" option specifies the directory in the servers
 119 filesystem to make available in this module. The rsync server will
 120 chroot to this path before starting the file transfer with the
 121 client. You must specify this option for each module in /etc/rsyncd.conf.
 122
 123 dit(bf(read only)) The "read only" option determines whether clients
 124 will be able to upload files or not. If "read only" is true then any
 125 attempted uploads will fail. If "read only" is false then uploads will
 126 be possible if file permissions on the server allow them. The default
 127 is for all modules to be read only.
 128
 129 dit(bf(list)) The "list" option determines if this module should be
 130 listed when the client asks for a listing of available modules. By
 131 setting this to false you can create hidden modules. The default is
 132 for modules to be listable.
 133
 134 dit(bf(uid)) The "uid" option specifies the user name or user id that
 135 file transfers to and from that module should take place as. In
 136 combination with the "gid" option this determines what file
 137 permissions are available. The default is the user "nobody".
 138
 139 dit(bf(gid)) The "gid" option specifies the group name or group id that
 140 file transfers to and from that module should take place as. This
 141 complements the "uid" option. The default is the group "nobody".
 142
 143 dit(bf(auth users)) The "auth users" option specifies a comma
 144 and space separated list of usernames that will be allowed to connect
 145 to this module. The usernames do not need to exist on the local
 146 system. If "auth users" is set then the client will be challenged to
 147 supply a username and password to connect to the module. A challenge
 148 response authentication protocol is used for this exchange. The plain
 149 text usernames are passwords are stored in the file specified by the
 150 "secrets file" option. The default is for all users to be able to
 151 connect without a password (this is called "anonymous rsync").
 152
 153 dit(bf(secrets file)) The "secrets file" option specifies the name of
 154 a file that contains the username:password pairs used for
 155 authenticating this module. This file is only consulted if the "auth
 156 users" option is specified. The file is line based and contains
 157 username:password pairs separated by a single colon. Any line starting
 158 with a hash (#) is considered a comment and is skipped. The passwords
 159 can contain any characters but be warned that many operating systems
 160 limit the length of passwords that can be typed at the client end, so
 161 you may find that passwords longer than 8 characters don't work.
 162
 163 bf(You should make sure that the secrets file is not readable by anyone
 164 other than the system administrator.) There is no default for the
 165 "secrets file" option, you must choose a name (such as
 166 /etc/rsyncd.secrets).
 167
 168 dit(bf(hosts allow)) The "hosts allow" option allows you to specify a
 169 list of patterns that are matched against a connecting clients
 170 hostname and IP address. If none of the patterns match then the
 171 connection is rejected.
 172
 173 Each pattern can be in one of five forms:
 174
 175 itemize(
 176   it() a dotted decimal IP address. In this case the incoming machines
 177   IP address must match exactly.
 178
 179   it() a address/mask in the form a.b.c.d/n were n is the number of
 180   one bits in in the netmask. All IP addresses which match the masked
 181   IP address will be allowed in.
 182
 183   it() a address/mask in the form a.b.c.d/e.f.g.h where e.f.g.h is a
 184   netmask in dotted decimal notation. All IP addresses which match the masked
 185   IP address will be allowed in.
 186
 187   it() a hostname. The hostname as determined by a reverse lookup will
 188   be matched (case insensitive) against the pattern. Only an exact
 189   match is allowed in.
 190
 191   it() a hostname pattern using wildcards. These are matched using the
 192   same rules as normal unix filename matching. If the pattern matches
 193   then the client is allowed in.
 194 )
 195
 196 You can also combine "hosts allow" with a separate "hosts deny"
 197 option. If both options are specified then the "hosts allow" option s
 198 checked first and a match results in the client being able to
 199 connect. The "hosts deny" option is then checked and a match means
 200 that the host is rejected. If the host does not match either the
 201 "hosts allow" or the "hosts deny" patterns then it is allowed to
 202 connect.
 203
 204 The default is no "hosts allow" option, which means all hosts can connect.
 205
 206 dit(bf(hosts allow)) The "hosts deny" option allows you to specify a
 207 list of patterns that are matched against a connecting clients
 208 hostname and IP address. If the pattern matches then the connection is
 209 rejected. See the "hosts allow" option for more information.
 210
 211 The default is no "hosts deny" option, which means all hosts can connect.
 212
 213 enddit()
 214
 215 manpagesection(EXAMPLES)
 216
 217 A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
 218 /home/ftp would be:
 219
 220 verb(
 221 [ftp]
 222         path = /home/ftp
 223         comment = ftp export area
 224 )
 225
 226
 227 A more sophisticated example would be:
 228
 229 verb(
 230 uid = nobody
 231 gid = nobody
 232 max connections = 4
 233 syslog facility = local5
 234
 235 [ftp]
 236         path = /var/ftp/pub
 237         comment = whole ftp area (approx 6.1 GB)
 238
 239 [sambaftp]
 240         path = /var/ftp/pub/samba
 241         comment = Samba ftp area (approx 300 MB)
 242
 243 [rsyncftp]
 244         path = /var/ftp/pub/rsync
 245         comment = rsync ftp area (approx 6 MB)
 246
 247 [sambawww]
 248         path = /public_html/samba
 249         comment = Samba WWW pages (approx 240 MB)
 250
 251 [cvs]
 252         path = /data/cvs
 253         comment = CVS repository (requires authentication)
 254         auth users = tridge, susan
 255         secrets file = /etc/rsyncd.secrets
 256 )
 257
 258 The /etc/rsyncd.secrets file would look something like this:
 259
 260 verb(
 261 tridge:mypass
 262 susan:herpass
 263 )
 264
 265 manpagefiles()
 266
 267 /etc/rsyncd.conf
 268
 269 manpageseealso()
 270
 271 rsync(1)
 272
 273 manpagediagnostics()
 274
 275 manpagebugs()
 276
 277 The rsync server does not send all types of error messages to the
 278 client. this means a client may be mystified as to why a transfer
 279 failed. The error will have been logged by syslog on the server.
 280
 281 Please report bugs! The rsync bug tracking system is online at
 282 url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/)
 283
 284 manpagesection(VERSION)
 285 This man page is current for version 2.0 of rsync
 286
 287 manpagesection(CREDITS)
 288
 289 rsync is distributed under the GNU public license.  See the file
 290 COPYING for details.
 291
 292 The primary ftp site for rsync is
 293 url(ftp://samba.anu.edu.au/pub/rsync)(ftp://samba.anu.edu.au/pub/rsync).
 294
 295 A WEB site is available at
 296 url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/)
 297
 298 We would be delighted to hear from you if you like this program.
 299
 300 This program uses the zlib compression library written by Jean-loup
 301 Gailly and Mark Adler.
 302
 303 manpagesection(THANKS)
 304
 305 Thanks to Warren Stanley for his original idea and patch for the rsync
 306 server. Thanks to Karsten Thygesen for his many suggestions and
 307 documentation!
 308
 309 manpageauthor()
 310
 311 rsync was written by Andrew Tridgell and Paul Mackerras.  They may be
 312 contacted via email at tridge@samba.anu.edu.au and
 313 Paul.Mackerras@cs.anu.edu.au
 314