home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / rsync221.zip / rsyncd.conf.yo < prev    next >
Text File  |  1999-03-04  |  18KB  |  442 lines
  1. mailto(rsync-bugs@samba.org)
  2. manpage(rsyncd.conf)(5)(25 Nov 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 \ 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 stand-alone 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. quote(rsync           873/tcp)
  56.  
  57. and a single line something like this to /etc/inetd.conf:
  58.     
  59. quote(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 tt(/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 tt(/var/run/rsyncd.lock).
  93.  
  94. dit(bf(log file)) The "log file" option tells the rsync daemon to log
  95. messages to that file rather than using syslog. This is particularly
  96. useful on systems (such as AIX) where syslog() doesn't work for
  97. chrooted programs.
  98.  
  99. dit(bf(pid file)) The "pid file" option tells the rsync daemon to write
  100. its process id to that file.
  101.  
  102. dit(bf(syslog facility)) The "syslog facility" option allows you to
  103. specify the syslog facility name to use when logging messages from the
  104. rsync server. You may use any standard syslog facility name which is
  105. defined on your system. Common names are auth, authpriv, cron, daemon,
  106. ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,
  107. local1, local2, local3, local4, local5, local6 and local7. The default
  108. is daemon. 
  109.  
  110. dit(bf(socket options)) This option can provide endless fun for people
  111. who like to tune their systems to the utmost degree. You can set all
  112. sorts of socket options which may make transfers faster (or
  113. slower!). Read the man page for the setsockopt() system call for
  114. details on some of the options you may be able to set. By default no
  115. special socket options are set.
  116.  
  117. enddit()
  118.  
  119.  
  120. manpagesection(MODULE OPTIONS)
  121.  
  122. After the global options you should define a number of modules, each
  123. module exports a directory tree as a symbolic name. Modules are
  124. exported by specifying a module name in square brackets [module]
  125. followed by the options for that module.
  126.  
  127. startdit()
  128.  
  129. dit(bf(comment)) The "comment" option specifies a description string
  130. that is displayed next to the module name when clients obtain a list
  131. of available modules. The default is no comment.
  132.  
  133. dit(bf(path)) The "path" option specifies the directory in the servers
  134. filesystem to make available in this module.  You must specify this option
  135. for each module in tt(/etc/rsyncd.conf).
  136.  
  137. dit(bf(use chroot)) If "use chroot" is true, the rsync server will chroot
  138. to the "path" before starting the file transfer with the client.  This has
  139. the advantage of extra protection against possible implementation security
  140. holes, but it has the disadvantages of requiring super-user privileges and
  141. of not being able to follow symbolic links outside of the new root path.
  142. The default is to use chroot.
  143.  
  144. dit(bf(read only)) The "read only" option determines whether clients
  145. will be able to upload files or not. If "read only" is true then any
  146. attempted uploads will fail. If "read only" is false then uploads will
  147. be possible if file permissions on the server allow them. The default
  148. is for all modules to be read only.
  149.  
  150. dit(bf(list)) The "list" option determines if this module should be
  151. listed when the client asks for a listing of available modules. By
  152. setting this to false you can create hidden modules. The default is
  153. for modules to be listable.
  154.  
  155. dit(bf(uid)) The "uid" option specifies the user name or user id that
  156. file transfers to and from that module should take place as. In
  157. combination with the "gid" option this determines what file
  158. permissions are available. The default is the user "nobody".
  159.  
  160. dit(bf(gid)) The "gid" option specifies the group name or group id that
  161. file transfers to and from that module should take place as. This
  162. complements the "uid" option. The default is the group "nobody".
  163.  
  164. dit(bf(exclude)) The "exclude" option allows you to specify a space
  165. separated list of patterns to add to the exclude list. This is
  166. equivalent to the client specifying these patterns with the --exclude
  167. option. Note that this option is not designed with strong security in
  168. mind, it is quite possible that a client may find a way to bypass this
  169. exclude list. If you want to absolutely ensure that certain files
  170. cannot be accessed then use the uid/gid options in combination with
  171. file permissions.
  172.  
  173. dit(bf(exclude from)) The "exclude from" option specifies a filename
  174. on the server that contains exclude patterns, one per line. This is
  175. equivalent to the client specifying the --exclude-from option with a
  176. equivalent file. See also the note about security for the exclude
  177. option above.
  178.  
  179. dit(bf(include)) The "include" option allows you to specify a space
  180. separated list of patterns which rsync should not exclude. This is
  181. equivalent to the client specifying these patterns with the --include
  182. option. This is useful as it allows you to build up quite complex
  183. exclude/include rules.
  184.  
  185. See the section of exclude patterns for information  on the syntax of
  186. this option.
  187.  
  188. dit(bf(include from)) The "include from" option specifies a filename
  189. on the server that contains include patterns, one per line. This is
  190. equivalent to the client specifying the --include-from option with a
  191. equivalent file.
  192.  
  193. dit(bf(auth users)) The "auth users" option specifies a comma
  194. and space separated list of usernames that will be allowed to connect
  195. to this module. The usernames do not need to exist on the local
  196. system. If "auth users" is set then the client will be challenged to
  197. supply a username and password to connect to the module. A challenge
  198. response authentication protocol is used for this exchange. The plain
  199. text usernames are passwords are stored in the file specified by the
  200. "secrets file" option. The default is for all users to be able to
  201. connect without a password (this is called "anonymous rsync").
  202.  
  203. dit(bf(secrets file)) The "secrets file" option specifies the name of
  204. a file that contains the username:password pairs used for
  205. authenticating this module. This file is only consulted if the "auth
  206. users" option is specified. The file is line based and contains
  207. username:password pairs separated by a single colon. Any line starting
  208. with a hash (#) is considered a comment and is skipped. The passwords
  209. can contain any characters but be warned that many operating systems
  210. limit the length of passwords that can be typed at the client end, so
  211. you may find that passwords longer than 8 characters don't work. 
  212.  
  213. bf(You should make sure that the secrets file is not readable by anyone
  214. other than the system administrator.) There is no default for the
  215. "secrets file" option, you must choose a name (such as
  216. tt(/etc/rsyncd.secrets)).
  217.  
  218. dit(bf(hosts allow)) The "hosts allow" option allows you to specify a
  219. list of patterns that are matched against a connecting clients
  220. hostname and IP address. If none of the patterns match then the
  221. connection is rejected.
  222.  
  223. Each pattern can be in one of five forms:
  224.  
  225. itemize(
  226.   it() a dotted decimal IP address. In this case the incoming machines
  227.   IP address must match exactly.
  228.  
  229.   it() a address/mask in the form a.b.c.d/n were n is the number of
  230.   one bits in in the netmask. All IP addresses which match the masked
  231.   IP address will be allowed in.
  232.  
  233.   it() a address/mask in the form a.b.c.d/e.f.g.h where e.f.g.h is a
  234.   netmask in dotted decimal notation. All IP addresses which match the masked
  235.   IP address will be allowed in.
  236.  
  237.   it() a hostname. The hostname as determined by a reverse lookup will
  238.   be matched (case insensitive) against the pattern. Only an exact
  239.   match is allowed in.
  240.  
  241.   it() a hostname pattern using wildcards. These are matched using the
  242.   same rules as normal unix filename matching. If the pattern matches
  243.   then the client is allowed in.
  244. )
  245.  
  246. You can also combine "hosts allow" with a separate "hosts deny"
  247. option. If both options are specified then the "hosts allow" option s
  248. checked first and a match results in the client being able to
  249. connect. The "hosts deny" option is then checked and a match means
  250. that the host is rejected. If the host does not match either the 
  251. "hosts allow" or the "hosts deny" patterns then it is allowed to
  252. connect.
  253.  
  254. The default is no "hosts allow" option, which means all hosts can connect.
  255.  
  256. dit(bf(hosts deny)) The "hosts deny" option allows you to specify a
  257. list of patterns that are matched against a connecting clients
  258. hostname and IP address. If the pattern matches then the connection is
  259. rejected. See the "hosts allow" option for more information.
  260.  
  261. The default is no "hosts deny" option, which means all hosts can connect.
  262.  
  263. dit(bf(transfer logging)) The "transfer logging" option enables per-file 
  264. logging of downloads and uploads in a format somewhat similar to that
  265. used by ftp daemons. If you want to customize the log formats look at
  266. the log format option.
  267.  
  268. dit(bf(log format)) The "log format" option allows you to specify the
  269. format used for logging file transfers when transfer logging is
  270. enabled. The format is a text string containing embedded single
  271. character escape sequences prefixed with a percent (%) character.
  272.  
  273. The prefixes that are understood are:
  274.  
  275. itemize(
  276.   it() %h for the remote host name
  277.   it() %a for the remote IP address
  278.   it() %l for the length of the file in bytes
  279.   it() %p for the process id of this rsync session
  280.   it() %o for the operation, which is either "send" or "recv"
  281.   it() %f for the filename
  282.   it() %P for the module path
  283.   it() %m for the module name
  284.   it() %t for the current time
  285.   it() %u for the authenticated username (or the null string)
  286.   it() %b for the number of bytes actually transferred 
  287.   it() %c when sending files this gives the number of checksum bytes
  288.     received for this file
  289. )
  290.  
  291. The default log format is "%o %h [%a] %m (%u) %f %l"
  292.  
  293. A perl script called rsyncstats to summarize this format is included
  294. in the rsync source code distribution.
  295.  
  296. dit(bf(timeout)) The "timeout" option allows you to override the
  297. clients choice for IO timeout for this module. Using this option you
  298. can ensure that rsync won't wait on a dead client forever. The timeout
  299. is specified in seconds. A value of zero means no timeout and is the
  300. default. A good choice for anonymous rsync servers may be 600 (giving
  301. a 10 minute timeout).
  302.  
  303. dit(bf(refuse options)) The "refuse options" option allows you to
  304. specify a space separated list of rsync command line options that will
  305. be refused by your rsync server.  The full names of the options must be
  306. used (i.e., you must use "checksum" not "c" to disable checksumming).  
  307. When an option is refused, the server prints an error message and exits.
  308. To prevent all compression, you can use "dont compress = *" (see below)
  309. instead of "refuse options = compress" to avoid returning an error to a
  310. client that requests compression.
  311.  
  312. dit(bf(dont compress)) The "dont compress" option allows you to select
  313. filenames based on wildcard patterns that should not be compressed
  314. during transfer. Compression is expensive in terms of CPU usage so it
  315. is usually good to not try to compress files that won't compress well,
  316. such as already compressed files. 
  317.  
  318. The "dont compress" option takes a space separated list of
  319. case-insensitive wildcard patterns. Any source filename matching one
  320. of the patterns will not be compressed during transfer.
  321.  
  322. The default setting is verb(*.gz *.tgz *.zip *.z *.rpm *.deb)
  323.  
  324. enddit()
  325.  
  326. manpagesection(AUTHENTICATION STRENGTH)
  327.  
  328. The authentication protocol used in rsync is a 128 bit MD4 based
  329. challenge response system. Although I believe that no one has ever
  330. demonstrated a brute-force break of this sort of system you should
  331. realize that this is not a "military strength" authentication system.
  332. It should be good enough for most purposes but if you want really top
  333. quality security then I recommend that you run rsync over ssh.
  334.  
  335. Also note that the rsync server protocol does not currently provide any
  336. encryption of the data that is transferred over the link. Only
  337. authentication is provided. Use ssh as the transport if you want
  338. encryption.
  339.  
  340. Future versions of rsync may support SSL for better authentication and
  341. encryption, but that is still being investigated.
  342.  
  343. manpagesection(EXAMPLES)
  344.  
  345. A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
  346. tt(/home/ftp) would be:
  347.  
  348. verb(
  349. [ftp]
  350.         path = /home/ftp
  351.         comment = ftp export area
  352. )
  353.  
  354.  
  355. A more sophisticated example would be:
  356.  
  357. uid = nobody nl()
  358. gid = nobody nl()
  359. use chroot = no nl()
  360. max connections = 4 nl()
  361. syslog facility = local5 nl()
  362. pid file = /etc/rsyncd.pid
  363.  
  364. verb([ftp]
  365.         path = /var/ftp/pub
  366.         comment = whole ftp area (approx 6.1 GB)
  367.  
  368. [sambaftp]
  369.         path = /var/ftp/pub/samba
  370.         comment = Samba ftp area (approx 300 MB)
  371.  
  372. [rsyncftp]
  373.         path = /var/ftp/pub/rsync
  374.         comment = rsync ftp area (approx 6 MB)
  375.         
  376. [sambawww]
  377.         path = /public_html/samba
  378.         comment = Samba WWW pages (approx 240 MB)
  379.  
  380. [cvs]
  381.         path = /data/cvs
  382.         comment = CVS repository (requires authentication)
  383.         auth users = tridge, susan
  384.         secrets file = /etc/rsyncd.secrets
  385. )
  386.  
  387. The /etc/rsyncd.secrets file would look something like this:
  388.  
  389. tridge:mypass nl()
  390. susan:herpass
  391.  
  392. manpagefiles()
  393.  
  394. /etc/rsyncd.conf
  395.  
  396. manpageseealso()
  397.  
  398. rsync(1)
  399.  
  400. manpagediagnostics()
  401.  
  402. manpagebugs()
  403.  
  404. The rsync server does not send all types of error messages to the
  405. client. this means a client may be mystified as to why a transfer
  406. failed. The error will have been logged by syslog on the server.
  407.  
  408. Please report bugs! The rsync bug tracking system is online at
  409. url(http://rsync.samba.org/)(http://rsync.samba.org/)
  410.  
  411. manpagesection(VERSION)
  412. This man page is current for version 2.0 of rsync
  413.  
  414. manpagesection(CREDITS)
  415.  
  416. rsync is distributed under the GNU public license.  See the file
  417. COPYING for details.
  418.  
  419. The primary ftp site for rsync is
  420. url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
  421.  
  422. A WEB site is available at
  423. url(http://rsync.samba.org/)(http://rsync.samba.org/)
  424.  
  425. We would be delighted to hear from you if you like this program.
  426.  
  427. This program uses the zlib compression library written by Jean-loup
  428. Gailly and Mark Adler.
  429.  
  430. manpagesection(THANKS)
  431.  
  432. Thanks to Warren Stanley for his original idea and patch for the rsync
  433. server. Thanks to Karsten Thygesen for his many suggestions and
  434. documentation! 
  435.  
  436. manpageauthor()
  437.  
  438. rsync was written by Andrew Tridgell and Paul Mackerras.  They may be
  439. contacted via email at tridge@samba.org and
  440. Paul.Mackerras@cs.anu.edu.au
  441.  
  442.