masqmail

view INSTALL @ 34:8ea86ac25658

reformating of man page sources with some typographic improvements
author meillo@marmaro.de
date Fri, 07 May 2010 13:50:23 +0200
parents
children 941413084f56
line source
1 simple installation instructions, see docs/install.html for more.
3 To compile MasqMail you need glib 1.2 (http://www.gtk.org).
5 You need a user and a group for masqmail to run, I suggest user
6 'mail' and group 'trusted'. Say:
8 groupadd -g 42 trusted
9 useradd -u 42 -g 42 -d / -s /bin/sh -c "Mail Transfer Agent" mail
11 If you use other names than 'mail' and 'trusted' use the options
12 described below for configure. The 42 is just a suggestion, you can
13 use any number you like, but preferably one < 100. It does not have
14 to be the same for the user 'mail' and the group 'trusted'.
16 Then do:
18 ./configure
19 make
20 make install
22 Debian:
23 If you compile for Debian, do the configure with at least these options,
24 this makes it compatible with the official debian package:
25 ./configure --with-liblockfile --with-group=mail
26 you do not need the group 'trusted', use 'mail' instead.
28 You can also build your own Debian package with
29 dpkg-buildpackage -rfakeroot
30 You need to have fakeroot installed to do this. Or, as root, do:
31 dpkg-buildpackage
33 SuSE/Redhat:
34 There are spec files for rpm creation in suse/ or redhat/. You may have to adjust these files.
37 Sorry, but after that you are not yet finished. For instruction on how
38 to deliver mail using a connection to your ISP see
39 docs/install.html. It is probably a good idea to copy the files
40 docs/*.html to a directory where you can access them with a browser.
42 additional options for configure:
43 ---------------------------------
45 --with-user=USER sets the user as which MasqMail will run. Default is
46 'mail'. USER has to exist before you 'make install'.
48 --with-group=GROUP sets the group as which MasqMail will run. Default
49 is 'trusted'. GROUP has to exist before you 'make install'.
51 --with-logdir=LOGDIR sets the directory where MasqMail stores its log
52 files. It will be created if it does not exist. Default is /var/masqmail/.
54 --with-spooldir=SPOOLDIR sets the directory where MasqMail stores its
55 spool files. It will be created if it does not exist. Default is
56 /var/spool/masqmail/.
58 --with-confdir=CONFDIR sets the default configuration directory to
59 CONFDIR, in case you prefer another location than /etc/masqmail/.
61 --enable-auth enables ESMTP AUTH support (disabled by default)
63 --disable-pop3 disables pop3 support (enabled by default)
65 --enable-maildir enables qmail style Maildir support (disabled by default)
67 --enable-ident enable RFC 1413 support. If you have the libident
68 dynamic library installed, this will be linked, otherwise it will be
69 statically linked using the sources included in the package.
71 --disable-resolver disable resolver support. Without the resolver functions,
72 masqmail uses only gethostbyname() to resolve DNS names, and you cannot send
73 mail without a smart host. Not recommended. You save 3K at most.
75 --disable-smtp-server disable SMTP server support. You may want this if you do
76 not need masqmail to listen. In this case, you cannot use masqmail as a smart
77 host for other hosts on your LAN, you cannot use mail clients that send SMTP,
78 you cannot even use pine. In short, use of this option is discouraged unless
79 your resources are extremely limited.
81 --enable-mserver enable online detection by connecting to the mserver
82 (masqdialer system).
84 --with-libcryto instead of using the md5 and hmac functions within the package,
85 link dynamically with libcrypto. This applies only if you have pop3 or SMTP
86 AUTH enabled. Makes only sense if your resources are limited and you have
87 libcrypto installed. Untested.
89 --with-glib-static link with glib statically. This makes the binary larger
90 by around 30K (i386 architecture), but if masqmail is the only binary using
91 glib, you save some space in total, because you do not need the shared glib
92 library installed.
94 --disable-debug disable debugging, setting it on by command line or configuration
95 has no effect. Strongly discouraged, since you miss valuable information if something
96 goes wrong. You save 6K.
98 BTW, to get 3K of space, call
99 strip --remove-section=.comment --remove-section=.note --strip-unneeded src/masqmail
101 after make install:
102 -------------------
104 You can also use these instructions to omit 'make install' if you do
105 not want to use it.
107 Check that 'make install' worked correctly. The following command:
109 ls -ld /usr/sbin/masqmail /var/masqmail/ /var/spool/masqmail /var/spool/masqmail/input
111 should give output similar to
113 -rwsr-xr-x 1 root root 86955 Oct 14 14:27 /usr/sbin/masqmail
114 drwxr-xr-x 2 mail trusted 1024 Oct 14 14:29 /var/masqmail/
115 drwxr-xr-x 3 mail trusted 1024 Oct 14 14:27 /var/spool/masqmail
116 drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/input
117 drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/lock
118 drwxr-xr-x 2 mail trusted 1024 Oct 14 18:32 /var/spool/masqmail/popuidl
120 (important is the set-user-id bit for /usr/sbin/masqmail and the
121 ownership of all items).
123 Use the example configuration files in examples/ to edit your own. The
124 main configuration should go to /etc/masqmail.conf. I recommend to
125 make a directory /etc/masqmail for the *.route amd *.get files.
127 The default destination for the executable 'masqmail' is
128 /usr/sbin. Check that it has the set user id bit set. (chmod u+s
129 /usr/sbin/masqmail does no harm in any case).
131 If you want to replace sendmail, move your old sendmail binary to
132 another name and make a symbolic link /usr/sbin/sendmail ->
133 /usr/sbin/masqmail.