* More documentation updates
authorArt Cancro <ajc@citadel.org>
Mon, 10 Feb 2003 04:50:35 +0000 (04:50 +0000)
committerArt Cancro <ajc@citadel.org>
Mon, 10 Feb 2003 04:50:35 +0000 (04:50 +0000)
citadel/ChangeLog
citadel/docs/citadel.html
citadel/docs/inetmailsetup.txt [deleted file]
citadel/docs/inetmailsetupmx.txt [deleted file]

index c7a575d2cc7dda4b64a6a25d507e1dddf6cee535..e522519031a5551a2f44e9e2a73f4075c31367f0 100644 (file)
@@ -1,4 +1,7 @@
  $Log$
+ Revision 601.128  2003/02/10 04:50:33  ajc
+ * More documentation updates
+
  Revision 601.127  2003/02/09 03:38:28  ajc
  * Updated the documentation some more
 
@@ -4453,4 +4456,3 @@ Sat Jul 11 00:20:48 EDT 1998 Nathan Bryant <bryant@cs.usm.maine.edu>
 
 Fri Jul 10 1998 Art Cancro <ajc@uncensored.citadel.org>
        * Initial CVS import
-
index d6beb891094fe543208b3704932ff5554c0abb3f..34678f0a7bffe372dd0dca4ceef57bc3cefcd9a2 100644 (file)
@@ -178,6 +178,8 @@ Citadel for Internet e-mail</a></li>
 mail protocols</a></li>
     <li><a href="#Hosting_an_Internet_mailing_list">Hosting an Internet mailing
 list</a><br>
+    <li><a href="#citmail">Using Citadel in conjunction with another
+MTA</a></li>
     </li>
   </ol>
                          
@@ -1808,8 +1810,129 @@ Internet e-mail.</p>
 
 <h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the Internet
 mail protocols</h3>
