masqmail

annotate INSTALL @ 363:02bc0331e390

find changesets by author, revision, files, or words in the commit message
Removed support for openssl linking It had been rarely used and could have caused legal problems. For explanations, see this mail message: Date: Sun, 04 Sep 2011 17:35:23 +0200 From: markus schnalke <meillo@marmaro.de> To: masqmail@marmaro.de Subject: [masqmail] RFC: Removal of configure options Message-ID: <1R0EjD-4aX-00@serveme.home.schnalke.org>
author markus schnalke <meillo@marmaro.de>
date Wed, 14 Sep 2011 12:07:34 +0200
parents 7a8d706f0ff1
children 72653295b75d
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@358 15 grep '^mail:' /etc/group
meillo@165 16
meillo@358 17 shows that the user `mail' and the group `mail' exist, it's probably
meillo@358 18 best to use these. If they don't exist, create them:
meillo@0 19
meillo@358 20 groupadd -g 12 mail
meillo@358 21 useradd -u 8 -g mail -d /nonexistent -s /bin/false -c "masqmail MTA" mail
meillo@0 22
meillo@358 23 The 8 and 12 are common uid/gid for the user and group `mail', but you can
meillo@358 24 use any (not yet used) number you like, preferably one lower than 100.
meillo@358 25 If you use other names than `mail' and `mail', you need to use the
meillo@358 26 configure options described below.
meillo@165 27
meillo@0 28
meillo@174 29 Compiling is a matter of the usual procedure. In the source directory,
meillo@59 30 after unpacking do:
meillo@0 31
meillo@59 32 ./configure
meillo@59 33 make
meillo@59 34 make install
meillo@0 35
meillo@0 36
meillo@0 37
meillo@59 38 Additional options for configure
meillo@59 39 --------------------------------
meillo@0 40
meillo@59 41 See the output of
meillo@0 42
meillo@59 43 ./configure -h
meillo@0 44
meillo@165 45 Here is a selection of the options with additional explanations:
meillo@0 46
meillo@165 47 --with-user=USER
meillo@165 48 sets the user as which masqmail will run. Default is 'mail'. USER has
meillo@165 49 to exist before you 'make install'.
meillo@0 50
meillo@165 51 --with-group=GROUP
meillo@358 52 sets the group as which masqmail will run. Default is 'mail'. GROUP
meillo@165 53 has to exist before you 'make install'.
meillo@0 54
meillo@0 55
meillo@165 56 --with-logdir=LOGDIR
meillo@165 57 sets the directory where masqmail stores its log files. It will be
meillo@165 58 created if it does not exist. Default is /var/log/masqmail/.
meillo@0 59
meillo@165 60 --with-spooldir=SPOOLDIR
meillo@165 61 sets the directory where masqmail stores its spool files. It will be
meillo@165 62 created if it does not exist. Default is /var/spool/masqmail/.
meillo@0 63
meillo@165 64 --with-confdir=CONFDIR
meillo@165 65 sets the default configuration directory to CONFDIR, in case you
meillo@165 66 prefer another location than /etc/masqmail/.
meillo@0 67
meillo@0 68
meillo@165 69 --enable-auth
meillo@165 70 enables ESMTP AUTH support (disabled by default)
meillo@0 71
meillo@165 72 --enable-ident
meillo@175 73 enables RFC 1413 support. If you have the libident dynamic library
meillo@165 74 installed, this will be linked, otherwise it will be statically linked
meillo@360 75 using the sources included in the package. Ident support brings few
meillo@360 76 advantages. If mail is received from machines that run identd, the
meillo@360 77 Received headers and log messages include a user name too. Additionally
meillo@360 78 a user can remove queued mail if it had been sent by himself from another
meillo@360 79 machine running identd. In any case: You cannot trust the ident
meillo@360 80 information more than you trust the specific remote machine.
meillo@0 81
meillo@165 82 --disable-resolver
meillo@175 83 disables resolver support. Without the resolver functions, masqmail
meillo@165 84 uses only gethostbyname() to resolve DNS names, and you cannot send
meillo@165 85 mail without a smart host. Not recommended.
meillo@0 86
meillo@165 87
meillo@165 88 --disable-debug
meillo@175 89 disables debugging; setting it on the command line or in the
meillo@175 90 configuration has no effect. Strongly discouraged, since you miss
meillo@175 91 valuable information if something goes wrong.
meillo@0 92
meillo@59 93
meillo@59 94
meillo@165 95 Checking the installation
meillo@165 96 -------------------------
meillo@0 97
meillo@0 98 Check that 'make install' worked correctly. The following command:
meillo@0 99
meillo@195 100 ls -ld /usr/local/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
meillo@174 101 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/*
meillo@0 102
meillo@0 103 should give output similar to
meillo@0 104
meillo@165 105 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail
meillo@59 106 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail
meillo@358 107 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/log/masqmail
meillo@358 108 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/run/masqmail
meillo@358 109 drwxr-xr-x 5 mail mail 4096 May 10 12:34 /var/spool/masqmail
meillo@358 110 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/input
meillo@358 111 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/lock
meillo@0 112
meillo@165 113 Important are the set-user-id bit for /usr/local/sbin/masqmail and
meillo@165 114 the permissions of all files.
meillo@0 115
meillo@0 116
meillo@59 117
meillo@165 118 Making masqmail the default
meillo@165 119 ---------------------------
meillo@0 120
meillo@165 121 `sendmail' is the de-facto standard name of the system's MTA, no
meillo@165 122 matter which MTA actually runs. If you want to make masqmail the
meillo@185 123 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic
meillo@185 124 links:
meillo@0 125
meillo@165 126 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail
meillo@185 127 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail
meillo@0 128
meillo@165 129 Now every mailer that used to call sendmail will now call masqmail.
meillo@165 130 If you already had an MTA installed and running, you can kill it and
meillo@165 131 start masqmail. Probably with:
meillo@59 132
meillo@165 133 /etc/init.d/sendmail restart
meillo@59 134
meillo@165 135 If this doesn't work as expected, you might need to add a special init
meillo@165 136 script for masqmail. Currently none is distributed with masqmail.
meillo@165 137 (Hopefully this will change soon.) Please ask on the mailing list for
meillo@165 138 help.
meillo@59 139
meillo@165 140 You can also directly start masqmail as daemon with:
meillo@59 141
meillo@165 142 /usr/local/sbin/masqmail -bd -q30m
meillo@59 143
meillo@59 144
meillo@59 145
meillo@165 146 Basic Configuration
meillo@165 147 -------------------
meillo@59 148
meillo@165 149 The only thing you must configure in order to use masqmail is the
meillo@165 150 hostname. It's the name under which masqmail operates. In most cases
meillo@165 151 it is the same as the machine's name, but it can be different.
meillo@59 152
meillo@227 153 The script `admin/guess-hostname' tries to print the hostname of
meillo@165 154 your machine. The first output line is probably the best choice.
meillo@59 155
meillo@165 156 Create a minimal config with:
meillo@59 157
meillo@165 158 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf
meillo@59 159
meillo@165 160 (Substitute `HOSTNAME' with the real value, of course.)
meillo@59 161
meillo@165 162 Such a setup (i.e. the default one) does:
meillo@165 163 - deliver mail locally
meillo@206 164 - accept mail on stdin (plain text)
meillo@206 165 - accept mail on stdin (SMTP) (if started with -bs)
meillo@206 166 - accept mail on the local port 25 (SMTP) (if started with -bd)
meillo@185 167
meillo@165 168 It does not
meillo@185 169 - transfer mail to other machines
meillo@165 170 - accept mail from outside your machine
meillo@59 171
meillo@59 172
meillo@165 173 For more elaborate setups, have a look at docs/*setup and
meillo@165 174 docs/INSTALL*. You can also take the example configuration files in
meillo@165 175 examples/ as basis for your own. Take the man pages masqmail.conf(5)
meillo@165 176 and masqmail.route(5) for reference.
meillo@92 177
meillo@165 178 All configuration files should go into /etc/masqmail.
meillo@59 179
meillo@59 180
meillo@59 181
meillo@59 182 Written by oku.
meillo@165 183 Improved by meillo.