1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <title>Citadel/UX Documentation</title>
6 <meta http-equiv="content-type"
7 content="text/html; charset=ISO-8859-1">
14 <h2>a messaging and collaboration platform for BBS and groupware applications</h2>
15 Copyright ©1987-2003 by the Citadel development team:<br>
18 <table cellpadding="2" cellspacing="2" border="0" align="center">
21 <td valign="top">Steven M. Bellovin<br>
23 <td valign="top"><i>author of public domain 'parsedate' function<br>
27 <td valign="top">Nathan Bryant<br>
29 <td valign="top"><i>build system, security, database access,
34 <td valign="top">Art Cancro<br>
36 <td valign="top"><i>overall system design and lead developer<br>
40 <td valign="top">Brian Costello<br>
42 <td valign="top"><i>cosmetics, additional commands<br>
46 <td valign="top">Michael Hampton<br>
48 <td valign="top"><i>client software development<br>
52 <td valign="top">Andru Luvisi<br>
54 <td valign="top"><i>troubleshooting and development assistance<br>
58 <td valign="top">Daniel Malament<br>
60 <td valign="top"><i>string compare function for IMAP server<br>
64 <td valign="top">Stu Mark<br>
66 <td valign="top"><i>additional client features, IGnet protocol
71 <td valign="top">Ben Mehlman<br>
73 <td valign="top"><i>additional client features<br>
77 <td valign="top">Ari Samson<br>
79 <td valign="top"><i>assistance with project management<br>
83 <td valign="top">John Walker<br>
85 <td valign="top"><i>author of public domain base64 encoder/decoder<br>
89 <td valign="top">Steve Williams<br>
91 <td valign="top"><i>documentation<br>
95 <td valign="top">Ethan Young<br>
97 <td valign="top"><i>IGnet protocol design<br>
106 <div align="justify">The entire package is open source; you can redistribute
107 and/or modify it under the terms of the GNU General Public License as
108 published by the Free Software Foundation; either version 2 of the License,
109 or (at your option) any later version.<br>
111 This program is distributed in the hope that it will be useful,
112 but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
113 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
114 License for more details. </div>
116 <div align="justify"><br>
117 For more information, visit either of these locations on the web:<br>
120 <li>The Citadel home page: <a href="http://www.citadel.org">http://www.citadel.org</a></li>
121 <li>UNCENSORED! BBS, the home of Citadel: <a
122 href="http://uncensored.citadel.org">http://uncensored.citadel.org</a></li>
126 <hr width="100%" size="2">
127 <h2 align="center">Table of Contents</h2>
130 <li><a href="#GPL">License</a></li>
131 <li><a href="#Installation">Installation</a></li>
134 <li><a href="#Everything_in_its_place...">Everything in its place...</a></li>
135 <li><a href="#The_BBS_Login">The BBS Login</a></li>
136 <li><a href="#Bypassing_the_login:_prompt">Bypassing the login: prompt</a></li>
137 <li><a href="#Compiling_the_programs">Compiling the programs</a></li>
138 <li><a href="#Upgrading">Upgrading</a></li>
139 <li><a href="#The_citadel.rc_file">The citadel.rc file</a></li>
140 <li><a href="#Using_an_external_editor_for_message">Using an external
141 editor for message composition</a></li>
142 <li><a href="#Printing_messages">Printing messages</a></li>
143 <li><a href="#URL_viewing">URL viewing</a></li>
144 <li><a href="#Setup_and_login">Setup and login</a></li>
145 <li><a href="#Configuring_your_host_system_to_start">Configuring your
146 host system to start the service</a></li>
147 <li><a href="#Logging_in_for_the_first_time">Logging in for the first
149 <li><a href="#Welcoming_new_users">Welcoming new users</a></li>
150 <li><a href="#Space_for_adding_your_own_client">Space for adding your
151 own client features (doors)</a></li>
152 <li><a href="#Troubleshooting_and_getting_help">Troubleshooting and
157 <li><a href="#sysop">System Administration</a></li>
160 <li><a href="#Overview_">Overview</a></li>
161 <li><a href="#Aide_commands">Aide commands</a></li>
162 <li><a href="#Editing_rooms">Editing rooms</a></li>
163 <li><a href="#File_directories">File directories</a></li>
164 <li><a href="#Creating_and_editing_user_accounts">Creating and editing
165 user accounts</a></li>
166 <li><a href="#Deleting_and_moving_messages">Deleting and moving messages</a></li>
167 <li><a href="#Customizing_the_help_files">Customizing the help files</a></li>
168 <li><a href="#Site_configuration">Site configuration</a><br>
172 <li> <a href="#Configuring_Citadel_for_Internet_e-mail">Configuring
173 Citadel for Internet e-mail</a></li>
175 <li><a href="#Introduction">Introduction</a></li>
176 <li><a href="#Basic_site_configuration">Basic site configuration</a></li>
177 <li><a href="#Enabling_the_Internet_mail_protocols">Enabling the Internet
178 mail protocols</a></li>
179 <li><a href="#Hosting_an_Internet_mailing_list">Hosting an Internet mailing
181 <li><a href="#citmail">Using Citadel in conjunction with another
189 <hr width="100%" size="2"><br>
191 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
195 <p> Version 2, June 1991 </p>
197 <pre>Copyright (C) 1989, 1991 Free Software Foundation, Inc. <br>59 Temple Place - Suite 330, Boston, MA 02111-1307, USA<br><br>Everyone is permitted to copy and distribute verbatim copies<br>of this license document, but changing it is not allowed.<br></pre>
199 <h3 align="justify">Preamble</h3>
201 <div align="justify"> </div>
203 <p align="justify"> The licenses for most software are designed to take
204 away your freedom to share and change it. By contrast, the GNU General
205 Public License is intended to guarantee your freedom to share and change
206 free software--to make sure the software is free for all its users. This
207 General Public License applies to most of the Free Software Foundation's
208 software and to any other program whose authors commit to using it. (Some
209 other Free Software Foundation software is covered by the GNU Library
210 General Public License instead.) You can apply it to your programs, too.
213 <div align="justify"> </div>
215 <p align="justify"> When we speak of free software, we are referring to
216 freedom, not price. Our General Public Licenses are designed to make
217 sure that you have the freedom to distribute copies of free software (and
218 charge for this service if you wish), that you receive source code or
219 can get it if you want it, that you can change the software or use pieces
220 of it in new free programs; and that you know you can do these things. </p>
222 <div align="justify"> </div>
224 <p align="justify"> To protect your rights, we need to make restrictions
225 that forbid anyone to deny you these rights or to ask you to surrender
226 the rights. These restrictions translate to certain responsibilities for
227 you if you distribute copies of the software, or if you modify it. </p>
229 <div align="justify"> </div>
231 <p align="justify"> For example, if you distribute copies of such a program,
232 whether gratis or for a fee, you must give the recipients all the rights
233 that you have. You must make sure that they, too, receive or can get
234 the source code. And you must show them these terms so they know their
237 <div align="justify"> </div>
239 <p align="justify"> We protect your rights with two steps: (1) copyright
240 the software, and (2) offer you this license which gives you legal permission
241 to copy, distribute and/or modify the software. </p>
243 <div align="justify"> </div>
245 <p align="justify"> Also, for each author's protection and ours, we want
246 to make certain that everyone understands that there is no warranty for
247 this free software. If the software is modified by someone else and passed
248 on, we want its recipients to know that what they have is not the original,
249 so that any problems introduced by others will not reflect on the original
250 authors' reputations. </p>
252 <div align="justify"> </div>
254 <p align="justify"> Finally, any free program is threatened constantly
255 by software patents. We wish to avoid the danger that redistributors of
256 a free program will individually obtain patent licenses, in effect making
257 the program proprietary. To prevent this, we have made it clear that any
258 patent must be licensed for everyone's free use or not licensed at all.
261 <div align="justify"> </div>
263 <p align="justify"> The precise terms and conditions for copying, distribution
264 and modification follow. </p>
266 <div align="justify"> </div>
268 <h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
270 <div align="justify"> </div>
272 <p align="justify"> <strong>0.</strong> This License applies to any program
273 or other work which contains a notice placed by the copyright holder
274 saying it may be distributed under the terms of this General Public License.
275 The "Program", below, refers to any such program or work, and a "work
276 based on the Program" means either the Program or any derivative work under
277 copyright law: that is to say, a work containing the Program or a portion
278 of it, either verbatim or with modifications and/or translated into another
279 language. (Hereinafter, translation is included without limitation in the
280 term "modification".) Each licensee is addressed as "you". </p>
282 <p align="justify"> Activities other than copying, distribution and modification
283 are not covered by this License; they are outside its scope. The act
284 of running the Program is not restricted, and the output from the Program
285 is covered only if its contents constitute a work based on the Program
286 (independent of having been made by running the Program). Whether that is
287 true depends on what the Program does. </p>
289 <p align="justify"> <strong>1.</strong> You may copy and distribute verbatim
290 copies of the Program's source code as you receive it, in any medium,
291 provided that you conspicuously and appropriately publish on each copy
292 an appropriate copyright notice and disclaimer of warranty; keep intact
293 all the notices that refer to this License and to the absence of any warranty;
294 and give any other recipients of the Program a copy of this License along
295 with the Program. </p>
297 <p align="justify"> You may charge a fee for the physical act of transferring
298 a copy, and you may at your option offer warranty protection in exchange
301 <p align="justify"> <strong>2.</strong> You may modify your copy or copies
302 of the Program or any portion of it, thus forming a work based on the
303 Program, and copy and distribute such modifications or work under the
304 terms of Section 1 above, provided that you also meet all of these conditions:
307 <p align="justify"> </p>
309 <div align="justify">
311 <li><strong>a)</strong> You must cause the modified files
312 to carry prominent notices stating that you changed the files and
313 the date of any change.
316 <li><strong>b)</strong> You must cause any work that you distribute
317 or publish, that in whole or in part contains or is derived from
318 the Program or any part thereof, to be licensed as a whole at no
319 charge to all third parties under the terms of this License.
323 <li><strong>c)</strong> If the modified program normally reads
324 commands interactively when run, you must cause it, when started running
325 for such interactive use in the most ordinary way, to print or display
326 an announcement including an appropriate copyright notice and a
327 notice that there is no warranty (or else, saying that you provide
328 a warranty) and that users may redistribute the program under these
329 conditions, and telling the user how to view a copy of this License.
330 (Exception: if the Program itself is interactive but does not normally
331 print such an announcement, your work based on the Program is not
332 required to print an announcement.) </li>
335 These requirements apply to the modified work as a whole. If identifiable
336 sections of that work are not derived from the Program, and can be reasonably
337 considered independent and separate works in themselves, then this License,
338 and its terms, do not apply to those sections when you distribute them
339 as separate works. But when you distribute the same sections as part
340 of a whole which is a work based on the Program, the distribution of the
341 whole must be on the terms of this License, whose permissions for other
342 licensees extend to the entire whole, and thus to each and every part
343 regardless of who wrote it. </div>
345 <p align="justify"> Thus, it is not the intent of this section to claim
346 rights or contest your rights to work written entirely by you; rather, the
347 intent is to exercise the right to control the distribution of derivative
348 or collective works based on the Program. </p>
350 <p align="justify"> In addition, mere aggregation of another work not based
351 on the Program with the Program (or with a work based on the Program)
352 on a volume of a storage or distribution medium does not bring the other
353 work under the scope of this License. </p>
355 <p align="justify"> <strong>3.</strong> You may copy and distribute the
356 Program (or a work based on it, under Section 2) in object code or executable
357 form under the terms of Sections 1 and 2 above provided that you also
358 do one of the following: <!-- we use this doubled UL to get the sub-sections indented, -->
359 <!-- while making the bullets as unobvious as possible. --> </p>
361 <div align="justify">
363 <li><strong>a)</strong> Accompany it with the complete corresponding
364 machine-readable source code, which must be distributed under the
365 terms of Sections 1 and 2 above on a medium customarily used for
366 software interchange; or,
369 <li><strong>b)</strong> Accompany it with a written offer,
370 valid for at least three years, to give any third party, for a charge
371 no more than your cost of physically performing source distribution,
372 a complete machine-readable copy of the corresponding source code,
373 to be distributed under the terms of Sections 1 and 2 above on a medium
374 customarily used for software interchange; or,
378 <li><strong>c)</strong> Accompany it with the information
379 you received as to the offer to distribute corresponding source code.
380 (This alternative is allowed only for noncommercial distribution and
381 only if you received the program in object code or executable form with
382 such an offer, in accord with Subsection b above.) </li>
385 The source code for a work means the preferred form of the work
386 for making modifications to it. For an executable work, complete source
387 code means all the source code for all modules it contains, plus any associated
388 interface definition files, plus the scripts used to control compilation
389 and installation of the executable. However, as a special exception, the
390 source code distributed need not include anything that is normally distributed
391 (in either source or binary form) with the major components (compiler,
392 kernel, and so on) of the operating system on which the executable runs,
393 unless that component itself accompanies the executable. </div>
395 <p align="justify"> If distribution of executable or object code is made
396 by offering access to copy from a designated place, then offering equivalent
397 access to copy the source code from the same place counts as distribution
398 of the source code, even though third parties are not compelled to copy
399 the source along with the object code. </p>
401 <p align="justify"> <strong>4.</strong> You may not copy, modify, sublicense,
402 or distribute the Program except as expressly provided under this License.
403 Any attempt otherwise to copy, modify, sublicense or distribute the
404 Program is void, and will automatically terminate your rights under this
405 License. However, parties who have received copies, or rights, from you
406 under this License will not have their licenses terminated so long as
407 such parties remain in full compliance. </p>
409 <p align="justify"> <strong>5.</strong> You are not required to accept
410 this License, since you have not signed it. However, nothing else grants
411 you permission to modify or distribute the Program or its derivative
412 works. These actions are prohibited by law if you do not accept this
413 License. Therefore, by modifying or distributing the Program (or any work
414 based on the Program), you indicate your acceptance of this License to
415 do so, and all its terms and conditions for copying, distributing or modifying
416 the Program or works based on it. </p>
418 <p align="justify"> <strong>6.</strong> Each time you redistribute the
419 Program (or any work based on the Program), the recipient automatically receives
420 a license from the original licensor to copy, distribute or modify the Program
421 subject to these terms and conditions. You may not impose any further
422 restrictions on the recipients' exercise of the rights granted herein.
423 You are not responsible for enforcing compliance by third parties to this
426 <p align="justify"> <strong>7.</strong> If, as a consequence of a court
427 judgment or allegation of patent infringement or for any other reason
428 (not limited to patent issues), conditions are imposed on you (whether
429 by court order, agreement or otherwise) that contradict the conditions
430 of this License, they do not excuse you from the conditions of this License.
431 If you cannot distribute so as to satisfy simultaneously your obligations
432 under this License and any other pertinent obligations, then as a consequence
433 you may not distribute the Program at all. For example, if a patent license
434 would not permit royalty-free redistribution of the Program by all those
435 who receive copies directly or indirectly through you, then the only way
436 you could satisfy both it and this License would be to refrain entirely
437 from distribution of the Program. </p>
439 <p align="justify"> If any portion of this section is held invalid or unenforceable
440 under any particular circumstance, the balance of the section is intended
441 to apply and the section as a whole is intended to apply in other circumstances.
444 <p align="justify"> It is not the purpose of this section to induce you
445 to infringe any patents or other property right claims or to contest validity
446 of any such claims; this section has the sole purpose of protecting the
447 integrity of the free software distribution system, which is implemented
448 by public license practices. Many people have made generous contributions
449 to the wide range of software distributed through that system in reliance
450 on consistent application of that system; it is up to the author/donor
451 to decide if he or she is willing to distribute software through any other
452 system and a licensee cannot impose that choice. </p>
454 <p align="justify"> This section is intended to make thoroughly clear what
455 is believed to be a consequence of the rest of this License. </p>
457 <p align="justify"> <strong>8.</strong> If the distribution and/or use
458 of the Program is restricted in certain countries either by patents or by
459 copyrighted interfaces, the original copyright holder who places the Program
460 under this License may add an explicit geographical distribution limitation
461 excluding those countries, so that distribution is permitted only in or among
462 countries not thus excluded. In such case, this License incorporates the
463 limitation as if written in the body of this License. </p>
465 <p align="justify"> <strong>9.</strong> The Free Software Foundation may
466 publish revised and/or new versions of the General Public License from
467 time to time. Such new versions will be similar in spirit to the present
468 version, but may differ in detail to address new problems or concerns.
471 <p align="justify"> Each version is given a distinguishing version number.
472 If the Program specifies a version number of this License which applies
473 to it and "any later version", you have the option of following the terms
474 and conditions either of that version or of any later version published
475 by the Free Software Foundation. If the Program does not specify a version
476 number of this License, you may choose any version ever published by the
477 Free Software Foundation. </p>
479 <p align="justify"> <strong>10.</strong> If you wish to incorporate parts
480 of the Program into other free programs whose distribution conditions
481 are different, write to the author to ask for permission. For software
482 which is copyrighted by the Free Software Foundation, write to the Free
483 Software Foundation; we sometimes make exceptions for this. Our decision
484 will be guided by the two goals of preserving the free status of all derivatives
485 of our free software and of promoting the sharing and reuse of software
488 <p align="justify"><strong>NO WARRANTY</strong></p>
490 <div align="justify"> </div>
492 <p align="justify"> <strong>11.</strong> BECAUSE THE PROGRAM IS LICENSED
493 FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED
494 BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
495 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
496 OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED
497 TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
498 PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
499 IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST
500 OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. </p>
502 <p align="justify"> <strong>12.</strong> IN NO EVENT UNLESS REQUIRED BY
503 APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
504 ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED
505 ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL
506 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
507 PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
508 INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF
509 THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR
510 OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. </p>
512 <p align="justify"> </p>
514 <h3>END OF TERMS AND CONDITIONS</h3>
517 <hr width="100%" size="2"><br>
520 <h2><a name="Installation"></a>Installation</h2>
523 <div align="justify">
526 <p>Citadel/UX is an advanced, multiuser, client/server, room-based BBS program.
527 It is designed to handle the needs of both small dialup systems and large-scale
528 Internet-connected systems. It was originally developed on an Altos system
529 running Xenix, and has been installed and tested on various Unix and Unix-like
530 platforms. The author's current development environment (and BBS) is
531 an ordinary Linux system. The current distribution includes: </p>
534 <li>The Citadel/UX server (this is the back end that does all processing)
536 <li>A text-based client program designed with the traditional Citadel
537 "look and feel" (room prompts, dot commands, and the like) </li>
538 <li>Setup programs </li>
539 <li>A set of utilities for system administration and maintenance
541 <li>Documentation </li>
545 <p>Some knowledge of the Unix system is necessary to install and manage the
546 system. It is mandatory that the sysop have "root" access to the operating
547 system. The following are required to install Citadel/UX: </p>
550 <li>A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX) </li>
551 <li>C compiler (such as gcc or egcs) and "make" </li>
552 <li>POSIX threads (the "pthreads" library) </li>
554 <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1 or newer
555 (GDBM also works, but its use is officially depracated. If you are building
556 a new system, do <i>not</i> use GDBM. If you have an existing system which
557 uses GDBM, you should migrate it to Berkeley DB as soon as possible.) </li>
558 <li>Enough disk space to hold all of the programs and data </li>
562 <p>If you are running Citadel/UX on a Linux system, it is STRONGLY recommended
563 that you run it on a recent distribution (such as <a
564 href="http://www.redhat.com">Red Hat</a> 7.3 or newer). A new-ish distribution
565 will have most or all of the prerequisite tools and libraries already
566 integrated for you.</p>
568 <h3>Now available:</h3>
571 <li>"WebCit", a gateway program to allow full access to Citadel via
572 the World Wide Web. Interactive access through any Web browser. </li>
573 <li>Access to Citadel via <i>any</i> standards-compliant e-mail program,
574 thanks to Citadel's built-in SMTP, POP, and IMAP services. You can
575 use Netscape/Mozilla, Evolution, Eudora, Pine, or even Microsoft VirusSpreader
576 (better known as "Outlook") with Citadel. </li>
580 <h3>Coming soon:</h3>
583 <li>Newer and better GUI-based clients. </li>
587 <h3><a name="Everything_in_its_place..."></a>Everything in its place...</h3>
589 <p>Hopefully you've unpacked the distribution archive into its own directory.
590 This is the directory in which all Citadel files are located and in which
591 all activity will take place. Several subdirectories have already been
592 created during the unpacking process, and others may be created by the software
593 if needed. Make sure you have Berkeley DB installed on your system, and
594 that you have all the development libraries and headers in place so that
595 you can compile against them. If you don't, you can get the latest Berkeley
596 DB at <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
597 If your operating system uses a separate library to support POSIX threads
598 (pthreads), make sure that library is installed as well. This is almost
599 never the case with Linux, but some commercial Unix flavors might need it.</p>
601 <h3><a name="The_BBS_Login"></a></h3>
603 <h3>The BBS Login</h3>
605 <p>As with many Unix programs, Citadel wants to run under its own user ID.
606 Unlike other programs, however, this user ID will do double-duty as a public
607 login for your system if you are running a BBS. This account is typically
608 called "bbs" or "citadel" or something to that effect. You will tell Citadel
609 what the user-id of that account is, and when someone logs in under that
610 account, Citadel will prompt for a user name.</p>
612 <p>The Citadel user should have a unique uid. The home directory should be
613 the one your Citadel installation resides in (in this example we will use
614 /usr/local/citadel) and the shell should be either "citadel" in that directory,
615 or a script that will start up citadel (you may wish to set up an external
616 text editor; see below). Example:</p>
618 <pre>bbs::100:1:BBS Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
620 <p>When you run setup later, you will be required to tell it what the Citadel
621 user's numeric user ID is, so it knows what user to run as. If you create
622 an account called <tt>bbs</tt>, <tt>guest</tt>, or <tt>citadel</tt>, the
623 setup program will automatically pick up the user ID by default.</p>
625 <p>For all other users in /etc/passwd, Citadel will automatically set up an
626 account using the full name (or 'gecos' in Unixspeak) of the user. It'll
627 also ignore any password you supply, because it uses the user's password
628 on the host system. This allows a 'single sign on' type of environment. Note
629 that this does have to be enabled at compile time -- it's the configure option
630 called <tt>--enable-autologin</tt>. Keep in mind that these users can use
631 *either* their Citadel login name or their login name on the host computer,
632 and their password on the host computer.</p>
634 <h3><a name="Bypassing_the_login:_prompt"></a></h3>
636 <h3>Bypassing the <tt>login:</tt> prompt</h3>
638 <p>If you normally log in to your host system using some method other than
639 telnet (such as ssh), you might want the telnet service to go straight
640 to the Citadel BBS, instead of displaying the <tt>login:</tt> prompt first.
641 You can do this by having telnetd start citadel directly instead of <tt>/bin/login</tt>.
642 This is actually very simple to implement; all you need to do is make a
643 simple change to your <tt>inetd</tt> or <tt>xinetd</tt> configuration. Here
644 are some configuration examples.</p>
646 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
647 replacing any existing telnet configuration line already there):</p>
649 <pre>telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel<br></pre>
651 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
652 then simply replace that file with this one):</p>
654 <pre>service telnet<br>{<br> flags = REUSE<br> socket_type = stream<br> wait = no<br> user = root<br> server = /usr/sbin/in.telnetd<br> server_args = -L /usr/local/citadel/citadel<br> log_on_failure += USERID<br> disable = no<br>}<br></pre>
656 <p>Please make sure you know what you're doing before you install this!
657 If you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
658 then change the directory name accordingly. If you know of any other local
659 peculiarities which need to be observed, edit the above configuration accordingly
660 as well. And, of course, if you're working remotely, make sure you can successfully
661 log in using SSH before you start changing your telnet configuration, otherwise
662 you could lock yourself out of your system (ask any networking specialist
663 about the dangers of "working inline" -- then pull up a chair and get a
664 fresh cup of coffee, because you're going to hear some war stories).</p>
666 <h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
668 <p>You can easily compile the Citadel system with the following commands:</p>
670 <pre>./configure<br>make<br>make install<br></pre>
672 <p>The 'configure' script will generate a Makefile from the Makefile.in, and
673 it will also write the file "sysdep.h" to your Citadel directory. Please
674 do not edit sysdep.h or Makefile.in yourself. The configure script will
675 figure out your system dependencies and set everything correctly.</p>
677 <p>Mac OS X 10.1 and later are now supported. (Sorry, 10.0 cannot be supported,
678 now or in the future.) You need to install the Developer Tools CD, which
679 you can purchase or download for free from <a
680 href="http://developer.apple.com">http://developer.apple.com</a>. Then run
681 configure like this:</p>
683 <pre>env CC=/usr/bin/cc ./configure (options - see below)<br></pre>
685 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
686 If you wish to place it in a different directory, you can instead do:</p>
688 <pre>./configure --prefix=/export/home/citadel (or whatever)<br></pre>
690 <p>If you've got Berkeley DB installed in a non-standard location, you can
691 help the configure script find it by doing something like this:</p>
693 <pre>./configure --with-db=/usr/local/BerkeleyDB-4.1<br></pre>
695 <p>The configure script prefers Berkeley DB if it is available, but will
696 fall back to GDBM if it has to.</p>
698 <p>File permissions are always a bother to work with. You don't want Citadel
699 to crash because someone couldn't access a file, but you also don't want
700 shell users peeking into the binaries to do things like reading others'
701 mail, finding private rooms, etc. The Citadel server needs to be started
702 as root in order to bind to privileged ports, but as soon as its initialization
703 is finished, it changes its user ID to your BBS user ID in order to avoid
706 <h3><a name="Upgrading"></a></h3>
710 <p>Any existing Citadel installation which is at version 5.50 or newer may
711 be upgraded in place without the need to discard your existing data files.</p>
713 <p>Upgrading to a new version uses the same build procedure as compiling the
714 program for a fresh install, except that you want to do <tt>make install-exec</tt>
715 instead of <tt>make install</tt>. This will overwrite the programs but
716 not your data. <b>Be sure to shut down citserver during this process!</b>
717 If Citadel is running while you upgrade, you may face data corruption issues.<br>
720 <p>After doing <tt>make install-exec</tt>, you should run <tt>setup</tt> again
721 to bring your data files up to date. Please see the setup section below
722 for more information on this.</p>
724 <h3><a name="The_citadel.rc_file"></a>The <tt>citadel.rc</tt> file</h3>
726 <p>The text-based client included with Citadel is suitable for BBS applications.
727 Much of its command set and other behavior is configurable through a Run
728 Control (RC) file. The standard client looks for this file in the following
732 <li><tt>$HOME/.citadelrc</tt></li>
733 <li><tt>/usr/local/lib/citadel.rc</tt></li>
734 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
737 The next couple of sections deal with client-side configuration.
739 <h3><a name="Using_an_external_editor_for_message"></a>Using an external
740 editor for message composition</h3>
742 <p>Citadel/UX has a built-in message editor. However, you can also use your
743 favorite text editor to write messages. To do this you simply put a line
744 in your citadel.rc file like this:</p>
746 <pre>editor=/usr/bin/vi<br></pre>
748 <p>The above example would make Citadel call the vi editor when using the
749 <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make it the default
750 editor for the <tt><b>E</b>nter</tt> command by editing the <tt>citadel.rc</tt>
751 file. <b>But be warned:</b> external editors on public systems can be a
752 security hole, because they usually provide users with the ability to drop
753 into a shell on the host system, or save files using names other than the
754 name of the temporary file they are editing. If you intend to use an external
755 editor on a public BBS, make sure you use one that has been hardened for such
756 a purpose -- one which has had the 'shell' and 'save as' commands disabled,
757 as well as any other functions which a destructive user could use to gain
758 unauthorized access to your host system.</p>
760 <h3><a name="Printing_messages"></a>Printing messages</h3>
762 <p>Citadel/UX can send messages to a printer, or just about anywhere else
763 in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt> specifies
764 what command you use to print. Text is sent to the standard input (stdin)
765 of the print command.</p>
767 <p>So if you did this:</p>
769 <pre>printcmd="nl|pr|lpr -Plocal"<br></pre>
771 <p>...that would add line numbers, then paginate, then print on the printer
772 named "local". There's tons of stuff you can do with this feature. For
773 example, you could use a command like <tt>cat <<$HOME/archive</tt>
774 to save copies of important messages in a textfile. Again, this is probably
775 something you don't want to configure for a public BBS host -- most system
776 administrators don't want remote users sending arbitrary things to local
779 <h3><a name="URL_viewing"></a>URL viewing</h3>
781 <p>This is one more feature which is appropriate for local users. While
782 reading a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
783 command, and it will perform some pre-defined action (usually, this is to
784 open up the URL in a web browser). For example:</p>
786 <pre>urlcmd=netscape -remote "openURL(%s)"<br></pre>
788 <p>In the above example, it would open up the URL in an open <a
789 href="http://www.netscape.com/download">Netscape</a> window.</p>
791 <h3><a name="Setup_and_login"></a></h3>
793 <h3>Setup and login</h3>
795 <p>Before logging in for the first time, you must run the setup program.
796 To begin this procedure, enter the following commands:</p>
798 <pre>cd /usr/local/citadel<br>./setup<br></pre>
800 <p>The setup program will guide you through a simple configuration procedure.
801 It will ask you what directory to place your data files in -- the default
802 is the current directory, which is usually the sensible thing to select.
803 If you want to run more than one instance of Citadel on the same host, however,
804 you can specify a different directory here -- just remember to specify the
805 directory name again when you start up the server later on.</p>
807 <p><tt>setup</tt> will then shut down the Citadel service if it is found
810 <p>You will then be prompted for the name of the system administrator. This
811 is not merely a cosmetic option -- when you log in to your system a little
812 while from now, you'll log in with this name, and it will automatically
813 assign your account the highest access level.</p>
815 <p>Next, you will be prompted for the User ID of the Citadel account on your
816 host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
817 or <tt>citadel</tt>, that account's UID will be the default. If you are
818 upgrading or reconfiguring an existing system, the existing value will be
821 <p>Then you will be prompted for a server port number. This is the TCP port
822 which Citadel clients use to connect to your Citadel server. In almost
823 all cases, you want to use the default -- port 504, which is the official
824 port number assigned by the IANA for Citadel implementations.</p>
826 <p>The Citadel service will then be started, and you will see the following
829 <pre>Setup is finished. You may now log in.<br></pre>
831 <p>Setup is now complete, on most systems, anyway. Please see below to find
832 out if you need to do anything else:</p>
834 <h3><a name="Configuring_your_host_system_to_start"></a>Configuring your
835 host system to start the service</h3>
837 <p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
838 and <tt>/etc/inittab</tt> in order to configure your host system to automatically
839 start the Citadel service. <tt>setup</tt> will automatically perform these
840 steps if it can, and if you allow it to -- just answer 'Yes' when prompted,
841 and everything will be taken care of for you. If you answer 'No' -- or
842 if your system is a little bit odd (for example, BSD systems don't have
843 <tt>/etc/inittab</tt>) -- read this section and do what you need to in order
844 to get things configured.</p>
846 <p>Before you can use Citadel, you must define the "citadel" service to your
847 system. This is accomplished by adding a line to your /etc/services file
848 that looks something like this:</p>
850 <pre>citadel 504/tcp # Citadel/UX Server<br></pre>
852 <p>504 is the port number officially designated by the IANA for use by Citadel.
853 There should not be any need to use a different port number, unless you
854 are running multiple Citadels on the same computer and therefore need a
855 different port for each one.</p>
857 <p>The next step is to arrange for the server to start. The <tt>citserver</tt>
858 program is the main Citadel server. Before we cover the recommended method
859 of starting the server, let's examine its usage options:</p>
861 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-d] [-f]<br></pre>
863 <p>The options are as follows:</p>
865 <p><tt>-hHomeDir</tt> - the directory your BBS data files live in. This
866 should, of course, be a directory that you've run the <tt>setup</tt> program
867 against to set up some data files. If a directory is not specified, the
868 directory name which was specified in the <tt>Makefile</tt> will be used.</p>
870 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed.
871 The available debugging levels are: </p>
874 <li>1 - Internal errors (failed thread creation, malloc problems, etc.)
876 <li>2 - Network errors (broken sockets, failed socket creation)
878 <li>3 - Begin and end of sessions, startup/shutdown of server </li>
879 <li>5 - Server commands being sent from clients </li>
880 <li>7 - Entry and exit of various functions </li>
881 <li>8 - Entry and exit of critical sections </li>
882 <li>9 - Various debugging checkpoints (insanely verbose) </li>
886 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace output.
887 Normally it is sent to stdout.</p>
889 <p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch would
890 be necessary if you were starting the Citadel server, for example, from
891 an rc.local script (which is not recommended, because this won't allow the
892 server to automatically restart when it is shut down).</p>
894 <p><tt>-f</tt> - Defragment all the databases upon startup. This isn't normally
895 necessary due to the nature of the data stored in Citadel, but the option
896 is provided in case you need it. (Note that this only applies to GDBM installations;
897 if you are using Berkeley DB it has no effect.)</p>
899 <p>The preferred method of starting the Citadel server is to place an entry
900 in your /etc/inittab file. This will conveniently bring the server up when
901 your system is up, and terminate it gracefully when your system is shutting
902 down. The exact syntax for your system may vary, but here's an entry that
903 could be used on a Linux system:</p>
905 <pre>cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x3<br></pre>
907 <p>In this example, we've chosen debugging level 3, and have the trace stuff
908 output to one of the virtual consoles. It's important to remember to turn
909 off any getty that is set up on that virtual console, if you do this. After
910 making this change, the command <tt>init q</tt> works on most systems to
911 tell init to re-read the file. If in doubt, just reboot the computer.</p>
913 <h3><a name="Logging_in_for_the_first_time"></a>Logging in for the first
916 <p>At this point, your system is ready to run. Run the <tt>citadel</tt> program
917 from the shell and log in as a new user. NOTE: the first user account to
918 be created will automatically be set to access level 6 (Aide). This overcomes
919 some obvious logistical problems - normally, Aide access is given by another
920 Aide, but since there aren't any on your system yet, this isn't possible.</p>
922 <h3><a name="Welcoming_new_users"></a>Welcoming new users</h3>
924 <p>Sometimes you might decide that you want a welcome message (or several
925 different messages) automatically mailed to new users upon their first login.
926 Now there is a way to do this. If you create a room called <tt>New User
927 Greetings</tt>, and it is a <i>private</i> room (invitation-only probably
928 makes the most sense), any messages you enter into that room will automatically
929 be delivered to all new users upon registration.</p>
931 <p>You can put anything you want there: a welcome message, system policies,
932 special information, etc. You can also put as many messages there as you
933 want to (although it really doesn't make sense to clutter new users' mailboxes
934 with lots of junk).</p>
936 <p>Don't worry about wasting disk space, either. Citadel has a single-instance
937 message store, so all the new users are actually looking at the same copy
938 of the message on disk.</p>
940 <h3><a name="Space_for_adding_your_own_client"></a>Space for adding your
941 own client features (doors)</h3>
943 <p><b>Please take note!</b> This function really represents the "old" way
944 of doing things, and it doesn't fit in well with the client/server paradigm.
945 Please consider it "deprecated" because it may be removed someday.</p>
947 <p>The "doorway" feature is just a generic way to add features to the system.
948 I called it "Doorway" to make it resemble the doors on non-Unix boards,
949 but as we all know, us Unix types don't have to write special code to access
950 the modem. :-) Anyway, when a user hits the <tt><b>*</b></tt> (doorway)
951 command, Citadel does...</p>
953 <pre>USERNAME=(username); export USERNAME<br>./subsystem (user-number) (screen-width) (access level)<br></pre>
955 <p>...so you can put whatever you want in there. I suggest putting in a
956 menu program to allow the users to pick one of a number of programs, etc.
957 Do be aware that door programs will only be available when the client and
958 server programs are running on the <i>same</i> computer, and when the user
959 is running the text-mode client. Because of these restrictions, Door programs
960 are being utilized less and less every day.</p>
962 <h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and getting
965 <p>That's just about all the information you need to install the system.
966 But if you get stuck, you can visit UNCENSORED! BBS and report a problem
967 or ask for help. But if you intend to report a problem getting the Citadel
968 server to run, <i>please</i> double-check the following things first: </p>
971 <li>Did you do <tt>./configure && make && make install</tt>
973 <li>Did you run setup? </li>
974 <li>Did you start the server? </li>
978 <p>To report a problem, you can log on to UNCENSORED! or any other BBS on
979 the Citadel network which carries the <tt>Citadel/UX></tt> room. Please
980 DO NOT e-mail the developers directly. Post a request for help on the BBS,
981 with all of the following information: </p>
984 <li>The exact nature of your difficulty </li>
985 <li>A transcript of the error message(s) if possible </li>
986 <li>The version of Citadel you are running </li>
987 <li>The version of Berkeley DB present on your system </li>
988 <li>Which operating system you are running, and what version </li>
989 <li>If you are running a Linux system, we need to know which distribution,
990 and the version of the kernel, libc, and pthreads you are using (it would
991 help to post the output of a <tt>ldd ./citserver</tt> command). </li>
997 <hr width="100%" size="2">
998 <h2><a name="sysop"></a>System Administration</h2>
1001 <div align="justify">
1002 <h3><a name="Overview_"></a>Overview</h3>
1004 <p>Citadel/UX, when installed properly, will do most of its maintenance by
1005 itself. It is intended to be run unattended for extended periods of time,
1006 and most installations do just that without any software failures.</p>
1008 <p>The system has seven access levels. Most users are at the bottom and
1009 have no special privileges. Aides are selected people who have special access
1010 within the Citadel program. Room Aides only have this access in a certain
1011 room. Preferred users can be selected by Aides for access to preferred only
1012 rooms. A sysop is anyone who has access to the various sysop utilities -
1013 these are in their own executable files, which should have their permissions
1014 set to allow only sysops to run them. You should either create a sysops
1015 group in /etc/group, or use some other existing group for this purpose.</p>
1017 <p>Aides have access to EVERY room on the system, public and private (all
1018 types). They also have access to commands starting with <tt>.<b>A</b>ide</tt>
1019 in addition to being able to delete and move messages. The system room,
1020 <tt>Aide></tt>, is accessible only by those users designated as Aides.</p>
1022 <h3><a name="Aide_commands"></a>Aide commands</h3>
1024 <p>Aides have the following commands available to them that are not available
1025 to normal users. They are:</p>
1030 <td width="30%"><tt> .<b>A</b>ide <b>K</b>ill this room </tt></td>
1031 <td> Deletes the current room from the system. </td>
1034 <td width="30%"><tt> .<b>A</b>ide <b>E</b>dit this room </tt></td>
1035 <td> Allows editing of the properties of the current room. This
1036 is explained in greater detail below. </td>
1039 <td width="30%"><tt> .<b>A</b>ide <b>W</b>ho knows room </tt></td>
1040 <td> For private rooms with access controls, or mailbox rooms, this
1041 command displays a list of users who have access to the current room. </td>
1044 <td width="30%"><tt> .<b>A</b>ide edit <b>U</b>ser </tt></td>
1045 <td> Allows editing of the properties of any user account on the
1049 <td width="30%"><tt> .<b>A</b>ide <b>V</b>alidate new users </tt></td>
1050 <td> For public access systems, this command reviews all new user
1051 registrations and allows you to set each new user's access level (or simply
1052 delete the accounts). </td>
1055 <td width="30%"><tt> .<b>A</b>ide enter <b>I</b>nfo file </tt></td>
1056 <td> Each room may contain a short textual description of its purpose,
1057 which is displayed to users upon entering the room for the first time (or
1058 in the room banner, for users of the Web client). This command allows you
1059 to enter or edit that description. </td>
1062 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite user
1064 <td> Access control command to grant any specific user access to
1065 a private room. </td>
1068 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick out user
1070 <td> Access control command to revoke any specifc user's access to
1071 the current room. This works regardless of whether the room is public or
1075 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>D</b>elete </tt></td>
1076 <td> If the current room has an associated file directory, this command
1077 may be used to delete files from it. </td>
1080 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end over net
1082 <td> If the current room has an associated file directory, this command
1083 may be used to transmit a copy of any file in that directory to another
1084 node on a Citadel network. </td>
1087 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>M</b>ove </tt></td>
1088 <td> If the current room has an associated file directory, this command
1089 may be used to move any file in that directory to another room. The target
1090 room must also have an associated file directory. </td>
1093 <td width="30%"><tt> .<b>A</b>ide <b>M</b>essage edit </tt></td>
1094 <td> This command allows editing of any of the various system banners
1095 and messages which are displayed to users. Type the name of the banner
1096 or message you wish to edit. </td>
1099 <td width="30%"><tt> .<b>A</b>ide <b>P</b>ost </tt></td>
1100 <td> This is the functional equivalent of the <tt><b>E</b>nter message</tt>
1101 command available to all users, except that it allows you to post using
1102 any user name. </td>
1105 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>G</b>eneral
1107 <td> This command allows configuration of a large number of global
1108 settings for your Citadel system. These settings will be explained in greater
1112 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>I</b>nternet
1114 <td> This command allows configuration of settings which affect how
1115 your Citadel system sends and receives messages on the Internet. </td>
1118 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration check
1119 <b>M</b>essage base </tt></td>
1120 <td> Perform a consistency check on your message store. This is
1121 a very time-consuming operation which should not be performed unless you
1122 have reason to believe there is trouble with your database. </td>
1125 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>N</b>etwork
1127 <td> Configure networking (e-mail, room sharing, etc.) with other
1128 Citadel nodes. </td>
1131 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration network
1132 <b>F</b>ilter list </tt></td>
1133 <td> If you are on a large public or semi-public network of Citadel
1134 nodes and you find content from certain systems or individuals objectionable,
1135 you can use this command to define a rule set to automatically reject those
1136 messages when they arrive on your system. </td>
1139 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>N</b>ow
1141 <td> Immediately shut down the Citadel service, disconnecting any
1142 users who are logged in. Please keep in mind that it will start right back
1143 up again if you are running the service from <tt>/etc/inittab</tt>, so in
1144 practice this command will probably not get much use. </td>
1147 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>S</b>cheduled
1149 <td> Shut down the Citadel service the next time there are zero users
1150 connected. This allows you to automatically wait until all users are logged
1154 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients
1156 <td> Any room may be made into a mailing list. Enter this command
1157 to open an editor window containing the list of Internet e-mail addresses
1158 to which every message posted in the room will be sent. </td>
1161 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest recipients
1163 <td> Similar to the regular mailing list command, except the messages
1164 will be sent out in 'digest' form -- recipients will see messages from the
1165 address of the room itself rather than the address of the author of each
1166 message, and a digest may contain more than one message. Each room may have
1167 any combination of List and Digest recipients. </td>
1170 <td width="30%"><tt> .<b>A</b>ide <b>N</b>etwork room sharing </tt></td>
1171 <td> Configures the sharing of the current room's contents with other
1172 Citadel nodes. Messages posted in this room on any Citadel system will
1173 automatically be replicated to other Citadel systems carrying the room.
1180 <h3><a name="Editing_rooms"></a>Editing rooms</h3>
1182 <p>This command allows any aide to change the parameters of a room. Go to
1183 the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit room</tt>
1184 command. A series of prompts will be displayed. The existing parameters
1185 will be displayed in brackets; simply press return if you want to leave
1186 any or all of them unchanged.</p>
1188 <pre> <br>Room name [IG's Fun Room]:<br></pre>
1190 <p>...the name of the room.</p>
1192 <pre>Private room [Yes]? <br></pre>
1194 <p>...enter Yes if you wish to restrict access to the room, or no if the
1195 room is to be accessible by all users. Note that Citadel doesn't bother
1196 users about access to rooms every time they need to access the room. Once
1197 a user gains access to a private room, it then behaves like a public room
1198 to them. The following four questions will only be asked if you selected
1201 <pre>Accessible by guessing room name [No]?<br></pre>
1203 <p>...if you enter Yes, the room will not show up in users' <tt><b>K</b>nown
1204 rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing the
1205 room's full name), they will gain access to the room.</p>
1207 <pre>Accessible by entering a password [No]?<br>Room password [mypasswd]: <br></pre>
1209 <p>...this adds an additional layer of security to the room, prompting users
1210 for a password before they can gain access to the room.</p>
1212 <p>If you did not select guessname or passworded, then the only way users
1213 can access the room is if an Aide explicitly invites them to the room using
1214 the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt> command.</p>
1216 <pre>Cause current users to forget room [No] ? No<br></pre>
1218 <p>Enter Yes if you wish to kick out anyone who currently has access to the
1221 <pre>Preferred users only [No]? No<br></pre>
1223 <p>Enter Yes if you wish to restrict the room to only users who have level
1224 5 (Preferred User) status (and Aides too, of course). You should make the
1225 room public if you intend to do this, otherwise the two restrictions will
1228 <pre>Read-only room [No]? No<br></pre>
1230 <p>If you set a room to Read-Only, then normal users will not be allowed
1231 to post messages in it. Messages may only be posted by Aides, and by utility
1232 programs such as the networker and the "aidepost" utility. This is useful
1233 in situations where a room is used exclusively for important announcements,
1234 or if you've set up a room to receive an Internet mailing list and posting
1235 wouldn't make sense. Other uses will, of course, become apparent as the
1238 <p>Now for a few other attributes...</p>
1240 <pre>Directory room [Yes]? Yes<br></pre>
1242 <p>...enter Yes if you wish to associate a directory with this room. This
1243 can be used as a small file repository for files relevant to the topic of
1244 the room. If you enter Yes, you will also be prompted with the following
1247 <pre>Directory name [mydirname]: <br></pre>
1249 <p>...the name of the subdirectory to put this room's files in. The name
1250 of the directory created will be <tt><i><your BBS directory></i>/files/<i><room
1251 dir name></i></tt>.</p>
1253 <pre>Uploading allowed [Yes]? Yes<br></pre>
1255 <p>...enter Yes if users are allowed to upload to this room.</p>
1257 <pre>Downloading allowed [Yes]? Yes<br></pre>
1259 <p>...enter Yes if users are allowed to download from this room.</p>
1261 <pre>Visible directory [Yes]? Yes<br></pre>
1263 <p>...enter Yes if users can read the directory of this room.</p>
1265 <pre>Network shared room [No]? No<br></pre>
1267 <p>...you can share a room over a network without setting this flag, and vice
1268 versa, but what this flag does is twofold: </p>
1271 <li>It prevents people with no network access from entering messages here
1273 <li>Messages are displayed with the name of their originating system
1274 in the header. </li>
1278 <pre>Permanent room [No]? No<br></pre>
1280 <p>Citadel contains an 'auto purger' which is capable of removing rooms which
1281 have not been posted in for a pre-defined period of time (by default this
1282 is set to two weeks). If you wish to keep this from happening to a particular
1283 room, you can set this option. (Keep in mind that <tt>Lobby></tt>, <tt>Aide></tt>,
1284 any private mailbox rooms, any network shared rooms, and any rooms with a
1285 file directory are automatically permanent.)</p>
1287 <pre>Anonymous messages [No]? No<br>Ask users whether to make messages anonymous [No]? No<br></pre>
1289 <p>...you can have rooms in which all messages are automatically anonymous,
1290 and you can have rooms in which users are prompted whether to make a message
1291 anonymous when they enter it. The real identity of the author of each message
1292 is still revealed to the Room Aide for this room, as well as any system-wide
1295 <pre>Room aide [Joe Responsible]: <br></pre>
1297 <p>...on larger systems, it helps to designate a person to be responsible
1298 for a room. Room Aides have access to a restricted set of Aide commands,
1299 ONLY when they are in the room in which they have this privilege. They
1300 can edit the room, delete the room, delete and move messages, and invite
1301 or kick out users (if it is a private room), but they cannot perform aide
1302 commands that are not room-related (such as changing users access levels).</p>
1304 <pre>Listing order [64]: <br></pre>
1306 <p>This is just a simple way to try to control the order rooms are listed
1307 in when users call up a <tt><b>K</b>nown Rooms</tt> listing. Rooms with
1308 a lower listing order are displayed prior to rooms with a higher listing
1309 order. It has no other effect. For users who list rooms in floor order,
1310 the display will sort first by floor, then by listing order.</p>
1312 <pre>Message expire policy (? for list) [0]:<br></pre>
1314 <p>This provides you with the opportunity to select how long each message
1315 will remain in a room before automatically being deleted. Press <tt><b>?</b></tt>
1316 for a list of options. You can choose to keep messages around forever (or
1317 until they are manually deleted), until they become a certain number of days
1318 old, or until a certain number of additional messages are posted in the
1319 room, at which time the oldest ones will scroll out.</p>
1321 <p>You will notice that you can also fall back to the default expire policy
1322 for the floor upon which the room resides. This is the default setting.
1323 You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit
1324 floor</tt> command. The default setting for the floor default, in turn,
1325 is the system default setting, which can be changed using the <tt><b>.A</b>ide
1326 <b>S</b>ystem configuration <b>G</b>eneral</tt> command.</p>
1328 <pre>Save changes (y/n)? Yes<br></pre>
1330 <p>...this gives you an opportunity to back out, if you feel you really messed
1331 things up while editing.</p>
1333 <h3><a name="File_directories"></a>File directories</h3>
1335 <p>If you have created any directory rooms, you can attach file descriptions
1336 to the filenames through a special file called <tt>filedir</tt>. Each line
1337 contains the name of a file in the directory, followed by a space and then
1338 a description of the file, such as:</p>
1340 <pre>myfile.txt This is a description of my file.<br>phluff A phile phull of phluff!<br></pre>
1342 <p>...this would create file descriptions for the files <tt>myfile.txt</tt>
1343 and <tt>phluff</tt> which would be displayed along with the directory. It
1344 should also be noted that when users upload files to your system, they will
1345 be prompted for file descriptions, which will be added to the <tt>filedir</tt>
1346 file. If one does not exist, it will be created.</p>
1348 <h3><a name="Creating_and_editing_user_accounts"></a>Creating and editing
1351 <p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1352 command to create and/or edit user accounts. There are several parameters
1353 which can be set here.</p>
1355 <p>To create a user:</p>
1357 <pre>Lobby> . Aide edit User <br>User name: New User Name<br>No such user.<br>Do you want to create this user? Yes<br></pre>
1359 <p>At this point, the new user account has been created, and the command
1360 will continue as if you were editing an existing account. Therefore the
1361 remainder of this procedure is the same for creating and editing:</p>
1363 <pre>Lobby> . Aide edit User <br>User name: person of significance<br>User #70 - Person of Significance PW: <br> <br><br>, <br> <br> <br><br>Current access level: 4 (Network User)<br></pre>
1365 <p>The blank lines are the user's 'registration' information -- personal information
1366 such as full name, address, telephone number, etc. This information will
1367 comprise the user's vCard in both their user profile and in the Global Address
1370 <pre>Change password [No]: No<br></pre>
1372 <p>...answer Yes to set or change the password for this account.</p>
1374 <pre>Access level [4]: <br></pre>
1376 <p>...this allows you to set or change the access level for this account.
1377 The access levels available are as follows: </p>
1380 <li>0 - Deleted. (This immediately deletes the account.) </li>
1381 <li>1 - New, unvalidated user </li>
1382 <li>2 - Problem user (severely restricts account - use for probationary
1384 <li>3 - User with no network privileges. Same access as a normal user
1385 except cannot post messages in rooms shared on a network. </li>
1386 <li>4 - Normal user </li>
1387 <li>5 - Preferred user (access is granted to privileged rooms) </li>
1388 <li>6 - Aide (administrative access to the whole system) </li>
1392 <pre>Permission to send/receive Internet mail [ No]? No<br></pre>
1394 <p>If your system is configured to only allow Internet mail privileges to
1395 certain users, this is where you can grant or revoke that privilege.</p>
1397 <pre>Ask user to register again [Yes]: Yes<br></pre>
1399 <p>If you answer Yes to this question, the user will be presented with a 'registration'
1400 screen or set of prompts, the next time they log in using a Citadel client.
1401 This will prompt them for their full name, address, telephone number, etc.</p>
1403 <pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1405 <p>These statistics are available for informational purposes only, so there
1406 is normally no need to change them.</p>
1408 <pre>Set last call to now [No]: No<br>Purge time (in days, 0 for system default [0]: <br></pre>
1410 <p>Citadel contains an auto-purger which is capable of automatically deleting
1411 accounts which have not been accessed in a predefined period of time. If
1412 you choose to perform this operation, you can 'touch' the account of a wayward
1413 user by setting their 'last call' time to 'now'. You can also adjust, on
1414 a per-user basis, the amount of time which must pass before their account
1415 is purged by the system. This time is set in days. You can also specify
1416 0 days to indicate that you wish to use the system default setting.</p>
1418 <h3><a name="Deleting_and_moving_messages"></a>Deleting and moving messages</h3>
1420 <p>Aides and Room Aides have the ability to delete and move messages. After
1421 each message, the normal prompt appears:</p>
1423 <pre>(8) <B>ack <A>gain <Q>uote <R>eply <N>ext <S>top m<Y> next <?>help -><br></pre>
1425 <p>Entering <tt><b>D</b>elete</tt> will delete the message. A <tt>(y/n)</tt>
1426 prompt will appear to confirm that you really want to delete the message.
1427 Entering <tt><b>M</b>ove</tt> will prompt for a room to which the message
1428 should be moved.</p>
1430 <h3><a name="Customizing_the_help_files"></a>Customizing the help files</h3>
1432 <p>The subdirectory called <tt>help</tt> contains your system's help files.
1433 There's nothing hard-coded into the system that dictates what files should
1434 be there. Whenever a user types the command <tt><b>.H</b>elp</tt> followed
1435 by the name of a help file, it displays the contents of that help file.</p>
1437 <p>The help files that come with the system, of course, are enough to guide
1438 a user through its operation. But you can add, change, or remove help files
1439 to suit whatever is appropriate for your system.</p>
1441 <p>There are several strings that you can put in help files that will be
1442 automatically substituted with other strings. They are:</p>
1444 <pre> <br> ^nodename = The node name of your system on a Citadel/UX network<br> ^humannode = Human-readable node name (also your node name on C86Net)<br> ^fqdn = Your system's fully-qualified domain name<br> ^username = The name of the user reading the help file<br> ^usernum = The user number of the user reading the help file<br> ^sysadm = The name of the system administraor (i.e., you)<br> ^variantname = The name of the BBS software you're running<br> ^bbsdir = The directory on the host system in which you have<br> installed the Citadel system.<br></pre>
1446 <p>So, for example, you could create a help file which looked like:</p>
1448 <pre> "Lots of help, of course, is available right here on ^humannode. Of<br>course, if you still have trouble, you could always bug ^sysadm about it!"<br></pre>
1450 <h3><a name="Site_configuration"></a>Site configuration</h3>
1452 <p>Once your Citadel server is up and running, the first thing you'll want
1453 to do is customize and tune it. This can be done from the text-based client
1454 with the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1455 command, or from WebCit (if you have it installed) by clicking 'Advanced
1456 Options' followed by 'Edit site-wide configuration.' Either method will
1457 offer the same configuration options. This document shows the text mode
1458 client being used.</p>
1460 <p>The first set of options deal with the identification of your system.</p>
1462 <pre>Lobby> . Aide System configuration General<br>Node name [uncnsrd]: <br>Fully qualified domain name [uncensored.citadel.org]: <br>Human readable node name [Uncensored]: <br>Modem dialup number [US 914 999 9999]: <br>Geographic location of this system [Mount Kisco, NY]: <br>Name of system administrator [IGnatius T Foobar]: <br>Paginator prompt [<jinkies
1463 !="" more="" text="" on="" the="" next="" screen="">]: <br></jinkies></pre>
1465 <p>'Node name' refers to the short, unqualified node name by which your system
1466 is known on a Citadel network. Generally it will be the same as the unqualified
1467 host name of your computer; this is, in fact, the default setting.</p>
1469 <p>Then enter the fully-qualified domain name (FQDN) of your system. If
1470 you are not on the Internet, you can simply set it to the same as your unqualified
1471 host name. Otherwise you should set this value to the host name by which
1472 your system is most commonly known.</p>
1474 <p>The field called 'Human-readable node name' (also known as the 'node title'
1475 or 'organization name' in other software) is used solely for display purposes.
1476 Set it to the actual name of your system as you want it to appear in banners,
1479 <p>If you have a modem or bank of modems answering data calls for your system,
1480 enter it in the field marked 'Modem dialup number.' Otherwise you may leave
1483 <p>'Geographic location of this system' is another display field. Enter
1484 a city and state, or city and country. </p>
1486 <p>'Name of system administrator' is important! Any user who logs on with
1487 the name you enter here will automatically be granted Aide privileges.
1488 This is one of two ways for the system administrator to grant himself/herself
1489 Aide access to the system when initially setting it up. (The other is simply
1490 to have the first account created on a new installation.)</p>
1492 <p>The next set of options are your system's security settings. Before delving
1493 into the actual options, we should review the various access levels available
1494 on the system. Citadel has seven access levels:</p>
1497 <li>0 (Deleted). A user whose access level is set to 0 will automatically
1498 be deleted by the system. </li>
1499 <li>1 (New User). Users at this level may only read messages. Entering
1500 messages is prohibited, except in the <tt>Mail></tt> room, where a message
1501 to 'sysop' may be entered. </li>
1502 <li>2 (Problem User). Also known as 'Twit.' </li>
1503 <li>3 (Local User). May enter messages, except in rooms shared on a
1504 Citadel network. </li>
1505 <li>4 (Network User). May enter messages in every accessible room.
1507 <li>5 (Preferred User). Use of this level is up to the whim of the system
1508 administrator. </li>
1509 <li>6 (Aide). Access is granted to the administrative functions of the
1510 system. (This access level may also be granted to a user only for a specific
1511 room, please see 'Room Aide' for more information.) </li>
1515 <pre>Require registration for new users [No]: No<br>Disable self-service user account creation [No]: No<br>Initial access level for new users [4]:<br>Access level required to create rooms [4]: <br>Automatically give room aide privs to a user who creates a private room [No]: No<br><br>Automatically move problem user messages to twit room [Yes]: Yes<br>Name of twit room [Trashcan]: <br>Restrict Internet mail to only those with that privilege [No]: No<br>Allow Aides to Zap (forget) rooms [Yes]: Yes<br>Allow system Aides access to user mailboxes [Yes]: Yes<br>Log all pages [No]: No<br></pre>
1517 <p>'Registration' refers to the process of a user entering various personal
1518 contact information (real name, address, telephone number, etc.) into the
1519 system. When enabled, this information is stored as a vCard object on the
1520 system in two places: the user's <tt>My Citadel Config></tt> room, and
1521 in the <tt>Global Address Book></tt> room. (Note: the latter should
1522 be made private on publicly-accessible systems, for obvious reasons.)</p>
1524 <p>If you answer Yes to 'Require registration for new users' then each new
1525 user, upon creating a new account, will immediately be entered into the registration
1526 process. On the other hand, if you answer Yes to 'Disable self-service user
1527 account creation' then new users will not be able to log in at all -- all
1528 accounts must be created by an Aide.</p>
1530 <p>'Initial access level for new users' should be set to 1 (New User) if
1531 you would like to review each new user's registration info before granting
1532 them higher access. This would be done periodically with the <tt><b>.A</b>ide
1533 <b>V</b>alidate new users</tt> command. If you do not require registration,
1534 you should set the initial access level to 4 (Network User).</p>
1536 <p>Given the above options, it then becomes clear that there are generally
1537 two ways you can set up your Citadel system, depending on its purpose:</p>
1540 <li><b>A public access BBS or message board</b> - since you do not know
1541 who might want to log in, self-service account creation needs to stay enabled.
1542 If you want to be strict about users identifying themselves, then you should
1543 also require users to register (just remember to post a privacy policy if
1544 you're going to collect personal information) -- then set the initial access
1545 level to 1 (New User), so new users cannot post messages until after you've
1546 validated them. For a more lax environment, you can remove the registration
1547 requirement and grant new accounts level 4 (Normal User) access on the first
1549 <li><b>A private email/groupware system for your organization</b> - in
1550 this case, disable self-service account creation; you don't want strangers
1551 welcoming themselves to your system. You'll probably also want to disable
1552 registration, because you or some other site administrator will be entering
1553 users' contact info when you create their accounts. Since this is also
1554 how you assign their Internet e-mail addresses, it's probably a good idea
1555 to do it yourself instead of expecting them to do it. </li>
1559 <p>'Access level required to create rooms' is up to you. You might wish
1560 to restrict the creation of new rooms only to Aides, or you might wish to
1561 allow anyone to create a room. The latter is one of the Citadel culture's
1562 most long-standing traditions; the former may be appropriate if users are
1563 abusing this privilege.</p>
1565 <p>You have the ability to 'Automatically give room aide privs to a user
1566 who creates a private room.' If you answer Yes, then any user who creates
1567 a guess-name, passworded, or invitation-only room will automatically become
1568 the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1569 command set while in that room. If you would rather grant this permission
1570 manually, answer No.</p>
1572 <p>Another tradition in the Citadel culture is to refrain from deleting problem
1573 users, but instead to 'twit' them (reduce their access level to 2 [Problem
1574 User]). You can then 'Automatically move problem user messages to twit
1575 room' (answer Yes, then specify 'Name of twit room' and remember to create
1576 that room). If you employ this logic, any user with level 2 (Problem User)
1577 access will continue to have access to the same set of rooms, but all messages
1578 posted will automatically be routed to the Trashcan (or whatever you call
1579 your twit room).</p>
1581 <p>If you have Internet mail configured, you have the option of restricting
1582 its use on a user-by-user basis. If you wish to do this, answer Yes to
1583 'Restrict Internet mail to only those with that privilege.' Obviously this
1584 makes no sense for an internal e-mail system, but for a public BBS it might
1587 <p>Normally, Aides have access to every room, public or private, except for
1588 user mailboxes. They are also forbidden from <tt><b>Z</b>ap</tt>ping rooms,
1589 because the review of content is considered one of their roles. If you
1590 wish to change these policies, the next two options allow you to. You may
1591 'Allow Aides to Zap (forget) rooms', in which case they may use the <tt><b>Z</b>ap</tt>
1592 command just like any other user. Furthermore, if you 'Allow system Aides
1593 access to user mailboxes', then they may <tt><b>.G</b>oto</tt> any private
1594 mailbox belonging to any user, using a special room name format.</p>
1596 <p>If your local security and/or privacy policy dictates that you keep a log
1597 of all pages (instant messages) that go through the system, then answer Yes
1598 to 'Log all pages'. If you answer Yes, you will be prompted for the name
1599 of a room to which all pages will be logged. If you answer No, then only
1600 the sender and recipient of each individual message will receive a copy.</p>
1602 <p>The next set of options deals with the tuning of your system. It is usually
1603 safe to leave these untouched.</p>
1605 <pre>Server connection idle timeout (in seconds) [900]: <br>Maximum concurrent sessions [20]: <br>Maximum message length [2147483647]: <br>Minimum number of worker threads [5]: <br>Maximum number of worker threads [256]: <br></pre>
1607 <p>The 'Server connection idle timeout' is for the connection between client
1608 and server software. It is <b>not</b> an idle timer for the user interface.
1609 900 seconds (15 minutes) is the default and a sane setting.</p>
1611 <p>'Maximum concurrent sessions' is the highest number of user sessions you
1612 wish to allow on your system at any given time. Citadel can scale to hundreds
1613 of concurrent users, but if you have limited hardware or (more likely) limited
1614 bandwidth, you might wish to set a maximum. You can also set it to zero
1617 <p>'Maximum message length' is just that. This could be a good way to prevent
1618 enormous multimedia files from finding their way into your message base.
1619 This maximum is enforced in all protocols and is also advertised by the
1622 <p>The minimum and maximum number of worker threads can be tuned to your liking.
1623 Citadel will attempt to keep one worker thread running per session, within
1624 these constraints. You should be aware that due to the use of the worker
1625 thread model, Citadel can handle a large number of concurrent sessions with
1626 a much smaller thread pool. If you don't know the programming theory behind
1627 multithreaded servers, you should leave these parameters alone.</p>
1629 <p>The next set of options affect how Citadel behaves on a network.</p>
1631 <pre>How often to run network jobs (in seconds) [3600]: <br>SMTP server port (-1 to disable) [25]: <br>POP3 server port (-1 to disable) [110]:<br>IMAP server port (-1 to disable) [143]:<br></pre>
1633 <p>'How often to run network jobs' refers to the sharing of content on a Citadel
1634 network. If your system is on a Citadel network, this configuration item
1635 dictates how often the Citadel server will contact other Citadel servers
1636 to send and receive messages. In reality, this will happen more frequently
1637 than you specify, because other Citadel servers will be contacting yours
1638 at regular intervals as well.</p>
1640 <p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP services.
1641 For a system being used primarily for Internet e-mail, these are essential,
1642 so you'll want to specify the standard port numbers: 25, 110, and 143.
1643 If Citadel is running alongside some other mail system, though, then you
1644 might want to choose other, unused port numbers, or enter -1 for any protocol
1645 to disable it entirely.</p>
1647 <p>The final set of options configures system-wide defaults for the auto-purger:</p>
1649 <pre>Default user purge time (days) [120]: <br>Default room purge time (days) [30]: <br>System default message expire policy (? for list) [2]: <br>Keep how many messages online? [150]:<br></pre>
1651 <p>Any user who does not log in for the period specified in 'Default user
1652 purge time' will be deleted the next time a purge is run. This setting may
1653 be modified on a per-user basis.</p>
1655 <p>'Default room purge time' behaves the same way, and may also be modified
1656 on a per-room basis.</p>
1658 <p>'System default message expire policy' defines the way in which old messages
1659 are expired (purged) off the system. You can specify any of:</p>
1662 <li>Purge by age (specify in days) </li>
1663 <li>Purge by message count in the room (specify number of messages)
1665 <li>Do not purge at all </li>
1669 <p>Again, this setting may be overridden on a per-floor basis, and the floor
1670 setting may be overridden on a per-room basis.</p>
1672 <pre>Save this configuration? No<br></pre>
1674 <p>When you're done, enter 'Yes' to confirm the changes, or 'No' to discard
1678 <hr width="100%" size="2">
1679 <h2 align="center"><a name="Configuring_Citadel_for_Internet_e-mail"></a>Configuring
1680 Citadel for Internet e-mail</h2>
1681 <div align="justify">
1682 <h3><a name="Introduction"></a>Introduction</h3>
1683 As you know by now, Citadel is a completely self-contained, full-featured
1684 Internet e-mail system. When you run Citadel you do not need any other
1685 mail software on your host system. This eliminates the need for tedious
1686 mucking about with sendmail, qmail, postfix, Cyrus, the UW IMAP server, or
1687 any of countless other needlessly complex programs that lead some people
1688 to the false assumption that Unix systems are difficult to administer.<br>
1690 Some of the many features supported by Citadel are:<br>
1692 <li>Built-in SMTP and ESMTP service, for delivering and receiving e-mail
1693 on the Internet</li>
1694 <li>Built-in POP3 service, for remote fetching of messages</li>
1695 <li>Built-in IMAP service, for access to mail using any standard mail client
1697 <li>Web mail (implemented using the "WebCit" middleware, which is installed
1699 <li>Support for mailing lists, in both "individual message" and "digest"
1701 <li>Multiple/virtual domain support</li>
1702 <li>Any user may have multiple Internet e-mail addresses, in multiple domains</li>
1703 <li>Global address book (Users with addresses in a domain may be spread
1704 out across many servers on a Citadel network)</li>
1705 <li>Easy-to-configure integration with <a
1706 href="http://www.spamassassin.org/">SpamAssassin</a> can block spam <i>before</i>
1707 it enters the mail system</li>
1709 This section of the documentation will demonstrate how to configure these
1712 <h3><a name="Basic_site_configuration"></a>Basic site configuration</h3>
1714 <P>Basic configuration of your Citadel system for Internet e-mail begins
1715 with the <tt><b>.A</b>ide <B>S</b>ystem configuration <B>I</b>nternet</tt>
1719 Lobby> <b>.A</b>ide <B>S</b>ystem configuration <B>I</b>nternet
1721 ### Host or domain Record type
1722 --- -------------------------------------------------- --------------------
1724 <A>dd <D>elete <S>ave <Q>uit ->
1727 <P>This is a "clean" setup. For a simple, standalone e-mail system
1728 you simply have to enter the <TT><B>A</B>dd</TT> command:</p>
1731 <A>dd <D>elete <S>ave <Q>uit -> <B>A</B>dd
1733 Enter host name: schmeep.splorph.com
1734 (1) localhost (Alias for this computer)
1735 (2) gateway domain (Domain for all Citadel systems)
1736 (3) smart-host (Forward all outbound mail to this host)
1737 (4) directory (Consult the Global Address Book)
1738 (5) SpamAssassin (Address of SpamAssassin server)
1743 <p><b>localhost:</b> Basically what you're doing here is telling Citadel what
1745 your machine are. If your machine were <tt>schmeep.splorph.com</tt> and you
1746 also had a DNS entry set up for <tt>blah.com</tt>, you might want to enter '1'
1747 and enter <tt>blah.com</tt> as your alias, so that e-mail sent to that
1748 address won't bounce.</p>
1750 <p><i>Important tip:</i> if your system is known by one name and <i>only</i>
1751 one domain, you might not even need to do this at all. You will recall that
1752 you entered your system's fully qualified domain name earlier when you went
1753 through the <tt><b>.A</b>ide <B>S</b>ystem configuration <b>G</b>eneral</tt>
1754 command. The domain name you entered there is automatically considered by
1755 Citadel to be a 'localhost' entry in your Internet mail configuration. It
1756 does not hurt to enter it in both locations, though.</p>
1758 <p><B>gateway domain:</b> this is a simple way of mapping various Citadel
1759 hosts in an Internet domain. For example, if you enter <tt>bar.com</tt>
1760 as a gateway domain, then mail to users at <tt>foo.bar.com</tt> will be
1761 forwarded to the host called <tt>foo</tt> on a Citadel network, mail to users
1762 at <tt>kunst.bar.com</tt> will be delivered to the Citadel server called
1763 <tt>kunst</tt>, etc. This feature has limited usefulness; if you are
1764 operating a network of Citadel servers, it is more likely that you will
1765 use the 'directory' feature, explained below.</p>
1767 <p><b>smart-host:</b> Normally, Citadel sends outbound Internet e-mail
1768 directly to its destination. This may not be appropriate for some sites; you
1769 may require (due to local convention, security policy, or whatever) that all
1770 outbound mail be sent to an SMTP relay or forwarder. To configure this
1771 functionality, simply enter the domain name or IP address of your relay as
1772 a 'smart-host' entry.</p>
1774 <p><b>directory:</b> a domain for which you are participating in directory
1775 services across any number of Citadel nodes. For example, if users who have
1776 addresses in the domain <tt>citadel.org</tt> are spread out across multiple
1777 Citadel servers on your network, then enter <tt>citadel.org</tt> as a
1778 'directory' entry. <i>For this to work, all Citadel servers participating
1779 in directory service <b>must</b> carry and share the <tt>Global Address
1780 Book></tt> room.</i></p>
1782 <p><b>spamassassin:</b> if you are running a
1783 <a href="http://www.spamassassin.org">SpamAssassin</a> service anywhere on
1784 your <b>local</b> network, enter its name or IP address as a 'spamassassin'
1785 entry. This may be (and, in fact, will usually be) <tt>127.0.0.1</tt> to
1786 specify that the service is running on the same host computer as the
1789 <p>Please install SpamAssassin as per its own documentation. You will want
1790 to run SpamAssassin in client/server mode, where a <tt>spamd</tt> daemon is
1791 always running on your computer. Citadel does not utilize the <tt>spamc</tt>
1792 client; instead, it implements SpamAssassin's protocol on its own.</p>
1794 <p>Connecting to a SpamAssassin service across a wide area network is
1795 strongly discouraged. In order to determine whether an incoming e-mail is
1796 spam, Citadel must feed the <i>entire message</i> to the SpamAssassin
1797 service. Doing this over a wide area network would consume time and
1798 bandwidth, which would affect performance.</p>
1800 <p>Citadel invokes the SpamAssassin service when incoming messages are
1801 arriving via SMTP. Before a message is accepted, it is submitted to
1802 SpamAssassin. If SpamAssassin determines that the message is spam, the
1803 Citadel SMTP service <i>rejects the message,</i> causing a delivery failure
1804 on the sending host. This is superior to software which files away spam
1805 in a separate folder, because delivery failures will cause some spammers to
1806 assume the address is invalid and remove it from their mailing lists.</p>
1808 <p>Now select <tt><b>S</b>ave</tt> and you are just about ready for
1809 Internet e-mail.</p>
1811 <h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the Internet
1814 <P>As previously mentioned, Citadel contains its own SMTP, POP3, and IMAP
1815 services. Enabling them is simple.</p>
1817 <P>Check for the existance of a current MTA (sendmail, qmail, etc.) by
1818 connecting to port 25 on your host.
1819 If you see something similar to the following you're running an MTA
1820 already and you'll need to shut it down:</p>
1823 smw @ pixel % telnet localhost 25
1825 Connected to localhost.
1826 Escape character is '^]'.
1827 220 pixel.citadel.org ESMTP Sendmail 8.9.3/8.9.3; Wed, 15 Mar 2000 19:00:53 -0500
1830 <P>In the above example, we see that the host already has Sendmail listening
1831 on port 25. Before Citadel can use port 25, Sendmail must be shut off.
1832 Please consult the documentation for your operating system for instructions
1833 on how to do this. (On a Red Hat Linux system, for example, you can run
1834 the <TT>ntsysv</tt> utility, un-checking <tt>sendmail</tt> to disable it
1835 at the next reboot; then, run <tt>service sendmail stop</tt> to shut off the
1836 currently running service.)</p>
1838 <p>If you get a 'connection refused' message when you telnet to port 25 there's
1839 nothing running and you should be able to continue. You might also want to
1840 turn off POP (try the above test substituting 110 for 25) and IMAP (port 143)
1841 and use Citadel's POP and IMAP services.</p>
1843 <p>Citadel will look for an existing pop/smtp server on startup. If they don't
1844 exist (and you've configured them properly) then Citadel should
1845 enable them at startup. You can check your logs to be sure, or you can
1846 start the server from a shell and watch it load. It might look something
1850 smw @ pixel % ./citserver
1852 Multithreaded message server for Citadel/UX
1853 Copyright (C) 1987-2000 by the Citadel/UX development team.
1854 Citadel/UX is open source, covered by the GNU General Public License, and
1855 you are welcome to change it and/or distribute copies of it under certain
1856 conditions. There is absolutely no warranty for this software. Please
1857 read the 'COPYING.txt' file for details.
1859 Loading citadel.config
1861 This is GDBM version 1.8.0, as of May 19, 1999.
1862 Checking floor reference counts
1863 Creating base rooms (if necessary)
1864 Registered a new service (TCP port 504)
1865 Registered a new service (TCP port 0)
1866 Initializing loadable modules
1867 Registered server command CHAT (Begin real-time chat)
1868 Registered server command PEXP (Poll for express messages)
1869 Registered server command GEXP (Get express messages)
1870 Registered server command SEXP (Send an express message)
1871 Registered server command DEXP (Disable express messages)
1872 Registered a new session function (type 0)
1873 Registered a new x-msg function (priority 0)
1875 Registered a new session function (type 1)
1876 Registered a new message function (type 201)
1877 Registered a new message function (type 202)
1878 Registered server command REGI (Enter registration info)
1879 Registered server command GREG (Get registration info)
1880 Registered a new user function (type 100)
1882 Server-hosted upgrade level is 5.62
1884 Registered server command EXPI (Expire old system objects)
1885 Registered server command FSCK (Check message ref counts)
1887 <B>citserver: Can't bind: Address already in use
1888 ERROR: could not bind to TCP port 25.</B>
1889 Registered a new service (TCP port 0)
1890 Registered a new session function (type 50)
1892 <B>citserver: Can't bind: Address already in use
1893 ERROR: could not bind to TCP port 110.</b>
1894 Registered a new session function (type 0)
1896 Registered a new message function (type 202)Loaded module: $Id:
1897 serv_inetcfg.c,v 1.2 2000/02/03 03:57:35 ajc Exp $
1898 Registered server command RWHO (Display who is online)
1899 Registered server command HCHG (Masquerade hostname)
1900 Registered server command RCHG (Masquerade roomname)
1901 Registered server command UCHG (Masquerade username)
1902 Registered server command STEL (Enter/exit stealth mode)
1905 Starting housekeeper thread
1908 <P>The lines emphasized in boldface in the above log output tell you that
1909 Citadel "can't bind" to various ports. The error 'address already in use'
1910 generally means that something else is already running on the requested
1911 port. Make SURE you've followed the above steps to remove sendmail/pop and
1912 start your Citadel server again.</p>
1914 <h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
1916 <P>Occationally it is not practical to remove a non-Citadel MTA on your
1917 host system. For example, you might have multiple groups of users, some of
1918 which are using Citadel and some of which are using a legacy Unix mail spool.
1919 This type of configuration is discouraged, but a tool is provided to allow
1922 <P>The tool is called <tt>citmail</tt> and it is, quite simply, a local MDA
1923 (Mail Delivery Agent) which you can configure into your MTA for final
1924 delivery of incoming messages to Citadel users. A full discussion of the
1925 finer points of complex Sendmail configurations is beyond the scope of this
1926 document; however, you might want to visit
1927 <a href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some
1928 useful HOWTO documents are provided.</p>
1930 <P>For outbound mail, you can either allow Citadel to perform deliveries
1931 directly (this won't affect your other mail system because outbound mail
1932 doesn't tie up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which
1933 will tell Citadel to forward all of its outbound mail to your other mail
1936 <h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet mailing
1938 It's fun. Try it.<br>
1940 <hr width="100%" size="2"><br>
projects / citadel.git / blob