X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/de2fd20eb70ed8877e3d7b7bd25082e70fb4e582..5e71c4446e10c27c1db0c7e7e5b71be68f3b88de:/rsyncd.conf.yo diff --git a/rsyncd.conf.yo b/rsyncd.conf.yo index 5d805322..dae328e7 100644 --- a/rsyncd.conf.yo +++ b/rsyncd.conf.yo @@ -1,5 +1,5 @@ -mailto(rsync-bugs@samba.anu.edu.au) -manpage(rsyncd.conf)(5)(13 May 1998)()() +mailto(rsync-bugs@samba.org) +manpage(rsyncd.conf)(5)(25 Nov 1998)()() manpagename(rsyncd.conf)(configuration file for rsync server) manpagesynopsis() @@ -46,7 +46,7 @@ manpagesection(LAUNCHING THE RSYNC DAEMON) The rsync daemon is launched by specifying the --daemon option to rsync. The daemon must run with root privileges. -You can launch it either via inetd or as a standalone daemon. If run +You can launch it either via inetd or as a stand-alone daemon. If run as a daemon then just run the command "rsync --daemon" from a suitable startup script. @@ -80,16 +80,13 @@ dit(bf(motd file)) The "motd file" option allows you to specify a usually contains site information and any legal notices. The default is no motd file. -dit(bf(max connections)) The "max connections" option allows you to -specify the maximum number of simultaneous connections you will allow -to your rsync server. Any clients connecting when the maximum has -been reached will receive a message telling them to try later. -The default is 0 which means no limit. +dit(bf(log file)) The "log file" option tells the rsync daemon to log +messages to that file rather than using syslog. This is particularly +useful on systems (such as AIX) where syslog() doesn't work for +chrooted programs. -dit(bf(lock file)) The "lock file" option specifies the file to use to -support the "max connections" option. The rsync server uses record -locking on this file to ensure that the max connections limit is not -exceeded. The default is tt(/var/run/rsyncd.lock). +dit(bf(pid file)) The "pid file" option tells the rsync daemon to write +its process id to that file. dit(bf(syslog facility)) The "syslog facility" option allows you to specify the syslog facility name to use when logging messages from the @@ -123,9 +120,26 @@ that is displayed next to the module name when clients obtain a list of available modules. The default is no comment. dit(bf(path)) The "path" option specifies the directory in the servers -filesystem to make available in this module. The rsync server will -chroot to this path before starting the file transfer with the -client. You must specify this option for each module in tt(/etc/rsyncd.conf). +filesystem to make available in this module. You must specify this option +for each module in tt(/etc/rsyncd.conf). + +dit(bf(use chroot)) If "use chroot" is true, the rsync server will chroot +to the "path" before starting the file transfer with the client. This has +the advantage of extra protection against possible implementation security +holes, but it has the disadvantages of requiring super-user privileges and +of not being able to follow symbolic links outside of the new root path. +The default is to use chroot. + +dit(bf(max connections)) The "max connections" option allows you to +specify the maximum number of simultaneous connections you will allow +to this module of your rsync server. Any clients connecting when the +maximum has been reached will receive a message telling them to try +later. The default is 0 which means no limit. + +dit(bf(lock file)) The "lock file" option specifies the file to use to +support the "max connections" option. The rsync server uses record +locking on this file to ensure that the max connections limit is not +exceeded. The default is tt(/var/run/rsyncd.lock). dit(bf(read only)) The "read only" option determines whether clients will be able to upload files or not. If "read only" is true then any @@ -162,6 +176,20 @@ equivalent to the client specifying the --exclude-from option with a equivalent file. See also the note about security for the exclude option above. +dit(bf(include)) The "include" option allows you to specify a space +separated list of patterns which rsync should not exclude. This is +equivalent to the client specifying these patterns with the --include +option. This is useful as it allows you to build up quite complex +exclude/include rules. + +See the section of exclude patterns for information on the syntax of +this option. + +dit(bf(include from)) The "include from" option specifies a filename +on the server that contains include patterns, one per line. This is +equivalent to the client specifying the --include-from option with a +equivalent file. + dit(bf(auth users)) The "auth users" option specifies a comma and space separated list of usernames that will be allowed to connect to this module. The usernames do not need to exist on the local @@ -232,6 +260,67 @@ rejected. See the "hosts allow" option for more information. The default is no "hosts deny" option, which means all hosts can connect. +dit(bf(transfer logging)) The "transfer logging" option enables per-file +logging of downloads and uploads in a format somewhat similar to that +used by ftp daemons. If you want to customize the log formats look at +the log format option. + +dit(bf(log format)) The "log format" option allows you to specify the +format used for logging file transfers when transfer logging is +enabled. The format is a text string containing embedded single +character escape sequences prefixed with a percent (%) character. + +The prefixes that are understood are: + +itemize( + it() %h for the remote host name + it() %a for the remote IP address + it() %l for the length of the file in bytes + it() %p for the process id of this rsync session + it() %o for the operation, which is either "send" or "recv" + it() %f for the filename + it() %P for the module path + it() %m for the module name + it() %t for the current time + it() %u for the authenticated username (or the null string) + it() %b for the number of bytes actually transferred + it() %c when sending files this gives the number of checksum bytes + received for this file +) + +The default log format is "%o %h [%a] %m (%u) %f %l" + +A perl script called rsyncstats to summarize this format is included +in the rsync source code distribution. + +dit(bf(timeout)) The "timeout" option allows you to override the +clients choice for IO timeout for this module. Using this option you +can ensure that rsync won't wait on a dead client forever. The timeout +is specified in seconds. A value of zero means no timeout and is the +default. A good choice for anonymous rsync servers may be 600 (giving +a 10 minute timeout). + +dit(bf(refuse options)) The "refuse options" option allows you to +specify a space separated list of rsync command line options that will +be refused by your rsync server. The full names of the options must be +used (i.e., you must use "checksum" not "c" to disable checksumming). +When an option is refused, the server prints an error message and exits. +To prevent all compression, you can use "dont compress = *" (see below) +instead of "refuse options = compress" to avoid returning an error to a +client that requests compression. + +dit(bf(dont compress)) The "dont compress" option allows you to select +filenames based on wildcard patterns that should not be compressed +during transfer. Compression is expensive in terms of CPU usage so it +is usually good to not try to compress files that won't compress well, +such as already compressed files. + +The "dont compress" option takes a space separated list of +case-insensitive wildcard patterns. Any source filename matching one +of the patterns will not be compressed during transfer. + +The default setting is verb(*.gz *.tgz *.zip *.z *.rpm *.deb) + enddit() manpagesection(AUTHENTICATION STRENGTH) @@ -239,7 +328,7 @@ manpagesection(AUTHENTICATION STRENGTH) The authentication protocol used in rsync is a 128 bit MD4 based challenge response system. Although I believe that no one has ever demonstrated a brute-force break of this sort of system you should -realise that this is not a "military strength" authentication system. +realize that this is not a "military strength" authentication system. It should be good enough for most purposes but if you want really top quality security then I recommend that you run rsync over ssh. @@ -267,8 +356,10 @@ A more sophisticated example would be: uid = nobody nl() gid = nobody nl() +use chroot = no nl() max connections = 4 nl() syslog facility = local5 nl() +pid file = /etc/rsyncd.pid verb([ftp] path = /var/ftp/pub @@ -315,7 +406,7 @@ client. this means a client may be mystified as to why a transfer failed. The error will have been logged by syslog on the server. Please report bugs! The rsync bug tracking system is online at -url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/) +url(http://rsync.samba.org/)(http://rsync.samba.org/) manpagesection(VERSION) This man page is current for version 2.0 of rsync @@ -326,10 +417,10 @@ rsync is distributed under the GNU public license. See the file COPYING for details. The primary ftp site for rsync is -url(ftp://samba.anu.edu.au/pub/rsync)(ftp://samba.anu.edu.au/pub/rsync). +url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). A WEB site is available at -url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/) +url(http://rsync.samba.org/)(http://rsync.samba.org/) We would be delighted to hear from you if you like this program. @@ -345,6 +436,6 @@ documentation! manpageauthor() rsync was written by Andrew Tridgell and Paul Mackerras. They may be -contacted via email at tridge@samba.anu.edu.au and +contacted via email at tridge@samba.org and Paul.Mackerras@cs.anu.edu.au