masqmail
view INSTALL @ 431:34c919a8d74e
Bumps version number and updates Changelog and NEWS
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Sat, 07 Feb 2015 11:17:53 +0100 |
| parents | bdbedce60247 |
| children |
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 on program startup if it does not exist. Default is
59 /var/log/masqmail.
61 --with-spooldir=SPOOLDIR
62 sets the directory where masqmail stores its spool files. It will be
63 created on program startup if it does not exist. Default is
64 /var/spool/masqmail.
66 --with-confdir=CONFDIR
67 sets the default configuration directory to CONFDIR, in case you
68 prefer another location than /etc/masqmail.
70 --with-piddir=PIDDIR
71 sets the directory for the pid file of the daemon. The default and usual
72 location is /var/run, but some GNU/Linux distributions have converted
73 to /run. It gets created on program startup if missing.
75 --with-lockdir=LOCKDIR
76 sets the default directory for lock file for spooled messages. Default
77 is /var/lock/masqmail. It gets created on program startup if missing.
80 --disable-resolver
81 disables resolver support. Without the resolver functions, masqmail
82 uses only gethostbyname() to resolve DNS names, and you cannot send
83 mail without a smart host. Not recommended.
85 --disable-auth
86 disables ESMTP AUTH support (enabled by default)
89 --disable-debug
90 disables debugging; setting it on the command line or in the
91 configuration has no effect. Strongly discouraged, since you miss
92 valuable information if something goes wrong.
96 Checking the installation
97 -------------------------
99 Check that 'make install' worked correctly. The following command:
101 ls -ld /usr/local/sbin/masqmail /etc/masqmail /var/log/masqmail/ \
102 /var/spool/masqmail/
104 should give output similar to
106 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail
107 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail
108 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/log/masqmail
109 drwxr-xr-x 5 mail mail 4096 May 10 12:34 /var/spool/masqmail
111 Important are the set-user-id bit for /usr/local/sbin/masqmail and
112 the ownership of the directories.
116 Making masqmail the default
117 ---------------------------
119 `sendmail' is the de-facto standard name of the system's MTA, no
120 matter which MTA actually runs. If you want to make masqmail the
121 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic
122 links:
124 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail
125 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail
127 Now every mailer that used to call sendmail will now call masqmail.
128 If you already had an MTA installed and running, you can kill it and
129 start masqmail. Probably with:
131 /etc/init.d/sendmail restart
133 If this doesn't work as expected, you might need to add a special init
134 script for masqmail. Currently none is distributed with masqmail.
135 (Hopefully this will change soon.) Please ask on the mailing list for
136 help.
138 You can also directly start masqmail as daemon with:
140 /usr/local/sbin/masqmail -bd -q30m
144 Basic Configuration
145 -------------------
147 The only thing you must configure in order to use masqmail is the
148 hostname. It's the name under which masqmail operates. In most cases
149 it is the same as the machine's name, but it can be different.
151 The script `admin/guess-hostname' tries to print the hostname of
152 your machine. The first output line is probably the best choice.
154 Create a minimal config with:
156 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf
158 (Substitute `HOSTNAME' with the real value, of course.)
160 Such a setup (i.e. the default one) does:
161 - deliver mail locally
162 - accept mail on stdin (plain text)
163 - accept mail on stdin (SMTP) (if started with -bs)
164 - accept mail on the local port 25 (SMTP) (if started with -bd)
166 It does not
167 - transfer mail to other machines
168 - accept mail from outside your machine
171 For more elaborate setups, have a look at docs/*setup and
172 docs/INSTALL*. You can also take the example configuration files in
173 examples/ as basis for your own. Take the man pages masqmail.conf(5)
174 and masqmail.route(5) for reference.
176 All configuration files should go into /etc/masqmail.
180 Written by oku.
181 Improved by meillo.