masqmail
view INSTALL @ 371:f122535c589e
Refactoring: early failure exit.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Tue, 25 Oct 2011 13:51:43 +0200 |
| parents | 02bc0331e390 |
| children | 5781ba87df95 |
line source
1 Additional information may be available in docs/ or on the website.
2 For installing on GNU/Linux distributions read docs/INSTALL.linux.
5 Installation instructions
6 -------------------------
8 To compile masqmail you need glib (>= 1.2) (http://www.gtk.org). Your
9 distribution probably provides it. Glib-2.0 works out of the box, for
10 glib-1.2, you need to adjust configure.ac. See the comment in there.
12 You need a user and a group for masqmail to run. If
14 grep '^mail:' /etc/passwd
15 grep '^mail:' /etc/group
17 shows that the user `mail' and the group `mail' exist, it's probably
18 best to use these. If they don't exist, create them:
20 groupadd -g 12 mail
21 useradd -u 8 -g mail -d /nonexistent -s /bin/false -c "masqmail MTA" mail
23 The 8 and 12 are common uid/gid for the user and group `mail', but you can
24 use any (not yet used) number you like, preferably one lower than 100.
25 If you use other names than `mail' and `mail', you need to use the
26 configure options described below.
29 Compiling is a matter of the usual procedure. In the source directory,
30 after unpacking do:
32 ./configure
33 make
34 make install
38 Additional options for configure
39 --------------------------------
41 See the output of
43 ./configure -h
45 Here is a selection of the options with additional explanations:
47 --with-user=USER
48 sets the user as which masqmail will run. Default is 'mail'. USER has
49 to exist before you 'make install'.
51 --with-group=GROUP
52 sets the group as which masqmail will run. Default is 'mail'. GROUP
53 has to exist before you 'make install'.
56 --with-logdir=LOGDIR
57 sets the directory where masqmail stores its log files. It will be
58 created if it does not exist. Default is /var/log/masqmail/.
60 --with-spooldir=SPOOLDIR
61 sets the directory where masqmail stores its spool files. It will be
62 created if it does not exist. Default is /var/spool/masqmail/.
64 --with-confdir=CONFDIR
65 sets the default configuration directory to CONFDIR, in case you
66 prefer another location than /etc/masqmail/.
69 --enable-ident
70 enables RFC 1413 support. If you have the libident dynamic library
71 installed, this will be linked, otherwise it will be statically linked
72 using the sources included in the package. Ident support brings few
73 advantages. If mail is received from machines that run identd, the
74 Received headers and log messages include a user name too. Additionally
75 a user can remove queued mail if it had been sent by himself from another
76 machine running identd. In any case: You cannot trust the ident
77 information more than you trust the specific remote machine.
79 --disable-resolver
80 disables resolver support. Without the resolver functions, masqmail
81 uses only gethostbyname() to resolve DNS names, and you cannot send
82 mail without a smart host. Not recommended.
84 --disable-auth
85 disables ESMTP AUTH support (enabled by default)
88 --disable-debug
89 disables debugging; setting it on the command line or in the
90 configuration has no effect. Strongly discouraged, since you miss
91 valuable information if something goes wrong.
95 Checking the installation
96 -------------------------
98 Check that 'make install' worked correctly. The following command:
100 ls -ld /usr/local/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
101 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/*
103 should give output similar to
105 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail
106 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail
107 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/log/masqmail
108 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/run/masqmail
109 drwxr-xr-x 5 mail mail 4096 May 10 12:34 /var/spool/masqmail
110 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/input
111 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/lock
113 Important are the set-user-id bit for /usr/local/sbin/masqmail and
114 the permissions of all files.
118 Making masqmail the default
119 ---------------------------
121 `sendmail' is the de-facto standard name of the system's MTA, no
122 matter which MTA actually runs. If you want to make masqmail the
123 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic
124 links:
126 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail
127 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail
129 Now every mailer that used to call sendmail will now call masqmail.
130 If you already had an MTA installed and running, you can kill it and
131 start masqmail. Probably with:
133 /etc/init.d/sendmail restart
135 If this doesn't work as expected, you might need to add a special init
136 script for masqmail. Currently none is distributed with masqmail.
137 (Hopefully this will change soon.) Please ask on the mailing list for
138 help.
140 You can also directly start masqmail as daemon with:
142 /usr/local/sbin/masqmail -bd -q30m
146 Basic Configuration
147 -------------------
149 The only thing you must configure in order to use masqmail is the
150 hostname. It's the name under which masqmail operates. In most cases
151 it is the same as the machine's name, but it can be different.
153 The script `admin/guess-hostname' tries to print the hostname of
154 your machine. The first output line is probably the best choice.
156 Create a minimal config with:
158 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf
160 (Substitute `HOSTNAME' with the real value, of course.)
162 Such a setup (i.e. the default one) does:
163 - deliver mail locally
164 - accept mail on stdin (plain text)
165 - accept mail on stdin (SMTP) (if started with -bs)
166 - accept mail on the local port 25 (SMTP) (if started with -bd)
168 It does not
169 - transfer mail to other machines
170 - accept mail from outside your machine
173 For more elaborate setups, have a look at docs/*setup and
174 docs/INSTALL*. You can also take the example configuration files in
175 examples/ as basis for your own. Take the man pages masqmail.conf(5)
176 and masqmail.route(5) for reference.
178 All configuration files should go into /etc/masqmail.
182 Written by oku.
183 Improved by meillo.