1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/INSTALL	Fri Sep 26 17:05:23 2008 +0200
     1.3 @@ -0,0 +1,135 @@
     1.4 +simple installation instructions, see docs/install.html for more.
     1.5 +
     1.6 +To compile MasqMail you need glib 1.2 (http://www.gtk.org).
     1.7 +
     1.8 +You need a user and a group for masqmail to run, I suggest user
     1.9 +'mail' and group 'trusted'. Say:
    1.10 +
    1.11 +groupadd -g 42 trusted
    1.12 +useradd -u 42 -g 42 -d / -s /bin/sh -c "Mail Transfer Agent" mail
    1.13 +
    1.14 +If you use other names than 'mail' and 'trusted' use the options
    1.15 +described below for configure. The 42 is just a suggestion, you can
    1.16 +use any number you like, but preferably one < 100. It does not have
    1.17 +to be the same for the user 'mail' and the group 'trusted'.
    1.18 +
    1.19 +Then do:
    1.20 +
    1.21 +./configure
    1.22 +make
    1.23 +make install
    1.24 +
    1.25 +Debian:
    1.26 +If you compile for Debian, do the configure with at least these options,
    1.27 +this makes it compatible with the official debian package:
    1.28 +./configure --with-liblockfile --with-group=mail
    1.29 +you do not need the group 'trusted', use 'mail' instead.
    1.30 +
    1.31 +You can also build your own Debian package with
    1.32 +dpkg-buildpackage -rfakeroot
    1.33 +You need to have fakeroot installed to do this. Or, as root, do:
    1.34 +dpkg-buildpackage
    1.35 +
    1.36 +SuSE/Redhat:
    1.37 +There are spec files for rpm creation in suse/ or redhat/. You may have to adjust these files.
    1.38 +
    1.39 +
    1.40 +Sorry, but after that you are not yet finished. For instruction on how
    1.41 +to deliver mail using a connection to your ISP see
    1.42 +docs/install.html. It is probably a good idea to copy the files
    1.43 +docs/*.html to a directory where you can access them with a browser.
    1.44 +
    1.45 +additional options for configure:
    1.46 +---------------------------------
    1.47 +
    1.48 +--with-user=USER sets the user as which MasqMail will run. Default is
    1.49 +'mail'. USER has to exist before you 'make install'.
    1.50 +
    1.51 +--with-group=GROUP sets the group as which MasqMail will run. Default
    1.52 +is 'trusted'. GROUP has to exist before you 'make install'.
    1.53 +
    1.54 +--with-logdir=LOGDIR sets the directory where MasqMail stores its log
    1.55 +files. It will be created if it does not exist. Default is /var/masqmail/.
    1.56 +
    1.57 +--with-spooldir=SPOOLDIR sets the directory where MasqMail stores its
    1.58 +spool files. It will be created if it does not exist. Default is
    1.59 +/var/spool/masqmail/.
    1.60 +
    1.61 +--with-confdir=CONFDIR sets the default configuration directory to
    1.62 +CONFDIR, in case you prefer another location than /etc/masqmail/.
    1.63 +
    1.64 +--enable-auth enables ESMTP AUTH support (disabled by default)
    1.65 +
    1.66 +--disable-pop3 disables pop3 support (enabled by default)
    1.67 +
    1.68 +--enable-maildir enables qmail style Maildir support (disabled by default)
    1.69 +
    1.70 +--enable-ident enable RFC 1413 support. If you have the libident
    1.71 +dynamic library installed, this will be linked, otherwise it will be
    1.72 +statically linked using the sources included in the package.
    1.73 +
    1.74 +--disable-resolver disable resolver support. Without the resolver functions,
    1.75 +masqmail uses only gethostbyname() to resolve DNS names, and you cannot send
    1.76 +mail without a smart host. Not recommended. You save 3K at most.
    1.77 +
    1.78 +--disable-smtp-server disable SMTP server support. You may want this if you do
    1.79 +not need masqmail to listen. In this case, you cannot use masqmail as a smart
    1.80 +host for other hosts on your LAN, you cannot use mail clients that send SMTP,
    1.81 +you cannot even use pine. In short, use of this option is discouraged unless
    1.82 +your resources are extremely limited.
    1.83 +
    1.84 +--enable-mserver enable online detection by connecting to the mserver
    1.85 +(masqdialer system).
    1.86 +
    1.87 +--with-libcryto instead of using the md5 and hmac functions within the package,
    1.88 +link dynamically with libcrypto. This applies only if you have pop3 or SMTP
    1.89 +AUTH enabled. Makes only sense if your resources are limited and you have
    1.90 +libcrypto installed. Untested.
    1.91 +
    1.92 +--with-glib-static link with glib statically. This makes the binary larger
    1.93 +by around 30K (i386 architecture), but if masqmail is the only binary using
    1.94 +glib, you save some space in total, because you do not need the shared glib
    1.95 +library installed.
    1.96 +
    1.97 +--disable-debug disable debugging, setting it on by command line or configuration
    1.98 +has no effect. Strongly discouraged, since you miss valuable information if something
    1.99 +goes wrong. You save 6K.
   1.100 +
   1.101 +BTW, to get 3K of space, call
   1.102 +strip --remove-section=.comment --remove-section=.note --strip-unneeded src/masqmail
   1.103 +
   1.104 +after make install:
   1.105 +-------------------
   1.106 +
   1.107 +You can also use these instructions to omit 'make install' if you do
   1.108 +not want to use it.
   1.109 +
   1.110 +Check that 'make install' worked correctly. The following command:
   1.111 +
   1.112 +ls -ld /usr/sbin/masqmail /var/masqmail/ /var/spool/masqmail /var/spool/masqmail/input
   1.113 +
   1.114 +should give output similar to
   1.115 +
   1.116 +-rwsr-xr-x   1 root     root        86955 Oct 14 14:27 /usr/sbin/masqmail
   1.117 +drwxr-xr-x   2 mail     trusted      1024 Oct 14 14:29 /var/masqmail/
   1.118 +drwxr-xr-x   3 mail     trusted      1024 Oct 14 14:27 /var/spool/masqmail
   1.119 +drwxr-xr-x   2 mail     trusted      1024 Oct 14 18:32 /var/spool/masqmail/input
   1.120 +drwxr-xr-x   2 mail     trusted      1024 Oct 14 18:32 /var/spool/masqmail/lock
   1.121 +drwxr-xr-x   2 mail     trusted      1024 Oct 14 18:32 /var/spool/masqmail/popuidl
   1.122 +
   1.123 +(important is the set-user-id bit for /usr/sbin/masqmail and the
   1.124 +ownership of all items).
   1.125 +
   1.126 +Use the example configuration files in examples/ to edit your own. The
   1.127 +main configuration should go to /etc/masqmail.conf. I recommend to
   1.128 +make a directory /etc/masqmail for the *.route amd *.get files.
   1.129 +
   1.130 +The default destination for the executable 'masqmail' is
   1.131 +/usr/sbin. Check that it has the set user id bit set. (chmod u+s
   1.132 +/usr/sbin/masqmail does no harm in any case).
   1.133 +
   1.134 +If you want to replace sendmail, move your old sendmail binary to
   1.135 +another name and make a symbolic link /usr/sbin/sendmail ->
   1.136 +/usr/sbin/masqmail.
   1.137 +
   1.138 +