/ [anubis] / anubis / README
To checkout: cvs -d:pserver:anonymous@cvs.gnu.org.ua:/cvsmirror/anubis co anubis/README
Puszcza

Contents of /anubis/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.15 - (show annotations)
Wed Oct 31 00:56:37 2007 UTC (14 years, 3 months ago) by gray
Branch: MAIN
CVS Tags: anubis_4_1, HEAD
Changes since 1.14: +77 -69 lines
Clean up formatting.

1
2 Introduction
3 ============
4
5 GNU Anubis is an SMTP message submission daemon. It represents an
6 intermediate layer between mail user agent (MUA) and mail transport agent
7 (MTA), receiving messages from the MUA, applying to them a set of
8 predefined changes and finally inserting modified messages into an MTA
9 routing network. The set of changes applied to a message is configurable on
10 a system-wide and per-user basis. The built-in configuration language used
11 for defining sets of changes allows for considerable flexibility and is
12 easily extensible.
13
14 --------* --------** ------***
15 | MUA | ---> | Anubis | ---> | MTA |
16 --------- ---------- ---------
17
18 * Mail User Agent (client)
19 ** An SMTP message submission daemon.
20 *** Mail Transport Agent (server)
21
22 GNU Anubis is GNU software. See the home page at:
23 http://www.gnu.org/software/anubis/
24
25 License:
26 GNU Anubis is free software distributed under the terms of GNU General
27 Public License version 3 or later. See the file COPYING for the copying
28 conditions.
29
30
31 SUPPORTED SOFTWARE
32 ==================
33
34 Recommended:
35
36 * GSASL -- an implementation of the SASL framework
37 (http://www.gnu.org/software/gsasl/). Anubis requires GSASL version
38 0.2.3 or newer.
39
40 * A database, any from the following:
41 - GDBM -- (http://www.gnu.org/software/gdbm/).
42 - MySQL -- (http://www.mysql.com/).
43 - PostgreSQL -- (http://www.postgresql.com/)
44
45 * GnuTLS -- a Transport Layer Security Library
46 (http://www.gnutls.org/)
47 * Guile -- The GNU extension language (http://www.gnu.org/software/guile/).
48 * GnuPG -- The GNU Privacy Guard (http://www.gnupg.org/)
49 with GPGME -- GnuPG Made Easy (http://www.gnupg.org/gpgme.html).
50
51 Optional:
52
53 * The TCP/IP Identification Protocol (RFC 1413) server (any).
54 * PCRE -- Perl-Compatible Regular Expression Library (http://www.pcre.org/).
55 * PAM -- Pluggable Authentication Modules
56 (http://www.kernel.org/pub/linux/libs/pam/).
57 * libwrap (TCP wrappers) -- an access control library.
58
59
60 INSTALLATION
61 ============
62
63 $ ./configure
64 $ make
65 $ make check (optional)
66 $ make install
67
68 By default, GNU Anubis will be installed in `/usr/local/sbin/anubis',
69 but this can be changed with the `--prefix' command, for instance:
70
71 $ ./configure --prefix=/usr
72 $ make
73 $ make check (optional)
74 $ make install
75
76 For better control, use the options below:
77
78 `--with-gsasl' to support SASL authentication.
79 `--with-mysql' to support MySQL database.
80 `--with-postgres' to support PostgreSQL database.
81 `--with-pcre' to support Perl-compatible regular expressions.
82 `--with-pam' to support Pluggable Authentication Modules.
83 `--with-socks-proxy' to support SOCKS v4/5 proxy support.
84 `--with-tcp-wrappers' to support libwrap (TCP wrappers).
85 `--without-gnutls' to disable GnuTLS support.
86 `--without-gpgme' to disable GNU Privacy Guard (GPGME) support.
87 `--without-guile' to disable Guile support.
88
89 `--with-unprivileged-user=USER'
90 to set an unprivileged user (default is "nobody").
91
92 Next, write a proper init script for your system. See the examples in
93 the `scripts' directory (part of the distribution).
94
95 NOTE: Remember about activating GNU Anubis with `ntsysv' tool or
96 similar, and configure its system configuration file (read the GNU Anubis
97 Manual about this topic).
98
99 CAUTION: It is now optional to install the TCP/IP IDENT protocol server
100 (RFC 1413). It depends on whether you are going to use a "transparent"
101 mode, or not. Please consult the documentation. Most modern GNU/Linux (or
102 *BSD) distributions come with an IDENT server. If you don't have it, try
103 `pidentd', available at: ftp://ftp.lysator.liu.se/pub/ident/servers/
104
105
106 Editing Configuration Files with GNU Emacs
107 ==========================================
108
109 The file elisp/anubis-mode.el provides the Emacs major mode for editing
110 Anubis configuration files.
111
112 After `make install' Emacs should be able to use anubis-mode when
113 editing appropriate configuration files. You will have to add the following
114 to your .emacs or site-start file:
115
116 (autoload 'anubis-mode "anubis-mode")
117 (setq auto-mode-alist (append auto-mode-alist
118 '(("/.anubisrc$" . anubis-mode)
119 ("/anubisrc$" . anubis-mode))))
120
121 You may also wish to modify the following variables:
122
123 * anubis-path
124
125 The path to the anubis executable. Use this if anubis cannot be found
126 using the search path.
127
128 * anubis-section-body-indent
129
130 Sets the indentation level for a section body. Defaults to 0.
131
132 * anubis-level-indent
133
134 Sets amount of indentation per block nesting level. Defaults to 2.
135
136
137 ^L
138 Local Variables:
139 mode: auto-fill
140 fill-column: 75
141 paragraph-separate: "[ ^L]*$"
142 version-control: never
143 End:

Send suggestions and bug reports to Sergey Poznyakoff
ViewVC Help
Powered by ViewVC 1.1.20