#
# GLOBAL OPTIONS
#

# The first parameters in the file (before a [module] header) are the global parameters.
#
# You may also include any module parameters in the global part of the config file in which
# case the supplied value will override the default for that parameter.
#
#motd file
# The "motd file" option allows you to specify a "message of the day" to display to
# clients on each connect. This usually contains site information and any legal notices.
# The default is no motd file.

#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.

#pid file
# The "pid file" option tells the rsync daemon to write its process id to that file.

#syslog facility
# The "syslog facility" option allows you to specify the syslog facility name to use
# when logging messages from the rsync server. You may use any standard syslog facility
# name which is defined on your system. Common names are auth, authpriv, cron, daemon,
# ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0, local1, local2,
# local3, local4, local5, local6 and local7. The default is ftp.

#socket options
# This option can provide endless fun for people who like to tune their systems to the
# utmost degree. You can set all sorts of socket options which may make transfers faster
# (or slower!). Read the man page for the setsockopt() system call for details on some
# of the options you may be able to set. By default no special socket options are set.

#
# MODULE OPTIONS
#

# After the global options you should define a number of modules, each module exports a
# directory tree as a symbolic name. Modules are exported by specifying a module name in
# square brackets [module] followed by the options for that module.

#comment
# The "comment" option specifies a description string that is displayed next to the module
# name when clients obtain a list of available modules. The default is no comment.

#path
# The "path" option specifies the directory in the servers filesystem to make available
# in this module. You must specify this option for each module in /etc/rsyncd.conf.

#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 when reading. For writing when "use chroot" is false, for security reasons
# symlinks may only be relative paths pointing to other files within the root path,
# and leading slashes are removed from absolute paths. The default for "use chroot" is
# true.

#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.

#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 /var/run/rsyncd.lock.

#read only
# The "read only" option determines whether clients will be able to upload files or not.
# If "read only" is true then any attempted uploads will fail. If "read only" is false
# then uploads will be possible if file permissions on the server allow them. The
# default is for all modules to be read only.

#list
# The "list" option determines if this module should be listed when the client asks for
# a listing of available modules. By setting this to false you can create hidden modules.
# The default is for modules to be listable.

#uid
# The "uid" option specifies the user name or user id that file transfers to and from
# that module should take place as when the daemon was run as root. In combination with
# the "gid" option this determines what file permissions are available. The default is
# the user "rsyncd".

#gid
# The "gid" option specifies the group name or group id that file transfers to and from
# that module should take place as when the daemon was run as root. This complements the
# "uid" option. The default is the group "rsyncd".

#exclude
# The "exclude" option allows you to specify a space separated list of patterns to add
# to the exclude list. This is equivalent to the client specifying these patterns with
# the --exclude option except that the exclude list is not passed to the client and thus
# only apply on the server. Only one "exclude" option may be specified, but you can use
# "-" and "+" before patterns to specify exclude/include.
#
# Note: that this option is not designed with strong security in mind, it is quite
# possible that a client may find a way to bypass this exclude list. If you want to
# absolutely ensure that certain files cannot be accessed then use the uid/gid options
# in combination with file permissions.

#exclude from
# The "exclude from" option specifies a filename on the server that contains exclude
# patterns, one per line. This is equivalent to the client specifying the --exclude-from
# option with a equivalent file except that the resulting exclude patterns are not
# passed to the client and thus only apply on the server. See also the note about
# security for the exclude option above.

#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. Only one "include" option may be specified, but you can use
# "+" and "-" before patterns to switch include/exclude.
#
# See the section of exclude patterns in the rsync man page for information on the
# syntax of this option.

#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.

#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 system. If "auth users" is set then the client will be challenged to supply a
# username and password to connect to the module. A challenge response authentication
# protocol is used for this exchange. The plain text usernames are passwords are stored
# in the file specified by the "secrets file" option. The default is for all users to be
# able to connect without a password (this is called "anonymous rsync").

#secrets file
# The "secrets file" option specifies the name of a file that contains the
# username:password pairs used for authenticating this module. This file is only consulted
# if the "auth users" option is specified. The file is line based and contains
# username:password pairs separated by a single colon. Any line starting with a hash (#) is
# considered a comment and is skipped. The passwords can contain any characters but be
# warned that many operating systems limit the length of passwords that can be typed at
# the client end, so you may find that passwords longer than 8 characters don't work.
#
# There is no default for the "secrets file" option, you must choose a name (such as
# /etc/rsyncd.secrets).

#strict modes
# The "strict modes" option determines whether or not the permissions on the secrets
# file will be checked. If "strict modes" is true, then the secrets file must not be
# readable by any user id other than the one that the rsync daemon is running under. If
# "strict modes" is false, the check is not performed. The default is true. This
# option was added to accommodate rsync running on the Windows operating system.

#hosts allow
# The "hosts allow" option allows you to specify a list of patterns that are matched
# against a connecting clients hostname and IP address. If none of the patterns match
# then the connection is rejected.
#
# See rsyncd.conf(5) for details.
#
# The default is no "hosts allow" option, which means all hosts can connect.

#hosts deny
# The "hosts deny" option allows you to specify a list of patterns that are matched
# against a connecting clients hostname and IP address. If the pattern matches then the
# connection is rejected. See the "hosts allow" option for more information.
#
# The default is no "hosts deny" option, which means all hosts can connect.

#ignore errors
# The "ignore errors" option tells rsyncd to ignore IO errors on the server when deciding
# whether to run the delete phase of the transfer. Normally rsync skips the --delete
# step if any IO errors have occurred in order to prevent disasterous deletion due to a
# temporary resource shortage or other IO error. In some cases this test is counter
# productive so you can use this option to turn off this behaviour.

#ignore nonreadable
# This tells the rsync server to completely ignore files that are not readable by the
# user. This is useful for public archives that may have some non-readable files among
# the directories, and the sysadmin doesn't want those files to be seen at all.
# This options is enabled by default.

#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.

#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.
#
# See rsyncd.conf(5) for details.

#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). Default value is 60 (one minute).

#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.

#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: *.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz