masqmail
view INSTALL @ 359:84e6b552f6ad
minor refactoring
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Sun, 04 Sep 2011 17:40:13 +0200 |
| parents | cab46cefa4ce |
| children | 7a8d706f0ff1 |
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-auth
70 enables ESMTP AUTH support (disabled by default)
72 --enable-ident
73 enables RFC 1413 support. If you have the libident dynamic library
74 installed, this will be linked, otherwise it will be statically linked
75 using the sources included in the package.
77 --disable-resolver
78 disables resolver support. Without the resolver functions, masqmail
79 uses only gethostbyname() to resolve DNS names, and you cannot send
80 mail without a smart host. Not recommended.
83 --with-libcryto
84 instead of using the md5 and hmac functions within the package, link
85 dynamically with libcrypto. This applies only if you have SMTP AUTH
86 enabled. Only makes sense if your resources are limited and you have
87 libcrypto installed. Untested.
90 --disable-debug
91 disables debugging; setting it on the command line or in the
92 configuration has no effect. Strongly discouraged, since you miss
93 valuable information if something goes wrong.
97 Checking the installation
98 -------------------------
100 Check that 'make install' worked correctly. The following command:
102 ls -ld /usr/local/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
103 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/*
105 should give output similar to
107 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail
108 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail
109 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/log/masqmail
110 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/run/masqmail
111 drwxr-xr-x 5 mail mail 4096 May 10 12:34 /var/spool/masqmail
112 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/input
113 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/lock
115 Important are the set-user-id bit for /usr/local/sbin/masqmail and
116 the permissions of all files.
120 Making masqmail the default
121 ---------------------------
123 `sendmail' is the de-facto standard name of the system's MTA, no
124 matter which MTA actually runs. If you want to make masqmail the
125 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic
126 links:
128 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail
129 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail
131 Now every mailer that used to call sendmail will now call masqmail.
132 If you already had an MTA installed and running, you can kill it and
133 start masqmail. Probably with:
135 /etc/init.d/sendmail restart
137 If this doesn't work as expected, you might need to add a special init
138 script for masqmail. Currently none is distributed with masqmail.
139 (Hopefully this will change soon.) Please ask on the mailing list for
140 help.
142 You can also directly start masqmail as daemon with:
144 /usr/local/sbin/masqmail -bd -q30m
148 Basic Configuration
149 -------------------
151 The only thing you must configure in order to use masqmail is the
152 hostname. It's the name under which masqmail operates. In most cases
153 it is the same as the machine's name, but it can be different.
155 The script `admin/guess-hostname' tries to print the hostname of
156 your machine. The first output line is probably the best choice.
158 Create a minimal config with:
160 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf
162 (Substitute `HOSTNAME' with the real value, of course.)
164 Such a setup (i.e. the default one) does:
165 - deliver mail locally
166 - accept mail on stdin (plain text)
167 - accept mail on stdin (SMTP) (if started with -bs)
168 - accept mail on the local port 25 (SMTP) (if started with -bd)
170 It does not
171 - transfer mail to other machines
172 - accept mail from outside your machine
175 For more elaborate setups, have a look at docs/*setup and
176 docs/INSTALL*. You can also take the example configuration files in
177 examples/ as basis for your own. Take the man pages masqmail.conf(5)
178 and masqmail.route(5) for reference.
180 All configuration files should go into /etc/masqmail.
184 Written by oku.
185 Improved by meillo.