masqmail

view INSTALL @ 204:5745edd5b769

removed the --disable-smtp-server configure option masqmail will now always have the possibility to listen on a port compiled in if you don't want it to listen on a port add this to your masqmail.conf: listen_addresses = "" also, if you don't start it as daemon it will not listen neither
author meillo@marmaro.de
date Fri, 16 Jul 2010 15:38:53 +0200
parents 45acc5727493
children 4fd237550525
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 '^trusted:' /etc/group
17 shows that the user `mail' and the group `trusted' exist, it's
18 probably best to use these. If they don't exist, create them:
20 groupadd -g 42 trusted
21 useradd -u 23 -g trusted -d /nonexistent -s /bin/false -c "masqmail MTA" mail
23 If you use other names than `mail' and `trusted' use the options
24 described below for configure. The 23 and 42 are just a suggestion,
25 you can use any (not yet used) number you like, but preferably one
26 lower than 100. It does not have to be the same for the user `mail'
27 and the group `trusted'.
30 Compiling is a matter of the usual procedure. In the source directory,
31 after unpacking do:
33 ./configure
34 make
35 make install
39 Additional options for configure
40 --------------------------------
42 See the output of
44 ./configure -h
46 Here is a selection of the options with additional explanations:
48 --with-user=USER
49 sets the user as which masqmail will run. Default is 'mail'. USER has
50 to exist before you 'make install'.
52 --with-group=GROUP
53 sets the group as which masqmail will run. Default is 'trusted'. GROUP
54 has to exist before you 'make install'.
57 --with-logdir=LOGDIR
58 sets the directory where masqmail stores its log files. It will be
59 created if it does not exist. Default is /var/log/masqmail/.
61 --with-spooldir=SPOOLDIR
62 sets the directory where masqmail stores its spool files. It will be
63 created if it does not exist. Default is /var/spool/masqmail/.
65 --with-confdir=CONFDIR
66 sets the default configuration directory to CONFDIR, in case you
67 prefer another location than /etc/masqmail/.
70 --enable-auth
71 enables ESMTP AUTH support (disabled by default)
73 --enable-maildir
74 enables qmail style Maildir support (disabled by default)
76 --enable-ident
77 enables RFC 1413 support. If you have the libident dynamic library
78 installed, this will be linked, otherwise it will be statically linked
79 using the sources included in the package.
81 --disable-resolver
82 disables resolver support. Without the resolver functions, masqmail
83 uses only gethostbyname() to resolve DNS names, and you cannot send
84 mail without a smart host. Not recommended.
87 --with-libcryto
88 instead of using the md5 and hmac functions within the package, link
89 dynamically with libcrypto. This applies only if you have SMTP AUTH
90 enabled. Only makes sense if your resources are limited and you have
91 libcrypto installed. Untested.
94 --disable-debug
95 disables debugging; setting it on the command line or in the
96 configuration has no effect. Strongly discouraged, since you miss
97 valuable information if something goes wrong.
101 Checking the installation
102 -------------------------
104 Check that 'make install' worked correctly. The following command:
106 ls -ld /usr/local/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
107 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/*
109 should give output similar to
111 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail
112 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail
113 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/log/masqmail
114 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/run/masqmail
115 drwxr-xr-x 5 mail trusted 4096 May 10 12:34 /var/spool/masqmail
116 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/input
117 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/lock
119 Important are the set-user-id bit for /usr/local/sbin/masqmail and
120 the permissions of all files.
124 Making masqmail the default
125 ---------------------------
127 `sendmail' is the de-facto standard name of the system's MTA, no
128 matter which MTA actually runs. If you want to make masqmail the
129 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic
130 links:
132 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail
133 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail
135 Now every mailer that used to call sendmail will now call masqmail.
136 If you already had an MTA installed and running, you can kill it and
137 start masqmail. Probably with:
139 /etc/init.d/sendmail restart
141 If this doesn't work as expected, you might need to add a special init
142 script for masqmail. Currently none is distributed with masqmail.
143 (Hopefully this will change soon.) Please ask on the mailing list for
144 help.
146 You can also directly start masqmail as daemon with:
148 /usr/local/sbin/masqmail -bd -q30m
152 Basic Configuration
153 -------------------
155 The only thing you must configure in order to use masqmail is the
156 hostname. It's the name under which masqmail operates. In most cases
157 it is the same as the machine's name, but it can be different.
159 The script `contrib/guess-hostname' tries to print the hostname of
160 your machine. The first output line is probably the best choice.
162 Create a minimal config with:
164 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf
166 (Substitute `HOSTNAME' with the real value, of course.)
168 Such a setup (i.e. the default one) does:
169 - deliver mail locally
170 - accept mail from local (via stdin)
171 - accept mail on localhost:25 (via SMTP) (if started as daemon)
173 It does not
174 - transfer mail to other machines
175 - accept mail from outside your machine
178 For more elaborate setups, have a look at docs/*setup and
179 docs/INSTALL*. You can also take the example configuration files in
180 examples/ as basis for your own. Take the man pages masqmail.conf(5)
181 and masqmail.route(5) for reference.
183 All configuration files should go into /etc/masqmail.
187 Written by oku.
188 Improved by meillo.