summaryrefslogtreecommitdiff
path: root/HOWTO
diff options
context:
space:
mode:
Diffstat (limited to 'HOWTO')
-rw-r--r--HOWTO41
1 files changed, 41 insertions, 0 deletions
diff --git a/HOWTO b/HOWTO
new file mode 100644
index 0000000..7115854
--- /dev/null
+++ b/HOWTO
@@ -0,0 +1,41 @@
+Configuration of this program in the typical case is quite simple.
+
+1. Compile and install the program. If you are using the RPM, skip this
+step. See the INSTALL file for more details. Note that this package is
+designed to execute as a non-priveleged user named "nullmail". When you
+do the final install, add the "nullmail" user (typically with either a
+non-priveleged group or a new "nullmail" group) and run "make
+install-root" to set up the files with the proper permissions.
+
+2. Determine who your relay host is. This is the computer or computers
+to which you will send all your mail.
+
+3. Into the file SYSCONFDIR/nullmailer/remotes, put one line for each of
+your relay hosts:
+ HOSTNAME PROTOCOL
+You will have specified the SYSCONFDIR during configuration of the
+install step. On most systems, it will be /usr/local/etc. The RPMs use
+/etc. HOSTNAME is the fully-qualified host name of the relay host, or
+its numerical IP address. PROTOCOL will typically be "smtp" (without
+the quotes), but QMQP[1] is also supported with the "qmqp" module.
+
+4. Start nullmailer-send. If you are using the RPM, ignore the rest of
+the instructions and type:
+ /etc/rc.d/init.d/nullmailer start
+Otherwise, you will need to set up the appropriate scripts to run
+nullmailer-send in the background, with its output going to a logging
+program. The following is an appropriate run script for use with
+daemontools[2]:
+ #!/bin/sh
+ exec setuidgid nullmail nullmailer-send 2>&1
+
+5. You're done! The included sendmail emulator front-end should allow
+most (if not all) sendmail-compatible programs to run without any
+changes. See the man page for nullmailer-inject for details on outgoing
+email message header formatting options.
+
+Footnotes:
+1. QMQP is a high-speed mail queueing protocol, used with qmail. See
+http://cr.yp.to/proto/qmqp.html
+2. See http://cr.yp.to/daemontools.html. I have RPMS available at
+http://em.ca/~bruceg/rpms/daemontools/