Mercurial > masqmail
annotate INSTALL @ 367:b27f66555ba8
Reformated multiline comments to have leading asterisks on each line
Now we use:
/*
** comment
*/
This makes the indent style simpler, too.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Thu, 20 Oct 2011 10:20:59 +0200 (2011-10-20) |
| parents | 72653295b75d |
| children | 5781ba87df95 |
| 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 --enable-ident |
| 175 | 70 enables RFC 1413 support. If you have the libident dynamic library |
| 165 | 71 installed, this will be linked, otherwise it will be statically linked |
|
360
7a8d706f0ff1
Added explanation about --enable-ident
markus schnalke <meillo@marmaro.de>
parents:
358
diff
changeset
|
72 using the sources included in the package. Ident support brings few |
|
7a8d706f0ff1
Added explanation about --enable-ident
markus schnalke <meillo@marmaro.de>
parents:
358
diff
changeset
|
73 advantages. If mail is received from machines that run identd, the |
|
7a8d706f0ff1
Added explanation about --enable-ident
markus schnalke <meillo@marmaro.de>
parents:
358
diff
changeset
|
74 Received headers and log messages include a user name too. Additionally |
|
7a8d706f0ff1
Added explanation about --enable-ident
markus schnalke <meillo@marmaro.de>
parents:
358
diff
changeset
|
75 a user can remove queued mail if it had been sent by himself from another |
|
7a8d706f0ff1
Added explanation about --enable-ident
markus schnalke <meillo@marmaro.de>
parents:
358
diff
changeset
|
76 machine running identd. In any case: You cannot trust the ident |
|
7a8d706f0ff1
Added explanation about --enable-ident
markus schnalke <meillo@marmaro.de>
parents:
358
diff
changeset
|
77 information more than you trust the specific remote machine. |
| 0 | 78 |
| 165 | 79 --disable-resolver |
| 175 | 80 disables resolver support. Without the resolver functions, masqmail |
| 165 | 81 uses only gethostbyname() to resolve DNS names, and you cannot send |
| 82 mail without a smart host. Not recommended. | |
| 0 | 83 |
|
364
72653295b75d
Enabled auth support per default
markus schnalke <meillo@marmaro.de>
parents:
363
diff
changeset
|
84 --disable-auth |
|
72653295b75d
Enabled auth support per default
markus schnalke <meillo@marmaro.de>
parents:
363
diff
changeset
|
85 disables ESMTP AUTH support (enabled by default) |
|
72653295b75d
Enabled auth support per default
markus schnalke <meillo@marmaro.de>
parents:
363
diff
changeset
|
86 |
| 0 | 87 |
| 165 | 88 --disable-debug |
| 175 | 89 disables debugging; setting it on the command line or in the |
| 90 configuration has no effect. Strongly discouraged, since you miss | |
| 91 valuable information if something goes wrong. | |
| 0 | 92 |
| 59 | 93 |
| 94 | |
| 165 | 95 Checking the installation |
| 96 ------------------------- | |
| 0 | 97 |
| 98 Check that 'make install' worked correctly. The following command: | |
| 99 | |
|
195
5beb5d6d9623
There was still a /usr/sbin/masqmail path
meillo@marmaro.de
parents:
194
diff
changeset
|
100 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
|
101 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/* |
| 0 | 102 |
| 103 should give output similar to | |
| 104 | |
| 165 | 105 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail |
| 59 | 106 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
|
107 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
|
108 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
|
109 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
|
110 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
|
111 drwxr-xr-x 2 mail mail 4096 May 10 12:34 /var/spool/masqmail/lock |
| 0 | 112 |
| 165 | 113 Important are the set-user-id bit for /usr/local/sbin/masqmail and |
| 114 the permissions of all files. | |
| 115 | |
| 116 | |
| 0 | 117 |
| 165 | 118 Making masqmail the default |
| 119 --------------------------- | |
| 0 | 120 |
| 165 | 121 `sendmail' is the de-facto standard name of the system's MTA, no |
| 122 matter which MTA actually runs. If you want to make masqmail the | |
| 185 | 123 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic |
| 124 links: | |
| 59 | 125 |
| 165 | 126 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail |
| 185 | 127 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail |
| 0 | 128 |
| 165 | 129 Now every mailer that used to call sendmail will now call masqmail. |
| 130 If you already had an MTA installed and running, you can kill it and | |
| 131 start masqmail. Probably with: | |
| 59 | 132 |
| 165 | 133 /etc/init.d/sendmail restart |
| 59 | 134 |
| 165 | 135 If this doesn't work as expected, you might need to add a special init |
| 136 script for masqmail. Currently none is distributed with masqmail. | |
| 137 (Hopefully this will change soon.) Please ask on the mailing list for | |
| 138 help. | |
| 59 | 139 |
| 165 | 140 You can also directly start masqmail as daemon with: |
| 59 | 141 |
| 165 | 142 /usr/local/sbin/masqmail -bd -q30m |
| 59 | 143 |
| 0 | 144 |
| 145 | |
| 165 | 146 Basic Configuration |
| 147 ------------------- | |
| 59 | 148 |
| 165 | 149 The only thing you must configure in order to use masqmail is the |
| 150 hostname. It's the name under which masqmail operates. In most cases | |
| 151 it is the same as the machine's name, but it can be different. | |
| 59 | 152 |
| 227 | 153 The script `admin/guess-hostname' tries to print the hostname of |
| 165 | 154 your machine. The first output line is probably the best choice. |
| 59 | 155 |
| 165 | 156 Create a minimal config with: |
| 59 | 157 |
| 165 | 158 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf |
| 59 | 159 |
| 165 | 160 (Substitute `HOSTNAME' with the real value, of course.) |
| 59 | 161 |
| 165 | 162 Such a setup (i.e. the default one) does: |
| 163 - deliver mail locally | |
|
206
0241aaccfcdb
default listen_addresses: use 127.0.0.1 instead of `localhost'
meillo@marmaro.de
parents:
205
diff
changeset
|
164 - 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
|
165 - 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
|
166 - accept mail on the local port 25 (SMTP) (if started with -bd) |
| 185 | 167 |
| 165 | 168 It does not |
| 185 | 169 - transfer mail to other machines |
| 165 | 170 - accept mail from outside your machine |
| 59 | 171 |
| 92 | 172 |
| 165 | 173 For more elaborate setups, have a look at docs/*setup and |
| 174 docs/INSTALL*. You can also take the example configuration files in | |
| 175 examples/ as basis for your own. Take the man pages masqmail.conf(5) | |
| 176 and masqmail.route(5) for reference. | |
| 59 | 177 |
| 165 | 178 All configuration files should go into /etc/masqmail. |
| 59 | 179 |
| 180 | |
| 181 | |
| 182 Written by oku. | |
| 165 | 183 Improved by meillo. |