--------------------------------------------------------------------------
dqd - dirqmail distribution - INSTALL file
Pawel Foremski <pjf@gna.org> 2004
--------------------------------------------------------------------------


1.  Required software

  - ucspi-tcp - http://cr.yp.to/ucspi-tcp/install.html

    If compilation fails, use patch from
    http://www.qmail.org/moni.csi.hu/pub/glibc-2.3.1/

  - daemontools - http://cr.yp.to/daemontools/install.html

    If compilation fails, use patch from
    http://www.qmail.org/moni.csi.hu/pub/glibc-2.3.1/

    Be sure to put it into your system's start scripts. You can use
    rc.daemontools script bundled with dqd in extra/ dir if you want.

  - GNU Bash - http://www.gnu.org/software/bash/bash.html.

  - C compiler and linker

    Preferably GCC and GNU ld, but any other should be right.

  - standard UNIX tools

    Like chown, chmod, echo, sed, test, cat, patch, useradd (or pw) etc...


2.  Optional software

  - BINC IMAP - http://www.bincimap.org/

  - stunnel 4 - http://www.stunnel.org/

  - libspf - http://www.libspf.org/


2.1. Supported software

  Some sample scripts disabled by default (like content filtering)
  supports qmail-qfilter, Clam AntiVirus and SpamAssassin.


3.  Installing dqd

  If you are ready for install proccess, run configure script found in
  dqd package. It will check your system for dependencies and
  report any problems if they occurs, then it will generate install
  script, which can be run to finally install dqd on your system.

  Note that build system supports VPATH-like builds.


3.1. The configure script

  configure has several options, but usually you should care only about
  following switches:

  * --with-me=DOMAIN

    Tells dqd the FQDN of the machine your are installing it on.

  * --with-ips=IP1[,IP2,...] and --without-ips=IP1[,IP2,...]

    qmail tries to find IP addresses of machine it is running on
    automatically by getting them from all network interfaces. However,
    if you are behind firewall and/or have some port forwarding, you
    should let it know about it by passing your additional IP addresses
    in --with-ips option. If you want some IPs to not be treated as
    local, pass them in --without-ips option.

  You can get list of all configure options by invoking it with --help
  option.

  If configure runs without any errors, it will print out a summary
  and generate the install script in the current directory. If
  everything is OK, go further.


3.2. The install script

  install script is generated by configure and it builds the whole
  system and installs it on your hard drive. During run it creates tmp
  dir in the current directory, so if you do not want to clutter your
  source code, you can cd into other, more adequate directory.

  It will add required users and groups, install qmail and checkpassword
  source (if you did not disabled it in configure), install all scripts,
  plugins and configuration files. If you have installed dqd before, and
  already have some configuration files, it will add .new extension to
  all new configuration files to prevent your old configuration from
  overwriting. However, it will overwrite all old programs and scripts.

  If you are ready, simply run the install script.


3.3. Providing a server certificate

  If you have chosen to enable SSL/TLS support (using stunnel), you will
  have to provide a server certificate and key in
  /var/qmail/control/servercert.pem file. Simply copy it there, if you
  have such, or use setup/servercert-gen script to generate self-signed
  certificate. You can see it's options by invoking it with --help
  option.

  Note: servercert.pem should be owned by qmaild:nofiles and has
        permissions set to 0640


3.4  Starting dqd

  If you are absolutely sure that your dqd is properly installed and
  configured, you can link all directories from /var/qmail/supervise/ to
  /service/ eg. by typing 'ln -s /var/qmail/supervise/* /service/'. If
  daemontools is running, dqd should be started automatically in max. 5
  seconds. Otherwise try to restart daemontools manually.

  If something goes wrong, see system logs (usually /var/log/maillog) or
  output of 'ps ax | more' (look for 'readproctitle service errors').


3.5  Useful tips

  After checking that everthing works fine, you will probably want to
  take a look at following files:

    * dqd/qfilter - content filtering, remember about memory limits
      - scan-clamav - path to clamdscan (Clam AntiVirus)
      - scan-spamc - path to spamc (SpamAssassin)

    * dqd/dlv - global .qmail commands
      - dlv-quota - cache timeout, etc

project hosted by