-Do stuff here.<br>
-<br>
+
+<P>As previously mentioned, Citadel contains its own SMTP, POP3, and IMAP
+services.  Enabling them is simple.</p>
+
+<P>Check for the existance of a current MTA (sendmail, qmail, etc.) by
+connecting to port 25 on your host.
+If you see something similar to the following you're running an MTA
+already and you'll need to shut it down:</p>
+
+<PRE>
+smw @ pixel % telnet localhost 25
+Trying 127.0.0.1...
+Connected to localhost.
+Escape character is '^]'.
+220 pixel.citadel.org ESMTP Sendmail 8.9.3/8.9.3; Wed, 15 Mar 2000 19:00:53 -0500
+</PRE>
+
+<P>In the above example, we see that the host already has Sendmail listening
+on port 25.  Before Citadel can use port 25, Sendmail must be shut off.
+Please consult the documentation for your operating system for instructions
+on how to do this.  (On a Red Hat Linux system, for example, you can run
+the <TT>ntsysv</tt> utility, un-checking <tt>sendmail</tt> to disable it
+at the next reboot; then, run <tt>service sendmail stop</tt> to shut off the
+currently running service.)</p>
+
+<p>If you get a 'connection refused' message when you telnet to port 25 there's 
+nothing running and you should be able to continue. You might also want to
+turn off POP (try the above test substituting 110 for 25) and IMAP (port 143)
+and use Citadel's POP and IMAP services.</p>
+
+<p>Citadel will look for an existing pop/smtp server on startup. If they don't 
+exist (and you've configured them properly) then Citadel should 
+enable them at startup.  You can check your logs to be sure, or you can 
+start the server from a shell and watch it load.  It might look something
+like this:</p>
+
+<FONT SIZE=-2><PRE>
+smw @ pixel % ./citserver
+
+Multithreaded message server for Citadel/UX
+Copyright (C) 1987-2000 by the Citadel/UX development team.
+Citadel/UX is open source, covered by the GNU General Public License, and
+you are welcome to change it and/or distribute copies of it under certain
+conditions.  There is absolutely no warranty for this software.  Please
+read the 'COPYING.txt' file for details.
+
+Loading citadel.config
+Opening databases
+This is GDBM version 1.8.0, as of May 19, 1999.
+Checking floor reference counts
+Creating base rooms (if necessary)
+Registered a new service (TCP port 504)
+Registered a new service (TCP port 0)
+Initializing loadable modules
+Registered server command CHAT (Begin real-time chat)
+Registered server command PEXP (Poll for express messages)
+Registered server command GEXP (Get express messages)
+Registered server command SEXP (Send an express message)
+Registered server command DEXP (Disable express messages)
+Registered a new session function (type 0)
+Registered a new x-msg function (priority 0)
+Loaded module: $Id$
+Registered a new session function (type 1)
+Registered a new message function (type 201)
+Registered a new message function (type 202)
+Registered server command REGI (Enter registration info)
+Registered server command GREG (Get registration info)
+Registered a new user function (type 100)
+Loaded module: $Id$
+Server-hosted upgrade level is 5.62
+Loaded module: $Id$
+Registered server command EXPI (Expire old system objects)
+Registered server command FSCK (Check message ref counts)
+Loaded module: $Id$
+<B>citserver: Can't bind: Address already in use
+ERROR: could not bind to TCP port 25.</B>
+Registered a new service (TCP port 0)
+Registered a new session function (type 50)
+Loaded module: $Id$
+<B>citserver: Can't bind: Address already in use
+ERROR: could not bind to TCP port 110.</b>
+Registered a new session function (type 0)
+Loaded module: $Id$
+Registered a new message function (type 202)Loaded module: $Id:
+serv_inetcfg.c,v 1.2 2000/02/03 03:57:35 ajc Exp $
+Registered server command RWHO (Display who is online)
+Registered server command HCHG (Masquerade hostname)
+Registered server command RCHG (Masquerade roomname)
+Registered server command UCHG (Masquerade username)
+Registered server command STEL (Enter/exit stealth mode)
+Loaded module: $Id$
+Changing uid to 513
+Starting housekeeper thread
+</PRE></FONT>
+
+<P>The lines emphasized in boldface in the above log output tell you that
+Citadel "can't bind" to various ports.  The error 'address already in use'
+generally means that something else is already running on the requested
+port.  Make SURE you've followed the above steps to remove sendmail/pop and 
+start your Citadel server again.</p>
+
+<h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
+
+<P>Occationally it is not practical to remove a non-Citadel MTA on your
+host system.  For example, you might have multiple groups of users, some of
+which are using Citadel and some of which are using a legacy Unix mail spool.
+This type of configuration is discouraged, but a tool is provided to allow
+it.</p>
+
+<P>The tool is called <tt>citmail</tt> and it is, quite simply, a local MDA
+(Mail Delivery Agent) which you can configure into your MTA for final
+delivery of incoming messages to Citadel users.  A full discussion of the
+finer points of complex Sendmail configurations is beyond the scope of this
+document; however, you might want to visit
+<a href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some
+useful HOWTO documents are provided.</p>
+
+<P>For outbound mail, you can either allow Citadel to perform deliveries
+directly (this won't affect your other mail system because outbound mail
+doesn't tie up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which
+will tell Citadel to forward all of its outbound mail to your other mail
+system.</p>
+
 <h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet mailing
 list</h3>
 It's fun. &nbsp;Try it.<br>
diff --git a/citadel/docs/inetmailsetup.txt b/citadel/docs/inetmailsetup.txt
deleted file mode 100644 (file)
index 589a185..0000000
+++ /dev/null
@@ -1,171 +0,0 @@
-Citadel/UX Internet E-mail setup instructions (native Citadel/UX version) 
-
-This document explains how to set up your citadel as an Internet e-mail
-capable system. Once you are through with this document you should be able to 
-have your users send mail from, and receive mail to 
-systemname@system.citadel.org. For example to send e-mail to a user at
-Uncensored! BBS via e-mail you would do the following:
-mail patriot@uncensored.citadel.org 
-
-To set this up is almost insanely simple. 
-
-  1. Check for the existance of a current MTA (sendmail, qmail, etc):
-     If you see something similar to the following you're running an MTA
-     already and you'll need to shut it down:
-
-      
- smw @ pixel % telnet localhost 25
- Trying 127.0.0.1...
- Connected to localhost.
- Escape character is '^]'.
- 220 pixel.citadel.org ESMTP Sendmail 8.9.3/8.9.3; Wed, 15 Mar 2000 19:00:53 -0500
-           
-
-
-
-     The above shows that pixel is running Sendmail version 8.9.3 and the
-current date. What this means is that Pixel is running the MX version of 
-bbs e-mail, which is described in inetmailsetupmx.txt. 
-     
-If you get a 'connection refused' message when you telnet to port 25 there's 
-nothing running and you should be able to continue. You might also want to
-turn off POP (try the above test substituting 110 for 25) and IMAP (port 143)
-and use Citadel's POP and IMAP services.
-
-The POP and IMAP services will ONLY allow retrieval of mail for Citadel users.
-For those of you who are running some kind of mail transport agent
-(as Pixel is, above) or POP server, the following will show how to remove
-it from a RedHat Linux system:
-
-
-                               Removing Sendmail
-
-          First cd to /etc/sysconfig.
-          As root, change (I don't recommend actively removing files
-          unless you REALLY know what you're doing) the sendmail file to
-         sendmail.old or move it from that directory completely.
-          Shut down sendmail.
-          You can either reboot or /etc/rc.d/init.d/sendmail stop, OR do a
-          ps and kill sendmail manually. Your method of choice is up to you.
-
-                             Removing POP and IMAP
-
-          cd /etc and edit inetd.conf. Look for a few lines similar to:
-
-                 # Pop and imap mail services et al
-                 #
-                 #pop-2   stream  tcp     nowait  root    /usr/sbin/tcpd ipop2d
-                 #pop-3   stream  tcp     nowait  root    /usr/sbin/tcpd ipop3d
-                 #imap    stream  tcp     nowait  root    /usr/sbin/tcpd imapd
-            
-
-          If they're already commented out you're good to go for the
-          Citadel/UX server to take over pop. If not, you'll want to
-          comment them out. 
-
-  2.Ensure you have the correct FQDN in (.A)ide (S)ystem (G)eneral
-     This is explained in siteconfig.txt. 
-  3.Add any alias FQDN's in (.A)ide (S)ystem (I)nternet
-     Explained in inetsiteconfig.txt. 
-  4.Add a Smart Host, if you need one. 
-  5.Restart your Citadel/UX server. 
-
-
-
-Some definitions:
-
-     FQDN: Fully Qualified Doman Name:
-     If your system were called 'test' on the foobar.com network, and you
-     had an entry on the internet by which you could get to your system
-     your FQDN would be test.foobar.com. For the most part, most FQDNs
-     will be your bbsname.citadel.org. Coordinate that with Freakdog on
-     DogpoundII (telnet://dogpound2.citadel.org). 
-
-     Alias FQDN:
-     Other names by which your system can be called. 
-
-     Smart Host:
-     An internet host that relays your mail for you, or a host to which 
-     you would send ALL your mail which could go out via an MX record. 
-
-
-
-Citadel will look for an existing pop/smtp server on startup. If they don't 
-exist (and you've configured them as shown in siteconfig.txt) citadel should 
-fire them up at start time. You can check your logs to be sure, or you can 
-start the  server from a shell and watch it load. It should look similar to 
-this: 
-
-
-smw @ pixel % ./citserver
-
-Multithreaded message server for Citadel/UX
-Copyright (C) 1987-2000 by the Citadel/UX development team.
-Citadel/UX is open source, covered by the GNU General Public License, and
-you are welcome to change it and/or distribute copies of it under certain
-conditions.  There is absolutely no warranty for this software.  Please
-read the 'COPYING.txt' file for details.
-
-Loading citadel.config
-Opening databases
-This is GDBM version 1.8.0, as of May 19, 1999.
-Checking floor reference counts
-Creating base rooms (if necessary)
-Registered a new service (TCP port 504)
-Registered a new service (TCP port 0)
-Initializing loadable modules
-Registered server command CHAT (Begin real-time chat)
-Registered server command PEXP (Poll for express messages)
-Registered server command GEXP (Get express messages)
-Registered server command SEXP (Send an express message)
-Registered server command DEXP (Disable express messages)
-Registered a new session function (type 0)
-Registered a new x-msg function (priority 0)
-Loaded module: $Id$
-Registered a new session function (type 1)
-Registered a new message function (type 201)
-Registered a new message function (type 202)
-Registered server command REGI (Enter registration info)
-Registered server command GREG (Get registration info)
-Registered a new user function (type 100)
-Loaded module: $Id$
-Server-hosted upgrade level is 5.62
-Loaded module: $Id$
-Registered server command EXPI (Expire old system objects)
-Registered server command FSCK (Check message ref counts)
-Loaded module: $Id$
-citserver: Can't bind: Address already in use
-ERROR: could not bind to TCP port 25.
-Registered a new service (TCP port 0)
-Registered a new session function (type 50)
-Loaded module: $Id$
-citserver: Can't bind: Address already in use
-ERROR: could not bind to TCP port 110.
-Registered a new session function (type 0)
-Loaded module: $Id$
-Registered a new message function (type 202)Loaded module: $Id:
-serv_inetcfg.c,v 1.2 2000/02/03 03:57:35 ajc Exp $
-Registered server command RWHO (Display who is online)
-Registered server command HCHG (Masquerade hostname)
-Registered server command RCHG (Masquerade roomname)
-Registered server command UCHG (Masquerade username)
-Registered server command STEL (Enter/exit stealth mode)
-Loaded module: $Id$
-Changing uid to 513
-Starting housekeeper thread
-
-Notice the two error lines below:
-citserver: Can't bind: Address already in use
-ERROR: could not bind to TCP port 110.
-
-This means that Citadel couldn't start up pop services. Generally this
-only happens if there's something on this port. In this case it's Pixel's pop 
-server (incidentally, PixelBBS uses Citadel/UX for pop).  You'll find the same
-is true for IMAP, which runs on port 143.
-
-citserver: Can't bind: Address already in use
-ERROR: could not bind to TCP port 25.
-
-This occurs whenever something is on port 25. In this case sendmail is
-there. Make SURE you've followed the above steps to remove sendmail/pop and 
-start your server again. 
diff --git a/citadel/docs/inetmailsetupmx.txt b/citadel/docs/inetmailsetupmx.txt
deleted file mode 100644 (file)
index d827041..0000000
+++ /dev/null
@@ -1,158 +0,0 @@
-Citadel/UX Internet E-mail setup instructions (mx version) 
-
-This document explains how to set up your citadel as an Internet e-mail
-capable system using your current MTA (eg, sendmail, qmail, etc) as
-opposed to using the Citadel/UX built-in servers.
-
-Once you are through with this document you should be able to have your
-users send mail from, and receive mail to
-username@bbs.bbsname.citadel.org. This version of the mailsetup document
-only pertains if you want to have local e-mail as WELL as BBS e-mail. If 
-you want ONLY your BBS users to be able to receive Internet e-mail check
-out mailsetup.html. 
-
-Note: These instructions were created using Sendmail 8.9.3. Earlier
-versions in the 8.8/8.9 line should still work, but prior to 8.8 this is
-not going to work. If you're using postfix or some aother mail server
-you're pretty much on your own, but please mail Patriot @pixel, or
-smw@pixel.citadel.org and let me know your configurations so I can add
-them to this document.
-
-
-  1.Set up an MX record for your site. 
-     Probably the most important step is this first one. This will ONLY
-     work if your internet coordinator (Freakdog @dogpound2,
-     mburger@compucomis.net if you're in the citadel.org domain) sets up
-     an MX record for your site. Or, if you have your own domain, set up
-     an MX record to point to your site. For purposes of examples I'm
-     going to use pixel (my BBS) to  show the setups. Pixel is set up as
-     pixel.citadel.org. Here's what the MX record should like
-     like in DNS on a machine in the citadel.org domain: 
-
-              bbs.pixel       IN      MX      10 pixel
-
-
-     This sets up an MX (mail exchange) id for your host and says that
-     incoming mail for  bbs.pixel.citadel.org is accepted by
-     pixel.citadel.org. Once this is set up, you should be
-     able to verify it with nslookup. Check out the nslookup session I ran
-     for Pixel, below: 
-
-     smw @ pixel % nslookup
-     Default Server:  ns1.dca.net
-     Address:  204.183.80.2
-
-     > set type=mx
-     > bbs.pixel.citadel.org
-     Server:  ns1.dca.net
-     Address:  204.183.80.2
-
-     bbs.pixel.citadel.org   preference = 10, mail exchanger = pixel.citadel.org
-     citadel.org     nameserver = linux.compucomis.net
-     citadel.org     nameserver = linux2.compucomis.net
-     citadel.org     nameserver = uncensored.citadel.org
-     citadel.org     nameserver = mansrv.manhasset.techsoftwareinc.com
-     pixel.citadel.org       internet address = 207.245.90.41
-     linux.compucomis.net    internet address = 207.8.143.10
-     linux2.compucomis.net   internet address = 207.8.143.13
-     uncensored.citadel.org  internet address = 66.9.37.38
-     >
-
-     As you can see pixel.citadel.org is listed as a mail exchanger for
-     bbs.pixel.citadel.org. Since you can see that with nslookup the
-     changes are out there and you're ready to get started. 
-
-  2.Set up sendmail 
-     
-     Sendmail has 'mailertable' functionality. If you already are running
-     sendmail with mailertable you can pretty much skip this step. If not,
-     read on:
-     
-       Locate the mailertable entry in /etc/sendmail.cf. (Kmailertable hash -o
-       /etc/mail/mailertable.db) and uncomment it. 
-       Search for the word 'mailertable again'. You should eventually
-       find an entry similar to this:
-
-
-      # not local -- try mailer table lookup
-      R$* <@ $+ > $*          $: < $2 > $1 < @ $2 > $3        extract host name
-      R< $+ . > $*            $: < $1 > $2                    strip trailing dot
-      R< $+ > $*              $: < $(mailertable $1 $) > $2   lookup
-      R< $~[ : $* > $*        $>95 < $1 : $2 > $3             check -- resolved?
-      R< $+ > $*              $: $>90 <$1> $2                 try domain
-
-          This entry should look similar to yours, and should NOT be
-          commented out. Be sure that it's uncommented.
-          Add the entry for citadel to be a local mailer:
-          Search for Mlocal, in sendmail.cf. Add the following after the
-          Mprog section:
-
-
-  Mcitadel,       P=/usr/local/citadel/citmail, F=lsDFMoqeu9S, S=10/30, R=20/40,
-                  D=$z:/, T=X-Unix, U=bbs,
-                  A=/usr/local/citadel/citmail $u
-
-
-         Notice /usr/local/citadel is the path to Pixel's citadel home
-         directory. Replace this witha your citadel's home dir.
-
-         Set up the mailertable itself: In the Kmailertable line above
-         there was a path to your
-         mailertable. In this case it's /etc/mail/mailertable.db. For
-         this example that's the file we'll use. cd /etc/mail and edit
-         mailertable. (don't worry if there's no file there called
-         mailertable. Simply create a new one.) This is the mailertable
-         for pixel:
-
-
-                       bbs.pixel.citadel.org      citadel:localhost       
-
-
-          Please note that the whitespaces are tabs. You need one after
-          bbs.mysite.org and citadel:localhost.
-          Compile the mailertable.
-          makemap -v hash mailertable.db < mailertable
-          That line simply makes a readable hashed database that sendmail
-          can read out of the mailertable entry you created. For the
-          entry above this should look similar to this:
-
-          key='bbs.pixel.citadel.org', val='citadel:localhost'
-          
-          Restart sendmail. If you're running later releases of Red Hat
-          Linux (for example) you can just do: /etc/rc.d/init.d/sendmail
-          restart. For others use the kill/restart method that  works best
-          for you.
-
-  3. In your bbs now, do a .as and change your FQDN to reflect your new MX
-     record. You should NOT have to restart citadel:
-
-                     Lobby> . Aide System configuration
-                     Node name [pixel]:
-                     Fully qualified domain name [bbs.pixel.citadel.org]:
-
-
-
-A few notes: 
-
-     Mail sent from the BBS to an internet e-mail address should go out
-immediately. E-mail coming IN to a bbs user will not process until your
-next network session.  On my site I had to set up a relay for
-bbs.pixel.citadel.org. In later versions of sendmail relaying is turned
-off by default. Check sendmail.cf for the following line:
-
-     FR-o /etc/mail/relay-domains
-
-If that line is commented out you're allowing relaying from any host. 
-Not recommended. I won't tell you how to run your sendmail but it's 
-usually better NOT to relay. If that line is commented out, no problems
-(aside from the obvious spam issues with relaying for the entire
-planet.:). If it isn't commented out udpdate/create the file
-
- /etc/mail/relay-domains 
-
-and put your new entry in it. For pixel this is: bbs.pixel.citadel.org. 
-
-
-
-Please contact me with questions/problems or just to let me know it's up
-and running. I'd be interested in hearing from folks. smw@pixel.citadel.org