masqmail
view INSTALL @ 418:4cbaf6d6793f
Changed the location of the route query file in the docs.
/var/run is for pid files only.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Tue, 29 May 2012 21:33:49 +0200 |
| parents | 72653295b75d |
| children | d209b4846f2b |
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 --disable-resolver
70 disables resolver support. Without the resolver functions, masqmail
71 uses only gethostbyname() to resolve DNS names, and you cannot send
72 mail without a smart host. Not recommended.
74 --disable-auth
75 disables ESMTP AUTH support (enabled by default)
78 --disable-debug
79 disables debugging; setting it on the command line or in the
80 configuration has no effect. Strongly discouraged, since you miss
81 valuable information if something goes wrong.
85 Checking the installation
86 -------------------------
88 Check that 'make install' worked correctly. The following command:
90 ls -ld /usr/local/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
91 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/*
93 should give output similar to
95 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail
96 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail
97 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/log/masqmail
98 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/run/masqmail
99 drwxr-xr-x 5 mail mail 4096 May 10 12:34 /var/spool/masqmail
100 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/input
101 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/lock
103 Important are the set-user-id bit for /usr/local/sbin/masqmail and
104 the permissions of all files.
108 Making masqmail the default
109 ---------------------------
111 `sendmail' is the de-facto standard name of the system's MTA, no
112 matter which MTA actually runs. If you want to make masqmail the
113 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic
114 links:
116 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail
117 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail
119 Now every mailer that used to call sendmail will now call masqmail.
120 If you already had an MTA installed and running, you can kill it and
121 start masqmail. Probably with:
123 /etc/init.d/sendmail restart
125 If this doesn't work as expected, you might need to add a special init
126 script for masqmail. Currently none is distributed with masqmail.
127 (Hopefully this will change soon.) Please ask on the mailing list for
128 help.
130 You can also directly start masqmail as daemon with:
132 /usr/local/sbin/masqmail -bd -q30m
136 Basic Configuration
137 -------------------
139 The only thing you must configure in order to use masqmail is the
140 hostname. It's the name under which masqmail operates. In most cases
141 it is the same as the machine's name, but it can be different.
143 The script `admin/guess-hostname' tries to print the hostname of
144 your machine. The first output line is probably the best choice.
146 Create a minimal config with:
148 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf
150 (Substitute `HOSTNAME' with the real value, of course.)
152 Such a setup (i.e. the default one) does:
153 - deliver mail locally
154 - accept mail on stdin (plain text)
155 - accept mail on stdin (SMTP) (if started with -bs)
156 - accept mail on the local port 25 (SMTP) (if started with -bd)
158 It does not
159 - transfer mail to other machines
160 - accept mail from outside your machine
163 For more elaborate setups, have a look at docs/*setup and
164 docs/INSTALL*. You can also take the example configuration files in
165 examples/ as basis for your own. Take the man pages masqmail.conf(5)
166 and masqmail.route(5) for reference.
168 All configuration files should go into /etc/masqmail.
172 Written by oku.
173 Improved by meillo.