masqmail
view INSTALL @ 186:3dff59a4e764
added two setup guides
they surely need improvements
please help to improve them
| author | meillo@marmaro.de |
|---|---|
| date | Wed, 14 Jul 2010 23:26:20 +0200 |
| parents | 8b17ea9fd17b |
| children | 89f951be358f |
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 42 -d / -s /bin/sh -c "Mail Transfer Agent" 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 --enable-pop3
82 enables POP3 support (disabled by default)
84 --disable-resolver
85 disables resolver support. Without the resolver functions, masqmail
86 uses only gethostbyname() to resolve DNS names, and you cannot send
87 mail without a smart host. Not recommended.
89 --disable-smtp-server
90 disables SMTP server support. You may want this if you do not need
91 masqmail to listen. In this case, you cannot use masqmail as a smart
92 host for other hosts on your LAN, you cannot use mail clients that
93 send SMTP, you cannot even use pine. In short, use of this option is
94 discouraged unless your resources are extremely limited.
97 --with-libcryto
98 instead of using the md5 and hmac functions within the package, link
99 dynamically with libcrypto. This applies only if you have POP3 or SMTP
100 AUTH enabled. Only makes sense if your resources are limited and you
101 have libcrypto installed. Untested.
103 --with-glib-static
104 links with glib statically. This makes the binary larger by around 30K
105 (i386 architecture), but if masqmail is the only binary using glib,
106 you save some space in total, because you do not need the shared glib
107 library installed.
110 --disable-debug
111 disables debugging; setting it on the command line or in the
112 configuration has no effect. Strongly discouraged, since you miss
113 valuable information if something goes wrong.
117 Checking the installation
118 -------------------------
120 Check that 'make install' worked correctly. The following command:
122 ls -ld /usr/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
123 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/*
125 should give output similar to
127 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail
128 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail
129 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/log/masqmail
130 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/run/masqmail
131 drwxr-xr-x 5 mail trusted 4096 May 10 12:34 /var/spool/masqmail
132 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/input
133 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/lock
134 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/popuidl
136 Important are the set-user-id bit for /usr/local/sbin/masqmail and
137 the permissions of all files.
141 Making masqmail the default
142 ---------------------------
144 `sendmail' is the de-facto standard name of the system's MTA, no
145 matter which MTA actually runs. If you want to make masqmail the
146 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic
147 links:
149 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail
150 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail
152 Now every mailer that used to call sendmail will now call masqmail.
153 If you already had an MTA installed and running, you can kill it and
154 start masqmail. Probably with:
156 /etc/init.d/sendmail restart
158 If this doesn't work as expected, you might need to add a special init
159 script for masqmail. Currently none is distributed with masqmail.
160 (Hopefully this will change soon.) Please ask on the mailing list for
161 help.
163 You can also directly start masqmail as daemon with:
165 /usr/local/sbin/masqmail -bd -q30m
169 Basic Configuration
170 -------------------
172 The only thing you must configure in order to use masqmail is the
173 hostname. It's the name under which masqmail operates. In most cases
174 it is the same as the machine's name, but it can be different.
176 The script `contrib/guess-hostname' tries to print the hostname of
177 your machine. The first output line is probably the best choice.
179 Create a minimal config with:
181 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf
183 (Substitute `HOSTNAME' with the real value, of course.)
185 Such a setup (i.e. the default one) does:
186 - deliver mail locally
187 - accept mail from local (via stdin)
188 - accept mail on localhost:25 (via SMTP) (if started as daemon)
190 It does not
191 - transfer mail to other machines
192 - accept mail from outside your machine
195 For more elaborate setups, have a look at docs/*setup and
196 docs/INSTALL*. You can also take the example configuration files in
197 examples/ as basis for your own. Take the man pages masqmail.conf(5)
198 and masqmail.route(5) for reference.
200 All configuration files should go into /etc/masqmail.
204 Written by oku.
205 Improved by meillo.