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>
176 <li><a href="#Introduction">Introduction</a></li>
177 <li><a href="#Basic_site_configuration">Basic site configuration</a></li>
178 <li><a href="#Enabling_the_Internet_mail_protocols">Enabling the Internet
179 mail protocols</a></li>
180 <li><a href="#Hosting_an_Internet_mailing_list">Hosting an Internet
183 <li><a href="#citmail">Using Citadel in conjunction with another MTA</a></li>
186 <li><a href="#Building_or_joining_a_Citadel_network">Building or joining
187 a Citadel network</a></li>
189 <li><a href="#Overview__">Overview</a></li>
190 <li><a href="#Conventions_and_etiquette_when">Conventions and etiquette
191 when connecting to the public Citadel network</a></li>
192 <li><a href="#Getting_ready_to_join_the_network">Getting ready to join
194 <li><a href="#Defining_neighbor_nodes">Defining neighbor nodes</a></li>
195 <li><a href="#Sharing_rooms">Sharing rooms</a></li>
196 <li><a href="#Sending_mail">Sending mail</a></li>
197 <li><a href="#Changing_the_polling_interval">Changing the polling interval</a></li>
203 <hr width="100%" size="2"><br>
205 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
209 <p> Version 2, June 1991 </p>
211 <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>
213 <h3 align="justify">Preamble</h3>
215 <div align="justify"> </div>
217 <p align="justify"> The licenses for most software are designed to take
218 away your freedom to share and change it. By contrast, the GNU General
219 Public License is intended to guarantee your freedom to share and change
220 free software--to make sure the software is free for all its users. This
221 General Public License applies to most of the Free Software Foundation's
222 software and to any other program whose authors commit to using it. (Some
223 other Free Software Foundation software is covered by the GNU Library General
224 Public License instead.) You can apply it to your programs, too. </p>
226 <div align="justify"> </div>
228 <p align="justify"> When we speak of free software, we are referring to
229 freedom, not price. Our General Public Licenses are designed to make
230 sure that you have the freedom to distribute copies of free software (and
231 charge for this service if you wish), that you receive source code or can
232 get it if you want it, that you can change the software or use pieces of
233 it in new free programs; and that you know you can do these things. </p>
235 <div align="justify"> </div>
237 <p align="justify"> To protect your rights, we need to make restrictions
238 that forbid anyone to deny you these rights or to ask you to surrender
239 the rights. These restrictions translate to certain responsibilities for
240 you if you distribute copies of the software, or if you modify it. </p>
242 <div align="justify"> </div>
244 <p align="justify"> For example, if you distribute copies of such a program,
245 whether gratis or for a fee, you must give the recipients all the rights
246 that you have. You must make sure that they, too, receive or can get the
247 source code. And you must show them these terms so they know their rights.
250 <div align="justify"> </div>
252 <p align="justify"> We protect your rights with two steps: (1) copyright
253 the software, and (2) offer you this license which gives you legal permission
254 to copy, distribute and/or modify the software. </p>
256 <div align="justify"> </div>
258 <p align="justify"> Also, for each author's protection and ours, we want
259 to make certain that everyone understands that there is no warranty for
260 this free software. If the software is modified by someone else and passed
261 on, we want its recipients to know that what they have is not the original,
262 so that any problems introduced by others will not reflect on the original
263 authors' reputations. </p>
265 <div align="justify"> </div>
267 <p align="justify"> Finally, any free program is threatened constantly by
268 software patents. We wish to avoid the danger that redistributors of a free
269 program will individually obtain patent licenses, in effect making the program
270 proprietary. To prevent this, we have made it clear that any patent must
271 be licensed for everyone's free use or not licensed at all. </p>
273 <div align="justify"> </div>
275 <p align="justify"> The precise terms and conditions for copying, distribution
276 and modification follow. </p>
278 <div align="justify"> </div>
280 <h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
282 <div align="justify"> </div>
284 <p align="justify"> <strong>0.</strong> This License applies to any program
285 or other work which contains a notice placed by the copyright holder saying
286 it may be distributed under the terms of this General Public License.
287 The "Program", below, refers to any such program or work, and a "work based
288 on the Program" means either the Program or any derivative work under copyright
289 law: that is to say, a work containing the Program or a portion of it,
290 either verbatim or with modifications and/or translated into another language.
291 (Hereinafter, translation is included without limitation in the term "modification".)
292 Each licensee is addressed as "you". </p>
294 <p align="justify"> Activities other than copying, distribution and modification
295 are not covered by this License; they are outside its scope. The act
296 of running the Program is not restricted, and the output from the Program
297 is covered only if its contents constitute a work based on the Program
298 (independent of having been made by running the Program). Whether that
299 is true depends on what the Program does. </p>
301 <p align="justify"> <strong>1.</strong> You may copy and distribute verbatim
302 copies of the Program's source code as you receive it, in any medium,
303 provided that you conspicuously and appropriately publish on each copy
304 an appropriate copyright notice and disclaimer of warranty; keep intact
305 all the notices that refer to this License and to the absence of any warranty;
306 and give any other recipients of the Program a copy of this License along
307 with the Program. </p>
309 <p align="justify"> You may charge a fee for the physical act of transferring
310 a copy, and you may at your option offer warranty protection in exchange
313 <p align="justify"> <strong>2.</strong> You may modify your copy or copies
314 of the Program or any portion of it, thus forming a work based on the
315 Program, and copy and distribute such modifications or work under the terms
316 of Section 1 above, provided that you also meet all of these conditions:
319 <p align="justify"> </p>
321 <div align="justify">
323 <li><strong>a)</strong> You must cause the modified files
324 to carry prominent notices stating that you changed the files and
325 the date of any change.
328 <li><strong>b)</strong> You must cause any work that you
329 distribute or publish, that in whole or in part contains or is derived
330 from the Program or any part thereof, to be licensed as a whole at
331 no charge to all third parties under the terms of this License.
335 <li><strong>c)</strong> If the modified program normally
336 reads commands interactively when run, you must cause it, when started
337 running for such interactive use in the most ordinary way, to print
338 or display an announcement including an appropriate copyright notice
339 and a notice that there is no warranty (or else, saying that you provide
340 a warranty) and that users may redistribute the program under
341 these conditions, and telling the user how to view a copy of this
342 License. (Exception: if the Program itself is interactive but does
343 not normally print such an announcement, your work based on the Program
344 is not required to print an announcement.) </li>
347 These requirements apply to the modified work as a whole. If
348 identifiable sections of that work are not derived from the Program,
349 and can be reasonably considered independent and separate works in themselves,
350 then this License, and its terms, do not apply to those sections when
351 you distribute them as separate works. But when you distribute the same
352 sections as part of a whole which is a work based on the Program, the distribution
353 of the whole must be on the terms of this License, whose permissions for
354 other licensees extend to the entire whole, and thus to each and every
355 part regardless of who wrote it. </div>
357 <p align="justify"> Thus, it is not the intent of this section to claim rights
358 or contest your rights to work written entirely by you; rather, the intent
359 is to exercise the right to control the distribution of derivative or collective
360 works based on the Program. </p>
362 <p align="justify"> In addition, mere aggregation of another work not based
363 on the Program with the Program (or with a work based on the Program)
364 on a volume of a storage or distribution medium does not bring the other
365 work under the scope of this License. </p>
367 <p align="justify"> <strong>3.</strong> You may copy and distribute the
368 Program (or a work based on it, under Section 2) in object code or executable
369 form under the terms of Sections 1 and 2 above provided that you also
370 do one of the following: <!-- we use this doubled UL to get the sub-sections indented, -->
371 <!-- while making the bullets as unobvious as possible. --> </p>
373 <div align="justify">
375 <li><strong>a)</strong> Accompany it with the complete corresponding
376 machine-readable source code, which must be distributed under the
377 terms of Sections 1 and 2 above on a medium customarily used for software
381 <li><strong>b)</strong> Accompany it with a written offer,
382 valid for at least three years, to give any third party, for a charge
383 no more than your cost of physically performing source distribution,
384 a complete machine-readable copy of the corresponding source code,
385 to be distributed under the terms of Sections 1 and 2 above on a medium
386 customarily used for software interchange; or,
390 <li><strong>c)</strong> Accompany it with the information
391 you received as to the offer to distribute corresponding source
392 code. (This alternative is allowed only for noncommercial distribution
393 and only if you received the program in object code or executable
394 form with such an offer, in accord with Subsection b above.) </li>
397 The source code for a work means the preferred form of the work
398 for making modifications to it. For an executable work, complete source
399 code means all the source code for all modules it contains, plus any associated
400 interface definition files, plus the scripts used to control compilation
401 and installation of the executable. However, as a special exception,
402 the source code distributed need not include anything that is normally
403 distributed (in either source or binary form) with the major components
404 (compiler, kernel, and so on) of the operating system on which the executable
405 runs, unless that component itself accompanies the executable. </div>
407 <p align="justify"> If distribution of executable or object code is made
408 by offering access to copy from a designated place, then offering equivalent
409 access to copy the source code from the same place counts as distribution
410 of the source code, even though third parties are not compelled to copy
411 the source along with the object code. </p>
413 <p align="justify"> <strong>4.</strong> You may not copy, modify, sublicense,
414 or distribute the Program except as expressly provided under this License.
415 Any attempt otherwise to copy, modify, sublicense or distribute the Program
416 is void, and will automatically terminate your rights under this License.
417 However, parties who have received copies, or rights, from you under
418 this License will not have their licenses terminated so long as such parties
419 remain in full compliance. </p>
421 <p align="justify"> <strong>5.</strong> You are not required to accept
422 this License, since you have not signed it. However, nothing else grants
423 you permission to modify or distribute the Program or its derivative works.
424 These actions are prohibited by law if you do not accept this License.
425 Therefore, by modifying or distributing the Program (or any work based
426 on the Program), you indicate your acceptance of this License to do so,
427 and all its terms and conditions for copying, distributing or modifying the
428 Program or works based on it. </p>
430 <p align="justify"> <strong>6.</strong> Each time you redistribute the Program
431 (or any work based on the Program), the recipient automatically receives a
432 license from the original licensor to copy, distribute or modify the Program
433 subject to these terms and conditions. You may not impose any further
434 restrictions on the recipients' exercise of the rights granted herein.
435 You are not responsible for enforcing compliance by third parties to this
438 <p align="justify"> <strong>7.</strong> If, as a consequence of a court
439 judgment or allegation of patent infringement or for any other reason
440 (not limited to patent issues), conditions are imposed on you (whether
441 by court order, agreement or otherwise) that contradict the conditions
442 of this License, they do not excuse you from the conditions of this License.
443 If you cannot distribute so as to satisfy simultaneously your obligations
444 under this License and any other pertinent obligations, then as a consequence
445 you may not distribute the Program at all. For example, if a patent license
446 would not permit royalty-free redistribution of the Program by all those
447 who receive copies directly or indirectly through you, then the only way
448 you could satisfy both it and this License would be to refrain entirely
449 from distribution of the Program. </p>
451 <p align="justify"> If any portion of this section is held invalid or unenforceable
452 under any particular circumstance, the balance of the section is intended
453 to apply and the section as a whole is intended to apply in other circumstances.
456 <p align="justify"> It is not the purpose of this section to induce you to
457 infringe any patents or other property right claims or to contest validity
458 of any such claims; this section has the sole purpose of protecting the
459 integrity of the free software distribution system, which is implemented
460 by public license practices. Many people have made generous contributions
461 to the wide range of software distributed through that system in reliance
462 on consistent application of that system; it is up to the author/donor to
463 decide if he or she is willing to distribute software through any other
464 system and a licensee cannot impose that choice. </p>
466 <p align="justify"> This section is intended to make thoroughly clear what
467 is believed to be a consequence of the rest of this License. </p>
469 <p align="justify"> <strong>8.</strong> If the distribution and/or use of
470 the Program is restricted in certain countries either by patents or by copyrighted
471 interfaces, the original copyright holder who places the Program under this
472 License may add an explicit geographical distribution limitation excluding
473 those countries, so that distribution is permitted only in or among countries
474 not thus excluded. In such case, this License incorporates the limitation
475 as if written in the body of this License. </p>
477 <p align="justify"> <strong>9.</strong> The Free Software Foundation may
478 publish revised and/or new versions of the General Public License from
479 time to time. Such new versions will be similar in spirit to the present
480 version, but may differ in detail to address new problems or concerns.
483 <p align="justify"> Each version is given a distinguishing version number.
484 If the Program specifies a version number of this License which applies
485 to it and "any later version", you have the option of following the terms
486 and conditions either of that version or of any later version published
487 by the Free Software Foundation. If the Program does not specify a version
488 number of this License, you may choose any version ever published by the
489 Free Software Foundation. </p>
491 <p align="justify"> <strong>10.</strong> If you wish to incorporate parts
492 of the Program into other free programs whose distribution conditions
493 are different, write to the author to ask for permission. For software
494 which is copyrighted by the Free Software Foundation, write to the Free
495 Software Foundation; we sometimes make exceptions for this. Our decision
496 will be guided by the two goals of preserving the free status of all derivatives
497 of our free software and of promoting the sharing and reuse of software
500 <p align="justify"><strong>NO WARRANTY</strong></p>
502 <div align="justify"> </div>
504 <p align="justify"> <strong>11.</strong> BECAUSE THE PROGRAM IS LICENSED
505 FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED
506 BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
507 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
508 OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
509 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
510 PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
511 IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
512 ALL NECESSARY SERVICING, REPAIR OR CORRECTION. </p>
514 <p align="justify"> <strong>12.</strong> IN NO EVENT UNLESS REQUIRED BY
515 APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY
516 OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED
517 ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL
518 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
519 PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
520 INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF
521 THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR
522 OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. </p>
524 <p align="justify"> </p>
526 <h3>END OF TERMS AND CONDITIONS</h3>
529 <hr width="100%" size="2"><br>
532 <h2><a name="Installation"></a>Installation</h2>
535 <div align="justify">
538 <p>Citadel/UX is an advanced, multiuser, client/server, room-based BBS program.
539 It is designed to handle the needs of both small dialup systems and large-scale
540 Internet-connected systems. It was originally developed on an Altos system
541 running Xenix, and has been installed and tested on various Unix and Unix-like
542 platforms. The author's current development environment (and BBS) is an
543 ordinary Linux system. The current distribution includes: </p>
546 <li>The Citadel/UX server (this is the back end that does all processing)
548 <li>A text-based client program designed with the traditional Citadel
549 "look and feel" (room prompts, dot commands, and the like) </li>
550 <li>Setup programs </li>
551 <li>A set of utilities for system administration and maintenance
553 <li>Documentation </li>
557 <p>Some knowledge of the Unix system is necessary to install and manage the
558 system. It is mandatory that the sysop have "root" access to the operating
559 system. The following are required to install Citadel/UX: </p>
562 <li>A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX) </li>
563 <li>C compiler (such as gcc or egcs) and "make" </li>
564 <li>POSIX threads (the "pthreads" library) </li>
566 <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1 or newer
567 (GDBM also works, but its use is officially depracated. If you are building
568 a new system, do <i>not</i> use GDBM. If you have an existing system which
569 uses GDBM, you should migrate it to Berkeley DB as soon as possible.) </li>
570 <li>Enough disk space to hold all of the programs and data </li>
574 <p>If you are running Citadel/UX on a Linux system, it is STRONGLY recommended
575 that you run it on a recent distribution (such as <a
576 href="http://www.redhat.com">Red Hat</a> 7.3 or newer). A new-ish distribution
577 will have most or all of the prerequisite tools and libraries already integrated
580 <h3>Now available:</h3>
583 <li>"WebCit", a gateway program to allow full access to Citadel via
584 the World Wide Web. Interactive access through any Web browser. </li>
585 <li>Access to Citadel via <i>any</i> standards-compliant e-mail
586 program, thanks to Citadel's built-in SMTP, POP, and IMAP services. You
587 can use Netscape/Mozilla, Evolution, Eudora, Pine, or even Microsoft VirusSpreader
588 (better known as "Outlook") with Citadel. </li>
592 <h3>Coming soon:</h3>
595 <li>Newer and better GUI-based clients. </li>
599 <h3><a name="Everything_in_its_place..."></a>Everything in its place...</h3>
601 <p>Hopefully you've unpacked the distribution archive into its own directory.
602 This is the directory in which all Citadel files are located and in which
603 all activity will take place. Several subdirectories have already been
604 created during the unpacking process, and others may be created by the
605 software if needed. Make sure you have Berkeley DB installed on your system,
606 and that you have all the development libraries and headers in place so
607 that you can compile against them. If you don't, you can get the latest
608 Berkeley DB at <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
609 If your operating system uses a separate library to support POSIX threads
610 (pthreads), make sure that library is installed as well. This is almost
611 never the case with Linux, but some commercial Unix flavors might need
614 <h3><a name="The_BBS_Login"></a></h3>
616 <h3>The BBS Login</h3>
618 <p>As with many Unix programs, Citadel wants to run under its own user ID.
619 Unlike other programs, however, this user ID will do double-duty as a public
620 login for your system if you are running a BBS. This account is typically
621 called "bbs" or "citadel" or something to that effect. You will tell Citadel
622 what the user-id of that account is, and when someone logs in under that
623 account, Citadel will prompt for a user name.</p>
625 <p>The Citadel user should have a unique uid. The home directory should be
626 the one your Citadel installation resides in (in this example we will use
627 /usr/local/citadel) and the shell should be either "citadel" in that directory,
628 or a script that will start up citadel (you may wish to set up an external
629 text editor; see below). Example:</p>
631 <pre>bbs::100:1:BBS Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
633 <p>When you run setup later, you will be required to tell it what the Citadel
634 user's numeric user ID is, so it knows what user to run as. If you create
635 an account called <tt>bbs</tt>, <tt>guest</tt>, or <tt>citadel</tt>, the
636 setup program will automatically pick up the user ID by default.</p>
638 <p>For all other users in /etc/passwd, Citadel will automatically set up
639 an account using the full name (or 'gecos' in Unixspeak) of the user. It'll
640 also ignore any password you supply, because it uses the user's password
641 on the host system. This allows a 'single sign on' type of environment.
642 Note that this does have to be enabled at compile time -- it's the configure
643 option called <tt>--enable-autologin</tt>. Keep in mind that these users
644 can use *either* their Citadel login name or their login name on the host
645 computer, and their password on the host computer.</p>
647 <h3><a name="Bypassing_the_login:_prompt"></a></h3>
649 <h3>Bypassing the <tt>login:</tt> prompt</h3>
651 <p>If you normally log in to your host system using some method other than
652 telnet (such as ssh), you might want the telnet service to go straight to
653 the Citadel BBS, instead of displaying the <tt>login:</tt> prompt first.
654 You can do this by having telnetd start citadel directly instead of <tt>/bin/login</tt>.
655 This is actually very simple to implement; all you need to do is make a
656 simple change to your <tt>inetd</tt> or <tt>xinetd</tt> configuration. Here
657 are some configuration examples.</p>
659 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
660 replacing any existing telnet configuration line already there):</p>
662 <pre>telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel<br></pre>
664 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
665 then simply replace that file with this one):</p>
667 <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>
669 <p>Please make sure you know what you're doing before you install this! If
670 you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
671 then change the directory name accordingly. If you know of any other local
672 peculiarities which need to be observed, edit the above configuration accordingly
673 as well. And, of course, if you're working remotely, make sure you can
674 successfully log in using SSH before you start changing your telnet configuration,
675 otherwise you could lock yourself out of your system (ask any networking
676 specialist about the dangers of "working inline" -- then pull up a chair
677 and get a fresh cup of coffee, because you're going to hear some war stories).</p>
679 <h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
681 <p>You can easily compile the Citadel system with the following commands:</p>
683 <pre>./configure<br>make<br>make install<br></pre>
685 <p>The 'configure' script will generate a Makefile from the Makefile.in,
686 and it will also write the file "sysdep.h" to your Citadel directory. Please
687 do not edit sysdep.h or Makefile.in yourself. The configure script will
688 figure out your system dependencies and set everything correctly.</p>
690 <p>Mac OS X 10.1 and later are now supported. (Sorry, 10.0 cannot be supported,
691 now or in the future.) You need to install the Developer Tools CD, which
692 you can purchase or download for free from <a
693 href="http://developer.apple.com">http://developer.apple.com</a>. Then run
694 configure like this:</p>
696 <pre>env CC=/usr/bin/cc ./configure (options - see below)<br></pre>
698 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
699 If you wish to place it in a different directory, you can instead do:</p>
701 <pre>./configure --prefix=/export/home/citadel (or whatever)<br></pre>
703 <p>If you've got Berkeley DB installed in a non-standard location, you can
704 help the configure script find it by doing something like this:</p>
706 <pre>./configure --with-db=/usr/local/BerkeleyDB-4.1<br></pre>
708 <p>The configure script prefers Berkeley DB if it is available, but will fall
709 back to GDBM if it has to.</p>
711 <p>File permissions are always a bother to work with. You don't want Citadel
712 to crash because someone couldn't access a file, but you also don't want
713 shell users peeking into the binaries to do things like reading others'
714 mail, finding private rooms, etc. The Citadel server needs to be started
715 as root in order to bind to privileged ports, but as soon as its initialization
716 is finished, it changes its user ID to your BBS user ID in order to avoid
719 <h3><a name="Upgrading"></a></h3>
723 <p>Any existing Citadel installation which is at version 5.50 or newer may
724 be upgraded in place without the need to discard your existing data files.</p>
726 <p>Upgrading to a new version uses the same build procedure as compiling
727 the program for a fresh install, except that you want to do <tt>make install-exec</tt>
728 instead of <tt>make install</tt>. This will overwrite the programs but
729 not your data. <b>Be sure to shut down citserver during this process!</b>
730 If Citadel is running while you upgrade, you may face data corruption issues.<br>
733 <p>After doing <tt>make install-exec</tt>, you should run <tt>setup</tt>
734 again to bring your data files up to date. Please see the setup section
735 below for more information on this.</p>
737 <h3><a name="The_citadel.rc_file"></a>The <tt>citadel.rc</tt> file</h3>
739 <p>The text-based client included with Citadel is suitable for BBS applications.
740 Much of its command set and other behavior is configurable through a Run
741 Control (RC) file. The standard client looks for this file in the following
745 <li><tt>$HOME/.citadelrc</tt></li>
746 <li><tt>/usr/local/lib/citadel.rc</tt></li>
747 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
750 The next couple of sections deal with client-side configuration.
752 <h3><a name="Using_an_external_editor_for_message"></a>Using an external editor
753 for message composition</h3>
755 <p>Citadel/UX has a built-in message editor. However, you can also use your
756 favorite text editor to write messages. To do this you simply put a line
757 in your citadel.rc file like this:</p>
759 <pre>editor=/usr/bin/vi<br></pre>
761 <p>The above example would make Citadel call the vi editor when using the
762 <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make it the default
763 editor for the <tt><b>E</b>nter</tt> command by editing the <tt>citadel.rc</tt>
764 file. <b>But be warned:</b> external editors on public systems can be
765 a security hole, because they usually provide users with the ability to
766 drop into a shell on the host system, or save files using names other than
767 the name of the temporary file they are editing. If you intend to use an
768 external editor on a public BBS, make sure you use one that has been hardened
769 for such a purpose -- one which has had the 'shell' and 'save as' commands
770 disabled, as well as any other functions which a destructive user could
771 use to gain unauthorized access to your host system.</p>
773 <h3><a name="Printing_messages"></a>Printing messages</h3>
775 <p>Citadel/UX can send messages to a printer, or just about anywhere else
776 in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt> specifies
777 what command you use to print. Text is sent to the standard input (stdin)
778 of the print command.</p>
780 <p>So if you did this:</p>
782 <pre>printcmd="nl|pr|lpr -Plocal"<br></pre>
784 <p>...that would add line numbers, then paginate, then print on the printer
785 named "local". There's tons of stuff you can do with this feature. For
786 example, you could use a command like <tt>cat <<$HOME/archive</tt> to
787 save copies of important messages in a textfile. Again, this is probably
788 something you don't want to configure for a public BBS host -- most system
789 administrators don't want remote users sending arbitrary things to local
792 <h3><a name="URL_viewing"></a>URL viewing</h3>
794 <p>This is one more feature which is appropriate for local users. While reading
795 a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
796 command, and it will perform some pre-defined action (usually, this is to
797 open up the URL in a web browser). For example:</p>
799 <pre>urlcmd=netscape -remote "openURL(%s)"<br></pre>
801 <p>In the above example, it would open up the URL in an open <a
802 href="http://www.netscape.com/download">Netscape</a> window.</p>
804 <h3><a name="Setup_and_login"></a></h3>
806 <h3>Setup and login</h3>
808 <p>Before logging in for the first time, you must run the setup program.
809 To begin this procedure, enter the following commands:</p>
811 <pre>cd /usr/local/citadel<br>./setup<br></pre>
813 <p>The setup program will guide you through a simple configuration procedure.
814 It will ask you what directory to place your data files in -- the default
815 is the current directory, which is usually the sensible thing to select.
816 If you want to run more than one instance of Citadel on the same host, however,
817 you can specify a different directory here -- just remember to specify the
818 directory name again when you start up the server later on.</p>
820 <p><tt>setup</tt> will then shut down the Citadel service if it is found to
823 <p>You will then be prompted for the name of the system administrator. This
824 is not merely a cosmetic option -- when you log in to your system a little
825 while from now, you'll log in with this name, and it will automatically assign
826 your account the highest access level.</p>
828 <p>Next, you will be prompted for the User ID of the Citadel account on your
829 host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
830 or <tt>citadel</tt>, that account's UID will be the default. If you are
831 upgrading or reconfiguring an existing system, the existing value will be
834 <p>Then you will be prompted for a server port number. This is the TCP port
835 which Citadel clients use to connect to your Citadel server. In almost all
836 cases, you want to use the default -- port 504, which is the official port
837 number assigned by the IANA for Citadel implementations.</p>
839 <p>The Citadel service will then be started, and you will see the following
842 <pre>Setup is finished. You may now log in.<br></pre>
844 <p>Setup is now complete, on most systems, anyway. Please see below to find
845 out if you need to do anything else:</p>
847 <h3><a name="Configuring_your_host_system_to_start"></a>Configuring your host
848 system to start the service</h3>
850 <p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
851 and <tt>/etc/inittab</tt> in order to configure your host system to automatically
852 start the Citadel service. <tt>setup</tt> will automatically perform these
853 steps if it can, and if you allow it to -- just answer 'Yes' when prompted,
854 and everything will be taken care of for you. If you answer 'No' -- or if
855 your system is a little bit odd (for example, BSD systems don't have <tt>/etc/inittab</tt>)
856 -- read this section and do what you need to in order to get things configured.</p>
858 <p>Before you can use Citadel, you must define the "citadel" service to your
859 system. This is accomplished by adding a line to your /etc/services file
860 that looks something like this:</p>
862 <pre>citadel 504/tcp # Citadel/UX Server<br></pre>
864 <p>504 is the port number officially designated by the IANA for use by Citadel.
865 There should not be any need to use a different port number, unless you
866 are running multiple Citadels on the same computer and therefore need a different
867 port for each one.</p>
869 <p>The next step is to arrange for the server to start. The <tt>citserver</tt>
870 program is the main Citadel server. Before we cover the recommended method
871 of starting the server, let's examine its usage options:</p>
873 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-d] [-f]<br></pre>
875 <p>The options are as follows:</p>
877 <p><tt>-hHomeDir</tt> - the directory your BBS data files live in. This should,
878 of course, be a directory that you've run the <tt>setup</tt> program against
879 to set up some data files. If a directory is not specified, the directory
880 name which was specified in the <tt>Makefile</tt> will be used.</p>
882 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed. The
883 available debugging levels are: </p>
886 <li>1 - Internal errors (failed thread creation, malloc problems, etc.)
888 <li>2 - Network errors (broken sockets, failed socket creation)
890 <li>3 - Begin and end of sessions, startup/shutdown of server </li>
891 <li>5 - Server commands being sent from clients </li>
892 <li>7 - Entry and exit of various functions </li>
893 <li>8 - Entry and exit of critical sections </li>
894 <li>9 - Various debugging checkpoints (insanely verbose) </li>
898 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace output.
899 Normally it is sent to stdout.</p>
901 <p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch would
902 be necessary if you were starting the Citadel server, for example, from
903 an rc.local script (which is not recommended, because this won't allow the
904 server to automatically restart when it is shut down).</p>
906 <p><tt>-f</tt> - Defragment all the databases upon startup. This isn't normally
907 necessary due to the nature of the data stored in Citadel, but the option
908 is provided in case you need it. (Note that this only applies to GDBM installations;
909 if you are using Berkeley DB it has no effect.)</p>
911 <p>The preferred method of starting the Citadel server is to place an entry
912 in your /etc/inittab file. This will conveniently bring the server up when
913 your system is up, and terminate it gracefully when your system is shutting
914 down. The exact syntax for your system may vary, but here's an entry that
915 could be used on a Linux system:</p>
917 <pre>cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x3<br></pre>
919 <p>In this example, we've chosen debugging level 3, and have the trace stuff
920 output to one of the virtual consoles. It's important to remember to turn
921 off any getty that is set up on that virtual console, if you do this. After
922 making this change, the command <tt>init q</tt> works on most systems to
923 tell init to re-read the file. If in doubt, just reboot the computer.</p>
925 <h3><a name="Logging_in_for_the_first_time"></a>Logging in for the first time</h3>
927 <p>At this point, your system is ready to run. Run the <tt>citadel</tt> program
928 from the shell and log in as a new user. NOTE: the first user account to
929 be created will automatically be set to access level 6 (Aide). This overcomes
930 some obvious logistical problems - normally, Aide access is given by another
931 Aide, but since there aren't any on your system yet, this isn't possible.</p>
933 <h3><a name="Welcoming_new_users"></a>Welcoming new users</h3>
935 <p>Sometimes you might decide that you want a welcome message (or several
936 different messages) automatically mailed to new users upon their first login.
937 Now there is a way to do this. If you create a room called <tt>New User
938 Greetings</tt>, and it is a <i>private</i> room (invitation-only probably
939 makes the most sense), any messages you enter into that room will automatically
940 be delivered to all new users upon registration.</p>
942 <p>You can put anything you want there: a welcome message, system policies,
943 special information, etc. You can also put as many messages there as you
944 want to (although it really doesn't make sense to clutter new users' mailboxes
945 with lots of junk).</p>
947 <p>Don't worry about wasting disk space, either. Citadel has a single-instance
948 message store, so all the new users are actually looking at the same copy
949 of the message on disk.</p>
951 <h3><a name="Space_for_adding_your_own_client"></a>Space for adding your own
952 client features (doors)</h3>
954 <p><b>Please take note!</b> This function really represents the "old" way
955 of doing things, and it doesn't fit in well with the client/server paradigm.
956 Please consider it "deprecated" because it may be removed someday.</p>
958 <p>The "doorway" feature is just a generic way to add features to the system.
959 I called it "Doorway" to make it resemble the doors on non-Unix boards, but
960 as we all know, us Unix types don't have to write special code to access
961 the modem. :-) Anyway, when a user hits the <tt><b>*</b></tt> (doorway) command,
964 <pre>USERNAME=(username); export USERNAME<br>./subsystem (user-number) (screen-width) (access level)<br></pre>
966 <p>...so you can put whatever you want in there. I suggest putting in a menu
967 program to allow the users to pick one of a number of programs, etc. Do
968 be aware that door programs will only be available when the client and server
969 programs are running on the <i>same</i> computer, and when the user is running
970 the text-mode client. Because of these restrictions, Door programs are being
971 utilized less and less every day.</p>
973 <h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and getting
976 <p>That's just about all the information you need to install the system.
977 But if you get stuck, you can visit UNCENSORED! BBS and report a problem or
978 ask for help. But if you intend to report a problem getting the Citadel server
979 to run, <i>please</i> double-check the following things first: </p>
982 <li>Did you do <tt>./configure && make && make install</tt>
984 <li>Did you run setup? </li>
985 <li>Did you start the server? </li>
989 <p>To report a problem, you can log on to UNCENSORED! or any other BBS on
990 the Citadel network which carries the <tt>Citadel/UX></tt> room. Please
991 DO NOT e-mail the developers directly. Post a request for help on the BBS,
992 with all of the following information: </p>
995 <li>The exact nature of your difficulty </li>
996 <li>A transcript of the error message(s) if possible </li>
997 <li>The version of Citadel you are running </li>
998 <li>The version of Berkeley DB present on your system </li>
999 <li>Which operating system you are running, and what version </li>
1000 <li>If you are running a Linux system, we need to know which distribution,
1001 and the version of the kernel, libc, and pthreads you are using (it would
1002 help to post the output of a <tt>ldd ./citserver</tt> command). </li>
1007 <div align="center">
1008 <hr width="100%" size="2">
1009 <h2><a name="sysop"></a>System Administration</h2>
1012 <div align="justify">
1013 <h3><a name="Overview_"></a>Overview</h3>
1015 <p>Citadel/UX, when installed properly, will do most of its maintenance by
1016 itself. It is intended to be run unattended for extended periods of time,
1017 and most installations do just that without any software failures.</p>
1019 <p>The system has seven access levels. Most users are at the bottom and have
1020 no special privileges. Aides are selected people who have special access within
1021 the Citadel program. Room Aides only have this access in a certain room.
1022 Preferred users can be selected by Aides for access to preferred only rooms.
1023 A sysop is anyone who has access to the various sysop utilities - these
1024 are in their own executable files, which should have their permissions set
1025 to allow only sysops to run them. You should either create a sysops group
1026 in /etc/group, or use some other existing group for this purpose.</p>
1028 <p>Aides have access to EVERY room on the system, public and private (all
1029 types). They also have access to commands starting with <tt>.<b>A</b>ide</tt>
1030 in addition to being able to delete and move messages. The system room,
1031 <tt>Aide></tt>, is accessible only by those users designated as Aides.</p>
1033 <h3><a name="Aide_commands"></a>Aide commands</h3>
1035 <p>Aides have the following commands available to them that are not available
1036 to normal users. They are:</p>
1041 <td width="30%"><tt> .<b>A</b>ide <b>K</b>ill this room </tt></td>
1042 <td> Deletes the current room from the system. </td>
1045 <td width="30%"><tt> .<b>A</b>ide <b>E</b>dit this room </tt></td>
1046 <td> Allows editing of the properties of the current room. This
1047 is explained in greater detail below. </td>
1050 <td width="30%"><tt> .<b>A</b>ide <b>W</b>ho knows room </tt></td>
1051 <td> For private rooms with access controls, or mailbox rooms, this
1052 command displays a list of users who have access to the current room. </td>
1055 <td width="30%"><tt> .<b>A</b>ide edit <b>U</b>ser </tt></td>
1056 <td> Allows editing of the properties of any user account on the
1060 <td width="30%"><tt> .<b>A</b>ide <b>V</b>alidate new users </tt></td>
1061 <td> For public access systems, this command reviews all new user
1062 registrations and allows you to set each new user's access level (or simply
1063 delete the accounts). </td>
1066 <td width="30%"><tt> .<b>A</b>ide enter <b>I</b>nfo file </tt></td>
1067 <td> Each room may contain a short textual description of its purpose,
1068 which is displayed to users upon entering the room for the first time (or
1069 in the room banner, for users of the Web client). This command allows you
1070 to enter or edit that description. </td>
1073 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite user
1075 <td> Access control command to grant any specific user access to
1076 a private room. </td>
1079 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick out user
1081 <td> Access control command to revoke any specifc user's access
1082 to the current room. This works regardless of whether the room is public
1086 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>D</b>elete </tt></td>
1087 <td> If the current room has an associated file directory, this
1088 command may be used to delete files from it. </td>
1091 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end over net
1093 <td> If the current room has an associated file directory, this
1094 command may be used to transmit a copy of any file in that directory to
1095 another node on a Citadel network. </td>
1098 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>M</b>ove </tt></td>
1099 <td> If the current room has an associated file directory, this
1100 command may be used to move any file in that directory to another room.
1101 The target room must also have an associated file directory. </td>
1104 <td width="30%"><tt> .<b>A</b>ide <b>M</b>essage edit </tt></td>
1105 <td> This command allows editing of any of the various system banners
1106 and messages which are displayed to users. Type the name of the banner or
1107 message you wish to edit. </td>
1110 <td width="30%"><tt> .<b>A</b>ide <b>P</b>ost </tt></td>
1111 <td> This is the functional equivalent of the <tt><b>E</b>nter message</tt>
1112 command available to all users, except that it allows you to post using any
1116 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>G</b>eneral
1118 <td> This command allows configuration of a large number of global
1119 settings for your Citadel system. These settings will be explained in greater
1123 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>I</b>nternet
1125 <td> This command allows configuration of settings which affect
1126 how your Citadel system sends and receives messages on the Internet. </td>
1129 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration check
1130 <b>M</b>essage base </tt></td>
1131 <td> Perform a consistency check on your message store. This is
1132 a very time-consuming operation which should not be performed unless you
1133 have reason to believe there is trouble with your database. </td>
1136 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>N</b>etwork
1138 <td> Configure networking (e-mail, room sharing, etc.) with other
1139 Citadel nodes. </td>
1142 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration network
1143 <b>F</b>ilter list </tt></td>
1144 <td> If you are on a large public or semi-public network of Citadel
1145 nodes and you find content from certain systems or individuals objectionable,
1146 you can use this command to define a rule set to automatically reject those
1147 messages when they arrive on your system. </td>
1150 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>N</b>ow
1152 <td> Immediately shut down the Citadel service, disconnecting any
1153 users who are logged in. Please keep in mind that it will start right back
1154 up again if you are running the service from <tt>/etc/inittab</tt>, so in
1155 practice this command will probably not get much use. </td>
1158 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>S</b>cheduled
1160 <td> Shut down the Citadel service the next time there are zero
1161 users connected. This allows you to automatically wait until all users are
1165 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients
1167 <td> Any room may be made into a mailing list. Enter this command
1168 to open an editor window containing the list of Internet e-mail addresses
1169 to which every message posted in the room will be sent. </td>
1172 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest recipients
1174 <td> Similar to the regular mailing list command, except the messages
1175 will be sent out in 'digest' form -- recipients will see messages from the
1176 address of the room itself rather than the address of the author of each
1177 message, and a digest may contain more than one message. Each room may have
1178 any combination of List and Digest recipients. </td>
1181 <td width="30%"><tt> .<b>A</b>ide <b>N</b>etwork room sharing </tt></td>
1182 <td> Configures the sharing of the current room's contents with
1183 other Citadel nodes. Messages posted in this room on any Citadel system
1184 will automatically be replicated to other Citadel systems carrying the room.
1191 <h3><a name="Editing_rooms"></a>Editing rooms</h3>
1193 <p>This command allows any aide to change the parameters of a room. Go to
1194 the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit room</tt>
1195 command. A series of prompts will be displayed. The existing parameters
1196 will be displayed in brackets; simply press return if you want to leave any
1197 or all of them unchanged.</p>
1199 <pre> <br>Room name [IG's Fun Room]:<br></pre>
1201 <p>...the name of the room.</p>
1203 <pre>Private room [Yes]? <br></pre>
1205 <p>...enter Yes if you wish to restrict access to the room, or no if the room
1206 is to be accessible by all users. Note that Citadel doesn't bother users
1207 about access to rooms every time they need to access the room. Once a user
1208 gains access to a private room, it then behaves like a public room to them.
1209 The following four questions will only be asked if you selected Private...</p>
1211 <pre>Accessible by guessing room name [No]?<br></pre>
1213 <p>...if you enter Yes, the room will not show up in users' <tt><b>K</b>nown
1214 rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing the
1215 room's full name), they will gain access to the room.</p>
1217 <pre>Accessible by entering a password [No]?<br>Room password [mypasswd]: <br></pre>
1219 <p>...this adds an additional layer of security to the room, prompting users
1220 for a password before they can gain access to the room.</p>
1222 <p>If you did not select guessname or passworded, then the only way users
1223 can access the room is if an Aide explicitly invites them to the room using
1224 the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt> command.</p>
1226 <pre>Cause current users to forget room [No] ? No<br></pre>
1228 <p>Enter Yes if you wish to kick out anyone who currently has access to the
1231 <pre>Preferred users only [No]? No<br></pre>
1233 <p>Enter Yes if you wish to restrict the room to only users who have level
1234 5 (Preferred User) status (and Aides too, of course). You should make the
1235 room public if you intend to do this, otherwise the two restrictions will
1238 <pre>Read-only room [No]? No<br></pre>
1240 <p>If you set a room to Read-Only, then normal users will not be allowed to
1241 post messages in it. Messages may only be posted by Aides, and by utility
1242 programs such as the networker and the "aidepost" utility. This is useful
1243 in situations where a room is used exclusively for important announcements,
1244 or if you've set up a room to receive an Internet mailing list and posting
1245 wouldn't make sense. Other uses will, of course, become apparent as the
1248 <p>Now for a few other attributes...</p>
1250 <pre>Directory room [Yes]? Yes<br></pre>
1252 <p>...enter Yes if you wish to associate a directory with this room. This
1253 can be used as a small file repository for files relevant to the topic of
1254 the room. If you enter Yes, you will also be prompted with the following
1257 <pre>Directory name [mydirname]: <br></pre>
1259 <p>...the name of the subdirectory to put this room's files in. The name
1260 of the directory created will be <tt><i><your BBS directory></i>/files/<i><room
1261 dir name></i></tt>.</p>
1263 <pre>Uploading allowed [Yes]? Yes<br></pre>
1265 <p>...enter Yes if users are allowed to upload to this room.</p>
1267 <pre>Downloading allowed [Yes]? Yes<br></pre>
1269 <p>...enter Yes if users are allowed to download from this room.</p>
1271 <pre>Visible directory [Yes]? Yes<br></pre>
1273 <p>...enter Yes if users can read the directory of this room.</p>
1275 <pre>Network shared room [No]? No<br></pre>
1277 <p>...you can share a room over a network without setting this flag, and
1278 vice versa, but what this flag does is twofold: </p>
1281 <li>It prevents people with no network access from entering messages
1283 <li>Messages are displayed with the name of their originating system
1284 in the header. </li>
1288 <pre>Permanent room [No]? No<br></pre>
1290 <p>Citadel contains an 'auto purger' which is capable of removing rooms which
1291 have not been posted in for a pre-defined period of time (by default this
1292 is set to two weeks). If you wish to keep this from happening to a particular
1293 room, you can set this option. (Keep in mind that <tt>Lobby></tt>,
1294 <tt>Aide></tt>, any private mailbox rooms, any network shared rooms,
1295 and any rooms with a file directory are automatically permanent.)</p>
1297 <pre>Anonymous messages [No]? No<br>Ask users whether to make messages anonymous [No]? No<br></pre>
1299 <p>...you can have rooms in which all messages are automatically anonymous,
1300 and you can have rooms in which users are prompted whether to make a message
1301 anonymous when they enter it. The real identity of the author of each
1302 message is still revealed to the Room Aide for this room, as well as any
1303 system-wide Aides.</p>
1305 <pre>Room aide [Joe Responsible]: <br></pre>
1307 <p>...on larger systems, it helps to designate a person to be responsible
1308 for a room. Room Aides have access to a restricted set of Aide commands,
1309 ONLY when they are in the room in which they have this privilege. They can
1310 edit the room, delete the room, delete and move messages, and invite or
1311 kick out users (if it is a private room), but they cannot perform aide commands
1312 that are not room-related (such as changing users access levels).</p>
1314 <pre>Listing order [64]: <br></pre>
1316 <p>This is just a simple way to try to control the order rooms are listed
1317 in when users call up a <tt><b>K</b>nown Rooms</tt> listing. Rooms with
1318 a lower listing order are displayed prior to rooms with a higher listing order.
1319 It has no other effect. For users who list rooms in floor order, the display
1320 will sort first by floor, then by listing order.</p>
1322 <pre>Message expire policy (? for list) [0]:<br></pre>
1324 <p>This provides you with the opportunity to select how long each message
1325 will remain in a room before automatically being deleted. Press <tt><b>?</b></tt>
1326 for a list of options. You can choose to keep messages around forever
1327 (or until they are manually deleted), until they become a certain number
1328 of days old, or until a certain number of additional messages are posted
1329 in the room, at which time the oldest ones will scroll out.</p>
1331 <p>You will notice that you can also fall back to the default expire policy
1332 for the floor upon which the room resides. This is the default setting.
1333 You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit
1334 floor</tt> command. The default setting for the floor default, in turn, is
1335 the system default setting, which can be changed using the <tt><b>.A</b>ide
1336 <b>S</b>ystem configuration <b>G</b>eneral</tt> command.</p>
1338 <pre>Save changes (y/n)? Yes<br></pre>
1340 <p>...this gives you an opportunity to back out, if you feel you really messed
1341 things up while editing.</p>
1343 <h3><a name="File_directories"></a>File directories</h3>
1345 <p>If you have created any directory rooms, you can attach file descriptions
1346 to the filenames through a special file called <tt>filedir</tt>. Each line
1347 contains the name of a file in the directory, followed by a space and then
1348 a description of the file, such as:</p>
1350 <pre>myfile.txt This is a description of my file.<br>phluff A phile phull of phluff!<br></pre>
1352 <p>...this would create file descriptions for the files <tt>myfile.txt</tt>
1353 and <tt>phluff</tt> which would be displayed along with the directory.
1354 It should also be noted that when users upload files to your system, they
1355 will be prompted for file descriptions, which will be added to the <tt>filedir</tt>
1356 file. If one does not exist, it will be created.</p>
1358 <h3><a name="Creating_and_editing_user_accounts"></a>Creating and editing
1361 <p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1362 command to create and/or edit user accounts. There are several parameters
1363 which can be set here.</p>
1365 <p>To create a user:</p>
1367 <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>
1369 <p>At this point, the new user account has been created, and the command will
1370 continue as if you were editing an existing account. Therefore the remainder
1371 of this procedure is the same for creating and editing:</p>
1373 <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>
1375 <p>The blank lines are the user's 'registration' information -- personal
1376 information such as full name, address, telephone number, etc. This information
1377 will comprise the user's vCard in both their user profile and in the Global
1380 <pre>Change password [No]: No<br></pre>
1382 <p>...answer Yes to set or change the password for this account.</p>
1384 <pre>Access level [4]: <br></pre>
1386 <p>...this allows you to set or change the access level for this account.
1387 The access levels available are as follows: </p>
1390 <li>0 - Deleted. (This immediately deletes the account.) </li>
1391 <li>1 - New, unvalidated user </li>
1392 <li>2 - Problem user (severely restricts account - use for probationary
1394 <li>3 - User with no network privileges. Same access as a normal user
1395 except cannot post messages in rooms shared on a network. </li>
1396 <li>4 - Normal user </li>
1397 <li>5 - Preferred user (access is granted to privileged rooms) </li>
1398 <li>6 - Aide (administrative access to the whole system) </li>
1402 <pre>Permission to send/receive Internet mail [ No]? No<br></pre>
1404 <p>If your system is configured to only allow Internet mail privileges to
1405 certain users, this is where you can grant or revoke that privilege.</p>
1407 <pre>Ask user to register again [Yes]: Yes<br></pre>
1409 <p>If you answer Yes to this question, the user will be presented with a
1410 'registration' screen or set of prompts, the next time they log in using
1411 a Citadel client. This will prompt them for their full name, address, telephone
1414 <pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1416 <p>These statistics are available for informational purposes only, so there
1417 is normally no need to change them.</p>
1419 <pre>Set last call to now [No]: No<br>Purge time (in days, 0 for system default [0]: <br></pre>
1421 <p>Citadel contains an auto-purger which is capable of automatically deleting
1422 accounts which have not been accessed in a predefined period of time.
1423 If you choose to perform this operation, you can 'touch' the account of
1424 a wayward user by setting their 'last call' time to 'now'. You can also
1425 adjust, on a per-user basis, the amount of time which must pass before their
1426 account is purged by the system. This time is set in days. You can also
1427 specify 0 days to indicate that you wish to use the system default setting.</p>
1429 <h3><a name="Deleting_and_moving_messages"></a>Deleting and moving messages</h3>
1431 <p>Aides and Room Aides have the ability to delete and move messages. After
1432 each message, the normal prompt appears:</p>
1434 <pre>(8) <B>ack <A>gain <Q>uote <R>eply <N>ext <S>top m<Y> next <?>help -><br></pre>
1436 <p>Entering <tt><b>D</b>elete</tt> will delete the message. A <tt>(y/n)</tt>
1437 prompt will appear to confirm that you really want to delete the message.
1438 Entering <tt><b>M</b>ove</tt> will prompt for a room to which the message
1439 should be moved.</p>
1441 <h3><a name="Customizing_the_help_files"></a>Customizing the help files</h3>
1443 <p>The subdirectory called <tt>help</tt> contains your system's help files.
1444 There's nothing hard-coded into the system that dictates what files should
1445 be there. Whenever a user types the command <tt><b>.H</b>elp</tt> followed
1446 by the name of a help file, it displays the contents of that help file.</p>
1448 <p>The help files that come with the system, of course, are enough to guide
1449 a user through its operation. But you can add, change, or remove help
1450 files to suit whatever is appropriate for your system.</p>
1452 <p>There are several strings that you can put in help files that will be automatically
1453 substituted with other strings. They are:</p>
1455 <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>
1457 <p>So, for example, you could create a help file which looked like:</p>
1459 <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>
1461 <h3><a name="Site_configuration"></a>Site configuration</h3>
1463 <p>Once your Citadel server is up and running, the first thing you'll want
1464 to do is customize and tune it. This can be done from the text-based client
1465 with the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1466 command, or from WebCit (if you have it installed) by clicking 'Advanced
1467 Options' followed by 'Edit site-wide configuration.' Either method will
1468 offer the same configuration options. This document shows the text mode
1469 client being used.</p>
1471 <p>The first set of options deal with the identification of your system.</p>
1473 <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
1474 !="" more="" text="" on="" the="" next="" screen="">]: <br></jinkies></pre>
1476 <p>'Node name' refers to the short, unqualified node name by which your system
1477 is known on a Citadel network. Generally it will be the same as the unqualified
1478 host name of your computer; this is, in fact, the default setting.</p>
1480 <p>Then enter the fully-qualified domain name (FQDN) of your system. If you
1481 are not on the Internet, you can simply set it to the same as your unqualified
1482 host name. Otherwise you should set this value to the host name by which
1483 your system is most commonly known.</p>
1485 <p>The field called 'Human-readable node name' (also known as the 'node title'
1486 or 'organization name' in other software) is used solely for display purposes.
1487 Set it to the actual name of your system as you want it to appear in banners,
1490 <p>If you have a modem or bank of modems answering data calls for your system,
1491 enter it in the field marked 'Modem dialup number.' Otherwise you may leave
1494 <p>'Geographic location of this system' is another display field. Enter a
1495 city and state, or city and country. </p>
1497 <p>'Name of system administrator' is important! Any user who logs on with
1498 the name you enter here will automatically be granted Aide privileges. This
1499 is one of two ways for the system administrator to grant himself/herself
1500 Aide access to the system when initially setting it up. (The other is simply
1501 to have the first account created on a new installation.)</p>
1503 <p>The next set of options are your system's security settings. Before delving
1504 into the actual options, we should review the various access levels available
1505 on the system. Citadel has seven access levels:</p>
1508 <li>0 (Deleted). A user whose access level is set to 0 will automatically
1509 be deleted by the system. </li>
1510 <li>1 (New User). Users at this level may only read messages. Entering
1511 messages is prohibited, except in the <tt>Mail></tt> room, where a message
1512 to 'sysop' may be entered. </li>
1513 <li>2 (Problem User). Also known as 'Twit.' </li>
1514 <li>3 (Local User). May enter messages, except in rooms shared on a
1515 Citadel network. </li>
1516 <li>4 (Network User). May enter messages in every accessible room.
1518 <li>5 (Preferred User). Use of this level is up to the whim of the
1519 system administrator. </li>
1520 <li>6 (Aide). Access is granted to the administrative functions of
1521 the system. (This access level may also be granted to a user only for
1522 a specific room, please see 'Room Aide' for more information.) </li>
1526 <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>
1528 <p>'Registration' refers to the process of a user entering various personal
1529 contact information (real name, address, telephone number, etc.) into the
1530 system. When enabled, this information is stored as a vCard object on
1531 the system in two places: the user's <tt>My Citadel Config></tt> room,
1532 and in the <tt>Global Address Book></tt> room. (Note: the latter should
1533 be made private on publicly-accessible systems, for obvious reasons.)</p>
1535 <p>If you answer Yes to 'Require registration for new users' then each new
1536 user, upon creating a new account, will immediately be entered into the
1537 registration process. On the other hand, if you answer Yes to 'Disable self-service
1538 user account creation' then new users will not be able to log in at all --
1539 all accounts must be created by an Aide.</p>
1541 <p>'Initial access level for new users' should be set to 1 (New User) if you
1542 would like to review each new user's registration info before granting
1543 them higher access. This would be done periodically with the <tt><b>.A</b>ide
1544 <b>V</b>alidate new users</tt> command. If you do not require registration,
1545 you should set the initial access level to 4 (Network User).</p>
1547 <p>Given the above options, it then becomes clear that there are generally
1548 two ways you can set up your Citadel system, depending on its purpose:</p>
1551 <li><b>A public access BBS or message board</b> - since you do not know
1552 who might want to log in, self-service account creation needs to stay enabled.
1553 If you want to be strict about users identifying themselves, then you should
1554 also require users to register (just remember to post a privacy policy
1555 if you're going to collect personal information) -- then set the initial
1556 access level to 1 (New User), so new users cannot post messages until after
1557 you've validated them. For a more lax environment, you can remove the registration
1558 requirement and grant new accounts level 4 (Normal User) access on the first
1560 <li><b>A private email/groupware system for your organization</b> -
1561 in this case, disable self-service account creation; you don't want strangers
1562 welcoming themselves to your system. You'll probably also want to disable
1563 registration, because you or some other site administrator will be entering
1564 users' contact info when you create their accounts. Since this is also how
1565 you assign their Internet e-mail addresses, it's probably a good idea to
1566 do it yourself instead of expecting them to do it. </li>
1570 <p>'Access level required to create rooms' is up to you. You might wish to
1571 restrict the creation of new rooms only to Aides, or you might wish to allow
1572 anyone to create a room. The latter is one of the Citadel culture's most
1573 long-standing traditions; the former may be appropriate if users are abusing
1576 <p>You have the ability to 'Automatically give room aide privs to a user who
1577 creates a private room.' If you answer Yes, then any user who creates a
1578 guess-name, passworded, or invitation-only room will automatically become
1579 the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1580 command set while in that room. If you would rather grant this permission
1581 manually, answer No.</p>
1583 <p>Another tradition in the Citadel culture is to refrain from deleting
1584 problem users, but instead to 'twit' them (reduce their access level to 2
1585 [Problem User]). You can then 'Automatically move problem user messages
1586 to twit room' (answer Yes, then specify 'Name of twit room' and remember
1587 to create that room). If you employ this logic, any user with level 2 (Problem
1588 User) access will continue to have access to the same set of rooms, but all
1589 messages posted will automatically be routed to the Trashcan (or whatever
1590 you call your twit room).</p>
1592 <p>If you have Internet mail configured, you have the option of restricting
1593 its use on a user-by-user basis. If you wish to do this, answer Yes to 'Restrict
1594 Internet mail to only those with that privilege.' Obviously this makes no
1595 sense for an internal e-mail system, but for a public BBS it might be appropriate.</p>
1597 <p>Normally, Aides have access to every room, public or private, except for
1598 user mailboxes. They are also forbidden from <tt><b>Z</b>ap</tt>ping rooms,
1599 because the review of content is considered one of their roles. If you wish
1600 to change these policies, the next two options allow you to. You may 'Allow
1601 Aides to Zap (forget) rooms', in which case they may use the <tt><b>Z</b>ap</tt>
1602 command just like any other user. Furthermore, if you 'Allow system Aides
1603 access to user mailboxes', then they may <tt><b>.G</b>oto</tt> any private
1604 mailbox belonging to any user, using a special room name format.</p>
1606 <p>If your local security and/or privacy policy dictates that you keep a
1607 log of all pages (instant messages) that go through the system, then answer
1608 Yes to 'Log all pages'. If you answer Yes, you will be prompted for the
1609 name of a room to which all pages will be logged. If you answer No, then
1610 only the sender and recipient of each individual message will receive a copy.</p>
1612 <p>The next set of options deals with the tuning of your system. It is usually
1613 safe to leave these untouched.</p>
1615 <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>
1617 <p>The 'Server connection idle timeout' is for the connection between client
1618 and server software. It is <b>not</b> an idle timer for the user interface.
1619 900 seconds (15 minutes) is the default and a sane setting.</p>
1621 <p>'Maximum concurrent sessions' is the highest number of user sessions you
1622 wish to allow on your system at any given time. Citadel can scale to hundreds
1623 of concurrent users, but if you have limited hardware or (more likely) limited
1624 bandwidth, you might wish to set a maximum. You can also set it to zero
1627 <p>'Maximum message length' is just that. This could be a good way to prevent
1628 enormous multimedia files from finding their way into your message base.
1629 This maximum is enforced in all protocols and is also advertised by the ESMTP
1632 <p>The minimum and maximum number of worker threads can be tuned to your
1633 liking. Citadel will attempt to keep one worker thread running per session,
1634 within these constraints. You should be aware that due to the use of the
1635 worker thread model, Citadel can handle a large number of concurrent sessions
1636 with a much smaller thread pool. If you don't know the programming theory
1637 behind multithreaded servers, you should leave these parameters alone.</p>
1639 <p>The next set of options affect how Citadel behaves on a network.</p>
1641 <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>
1643 <p>'How often to run network jobs' refers to the sharing of content on a
1644 Citadel network. If your system is on a Citadel network, this configuration
1645 item dictates how often the Citadel server will contact other Citadel servers
1646 to send and receive messages. In reality, this will happen more frequently
1647 than you specify, because other Citadel servers will be contacting yours
1648 at regular intervals as well.</p>
1650 <p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP services.
1651 For a system being used primarily for Internet e-mail, these are essential,
1652 so you'll want to specify the standard port numbers: 25, 110, and 143. If
1653 Citadel is running alongside some other mail system, though, then you might
1654 want to choose other, unused port numbers, or enter -1 for any protocol to
1655 disable it entirely.</p>
1657 <p>The final set of options configures system-wide defaults for the auto-purger:</p>
1659 <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>
1661 <p>Any user who does not log in for the period specified in 'Default user
1662 purge time' will be deleted the next time a purge is run. This setting
1663 may be modified on a per-user basis.</p>
1665 <p>'Default room purge time' behaves the same way, and may also be modified
1666 on a per-room basis.</p>
1668 <p>'System default message expire policy' defines the way in which old messages
1669 are expired (purged) off the system. You can specify any of:</p>
1672 <li>Purge by age (specify in days) </li>
1673 <li>Purge by message count in the room (specify number of messages)
1675 <li>Do not purge at all </li>
1679 <p>Again, this setting may be overridden on a per-floor basis, and the floor
1680 setting may be overridden on a per-room basis.</p>
1682 <pre>Save this configuration? No<br></pre>
1684 <p>When you're done, enter 'Yes' to confirm the changes, or 'No' to discard
1688 <hr width="100%" size="2">
1689 <h2 align="center"><a name="Configuring_Citadel_for_Internet_e-mail"></a>Configuring
1690 Citadel for Internet e-mail</h2>
1692 <div align="justify">
1693 <h3><a name="Introduction"></a>Introduction</h3>
1694 As you know by now, Citadel is a completely self-contained, full-featured
1695 Internet e-mail system. When you run Citadel you do not need any other
1696 mail software on your host system. This eliminates the need for tedious
1697 mucking about with sendmail, qmail, postfix, Cyrus, the UW IMAP server, or
1698 any of countless other needlessly complex programs that lead some people to
1699 the false assumption that Unix systems are difficult to administer.<br>
1701 Some of the many features supported by Citadel are:<br>
1704 <li>Built-in SMTP and ESMTP service, for delivering and receiving e-mail
1705 on the Internet</li>
1706 <li>Built-in POP3 service, for remote fetching of messages</li>
1707 <li>Built-in IMAP service, for access to mail using any standard mail
1709 <li>Web mail (implemented using the "WebCit" middleware, which is installed
1711 <li>Support for mailing lists, in both "individual message" and "digest"
1713 <li>Multiple/virtual domain support</li>
1714 <li>Any user may have multiple Internet e-mail addresses, in multiple
1716 <li>Global address book (Users with addresses in a domain may be spread
1717 out across many servers on a Citadel network)</li>
1718 <li>Easy-to-configure integration with <a
1719 href="http://www.spamassassin.org/">SpamAssassin</a> can block spam <i>before</i>
1720 it enters the mail system</li>
1723 This section of the documentation will demonstrate how to configure these
1727 <h3><a name="Basic_site_configuration"></a>Basic site configuration</h3>
1729 <p>Basic configuration of your Citadel system for Internet e-mail begins with
1730 the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>I</b>nternet</tt> command:</p>
1732 <pre>Lobby> <b>.A</b>ide <b>S</b>ystem configuration <b>I</b>nternet<br><br>### Host or domain Record type<br>--- -------------------------------------------------- --------------------<br> 1<br><A>dd <D>elete <S>ave <Q>uit -><br></pre>
1734 <p>This is a "clean" setup. For a simple, standalone e-mail system you simply
1735 have to enter the <tt><b>A</b>dd</tt> command:</p>
1737 <pre><A>dd <D>elete <S>ave <Q>uit -> <b>A</b>dd<br><br>Enter host name: schmeep.splorph.com<br> (1) localhost (Alias for this computer)<br> (2) gateway domain (Domain for all Citadel systems)<br> (3) smart-host (Forward all outbound mail to this host)<br> (4) directory (Consult the Global Address Book)<br> (5) SpamAssassin (Address of SpamAssassin server)<br><br>Which one [1]:<br></pre>
1739 <p><b>localhost:</b> Basically what you're doing here is telling Citadel
1740 what any aliases for your machine are. If your machine were <tt>schmeep.splorph.com</tt>
1741 and you also had a DNS entry set up for <tt>blah.com</tt>, you might want
1742 to enter '1' and enter <tt>blah.com</tt> as your alias, so that e-mail sent
1743 to that address won't bounce.</p>
1745 <p><i>Important tip:</i> if your system is known by one name and <i>only</i>
1746 one domain, you might not even need to do this at all. You will recall that
1747 you entered your system's fully qualified domain name earlier when you went
1748 through the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1749 command. The domain name you entered there is automatically considered by
1750 Citadel to be a 'localhost' entry in your Internet mail configuration. It
1751 does not hurt to enter it in both locations, though.</p>
1753 <p><b>gateway domain:</b> this is a simple way of mapping various Citadel
1754 hosts in an Internet domain. For example, if you enter <tt>bar.com</tt> as
1755 a gateway domain, then mail to users at <tt>foo.bar.com</tt> will be forwarded
1756 to the host called <tt>foo</tt> on a Citadel network, mail to users at <tt>kunst.bar.com</tt>
1757 will be delivered to the Citadel server called <tt>kunst</tt>, etc. This
1758 feature has limited usefulness; if you are operating a network of Citadel
1759 servers, it is more likely that you will use the 'directory' feature, explained
1762 <p><b>smart-host:</b> Normally, Citadel sends outbound Internet e-mail directly
1763 to its destination. This may not be appropriate for some sites; you may
1764 require (due to local convention, security policy, or whatever) that all outbound
1765 mail be sent to an SMTP relay or forwarder. To configure this functionality,
1766 simply enter the domain name or IP address of your relay as a 'smart-host'
1769 <p><b>directory:</b> a domain for which you are participating in directory
1770 services across any number of Citadel nodes. For example, if users who have
1771 addresses in the domain <tt>citadel.org</tt> are spread out across multiple
1772 Citadel servers on your network, then enter <tt>citadel.org</tt> as a 'directory'
1773 entry. <i>For this to work, all Citadel servers participating in directory
1774 service <b>must</b> carry and share the <tt>Global Address Book></tt>
1777 <p><b>spamassassin:</b> if you are running a <a
1778 href="http://www.spamassassin.org">SpamAssassin</a> service anywhere on your
1779 <b>local</b> network, enter its name or IP address as a 'spamassassin' entry.
1780 This may be (and, in fact, will usually be) <tt>127.0.0.1</tt> to specify
1781 that the service is running on the same host computer as the Citadel server.</p>
1783 <p>Please install SpamAssassin as per its own documentation. You will want
1784 to run SpamAssassin in client/server mode, where a <tt>spamd</tt> daemon
1785 is always running on your computer. Citadel does not utilize the <tt>spamc</tt>
1786 client; instead, it implements SpamAssassin's protocol on its own.</p>
1788 <p>Connecting to a SpamAssassin service across a wide area network is strongly
1789 discouraged. In order to determine whether an incoming e-mail is spam, Citadel
1790 must feed the <i>entire message</i> to the SpamAssassin service. Doing this
1791 over a wide area network would consume time and bandwidth, which would affect
1794 <p>Citadel invokes the SpamAssassin service when incoming messages are arriving
1795 via SMTP. Before a message is accepted, it is submitted to SpamAssassin.
1796 If SpamAssassin determines that the message is spam, the Citadel SMTP service
1797 <i>rejects the message,</i> causing a delivery failure on the sending host.
1798 This is superior to software which files away spam in a separate folder,
1799 because delivery failures will cause some spammers to assume the address
1800 is invalid and remove it from their mailing lists.</p>
1802 <p>Now select <tt><b>S</b>ave</tt> and you are just about ready for Internet
1805 <h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the Internet
1808 <p>As previously mentioned, Citadel contains its own SMTP, POP3, and IMAP
1809 services. Enabling them is simple.</p>
1811 <p>Check for the existance of a current MTA (sendmail, qmail, etc.) by connecting
1812 to port 25 on your host. If you see something similar to the following you're
1813 running an MTA already and you'll need to shut it down:</p>
1815 <pre>smw @ pixel % telnet localhost 25<br>Trying 127.0.0.1...<br>Connected to localhost.<br>Escape character is '^]'.<br>220 pixel.citadel.org ESMTP Sendmail 8.9.3/8.9.3; Wed, 15 Mar 2000 19:00:53 -0500<br></pre>
1817 <p>In the above example, we see that the host already has Sendmail listening
1818 on port 25. Before Citadel can use port 25, Sendmail must be shut off. Please
1819 consult the documentation for your operating system for instructions on how
1820 to do this. (On a Red Hat Linux system, for example, you can run the <tt>ntsysv</tt>
1821 utility, un-checking <tt>sendmail</tt> to disable it at the next reboot;
1822 then, run <tt>service sendmail stop</tt> to shut off the currently running
1825 <p>If you get a 'connection refused' message when you telnet to port 25 there's
1826 nothing running and you should be able to continue. You might also want
1827 to turn off POP (try the above test substituting 110 for 25) and IMAP (port
1828 143) and use Citadel's POP and IMAP services.</p>
1830 <p>Citadel will look for an existing pop/smtp server on startup. If they
1831 don't exist (and you've configured them properly) then Citadel should enable
1832 them at startup. You can check your logs to be sure, or you can start the
1833 server from a shell and watch it load. It might look something like this:</p>
1835 <pre>smw @ pixel % ./citserver<br><br>Multithreaded message server for Citadel/UX<br>Copyright (C) 1987-2000 by the Citadel/UX development team.<br>Citadel/UX is open source, covered by the GNU General Public License, and<br>you are welcome to change it and/or distribute copies of it under certain<br>conditions. There is absolutely no warranty for this software. Please<br>read the 'COPYING.txt' file for details.<br><br>Loading citadel.config<br>Opening databases<br>This is GDBM version 1.8.0, as of May 19, 1999.<br>Checking floor reference counts<br>Creating base rooms (if necessary)<br>Registered a new service (TCP port 504)<br>Registered a new service (TCP port 0)<br>Initializing loadable modules<br>Registered server command CHAT (Begin real-time chat)<br>Registered server command PEXP (Poll for express messages)<br>Registered server command GEXP (Get express messages)<br>Registered server command SEXP (Send an express message)<br>Registered server command DEXP (Disable express messages)<br>Registered a new session function (type 0)<br>Registered a new x-msg function (priority 0)<br>Loaded module: $Id$<br>Registered a new session function (type 1)<br>Registered a new message function (type 201)<br>Registered a new message function (type 202)<br>Registered server command REGI (Enter registration info)<br>Registered server command GREG (Get registration info)<br>Registered a new user function (type 100)<br>Loaded module: $Id$<br>Server-hosted upgrade level is 5.62<br>Loaded module: $Id$<br>Registered server command EXPI (Expire old system objects)<br>Registered server command FSCK (Check message ref counts)<br>Loaded module: $Id$<br><b>citserver: Can't bind: Address already in use<br>ERROR: could not bind to TCP port 25.</b>
1836 Registered a new service (TCP port 0)
1837 Registered a new session function (type 50)
1839 <b>citserver: Can't bind: Address already in use<br>ERROR: could not bind to TCP port 110.</b>
1840 Registered a new session function (type 0)
1842 Registered a new message function (type 202)Loaded module: $Id:
1843 serv_inetcfg.c,v 1.2 2000/02/03 03:57:35 ajc Exp $
1844 Registered server command RWHO (Display who is online)
1845 Registered server command HCHG (Masquerade hostname)
1846 Registered server command RCHG (Masquerade roomname)
1847 Registered server command UCHG (Masquerade username)
1848 Registered server command STEL (Enter/exit stealth mode)
1851 Starting housekeeper thread
1854 <p>The lines emphasized in boldface in the above log output tell you that
1855 Citadel "can't bind" to various ports. The error 'address already in use'
1856 generally means that something else is already running on the requested port.
1857 Make SURE you've followed the above steps to remove sendmail/pop and start
1858 your Citadel server again.</p>
1860 <h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
1862 <p>Occationally it is not practical to remove a non-Citadel MTA on your host
1863 system. For example, you might have multiple groups of users, some of which
1864 are using Citadel and some of which are using a legacy Unix mail spool. This
1865 type of configuration is discouraged, but a tool is provided to allow it.</p>
1867 <p>The tool is called <tt>citmail</tt> and it is, quite simply, a local MDA
1868 (Mail Delivery Agent) which you can configure into your MTA for final delivery
1869 of incoming messages to Citadel users. A full discussion of the finer points
1870 of complex Sendmail configurations is beyond the scope of this document;
1871 however, you might want to visit <a
1872 href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some useful
1873 HOWTO documents are provided.</p>
1875 <p>For outbound mail, you can either allow Citadel to perform deliveries directly
1876 (this won't affect your other mail system because outbound mail doesn't tie
1877 up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which will tell
1878 Citadel to forward all of its outbound mail to your other mail system.</p>
1880 <h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet mailing
1882 FIXME It's fun. Try it.
1883 <hr width="100%" size="2">
1885 <h2><a name="Building_or_joining_a_Citadel_network"></a>Building or joining
1886 a Citadel network</h2>
1889 <h3><a name="Overview__"></a>Overview</h3>
1891 <p>If you are running Citadel as a BBS or other forum type of application,
1892 one way to 'keep the conversation going' is to share rooms with other Citadel
1893 systems. In a shared room, a message posted to the room is automatically
1894 propagated to every system on the network. It's kind of like a UseNet newsgroup,
1895 but without the spam.</p>
1897 <p>If you are using Citadel as the e-mail and groupware platform for a large
1898 organization, you can use its networking features to build a large network
1899 of Citadel servers which share content (think of rooms as public folders),
1900 redistribute e-mail throughout the organization, and integrate the global
1901 address book. It might make sense, for example, in a large corporation
1902 to give each department or location its own Citadel server. Thanks
1903 to Citadel's global address book features, you could still have all of the
1904 users share a single e-mail domain.</p>
1906 <p>Obviously, the first thing you have to do is find another Citadel to share
1907 rooms with, and make arrangements with them. The following Citadels are
1908 a good place to start:</p>
1911 <li>UNCENSORED! - <a href="http://uncensored.citadel.org">uncensored.citadel.org</a>
1913 <li>The Dog Pound II - <a href="http://dogpound2.citadel.org">dogpound2.citadel.org</a>
1915 <li>PixelBBS - <a href="http://pixel.citadel.org">pixel.citadel.org</a>
1919 <p>You don't have to be a part of the citadel.org domain to participate in
1920 the public Citadel network, but the DNS service is provided free of charge
1921 by the Citadel community if you wish to do this.</p>
1923 <h3><a name="Conventions_and_etiquette_when"></a>Conventions and etiquette
1924 when connecting to the public Citadel network</h3>
1926 <p>Before we get into the technical nitty gritty, there are two points of
1927 etiquette to keep in mind. The first thing to keep in mind is that the operator
1928 of any particular Citadel may not be willing to share some of his/her rooms.
1929 Some sites are proud to offer exclusive content in certain areas. Chances
1930 are, if a room is already being shared on the network, it's available for
1931 anyone to share; if not, it can't hurt to ask -- but take care not to demand
1932 it of them. Ask if you may share the room instead of telling them that you
1933 wish to share the room. When looking at a <tt><b>K</b></tt>nown rooms list,
1934 network rooms are the ones ending in parentheses instead of angle brackets.
1935 For example, <tt>Gateway)</tt> would be a network room, <tt>Lobby></tt>
1938 <p>The other point of etiquette to remember is that you should be making
1939 the arrangements in advance, and then set it up. It is extremely rude to
1940 simply begin networking with another Citadel, or unilaterally start sharing
1941 a new room, without first obtaining permission from its operator. Always
1942 ask first. Most Citadel operators are more than happy to network with you.
1943 Also, if later on you decide to take your system down, please take the time
1944 to notify the operators of any other Citadels you network with, so they can
1945 unconfigure their end.</p>
1947 <h3><a name="Getting_ready_to_join_the_network"></a>Getting ready to join
1950 <p>Ok, first things first. On a Citadel room sharing network, the first
1951 thing you need to know is your own system's node name. Presumably you set
1952 this up during installation, but if you want to change it you can do so using
1953 the <tt><b>.A</b>ide <b>S</b>ysconfig <b>G</b>eneral</tt> command:</p>
1955 <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></pre>
1957 <p>The "node name" is important, it's how the network identifies messages
1958 coming from your system. The "human readable node name" is simply a label;
1959 it shows up in messages coming from your system. "Fully qualified domain
1960 name" is your DNS name; it's used for routing messages on the Internet. In
1961 the above example, the node name is "uncnsrd".</p>
1963 <h3><a name="Defining_neighbor_nodes"></a>Defining neighbor nodes</h3>
1965 <p>The next thing you need to do is configure your neighbor node(s). You
1966 need to do this for each node you network with. Let's say you wanted to
1967 talk to a Citadel system called "frobozz". Use the <tt><b>.A</b>ide <b>S</b>ysconfig
1968 <b>N</b>etwork</tt> command:</p>
1970 <pre>Lobby> . Aide System configuration Network<br>### Node Secret Host or IP Port#<br>--- ---------------- ---------------- -------------------------------- -----<br><A>dd <D>elete <S>ave <Q>uit -> Add<br><br>Enter node name : frobozz<br>Enter shared secret: frotz<br>Enter host or IP : frobozz.magick.org<br>Enter port number : [504]: 504<br><br>### Node Secret Host or IP Port#<br>--- ---------------- ---------------- -------------------------------- -----<br> 1 frobozz frotz frobozz.magick.org 504<br><A>dd <D>elete <S>ave <Q>uit -> Save<br><br>Lobby><br></pre>
1972 <p>As you can see in the above example, you have to enter the Citadel node
1973 name, the DNS name or IP address of the server, and the port number the Citadel
1974 service is running on. The "shared secret" is a password to allow the two
1975 Citadel nodes to connect to each other to exchange network data. The password
1976 must be <i>identical</i> on both ends of the connection -- when the operator
1977 of the other Citadel node sets up the connection with your system, he/she
1978 must use the same password.</p>
1980 <h3><a name="Sharing_rooms"></a>Sharing rooms</h3>
1982 <p>Now you're ready to share rooms. You have to do this for each room you
1983 want to share, and you have to do it from BOTH ENDS -- again, when you share
1984 a room with another Citadel, they must share it with you as well. Let's
1985 say you have a room called "Quiche Recipes>" and you want to share it
1986 with the node you set up above. First, edit the room and flag it as a network
1989 <pre>Quiche Recipes> . Aide Edit this room<br>Room name [Quiche Recipes]:<br>Private room [No]: No<br>Preferred users only [No]: No<br>Read-only room [No]: No<br>Directory room [No]: No<br>Permanent room [No]: No<br>Network shared room [No]: Yes<br>Automatically make all messages anonymous [No]: No<br>Ask users whether to make messages anonymous [No]: No<br>Listing order [64]:<br>Room aide (or 'none') [none]:<br>Message expire policy (? for list) [0]:<br>Save changes (y/n)? Yes<br>Ok<br><br>Quiche Recipes)<br></pre>
1991 <p>Notice how the prompt changed? It was > before, but it's ) now. That
1992 means it's a network room. Now you can tell Citadel that you want to share
1993 the room with frobozz. Enter this command:</p>
1995 <pre>Quiche Recipes) . Aide Network room sharing<br></pre>
1997 <p>Your text editor will pop up (you <i>did</i> configure Citadel to use
1998 your favorite text editor, right?) with a screen that looks like this:</p>
2000 <pre># Configuration for room: Quiche Recipes<br># Nodes with which we share this room<br># Specify one per line.<br></pre>
2002 <p>All you have to do is enter the name of the other Citadel node (i.e. "frobozz"
2003 in our example) on a line by itself. As usual, lines starting with a "#"
2004 are comments. Just go to the end of the file, type "frobozz" (without the
2005 quotes), save the file... and you're done!</p>
2007 <p>At this point, you just sit back and enjoy. Your Citadel and the other
2008 one will begin polling each other at regular intervals (once per hour by
2009 default) and sharing messages.</p>
2011 <h3><a name="Sending_mail"></a>Sending mail</h3>
2013 <p>You can send mail to any user on any node of your Citadel network. It
2014 may take a little while for your system to learn the entire node list, though,
2015 as this is done by watching incoming messages on the network and learning
2016 which nodes are out there.</p>
2018 <p>To send a private message, just enter <tt>user @ host</tt> as the recipient:</p>
2020 <pre>Mail> Enter message <br>Enter recipient: Some other user @ frobozz<br> Feb 11 2003 11:36pm from I. M. Me to Some other user @ frobozz<br>type message here...<br><br>Entry command (? for options) -><br></pre>
2022 <h3><a name="Changing_the_polling_interval"></a>Changing the polling interval</h3>
2024 <p>As previously mentioned, Citadel will poll other Citadel nodes for messages
2025 once per hour. If this is not an acceptable interval, you can change it using
2026 the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt> command.
2027 Enter this command and look for the option:</p>
2029 <pre>How often to run network jobs (in seconds) [3600]:<br></pre>
2031 <p>Change it to whatever you like. For example, 15 minutes is 900 seconds.
2032 So if you changed the default value to 900, network polling would occur
2033 every 15 minutes.</p>
projects / citadel.git / blob