Mercurial > masqmail
annotate INSTALL @ 378:5781ba87df95
Removed ident. This had been discussed on the mailing list in Oct 2011.
Ident is hardly useful in typical setups for masqmail. Probably Oliver
had used it in his setup; that would make sense. Now, I know of nobody
who needs it.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Sat, 14 Jan 2012 21:36:58 +0100 |
| parents | 72653295b75d |
| children | d209b4846f2b |
| rev | line source |
|---|---|
| 59 | 1 Additional information may be available in docs/ or on the website. |
|
174
dbe3dadd1afe
Documentation improvements in the INSTALL file and some man pages
meillo@marmaro.de
parents:
92
diff
changeset
|
2 For installing on GNU/Linux distributions read docs/INSTALL.linux. |
| 59 | 3 |
| 0 | 4 |
| 59 | 5 Installation instructions |
| 6 ------------------------- | |
| 7 | |
| 165 | 8 To compile masqmail you need glib (>= 1.2) (http://www.gtk.org). Your |
|
181
8b17ea9fd17b
added comments on how to compile with glib-1.2
meillo@marmaro.de
parents:
175
diff
changeset
|
9 distribution probably provides it. Glib-2.0 works out of the box, for |
|
8b17ea9fd17b
added comments on how to compile with glib-1.2
meillo@marmaro.de
parents:
175
diff
changeset
|
10 glib-1.2, you need to adjust configure.ac. See the comment in there. |
| 165 | 11 |
| 12 You need a user and a group for masqmail to run. If | |
| 0 | 13 |
| 165 | 14 grep '^mail:' /etc/passwd |
|
358
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
15 grep '^mail:' /etc/group |
| 165 | 16 |
|
358
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
17 shows that the user `mail' and the group `mail' exist, it's probably |
|
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
18 best to use these. If they don't exist, create them: |
| 0 | 19 |
|
358
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
20 groupadd -g 12 mail |
|
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
21 useradd -u 8 -g mail -d /nonexistent -s /bin/false -c "masqmail MTA" mail |
| 0 | 22 |
|
358
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
23 The 8 and 12 are common uid/gid for the user and group `mail', but you can |
|
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
24 use any (not yet used) number you like, preferably one lower than 100. |
|
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
25 If you use other names than `mail' and `mail', you need to use the |
|
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
26 configure options described below. |
| 165 | 27 |
| 0 | 28 |
|
174
dbe3dadd1afe
Documentation improvements in the INSTALL file and some man pages
meillo@marmaro.de
parents:
92
diff
changeset
|
29 Compiling is a matter of the usual procedure. In the source directory, |
| 59 | 30 after unpacking do: |
| 0 | 31 |
| 59 | 32 ./configure |
| 33 make | |
| 34 make install | |
| 0 | 35 |
| 36 | |
| 37 | |
| 59 | 38 Additional options for configure |
| 39 -------------------------------- | |
| 0 | 40 |
| 59 | 41 See the output of |
| 42 | |
| 43 ./configure -h | |
| 44 | |
| 165 | 45 Here is a selection of the options with additional explanations: |
| 0 | 46 |
| 165 | 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'. | |
| 0 | 50 |
| 165 | 51 --with-group=GROUP |
|
358
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
52 sets the group as which masqmail will run. Default is 'mail'. GROUP |
| 165 | 53 has to exist before you 'make install'. |
| 0 | 54 |
| 165 | 55 |
| 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/. | |
| 0 | 59 |
| 165 | 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/. | |
| 0 | 63 |
| 165 | 64 --with-confdir=CONFDIR |
| 65 sets the default configuration directory to CONFDIR, in case you | |
| 66 prefer another location than /etc/masqmail/. | |
| 67 | |
| 0 | 68 |
| 165 | 69 --disable-resolver |
| 175 | 70 disables resolver support. Without the resolver functions, masqmail |
| 165 | 71 uses only gethostbyname() to resolve DNS names, and you cannot send |
| 72 mail without a smart host. Not recommended. | |
| 0 | 73 |
|
364
72653295b75d
Enabled auth support per default
markus schnalke <meillo@marmaro.de>
parents:
363
diff
changeset
|
74 --disable-auth |
|
72653295b75d
Enabled auth support per default
markus schnalke <meillo@marmaro.de>
parents:
363
diff
changeset
|
75 disables ESMTP AUTH support (enabled by default) |
|
72653295b75d
Enabled auth support per default
markus schnalke <meillo@marmaro.de>
parents:
363
diff
changeset
|
76 |
| 0 | 77 |
| 165 | 78 --disable-debug |
| 175 | 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. | |
| 0 | 82 |
| 59 | 83 |
| 84 | |
| 165 | 85 Checking the installation |
| 86 ------------------------- | |
| 0 | 87 |
| 88 Check that 'make install' worked correctly. The following command: | |
| 89 | |
|
195
5beb5d6d9623
There was still a /usr/sbin/masqmail path
meillo@marmaro.de
parents:
194
diff
changeset
|
90 ls -ld /usr/local/sbin/masqmail /etc/masqmail /var/log/masqmail/ \ |
|
174
dbe3dadd1afe
Documentation improvements in the INSTALL file and some man pages
meillo@marmaro.de
parents:
92
diff
changeset
|
91 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/* |
| 0 | 92 |
| 93 should give output similar to | |
| 94 | |
| 165 | 95 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail |
| 59 | 96 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail |
|
358
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
97 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/log/masqmail |
|
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
98 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/run/masqmail |
|
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
99 drwxr-xr-x 5 mail mail 4096 May 10 12:34 /var/spool/masqmail |
|
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
100 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/input |
|
92340177150d
Eventually switched the default group from `trusted' to `mail'
markus schnalke <meillo@marmaro.de>
parents:
227
diff
changeset
|
101 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/lock |
| 0 | 102 |
| 165 | 103 Important are the set-user-id bit for /usr/local/sbin/masqmail and |
| 104 the permissions of all files. | |
| 105 | |
| 106 | |
| 0 | 107 |
| 165 | 108 Making masqmail the default |
| 109 --------------------------- | |
| 0 | 110 |
| 165 | 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 | |
| 185 | 113 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic |
| 114 links: | |
| 59 | 115 |
| 165 | 116 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail |
| 185 | 117 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail |
| 0 | 118 |
| 165 | 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: | |
| 59 | 122 |
| 165 | 123 /etc/init.d/sendmail restart |
| 59 | 124 |
| 165 | 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. | |
| 59 | 129 |
| 165 | 130 You can also directly start masqmail as daemon with: |
| 59 | 131 |
| 165 | 132 /usr/local/sbin/masqmail -bd -q30m |
| 59 | 133 |
| 0 | 134 |
| 135 | |
| 165 | 136 Basic Configuration |
| 137 ------------------- | |
| 59 | 138 |
| 165 | 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. | |
| 59 | 142 |
| 227 | 143 The script `admin/guess-hostname' tries to print the hostname of |
| 165 | 144 your machine. The first output line is probably the best choice. |
| 59 | 145 |
| 165 | 146 Create a minimal config with: |
| 59 | 147 |
| 165 | 148 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf |
| 59 | 149 |
| 165 | 150 (Substitute `HOSTNAME' with the real value, of course.) |
| 59 | 151 |
| 165 | 152 Such a setup (i.e. the default one) does: |
| 153 - deliver mail locally | |
|
206
0241aaccfcdb
default listen_addresses: use 127.0.0.1 instead of `localhost'
meillo@marmaro.de
parents:
205
diff
changeset
|
154 - accept mail on stdin (plain text) |
|
0241aaccfcdb
default listen_addresses: use 127.0.0.1 instead of `localhost'
meillo@marmaro.de
parents:
205
diff
changeset
|
155 - accept mail on stdin (SMTP) (if started with -bs) |
|
0241aaccfcdb
default listen_addresses: use 127.0.0.1 instead of `localhost'
meillo@marmaro.de
parents:
205
diff
changeset
|
156 - accept mail on the local port 25 (SMTP) (if started with -bd) |
| 185 | 157 |
| 165 | 158 It does not |
| 185 | 159 - transfer mail to other machines |
| 165 | 160 - accept mail from outside your machine |
| 59 | 161 |
| 92 | 162 |
| 165 | 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. | |
| 59 | 167 |
| 165 | 168 All configuration files should go into /etc/masqmail. |
| 59 | 169 |
| 170 | |
| 171 | |
| 172 Written by oku. | |
| 165 | 173 Improved by meillo. |