masqmail

annotate INSTALL @ 246:4cff8638dd9b

find changesets by author, revision, files, or words in the commit message
SMTP client: tries EHLO now always first Changed the behavior of the SMTP client. Now always an EHLO greeting is sent, no matter what kind of greeting text the server had sent. If the EHLO failed, an HELO greeting is tried as fall back. This is the behavior RFC 2821 requires (section 3.2). This change will fix setups that were not possible to sent to a server because that requires AUTH but hadn't said ``ESMTP'' in its greeting message. See also: Debian bug #349211 Thanks to Steffen (inne)
author markus schnalke <meillo@marmaro.de>
date Thu, 28 Oct 2010 16:40:02 -0300
parents 0241aaccfcdb
children 92340177150d
rev   line source
meillo@59 1 Additional information may be available in docs/ or on the website.
meillo@174 2 For installing on GNU/Linux distributions read docs/INSTALL.linux.
meillo@0 3
meillo@59 4
meillo@59 5 Installation instructions
meillo@59 6 -------------------------
meillo@59 7
meillo@165 8 To compile masqmail you need glib (>= 1.2) (http://www.gtk.org). Your
meillo@181 9 distribution probably provides it. Glib-2.0 works out of the box, for
meillo@181 10 glib-1.2, you need to adjust configure.ac. See the comment in there.
meillo@0 11
meillo@165 12 You need a user and a group for masqmail to run. If
meillo@165 13
meillo@165 14 grep '^mail:' /etc/passwd
meillo@165 15 grep '^trusted:' /etc/group
meillo@165 16
meillo@165 17 shows that the user `mail' and the group `trusted' exist, it's
meillo@165 18 probably best to use these. If they don't exist, create them:
meillo@0 19
meillo@59 20 groupadd -g 42 trusted
meillo@194 21 useradd -u 23 -g trusted -d /nonexistent -s /bin/false -c "masqmail MTA" mail
meillo@0 22
meillo@165 23 If you use other names than `mail' and `trusted' use the options
meillo@165 24 described below for configure. The 23 and 42 are just a suggestion,
meillo@165 25 you can use any (not yet used) number you like, but preferably one
meillo@165 26 lower than 100. It does not have to be the same for the user `mail'
meillo@165 27 and the group `trusted'.
meillo@165 28
meillo@0 29
meillo@174 30 Compiling is a matter of the usual procedure. In the source directory,
meillo@59 31 after unpacking do:
meillo@0 32
meillo@59 33 ./configure
meillo@59 34 make
meillo@59 35 make install
meillo@0 36
meillo@0 37
meillo@0 38
meillo@59 39 Additional options for configure
meillo@59 40 --------------------------------
meillo@0 41
meillo@59 42 See the output of
meillo@0 43
meillo@59 44 ./configure -h
meillo@0 45
meillo@165 46 Here is a selection of the options with additional explanations:
meillo@0 47
meillo@165 48 --with-user=USER
meillo@165 49 sets the user as which masqmail will run. Default is 'mail'. USER has
meillo@165 50 to exist before you 'make install'.
meillo@0 51
meillo@165 52 --with-group=GROUP
meillo@165 53 sets the group as which masqmail will run. Default is 'trusted'. GROUP
meillo@165 54 has to exist before you 'make install'.
meillo@0 55
meillo@0 56
meillo@165 57 --with-logdir=LOGDIR
meillo@165 58 sets the directory where masqmail stores its log files. It will be
meillo@165 59 created if it does not exist. Default is /var/log/masqmail/.
meillo@0 60
meillo@165 61 --with-spooldir=SPOOLDIR
meillo@165 62 sets the directory where masqmail stores its spool files. It will be
meillo@165 63 created if it does not exist. Default is /var/spool/masqmail/.
meillo@0 64
meillo@165 65 --with-confdir=CONFDIR
meillo@165 66 sets the default configuration directory to CONFDIR, in case you
meillo@165 67 prefer another location than /etc/masqmail/.
meillo@0 68
meillo@0 69
meillo@165 70 --enable-auth
meillo@165 71 enables ESMTP AUTH support (disabled by default)
meillo@0 72
meillo@165 73 --enable-ident
meillo@175 74 enables RFC 1413 support. If you have the libident dynamic library
meillo@165 75 installed, this will be linked, otherwise it will be statically linked
meillo@165 76 using the sources included in the package.
meillo@0 77
meillo@165 78 --disable-resolver
meillo@175 79 disables resolver support. Without the resolver functions, masqmail
meillo@165 80 uses only gethostbyname() to resolve DNS names, and you cannot send
meillo@165 81 mail without a smart host. Not recommended.
meillo@0 82
meillo@165 83
meillo@165 84 --with-libcryto
meillo@165 85 instead of using the md5 and hmac functions within the package, link
meillo@192 86 dynamically with libcrypto. This applies only if you have SMTP AUTH
meillo@192 87 enabled. Only makes sense if your resources are limited and you have
meillo@192 88 libcrypto installed. Untested.
meillo@165 89
meillo@0 90
meillo@165 91 --disable-debug
meillo@175 92 disables debugging; setting it on the command line or in the
meillo@175 93 configuration has no effect. Strongly discouraged, since you miss
meillo@175 94 valuable information if something goes wrong.
meillo@0 95
meillo@59 96
meillo@59 97
meillo@165 98 Checking the installation
meillo@165 99 -------------------------
meillo@0 100
meillo@0 101 Check that 'make install' worked correctly. The following command:
meillo@0 102
meillo@195 103 ls -ld /usr/local/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
meillo@174 104 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/*
meillo@0 105
meillo@0 106 should give output similar to
meillo@0 107
meillo@165 108 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail
meillo@59 109 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail
meillo@59 110 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/log/masqmail
meillo@59 111 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/run/masqmail
meillo@59 112 drwxr-xr-x 5 mail trusted 4096 May 10 12:34 /var/spool/masqmail
meillo@59 113 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/input
meillo@59 114 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/lock
meillo@0 115
meillo@165 116 Important are the set-user-id bit for /usr/local/sbin/masqmail and
meillo@165 117 the permissions of all files.
meillo@0 118
meillo@0 119
meillo@59 120
meillo@165 121 Making masqmail the default
meillo@165 122 ---------------------------
meillo@0 123
meillo@165 124 `sendmail' is the de-facto standard name of the system's MTA, no
meillo@165 125 matter which MTA actually runs. If you want to make masqmail the
meillo@185 126 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic
meillo@185 127 links:
meillo@0 128
meillo@165 129 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail
meillo@185 130 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail
meillo@0 131
meillo@165 132 Now every mailer that used to call sendmail will now call masqmail.
meillo@165 133 If you already had an MTA installed and running, you can kill it and
meillo@165 134 start masqmail. Probably with:
meillo@59 135
meillo@165 136 /etc/init.d/sendmail restart
meillo@59 137
meillo@165 138 If this doesn't work as expected, you might need to add a special init
meillo@165 139 script for masqmail. Currently none is distributed with masqmail.
meillo@165 140 (Hopefully this will change soon.) Please ask on the mailing list for
meillo@165 141 help.
meillo@59 142
meillo@165 143 You can also directly start masqmail as daemon with:
meillo@59 144
meillo@165 145 /usr/local/sbin/masqmail -bd -q30m
meillo@59 146
meillo@59 147
meillo@59 148
meillo@165 149 Basic Configuration
meillo@165 150 -------------------
meillo@59 151
meillo@165 152 The only thing you must configure in order to use masqmail is the
meillo@165 153 hostname. It's the name under which masqmail operates. In most cases
meillo@165 154 it is the same as the machine's name, but it can be different.
meillo@59 155
meillo@227 156 The script `admin/guess-hostname' tries to print the hostname of
meillo@165 157 your machine. The first output line is probably the best choice.
meillo@59 158
meillo@165 159 Create a minimal config with:
meillo@59 160
meillo@165 161 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf
meillo@59 162
meillo@165 163 (Substitute `HOSTNAME' with the real value, of course.)
meillo@59 164
meillo@165 165 Such a setup (i.e. the default one) does:
meillo@165 166 - deliver mail locally
meillo@206 167 - accept mail on stdin (plain text)
meillo@206 168 - accept mail on stdin (SMTP) (if started with -bs)
meillo@206 169 - accept mail on the local port 25 (SMTP) (if started with -bd)
meillo@185 170
meillo@165 171 It does not
meillo@185 172 - transfer mail to other machines
meillo@165 173 - accept mail from outside your machine
meillo@59 174
meillo@59 175
meillo@165 176 For more elaborate setups, have a look at docs/*setup and
meillo@165 177 docs/INSTALL*. You can also take the example configuration files in
meillo@165 178 examples/ as basis for your own. Take the man pages masqmail.conf(5)
meillo@165 179 and masqmail.route(5) for reference.
meillo@92 180
meillo@165 181 All configuration files should go into /etc/masqmail.
meillo@59 182
meillo@59 183
meillo@59 184
meillo@59 185 Written by oku.
meillo@165 186 Improved by meillo.