Mercurial > masqmail
annotate INSTALL @ 203:45acc5727493
removed --with-glib-static configure option
linking glib statically is interesting if no other program uses it
on today's systems glib is widely used
if one cares on linking statically, he can link everything statically
the special case for glib will not get special care anymore
| author | meillo@marmaro.de |
|---|---|
| date | Fri, 16 Jul 2010 14:48:17 +0200 |
| parents | 5beb5d6d9623 |
| children | 5745edd5b769 |
| 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 |
| 15 grep '^trusted:' /etc/group | |
| 16 | |
| 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: | |
| 0 | 19 |
| 59 | 20 groupadd -g 42 trusted |
|
194
346955794084
specified group by name; added path to --with-glib-static
meillo@marmaro.de
parents:
192
diff
changeset
|
21 useradd -u 23 -g trusted -d /nonexistent -s /bin/false -c "masqmail MTA" mail |
| 0 | 22 |
| 165 | 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'. | |
| 28 | |
| 0 | 29 |
|
174
dbe3dadd1afe
Documentation improvements in the INSTALL file and some man pages
meillo@marmaro.de
parents:
92
diff
changeset
|
30 Compiling is a matter of the usual procedure. In the source directory, |
| 59 | 31 after unpacking do: |
| 0 | 32 |
| 59 | 33 ./configure |
| 34 make | |
| 35 make install | |
| 0 | 36 |
| 37 | |
| 38 | |
| 59 | 39 Additional options for configure |
| 40 -------------------------------- | |
| 0 | 41 |
| 59 | 42 See the output of |
| 43 | |
| 44 ./configure -h | |
| 45 | |
| 165 | 46 Here is a selection of the options with additional explanations: |
| 0 | 47 |
| 165 | 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'. | |
| 0 | 51 |
| 165 | 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'. | |
| 0 | 55 |
| 165 | 56 |
| 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/. | |
| 0 | 60 |
| 165 | 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/. | |
| 0 | 64 |
| 165 | 65 --with-confdir=CONFDIR |
| 66 sets the default configuration directory to CONFDIR, in case you | |
| 67 prefer another location than /etc/masqmail/. | |
| 68 | |
| 0 | 69 |
| 165 | 70 --enable-auth |
| 71 enables ESMTP AUTH support (disabled by default) | |
| 0 | 72 |
| 165 | 73 --enable-maildir |
| 74 enables qmail style Maildir support (disabled by default) | |
| 0 | 75 |
| 165 | 76 --enable-ident |
| 175 | 77 enables RFC 1413 support. If you have the libident dynamic library |
| 165 | 78 installed, this will be linked, otherwise it will be statically linked |
| 79 using the sources included in the package. | |
| 0 | 80 |
| 165 | 81 --disable-resolver |
| 175 | 82 disables resolver support. Without the resolver functions, masqmail |
| 165 | 83 uses only gethostbyname() to resolve DNS names, and you cannot send |
| 84 mail without a smart host. Not recommended. | |
| 0 | 85 |
| 165 | 86 --disable-smtp-server |
| 175 | 87 disables SMTP server support. You may want this if you do not need |
| 165 | 88 masqmail to listen. In this case, you cannot use masqmail as a smart |
| 89 host for other hosts on your LAN, you cannot use mail clients that | |
| 90 send SMTP, you cannot even use pine. In short, use of this option is | |
| 91 discouraged unless your resources are extremely limited. | |
| 0 | 92 |
| 93 | |
| 165 | 94 --with-libcryto |
| 95 instead of using the md5 and hmac functions within the package, link | |
| 192 | 96 dynamically with libcrypto. This applies only if you have SMTP AUTH |
| 97 enabled. Only makes sense if your resources are limited and you have | |
| 98 libcrypto installed. Untested. | |
| 0 | 99 |
| 100 | |
| 165 | 101 --disable-debug |
| 175 | 102 disables debugging; setting it on the command line or in the |
| 103 configuration has no effect. Strongly discouraged, since you miss | |
| 104 valuable information if something goes wrong. | |
| 0 | 105 |
| 59 | 106 |
| 107 | |
| 165 | 108 Checking the installation |
| 109 ------------------------- | |
| 0 | 110 |
| 111 Check that 'make install' worked correctly. The following command: | |
| 112 | |
|
195
5beb5d6d9623
There was still a /usr/sbin/masqmail path
meillo@marmaro.de
parents:
194
diff
changeset
|
113 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
|
114 /var/run/masqmail /var/spool/masqmail/ /var/spool/masqmail/* |
| 0 | 115 |
| 116 should give output similar to | |
| 117 | |
| 165 | 118 -rwsr-xr-x 1 root root 399356 May 10 12:34 /usr/local/sbin/masqmail |
| 59 | 119 drwxr-xr-x 2 root root 4096 May 10 12:34 /etc/masqmail |
| 120 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/log/masqmail | |
| 121 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/run/masqmail | |
| 122 drwxr-xr-x 5 mail trusted 4096 May 10 12:34 /var/spool/masqmail | |
| 123 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/input | |
| 124 drwxr-xr-x 2 mail trusted 4096 May 10 12:34 /var/spool/masqmail/lock | |
| 0 | 125 |
| 165 | 126 Important are the set-user-id bit for /usr/local/sbin/masqmail and |
| 127 the permissions of all files. | |
| 128 | |
| 129 | |
| 0 | 130 |
| 165 | 131 Making masqmail the default |
| 132 --------------------------- | |
| 0 | 133 |
| 165 | 134 `sendmail' is the de-facto standard name of the system's MTA, no |
| 135 matter which MTA actually runs. If you want to make masqmail the | |
| 185 | 136 system's MTA (i.e. replace sendmail, postfix, etc), make two symbolic |
| 137 links: | |
| 59 | 138 |
| 165 | 139 ln -s /usr/local/sbin/masqmail /usr/lib/sendmail |
| 185 | 140 ln -s /usr/local/sbin/masqmail /usr/sbin/sendmail |
| 0 | 141 |
| 165 | 142 Now every mailer that used to call sendmail will now call masqmail. |
| 143 If you already had an MTA installed and running, you can kill it and | |
| 144 start masqmail. Probably with: | |
| 59 | 145 |
| 165 | 146 /etc/init.d/sendmail restart |
| 59 | 147 |
| 165 | 148 If this doesn't work as expected, you might need to add a special init |
| 149 script for masqmail. Currently none is distributed with masqmail. | |
| 150 (Hopefully this will change soon.) Please ask on the mailing list for | |
| 151 help. | |
| 59 | 152 |
| 165 | 153 You can also directly start masqmail as daemon with: |
| 59 | 154 |
| 165 | 155 /usr/local/sbin/masqmail -bd -q30m |
| 59 | 156 |
| 0 | 157 |
| 158 | |
| 165 | 159 Basic Configuration |
| 160 ------------------- | |
| 59 | 161 |
| 165 | 162 The only thing you must configure in order to use masqmail is the |
| 163 hostname. It's the name under which masqmail operates. In most cases | |
| 164 it is the same as the machine's name, but it can be different. | |
| 59 | 165 |
| 165 | 166 The script `contrib/guess-hostname' tries to print the hostname of |
| 167 your machine. The first output line is probably the best choice. | |
| 59 | 168 |
| 165 | 169 Create a minimal config with: |
| 59 | 170 |
| 165 | 171 echo "host_name = HOSTNAME" >/etc/masqmail/masqmail.conf |
| 59 | 172 |
| 165 | 173 (Substitute `HOSTNAME' with the real value, of course.) |
| 59 | 174 |
| 165 | 175 Such a setup (i.e. the default one) does: |
| 176 - deliver mail locally | |
| 177 - accept mail from local (via stdin) | |
| 185 | 178 - accept mail on localhost:25 (via SMTP) (if started as daemon) |
| 179 | |
| 165 | 180 It does not |
| 185 | 181 - transfer mail to other machines |
| 165 | 182 - accept mail from outside your machine |
| 59 | 183 |
| 92 | 184 |
| 165 | 185 For more elaborate setups, have a look at docs/*setup and |
| 186 docs/INSTALL*. You can also take the example configuration files in | |
| 187 examples/ as basis for your own. Take the man pages masqmail.conf(5) | |
| 188 and masqmail.route(5) for reference. | |
| 59 | 189 |
| 165 | 190 All configuration files should go into /etc/masqmail. |
| 59 | 191 |
| 192 | |
| 193 | |
| 194 Written by oku. | |
| 165 | 195 Improved by meillo. |