masqmail
view INSTALL @ 423:196dfb2a3056
Updated tests to the changes on spool dir.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Wed, 30 May 2012 10:38:29 +0200 |
| parents | f37384470855 |
| children | a19e47ebbb33 |
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/.
68 --with-piddir=PIDDIR
69 sets the directory for the pid file of the daemon. The default and usual
70 location is /var/run, but some GNU/Linux distributions have converted
71 to /run. It gets created on program startup if missing.
73 --with-lockdir=LOCKDIR
74 sets the default directory for lock file for spooled messages. Default
75 is /var/lock/masqmail. It gets created on program startup if missing.
78 --disable-resolver
79 disables resolver support. Without the resolver functions, masqmail
80 uses only gethostbyname() to resolve DNS names, and you cannot send
81 mail without a smart host. Not recommended.
83 --disable-auth
84 disables ESMTP AUTH support (enabled by default)
87 --disable-debug
88 disables debugging; setting it on the command line or in the
89 configuration has no effect. Strongly discouraged, since you miss
90 valuable information if something goes wrong.
94 Checking the installation
95 -------------------------
97 Check that 'make install' worked correctly. The following command:
99 ls -ld /usr/local/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
100 /var/spool/masqmail/
102 should give output similar to
104 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail
105 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail
106 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/log/masqmail
107 drwxr-xr-x 5 mail mail 4096 May 10 12:34 /var/spool/masqmail
109 Important are the set-user-id bit for /usr/local/sbin/masqmail and
110 the ownership of the directories.
114 Making masqmail the default
115 ---------------------------
117 `sendmail' is the de-facto standard name of the system's MTA, no
118 matter which MTA actually runs. If you want to make masqmail the
119 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic
120 links:
122 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail
123 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail
125 Now every mailer that used to call sendmail will now call masqmail.
126 If you already had an MTA installed and running, you can kill it and
127 start masqmail. Probably with:
129 /etc/init.d/sendmail restart
131 If this doesn't work as expected, you might need to add a special init
132 script for masqmail. Currently none is distributed with masqmail.
133 (Hopefully this will change soon.) Please ask on the mailing list for
134 help.
136 You can also directly start masqmail as daemon with:
138 /usr/local/sbin/masqmail -bd -q30m
142 Basic Configuration
143 -------------------
145 The only thing you must configure in order to use masqmail is the
146 hostname. It's the name under which masqmail operates. In most cases
147 it is the same as the machine's name, but it can be different.
149 The script `admin/guess-hostname' tries to print the hostname of
150 your machine. The first output line is probably the best choice.
152 Create a minimal config with:
154 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf
156 (Substitute `HOSTNAME' with the real value, of course.)
158 Such a setup (i.e. the default one) does:
159 - deliver mail locally
160 - accept mail on stdin (plain text)
161 - accept mail on stdin (SMTP) (if started with -bs)
162 - accept mail on the local port 25 (SMTP) (if started with -bd)
164 It does not
165 - transfer mail to other machines
166 - accept mail from outside your machine
169 For more elaborate setups, have a look at docs/*setup and
170 docs/INSTALL*. You can also take the example configuration files in
171 examples/ as basis for your own. Take the man pages masqmail.conf(5)
172 and masqmail.route(5) for reference.
174 All configuration files should go into /etc/masqmail.
178 Written by oku.
179 Improved by meillo.