view release on metacpan or  search on metacpan

doc/toaster-watcher.conf  view on Meta::CPAN

    blank. The password will be set to whatever is used the first time the
    user logs in. Very helpful for migrating domains from other servers, but
    please consider the security implications.

      vpopmail_default_domain        = 0

    If you have just one domain you can set it with this option. The default
    domain users can authenticate with just their user name, and don't need
    to use <user>@<virtualdomain>. It is advised to not set this. Should you
    need to migrate your users to a new mail system in the future, you can
    bet the new system will support full email address authentications. If
    not, you'll be going through the pain of getting all your users to
    adjust their mail settings.

      vpopmail_roaming_users         = 1
      vpopmail_relay_clear_minutes   = 180

    The "roaming users" setting enables POP-before-SMTP and IMAP-before-SMTP
    authentication. If this is enabled, then relay clear minutes determines
    how long users can send mail after they've checked mail.

      vpopmail_mysql                 = 1

    Should Vpopmail use MySQL for authentication? This is highly
    recommended. Should you ever need to scale your system to more than one
    CPU, MySQL lets you use replication to split the load among a cluster of
    servers.

      vpopmail_mysql_limits          = 0

    Should Vpopmail use MySQL for limits? This is handy, but it is a
    relatively new feature of vpopmail. If you are upgrading an existing
    toaster, you'll need to copy all of your existing domains into the MySQL
    limits table before enabling this feature. As of 5.4.0, you can enable
    default limits for all domains via ~vpopmail/etc/vlimits.default.

      vpopmail_mysql_replication     = 0
      vpopmail_mysql_logging         = 0
      vpopmail_mysql_repl_master     = db.example.com
      vpopmail_mysql_repl_slave      = localhost

    Important: If you are not using replication, put in the name of your
    master database server as BOTH the master and the slave.

      vpopmail_mysql_database        = vpopmail
      vpopmail_mysql_user            = vpopmail
      vpopmail_mysql_pass            = supersecretword

    Important: Replace "supersecretword" with the correct password for your
    database server.

      vpopmail_auth_logging          = 1
      vpopmail_logging               = 1
      vpopmail_logging_verbose       = 1
      vpopmail_valias                = 1
      vpopmail_qmail_ext             = 1
      vpopmail_rebuild_tcpserver_file = 0

    By default, vpopmail updates ~vpopmail/etc/tcp.smtp every time a new
    user is added to the relay table, which is every time a user
    successfully authenticates. This generates a lot of disk i/o on a busy
    mail seerver but is necessary for tcpserver to "see" the update. This is
    not necessary with the Mail::Toaster because we use the MySQL patch to
    tcpserver to check the SQL table directly.

      vpopmail_ip_alias_domains      = 0

    If IP alias domains is turned on, and the user does not supply a domain
    as part of their login, then a reverse IP lookup is done on the server
    IP address that the client connected to. If the servers IP address
    resolves to a domain name, then vpopmail uses that name as the domain.

    IP w.x.y.z resolves to test.com. User sets their pop server ip to
    w.x.y.z and connects. Vpopmail gets the connection, checks the IP of the
    SERVER side of the connection. Does a reverse IP lookup and obtains
    test.com. User sends joe as their pop user name. Vpopmail uses test.com
    as the domain.

    You can mix and match name and ip based virtual domains. You can also
    use the vipmap utility to skip the reverse DNS lookup (or if reverse DNS
    is not set up for the IP address).

      vpopmail_etc_passwd            = 0

    This enables local logins-- accounts which are listed in /etc/passwd--
    to receive and check mail.

    If you enable this feature, you'll need to add a few lines to
    /etc/pam.conf to allow courier-imap to work with /etc/passwd accounts.
    See http://www.inter7.com/courierimap/INSTALL.html for details.

      vpopmail_domain_quotas         = 0
      vpopmail_default_quota         = 100000000S,10000C

    The domain quota feature has been broken on vpopmail almost forever.
    Even when it worked, it introduced extremely high CPU loads on busy mail
    systems. It is to be avoided.

    The default quota option is deprecated in vpopmail 5.4.0 and higher. See
    ~vpopmail/etc/vlimits.default to control default limits.

      vpopmail_disable_many_domains  = 0

      filtering_spamassassin_method  = site   # site | user | domain

    Please see the Toaster FAQ for instructions on enabling per-user and
    per-domain SpamAssassin preferences.

      filtering_method  = smtp   # smtp | tcpserver

    Mail scanners such as qmail-scanner, qscanc, and simscan are run by
    setting the QMAILQUEUE environment variable. This can be done either in
    the SMTP service run file (see the qmail_queue setting), or in the
    tcp.smtp file. "smtp" chooses the run file and affects ALL connections
    to the server; "tcpserver" chooses the tcp.smtp file and lets you choose
    which IP addresses (or blocks) use your scanner.

    When set to tcpserver, toaster_watcher.pl ignores: smtpd_qmail_queue,
    submit_qmail_queue

      filtering_maildrop_filter_file     = /usr/local/etc/mail/mailfilter

    The maildrop filter file for your site. You should not changes this
    setting.

      filtering_report_spam_spamassassin = 1
      filtering_report_spam_pyzor        = 0          # don't enable this with report_spamassassin

    You can have your mail server report spam messages via spamassassin -r
    or to the pyzor servers. Since the spamassassin reporting includes
    pyzor, if you choose it, disable pyzor reporting.

      filtering_debug                    = 1

    Enable maildrop debugging to be written to /var/log/mail/maildrop.log

      #######################################
      #           qmail-send                #
      #######################################

      send_log_method                = multilog

    You have several choices for qmail-send logging:

    syslog - logs to syslog (normally /var/log/maillog on FreeBSD). This is
    generally not recommended, but it may be handy for sendmail refugees.
    multilog - logs via multilog to the location specified under "Qmail
    Settings." - This is required for maillogs & RRDutil, and is the
    recommended logging method for qmail and the toaster.
    debug - enables full debugging, records entire SMTP converation (and
    also logs via multilog).
    stats - only logs stats lines (via multilog).
    disabled - silently discards all logs

      send_log_maxsize_bytes         = 1000000

    It's important to make sure maxsize_bytes is larger than 5 minutes of
    logging. You can determine this by checking the size of the files in
    /var/log/mail/send. If any approach this file size, raise it. By
    default, toaster-watcher will trigger maillogs every 5 minutes, updating
    your mail message counters.

      send_log_isoqlog               = 1

    This allows you to choose whether your qmail-send logs will be
    post-processed by isoqlog. This will trigger isoqlog every 5 minutes at
    which time it'll update the pretty HTML pages it generates. This is a
    handy default but if you have a really busy mail server (see if isoqlog
    takes more than a couple seconds to run) with lots of logs, it's better
    to disable this and run isoqlog from cron less frequently.

      send_mailbox_string            = ./Maildir/

    This allows you to change your default delivery location. Most toasters
    will not change this. For a good explanation of other qmail delivery
    options, see http://www.lifewithqmail.org/

      #######################################
      #           qmail-smtpd               #
      #######################################

      smtpd_listen_on_address         = all     # all, a hostname, or IP
      smtpd_listen_on_port            = smtp    # smtp or a port number

    On which address and port should the toaster listen for smtp
    connections?

    For the port number, "smtp" means port 25 (as defined by /etc/services).

      smtpd_hostname                  = system

    Where should the toaster get the hostname to be reported by the SMTP
    service?

    system - will set to the systems hostname (as set in /etc/rc.conf) qmail
    - will set to contents of qmail/control/me Anything else is considered
    to be a hostname.

      # smtpd_hostname [ system | qmail | mail.example.com ]
      #
      #  system - will set to the systems hostname
      #  qmail  - will set to contents of qmail/control/me
      #  other  - anything else is considered to be a hostname
      ##

      smtpd_max_memory_per_connection = 25      # in megabytes
      smtpd_max_connections           = 50
      smtpd_max_memory                = 256

    smptd_max_memory_per_connection sets the maximum amount of RAM for any
    particular SMTP connection (this is enforced by "softlimit"). If you are
    running clamav, and SpamAssassin, it's very possible that 25 megabytes
    per connection may not be enough. This is a VERY important setting,
    because softlimit/qmail will start deferring (soft-bouncing) mail if the
    smtpd processes use more memory than allowed in this value.

    If smtpd_max_connections is exceeded, further connections are deferred.
    (For those familiar with "Life With Qmail", this replaces the
    "concurrencyincoming" file).

    smtpd_max_memory should be set to smtpd_max_connections multiplied by
    smtpd_max_memory_per_connection.

    Suppose your machine has 1024MB of RAM. It's primarily a mail exchanger,
    so you want to allow SMTP processes to use 750MB of your RAM, leaving
    just a touch over 256MB for other processes. You set your
    smtpd_max_memory to 750.