1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <title>Citadel/UX Documentation</title>
7 <meta http-equiv="content-type"
8 content="text/html; charset=ISO-8859-1">
15 <h2>a messaging and collaboration platform for BBS and groupware applications</h2>
16 Copyright ©1987-2003 by the Citadel development team:<br>
19 <table cellpadding="2" cellspacing="2" border="0" align="center">
22 <td valign="top">Steven M. Bellovin<br>
24 <td valign="top"><i>author of public domain 'parsedate'
29 <td valign="top">Nathan Bryant<br>
31 <td valign="top"><i>build system, security, database
32 access, and others<br>
36 <td valign="top">Art Cancro<br>
38 <td valign="top"><i>overall system design and lead developer<br>
42 <td valign="top">Brian Costello<br>
44 <td valign="top"><i>cosmetics, additional commands<br>
48 <td valign="top">Nick Georbit<br>
50 <td valign="top"><i>additional client features<br>
54 <td valign="top">Michael Hampton<br>
56 <td valign="top"><i>client software development<br>
60 <td valign="top">Andru Luvisi<br>
62 <td valign="top"><i>troubleshooting and development assistance<br>
66 <td valign="top">Daniel Malament<br>
68 <td valign="top"><i>string compare function for IMAP
73 <td valign="top">Stu Mark<br>
75 <td valign="top"><i>additional client features, IGnet
80 <td valign="top">Ben Mehlman<br>
82 <td valign="top"><i>additional client features<br>
86 <td valign="top">Ari Samson<br>
88 <td valign="top"><i>assistance with project management<br>
92 <td valign="top">John Walker<br>
94 <td valign="top"><i>author of public domain base64 encoder/decoder<br>
98 <td valign="top">Steve Williams<br>
100 <td valign="top"><i>documentation<br>
104 <td valign="top">Ethan Young<br>
106 <td valign="top"><i>IGnet protocol design<br>
115 <div align="justify">The entire package is open source; you can redistribute
116 and/or modify it under the terms of the GNU General Public License
117 as published by the Free Software Foundation; either version 2 of the
118 License, or (at your option) any later version.<br>
120 This program is distributed in the hope that it will be useful,
121 but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
122 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
123 License for more details. </div>
125 <div align="justify"><br>
126 For more information, visit either of these locations on the
130 <li>The Citadel home page: <a
131 href="http://www.citadel.org">http://www.citadel.org</a></li>
132 <li>UNCENSORED! BBS, the home of Citadel: <a
133 href="http://uncensored.citadel.org">http://uncensored.citadel.org</a></li>
137 <hr width="100%" size="2">
138 <h2 align="center">Table of Contents</h2>
141 <li><a href="#GPL">License</a></li>
142 <li><a href="#Installation">Installation</a></li>
145 <li><a href="#Everything_in_its_place...">Everything in its place...</a></li>
146 <li><a href="#The_BBS_Login">The BBS Login</a></li>
147 <li><a href="#Bypassing_the_login:_prompt">Bypassing the login:
149 <li><a href="#Compiling_the_programs">Compiling the programs</a></li>
150 <li><a href="#Upgrading">Upgrading</a></li>
151 <li><a href="#The_citadel.rc_file">The citadel.rc file</a></li>
152 <li><a href="#Using_an_external_editor_for_message">Using an external
153 editor for message composition</a></li>
154 <li><a href="#Printing_messages">Printing messages</a></li>
155 <li><a href="#URL_viewing">URL viewing</a></li>
156 <li><a href="#Setup_and_login">Setup and login</a></li>
157 <li><a href="#Configuring_your_host_system_to_start">Configuring
158 your host system to start the service</a></li>
159 <li><a href="#Logging_in_for_the_first_time">Logging in for the
161 <li><a href="#Welcoming_new_users">Welcoming new users</a></li>
162 <li><a href="#Space_for_adding_your_own_client">Space for adding
163 your own client features (doors)</a></li>
164 <li><a href="#Troubleshooting_and_getting_help">Troubleshooting
165 and getting help</a><br>
169 <li><a href="#sysop">System Administration</a></li>
172 <li><a href="#Overview_">Overview</a></li>
173 <li><a href="#Aide_commands">Aide commands</a></li>
174 <li><a href="#Editing_rooms">Editing rooms</a></li>
175 <li><a href="#File_directories">File directories</a></li>
176 <li><a href="#Creating_and_editing_user_accounts">Creating and
177 editing user accounts</a></li>
178 <li><a href="#Deleting_and_moving_messages">Deleting and moving
180 <li><a href="#Customizing_the_help_files">Customizing the help
182 <li><a href="#Site_configuration">Site configuration</a><br>
186 <li> <a href="#Configuring_Citadel_for_Internet_e-mail">Configuring
187 Citadel for Internet e-mail</a></li>
190 <li><a href="#Introduction">Introduction</a></li>
191 <li><a href="#Basic_site_configuration">Basic site configuration</a></li>
192 <li><a href="#Enabling_the_Internet_mail_protocols">Enabling the
193 Internet mail protocols</a></li>
194 <li><a href="#Hosting_an_Internet_mailing_list">Hosting an Internet
197 <li><a href="#citmail">Using Citadel in conjunction with another
201 <li><a href="#Building_or_joining_a_Citadel_network">Building or joining
202 a Citadel network</a></li>
205 <li><a href="#Overview__">Overview</a></li>
206 <li><a href="#Conventions_and_etiquette_when">Conventions and etiquette
207 when connecting to the public Citadel network</a></li>
208 <li><a href="#Getting_ready_to_join_the_network">Getting ready to
209 join the network</a></li>
210 <li><a href="#Defining_neighbor_nodes">Defining neighbor nodes</a></li>
211 <li><a href="#Sharing_rooms">Sharing rooms</a></li>
212 <li><a href="#Sending_mail">Sending mail</a></li>
213 <li><a href="#Changing_the_polling_interval">Changing the polling
217 <li><a href="#Database_maintenance">Database maintenance</a></li>
220 <li><a href="#Introduction_">Introduction</a></li>
221 <li><a href="#Database_repair">Database repair</a></li>
222 <li><a href="#ImportingExporting_your_Citadel">Importing/Exporting
223 your Citadel database</a><br>
227 <li><a href="#utilities">Included utilities</a></li>
229 <LI><A HREF="#overview">Overview</a></LI>
230 <LI><A HREF="#aidepost">aidepost</a></LI>
231 <LI><A HREF="#whobbs">whobbs</a></LI>
232 <LI><A HREF="#stats">stats</a></LI>
233 <LI><A HREF="#msgform">msgform</a></LI>
234 <LI><A HREF="#userlist">userlist</a></LI>
235 <LI><A HREF="#readlog">readlog</a></LI>
236 <LI><A HREF="#sendcommand">sendcommand</a></LI>
242 <hr width="100%" size="2"><br>
244 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
248 <p> Version 2, June 1991 </p>
250 <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>
252 <h3 align="justify">Preamble</h3>
254 <div align="justify"> </div>
256 <p align="justify"> The licenses for most software are designed to take
257 away your freedom to share and change it. By contrast, the GNU General
258 Public License is intended to guarantee your freedom to share and change
259 free software--to make sure the software is free for all its users.
260 This General Public License applies to most of the Free Software Foundation's
261 software and to any other program whose authors commit to using it.
262 (Some other Free Software Foundation software is covered by the GNU Library
263 General Public License instead.) You can apply it to your programs, too.
266 <div align="justify"> </div>
268 <p align="justify"> When we speak of free software, we are referring to
269 freedom, not price. Our General Public Licenses are designed to make
270 sure that you have the freedom to distribute copies of free software
271 (and charge for this service if you wish), that you receive source code
272 or can get it if you want it, that you can change the software or use pieces
273 of it in new free programs; and that you know you can do these things. </p>
275 <div align="justify"> </div>
277 <p align="justify"> To protect your rights, we need to make restrictions
278 that forbid anyone to deny you these rights or to ask you to surrender
279 the rights. These restrictions translate to certain responsibilities
280 for you if you distribute copies of the software, or if you modify it.
283 <div align="justify"> </div>
285 <p align="justify"> For example, if you distribute copies of such a program,
286 whether gratis or for a fee, you must give the recipients all the rights
287 that you have. You must make sure that they, too, receive or can get
288 the source code. And you must show them these terms so they know their
291 <div align="justify"> </div>
293 <p align="justify"> We protect your rights with two steps: (1) copyright
294 the software, and (2) offer you this license which gives you legal permission
295 to copy, distribute and/or modify the software. </p>
297 <div align="justify"> </div>
299 <p align="justify"> Also, for each author's protection and ours, we want
300 to make certain that everyone understands that there is no warranty
301 for this free software. If the software is modified by someone else and
302 passed on, we want its recipients to know that what they have is not
303 the original, so that any problems introduced by others will not reflect
304 on the original authors' reputations. </p>
306 <div align="justify"> </div>
308 <p align="justify"> Finally, any free program is threatened constantly by
309 software patents. We wish to avoid the danger that redistributors of a free
310 program will individually obtain patent licenses, in effect making the program
311 proprietary. To prevent this, we have made it clear that any patent must
312 be licensed for everyone's free use or not licensed at all. </p>
314 <div align="justify"> </div>
316 <p align="justify"> The precise terms and conditions for copying, distribution
317 and modification follow. </p>
319 <div align="justify"> </div>
321 <h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
323 <div align="justify"> </div>
325 <p align="justify"> <strong>0.</strong> This License applies to any program
326 or other work which contains a notice placed by the copyright holder
327 saying it may be distributed under the terms of this General Public License.
328 The "Program", below, refers to any such program or work, and a "work
329 based on the Program" means either the Program or any derivative work
330 under copyright law: that is to say, a work containing the Program or
331 a portion of it, either verbatim or with modifications and/or translated
332 into another language. (Hereinafter, translation is included without limitation
333 in the term "modification".) Each licensee is addressed as "you". </p>
335 <p align="justify"> Activities other than copying, distribution and modification
336 are not covered by this License; they are outside its scope. The act
337 of running the Program is not restricted, and the output from the Program
338 is covered only if its contents constitute a work based on the Program
339 (independent of having been made by running the Program). Whether that
340 is true depends on what the Program does. </p>
342 <p align="justify"> <strong>1.</strong> You may copy and distribute verbatim
343 copies of the Program's source code as you receive it, in any medium,
344 provided that you conspicuously and appropriately publish on each copy
345 an appropriate copyright notice and disclaimer of warranty; keep intact
346 all the notices that refer to this License and to the absence of any
347 warranty; and give any other recipients of the Program a copy of this License
348 along with the Program. </p>
350 <p align="justify"> You may charge a fee for the physical act of transferring
351 a copy, and you may at your option offer warranty protection in exchange
354 <p align="justify"> <strong>2.</strong> You may modify your copy or copies
355 of the Program or any portion of it, thus forming a work based on the
356 Program, and copy and distribute such modifications or work under the
357 terms of Section 1 above, provided that you also meet all of these conditions:
360 <p align="justify"> </p>
362 <div align="justify">
364 <li><strong>a)</strong> You must cause the modified files
365 to carry prominent notices stating that you changed the files and
366 the date of any change.
370 <li><strong>b)</strong> You must cause any work that
371 you distribute or publish, that in whole or in part contains or
372 is derived from the Program or any part thereof, to be licensed
373 as a whole at no charge to all third parties under the terms of this
378 <li><strong>c)</strong> If the modified program normally
379 reads commands interactively when run, you must cause it, when
380 started running for such interactive use in the most ordinary way,
381 to print or display an announcement including an appropriate copyright
382 notice and a notice that there is no warranty (or else, saying that
383 you provide a warranty) and that users may redistribute the program
384 under these conditions, and telling the user how to view a copy of
385 this License. (Exception: if the Program itself is interactive but
386 does not normally print such an announcement, your work based on
387 the Program is not required to print an announcement.) </li>
390 These requirements apply to the modified work as a whole.
391 If identifiable sections of that work are not derived from the Program,
392 and can be reasonably considered independent and separate works in themselves,
393 then this License, and its terms, do not apply to those sections when
394 you distribute them as separate works. But when you distribute the
395 same sections as part of a whole which is a work based on the Program,
396 the distribution of the whole must be on the terms of this License, whose
397 permissions for other licensees extend to the entire whole, and thus
398 to each and every part regardless of who wrote it. </div>
400 <p align="justify"> Thus, it is not the intent of this section to claim rights
401 or contest your rights to work written entirely by you; rather, the intent
402 is to exercise the right to control the distribution of derivative or collective
403 works based on the Program. </p>
405 <p align="justify"> In addition, mere aggregation of another work not based
406 on the Program with the Program (or with a work based on the Program)
407 on a volume of a storage or distribution medium does not bring the other
408 work under the scope of this License. </p>
410 <p align="justify"> <strong>3.</strong> You may copy and distribute the
411 Program (or a work based on it, under Section 2) in object code or executable
412 form under the terms of Sections 1 and 2 above provided that you also
413 do one of the following: <!-- we use this doubled UL to get the sub-sections indented, -->
414 <!-- while making the bullets as unobvious as possible. --> </p>
416 <div align="justify">
418 <li><strong>a)</strong> Accompany it with the complete
419 corresponding machine-readable source code, which must be distributed
420 under the terms of Sections 1 and 2 above on a medium customarily
421 used for software interchange; or,
425 <li><strong>b)</strong> Accompany it with a written offer,
426 valid for at least three years, to give any third party, for a
427 charge no more than your cost of physically performing source distribution,
428 a complete machine-readable copy of the corresponding source code,
429 to be distributed under the terms of Sections 1 and 2 above on a
430 medium customarily used for software interchange; or,
434 <li><strong>c)</strong> Accompany it with the information
435 you received as to the offer to distribute corresponding source
436 code. (This alternative is allowed only for noncommercial distribution
437 and only if you received the program in object code or executable
438 form with such an offer, in accord with Subsection b above.) </li>
441 The source code for a work means the preferred form of the
442 work for making modifications to it. For an executable work, complete
443 source code means all the source code for all modules it contains, plus
444 any associated interface definition files, plus the scripts used to control
445 compilation and installation of the executable. However, as a special
446 exception, the source code distributed need not include anything that
447 is normally distributed (in either source or binary form) with the major
448 components (compiler, kernel, and so on) of the operating system on which
449 the executable runs, unless that component itself accompanies the executable.
452 <p align="justify"> If distribution of executable or object code is made
453 by offering access to copy from a designated place, then offering equivalent
454 access to copy the source code from the same place counts as distribution
455 of the source code, even though third parties are not compelled to copy
456 the source along with the object code. </p>
458 <p align="justify"> <strong>4.</strong> You may not copy, modify, sublicense,
459 or distribute the Program except as expressly provided under this License.
460 Any attempt otherwise to copy, modify, sublicense or distribute the
461 Program is void, and will automatically terminate your rights under this
462 License. However, parties who have received copies, or rights, from
463 you under this License will not have their licenses terminated so long
464 as such parties remain in full compliance. </p>
466 <p align="justify"> <strong>5.</strong> You are not required to accept
467 this License, since you have not signed it. However, nothing else grants
468 you permission to modify or distribute the Program or its derivative
469 works. These actions are prohibited by law if you do not accept this
470 License. Therefore, by modifying or distributing the Program (or any work
471 based on the Program), you indicate your acceptance of this License to
472 do so, and all its terms and conditions for copying, distributing or modifying
473 the Program or works based on it. </p>
475 <p align="justify"> <strong>6.</strong> Each time you redistribute the Program
476 (or any work based on the Program), the recipient automatically receives a
477 license from the original licensor to copy, distribute or modify the Program
478 subject to these terms and conditions. You may not impose any further
479 restrictions on the recipients' exercise of the rights granted herein.
480 You are not responsible for enforcing compliance by third parties to this
483 <p align="justify"> <strong>7.</strong> If, as a consequence of a court
484 judgment or allegation of patent infringement or for any other reason
485 (not limited to patent issues), conditions are imposed on you (whether
486 by court order, agreement or otherwise) that contradict the conditions
487 of this License, they do not excuse you from the conditions of this License.
488 If you cannot distribute so as to satisfy simultaneously your obligations
489 under this License and any other pertinent obligations, then as a consequence
490 you may not distribute the Program at all. For example, if a patent
491 license would not permit royalty-free redistribution of the Program by
492 all those who receive copies directly or indirectly through you, then
493 the only way you could satisfy both it and this License would be to refrain
494 entirely from distribution of the Program. </p>
496 <p align="justify"> If any portion of this section is held invalid or unenforceable
497 under any particular circumstance, the balance of the section is intended
498 to apply and the section as a whole is intended to apply in other circumstances.
501 <p align="justify"> It is not the purpose of this section to induce you to
502 infringe any patents or other property right claims or to contest validity
503 of any such claims; this section has the sole purpose of protecting
504 the integrity of the free software distribution system, which is implemented
505 by public license practices. Many people have made generous contributions
506 to the wide range of software distributed through that system in reliance
507 on consistent application of that system; it is up to the author/donor
508 to decide if he or she is willing to distribute software through any other
509 system and a licensee cannot impose that choice. </p>
511 <p align="justify"> This section is intended to make thoroughly clear what
512 is believed to be a consequence of the rest of this License. </p>
514 <p align="justify"> <strong>8.</strong> If the distribution and/or use of
515 the Program is restricted in certain countries either by patents or by copyrighted
516 interfaces, the original copyright holder who places the Program under this
517 License may add an explicit geographical distribution limitation excluding
518 those countries, so that distribution is permitted only in or among countries
519 not thus excluded. In such case, this License incorporates the limitation
520 as if written in the body of this License. </p>
522 <p align="justify"> <strong>9.</strong> The Free Software Foundation may
523 publish revised and/or new versions of the General Public License from
524 time to time. Such new versions will be similar in spirit to the present
525 version, but may differ in detail to address new problems or concerns.
528 <p align="justify"> Each version is given a distinguishing version number.
529 If the Program specifies a version number of this License which applies
530 to it and "any later version", you have the option of following the terms
531 and conditions either of that version or of any later version published
532 by the Free Software Foundation. If the Program does not specify a version
533 number of this License, you may choose any version ever published by
534 the Free Software Foundation. </p>
536 <p align="justify"> <strong>10.</strong> If you wish to incorporate parts
537 of the Program into other free programs whose distribution conditions
538 are different, write to the author to ask for permission. For software
539 which is copyrighted by the Free Software Foundation, write to the Free
540 Software Foundation; we sometimes make exceptions for this. Our decision
541 will be guided by the two goals of preserving the free status of all derivatives
542 of our free software and of promoting the sharing and reuse of software
545 <p align="justify"><strong>NO WARRANTY</strong></p>
547 <div align="justify"> </div>
549 <p align="justify"> <strong>11.</strong> BECAUSE THE PROGRAM IS LICENSED
550 FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT
551 PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING
552 THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
553 WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
554 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
555 FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
556 OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
557 THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. </p>
559 <p align="justify"> <strong>12.</strong> IN NO EVENT UNLESS REQUIRED BY
560 APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
561 ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED
562 ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL
563 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
564 PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
565 INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE
566 OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER
567 OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. </p>
569 <p align="justify"> </p>
571 <h3>END OF TERMS AND CONDITIONS</h3>
574 <hr width="100%" size="2"><br>
577 <h2><a name="Installation"></a>Installation</h2>
580 <div align="justify">
583 <p>Citadel/UX is an advanced, multiuser, client/server, room-based BBS program.
584 It is designed to handle the needs of both small dialup systems and
585 large-scale Internet-connected systems. It was originally developed on
586 an Altos system running Xenix, and has been installed and tested on various
587 Unix and Unix-like platforms. The author's current development environment
588 (and BBS) is an ordinary Linux system. The current distribution includes:
592 <li>The Citadel/UX server (this is the back end that does all
594 <li>A text-based client program designed with the traditional
595 Citadel "look and feel" (room prompts, dot commands, and the like)
597 <li>Setup programs </li>
598 <li>A set of utilities for system administration and maintenance
600 <li>Documentation </li>
604 <p>Some knowledge of the Unix system is necessary to install and manage the
605 system. It is mandatory that the sysop have "root" access to the operating
606 system. The following are required to install Citadel/UX: </p>
609 <li>A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX)
611 <li>C compiler (such as gcc or egcs) and "make" </li>
612 <li>POSIX threads (the "pthreads" library) </li>
614 <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1
615 or newer (GDBM also works, but its use is officially depracated. If
616 you are building a new system, do <i>not</i> use GDBM. If you have an
617 existing system which uses GDBM, you should migrate it to Berkeley DB
618 as soon as possible.) </li>
619 <li>Enough disk space to hold all of the programs and data </li>
623 <p>If you are running Citadel/UX on a Linux system, it is STRONGLY recommended
624 that you run it on a recent distribution (such as <a
625 href="http://www.redhat.com">Red Hat</a> 7.3 or newer). A new-ish distribution
626 will have most or all of the prerequisite tools and libraries already
627 integrated for you.</p>
629 <h3>Now available:</h3>
632 <li>"WebCit", a gateway program to allow full access to Citadel
633 via the World Wide Web. Interactive access through any Web browser.
635 <li>Access to Citadel via <i>any</i> standards-compliant e-mail
636 program, thanks to Citadel's built-in SMTP, POP, and IMAP services.
637 You can use Netscape/Mozilla, Evolution, Eudora, Pine, or even Microsoft
638 VirusSpreader (better known as "Outlook") with Citadel. </li>
642 <h3>Coming soon:</h3>
645 <li>Newer and better GUI-based clients. </li>
649 <h3><a name="Everything_in_its_place..."></a>Everything in its place...</h3>
651 <p>Hopefully you've unpacked the distribution archive into its own directory.
652 This is the directory in which all Citadel files are located and in
653 which all activity will take place. Several subdirectories have already
654 been created during the unpacking process, and others may be created
655 by the software if needed. Make sure you have Berkeley DB installed on
656 your system, and that you have all the development libraries and headers
657 in place so that you can compile against them. If you don't, you can
658 get the latest Berkeley DB at <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
659 If your operating system uses a separate library to support POSIX threads
660 (pthreads), make sure that library is installed as well. This is almost
661 never the case with Linux, but some commercial Unix flavors might need
664 <h3><a name="The_BBS_Login"></a></h3>
666 <h3>The BBS Login</h3>
668 <p>As with many Unix programs, Citadel wants to run under its own user ID.
669 Unlike other programs, however, this user ID will do double-duty as a
670 public login for your system if you are running a BBS. This account is
671 typically called "bbs" or "citadel" or something to that effect. You will
672 tell Citadel what the user-id of that account is, and when someone logs
673 in under that account, Citadel will prompt for a user name.</p>
675 <p>The Citadel user should have a unique uid. The home directory should be
676 the one your Citadel installation resides in (in this example we will
677 use /usr/local/citadel) and the shell should be either "citadel" in that
678 directory, or a script that will start up citadel (you may wish to set
679 up an external text editor; see below). Example:</p>
681 <pre>bbs::100:1:BBS Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
683 <p>When you run setup later, you will be required to tell it what the Citadel
684 user's numeric user ID is, so it knows what user to run as. If you create
685 an account called <tt>bbs</tt>, <tt>guest</tt>, or <tt>citadel</tt>, the
686 setup program will automatically pick up the user ID by default.</p>
688 <p>For all other users in /etc/passwd, Citadel will automatically set up
689 an account using the full name (or 'gecos' in Unixspeak) of the user. It'll
690 also ignore any password you supply, because it uses the user's password
691 on the host system. This allows a 'single sign on' type of environment.
692 Note that this does have to be enabled at compile time -- it's the configure
693 option called <tt>--enable-autologin</tt>. Keep in mind that these users
694 can use *either* their Citadel login name or their login name on the host
695 computer, and their password on the host computer.</p>
697 <h3><a name="Bypassing_the_login:_prompt"></a></h3>
699 <h3>Bypassing the <tt>login:</tt> prompt</h3>
701 <p>If you normally log in to your host system using some method other than
702 telnet (such as ssh), you might want the telnet service to go straight
703 to the Citadel BBS, instead of displaying the <tt>login:</tt> prompt first.
704 You can do this by having telnetd start citadel directly instead of
705 <tt>/bin/login</tt>. This is actually very simple to implement; all you
706 need to do is make a simple change to your <tt>inetd</tt> or <tt>xinetd</tt>
707 configuration. Here are some configuration examples.</p>
709 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
710 replacing any existing telnet configuration line already there):</p>
712 <pre>telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel<br></pre>
714 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
715 then simply replace that file with this one):</p>
717 <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>
719 <p>Please make sure you know what you're doing before you install this! If
720 you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
721 then change the directory name accordingly. If you know of any other
722 local peculiarities which need to be observed, edit the above configuration
723 accordingly as well. And, of course, if you're working remotely, make
724 sure you can successfully log in using SSH before you start changing your
725 telnet configuration, otherwise you could lock yourself out of your system
726 (ask any networking specialist about the dangers of "working inline" --
727 then pull up a chair and get a fresh cup of coffee, because you're going
728 to hear some war stories).</p>
730 <h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
732 <p>You can easily compile the Citadel system with the following commands:</p>
734 <pre>./configure<br>make<br>make install<br></pre>
736 <p>The 'configure' script will generate a Makefile from the Makefile.in,
737 and it will also write the file "sysdep.h" to your Citadel directory. Please
738 do not edit sysdep.h or Makefile.in yourself. The configure script will
739 figure out your system dependencies and set everything correctly.</p>
741 <p>Mac OS X 10.1 and later are now supported. (Sorry, 10.0 cannot be supported,
742 now or in the future.) You need to install the Developer Tools CD, which
743 you can purchase or download for free from <a
744 href="http://developer.apple.com">http://developer.apple.com</a>. Then run
745 configure like this:</p>
747 <pre>env CC=/usr/bin/cc ./configure (options - see below)<br></pre>
749 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
750 If you wish to place it in a different directory, you can instead do:</p>
752 <pre>./configure --prefix=/export/home/citadel (or whatever)<br></pre>
754 <p>If you've got Berkeley DB installed in a non-standard location, you can
755 help the configure script find it by doing something like this:</p>
757 <pre>./configure --with-db=/usr/local/BerkeleyDB-4.1<br></pre>
759 <p>The configure script prefers Berkeley DB if it is available, but will fall
760 back to GDBM if it has to.</p>
762 <p>File permissions are always a bother to work with. You don't want Citadel
763 to crash because someone couldn't access a file, but you also don't want
764 shell users peeking into the binaries to do things like reading others'
765 mail, finding private rooms, etc. The Citadel server needs to be started
766 as root in order to bind to privileged ports, but as soon as its initialization
767 is finished, it changes its user ID to your BBS user ID in order to avoid
770 <h3><a name="Upgrading"></a></h3>
774 <p>Any existing Citadel installation which is at version 5.50 or newer may
775 be upgraded in place without the need to discard your existing data files.</p>
777 <p>Upgrading to a new version uses the same build procedure as compiling
778 the program for a fresh install, except that you want to do <tt>make install-exec</tt>
779 instead of <tt>make install</tt>. This will overwrite the programs but
780 not your data. <b>Be sure to shut down citserver during this process!</b>
781 If Citadel is running while you upgrade, you may face data corruption issues.<br>
784 <p>After doing <tt>make install-exec</tt>, you should run <tt>setup</tt>
785 again to bring your data files up to date. Please see the setup section
786 below for more information on this.</p>
788 <h3><a name="The_citadel.rc_file"></a>The <tt>citadel.rc</tt> file</h3>
790 <p>The text-based client included with Citadel is suitable for BBS applications.
791 Much of its command set and other behavior is configurable through a Run
792 Control (RC) file. The standard client looks for this file in the following
796 <li><tt>$HOME/.citadelrc</tt></li>
797 <li><tt>/usr/local/lib/citadel.rc</tt></li>
798 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
801 The next couple of sections deal with client-side configuration.
803 <h3><a name="Using_an_external_editor_for_message"></a>Using an external editor
804 for message composition</h3>
806 <p>Citadel/UX has a built-in message editor. However, you can also use your
807 favorite text editor to write messages. To do this you simply put a line
808 in your citadel.rc file like this:</p>
810 <pre>editor=/usr/bin/vi<br></pre>
812 <p>The above example would make Citadel call the vi editor when using the
813 <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make it the
814 default editor for the <tt><b>E</b>nter</tt> command by editing the <tt>citadel.rc</tt>
815 file. <b>But be warned:</b> external editors on public systems can be
816 a security hole, because they usually provide users with the ability to
817 drop into a shell on the host system, or save files using names other than
818 the name of the temporary file they are editing. If you intend to use an
819 external editor on a public BBS, make sure you use one that has been hardened
820 for such a purpose -- one which has had the 'shell' and 'save as' commands
821 disabled, as well as any other functions which a destructive user could
822 use to gain unauthorized access to your host system.</p>
824 <h3><a name="Printing_messages"></a>Printing messages</h3>
826 <p>Citadel/UX can send messages to a printer, or just about anywhere else
827 in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt>
828 specifies what command you use to print. Text is sent to the standard input
829 (stdin) of the print command.</p>
831 <p>So if you did this:</p>
833 <pre>printcmd="nl|pr|lpr -Plocal"<br></pre>
835 <p>...that would add line numbers, then paginate, then print on the printer
836 named "local". There's tons of stuff you can do with this feature. For
837 example, you could use a command like <tt>cat <<$HOME/archive</tt>
838 to save copies of important messages in a textfile. Again, this is probably
839 something you don't want to configure for a public BBS host -- most system
840 administrators don't want remote users sending arbitrary things to local
843 <h3><a name="URL_viewing"></a>URL viewing</h3>
845 <p>This is one more feature which is appropriate for local users. While reading
846 a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
847 command, and it will perform some pre-defined action (usually, this is
848 to open up the URL in a web browser). For example:</p>
850 <pre>urlcmd=netscape -remote "openURL(%s)"<br></pre>
852 <p>In the above example, it would open up the URL in an open <a
853 href="http://www.netscape.com/download">Netscape</a> window.</p>
855 <h3><a name="Setup_and_login"></a></h3>
857 <h3>Setup and login</h3>
859 <p>Before logging in for the first time, you must run the setup program.
860 To begin this procedure, enter the following commands:</p>
862 <pre>cd /usr/local/citadel<br>./setup<br></pre>
864 <p>The setup program will guide you through a simple configuration procedure.
865 It will ask you what directory to place your data files in -- the default
866 is the current directory, which is usually the sensible thing to select.
867 If you want to run more than one instance of Citadel on the same host,
868 however, you can specify a different directory here -- just remember to
869 specify the directory name again when you start up the server later on.</p>
871 <p><tt>setup</tt> will then shut down the Citadel service if it is found to
874 <p>You will then be prompted for the name of the system administrator. This
875 is not merely a cosmetic option -- when you log in to your system a little
876 while from now, you'll log in with this name, and it will automatically
877 assign your account the highest access level.</p>
879 <p>Next, you will be prompted for the User ID of the Citadel account on your
880 host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
881 or <tt>citadel</tt>, that account's UID will be the default. If you
882 are upgrading or reconfiguring an existing system, the existing value
883 will be preserved.</p>
885 <p>Then you will be prompted for a server port number. This is the TCP port
886 which Citadel clients use to connect to your Citadel server. In almost
887 all cases, you want to use the default -- port 504, which is the official
888 port number assigned by the IANA for Citadel implementations.</p>
890 <p>The Citadel service will then be started, and you will see the following
893 <pre>Setup is finished. You may now log in.<br></pre>
895 <p>Setup is now complete, on most systems, anyway. Please see below to find
896 out if you need to do anything else:</p>
898 <h3><a name="Configuring_your_host_system_to_start"></a>Configuring your host
899 system to start the service</h3>
901 <p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
902 and <tt>/etc/inittab</tt> in order to configure your host system to automatically
903 start the Citadel service. <tt>setup</tt> will automatically perform these
904 steps if it can, and if you allow it to -- just answer 'Yes' when prompted,
905 and everything will be taken care of for you. If you answer 'No' -- or
906 if your system is a little bit odd (for example, BSD systems don't have
907 <tt>/etc/inittab</tt>) -- read this section and do what you need to in order
908 to get things configured.</p>
910 <p>Before you can use Citadel, you must define the "citadel" service to your
911 system. This is accomplished by adding a line to your /etc/services file
912 that looks something like this:</p>
914 <pre>citadel 504/tcp # Citadel/UX Server<br></pre>
916 <p>504 is the port number officially designated by the IANA for use by Citadel.
917 There should not be any need to use a different port number, unless you
918 are running multiple Citadels on the same computer and therefore need a
919 different port for each one.</p>
921 <p>The next step is to arrange for the server to start. The <tt>citserver</tt>
922 program is the main Citadel server. Before we cover the recommended method
923 of starting the server, let's examine its usage options:</p>
925 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-d] [-f]<br></pre>
927 <p>The options are as follows:</p>
929 <p><tt>-hHomeDir</tt> - the directory your BBS data files live in. This should,
930 of course, be a directory that you've run the <tt>setup</tt> program against
931 to set up some data files. If a directory is not specified, the directory
932 name which was specified in the <tt>Makefile</tt> will be used.</p>
934 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed. The
935 available debugging levels are: </p>
938 <li>1 - Internal errors (failed thread creation, malloc problems,
940 <li>2 - Network errors (broken sockets, failed socket creation)
942 <li>3 - Begin and end of sessions, startup/shutdown of server </li>
943 <li>5 - Server commands being sent from clients </li>
944 <li>7 - Entry and exit of various functions </li>
945 <li>8 - Entry and exit of critical sections </li>
946 <li>9 - Various debugging checkpoints (insanely verbose) </li>
950 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace output.
951 Normally it is sent to stdout.</p>
953 <p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch would
954 be necessary if you were starting the Citadel server, for example, from
955 an rc.local script (which is not recommended, because this won't allow
956 the server to automatically restart when it is shut down).</p>
958 <p><tt>-f</tt> - Defragment all the databases upon startup. This isn't normally
959 necessary due to the nature of the data stored in Citadel, but the option
960 is provided in case you need it. (Note that this only applies to GDBM
961 installations; if you are using Berkeley DB it has no effect.)</p>
963 <p>The preferred method of starting the Citadel server is to place an entry
964 in your /etc/inittab file. This will conveniently bring the server up
965 when your system is up, and terminate it gracefully when your system is
966 shutting down. The exact syntax for your system may vary, but here's an
967 entry that could be used on a Linux system:</p>
969 <pre>cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x3<br></pre>
971 <p>In this example, we've chosen debugging level 3, and have the trace stuff
972 output to one of the virtual consoles. It's important to remember to turn
973 off any getty that is set up on that virtual console, if you do this.
974 After making this change, the command <tt>init q</tt> works on most systems
975 to tell init to re-read the file. If in doubt, just reboot the computer.</p>
977 <h3><a name="Logging_in_for_the_first_time"></a>Logging in for the first time</h3>
979 <p>At this point, your system is ready to run. Run the <tt>citadel</tt> program
980 from the shell and log in as a new user. NOTE: the first user account
981 to be created will automatically be set to access level 6 (Aide). This
982 overcomes some obvious logistical problems - normally, Aide access is given
983 by another Aide, but since there aren't any on your system yet, this isn't
986 <h3><a name="Welcoming_new_users"></a>Welcoming new users</h3>
988 <p>Sometimes you might decide that you want a welcome message (or several
989 different messages) automatically mailed to new users upon their first
990 login. Now there is a way to do this. If you create a room called <tt>New
991 User Greetings</tt>, and it is a <i>private</i> room (invitation-only probably
992 makes the most sense), any messages you enter into that room will automatically
993 be delivered to all new users upon registration.</p>
995 <p>You can put anything you want there: a welcome message, system policies,
996 special information, etc. You can also put as many messages there as you
997 want to (although it really doesn't make sense to clutter new users' mailboxes
998 with lots of junk).</p>
1000 <p>Don't worry about wasting disk space, either. Citadel has a single-instance
1001 message store, so all the new users are actually looking at the same copy
1002 of the message on disk.</p>
1004 <h3><a name="Space_for_adding_your_own_client"></a>Space for adding your own
1005 client features (doors)</h3>
1007 <p><b>Please take note!</b> This function really represents the "old" way
1008 of doing things, and it doesn't fit in well with the client/server paradigm.
1009 Please consider it "deprecated" because it may be removed someday.</p>
1011 <p>The "doorway" feature is just a generic way to add features to the system.
1012 I called it "Doorway" to make it resemble the doors on non-Unix boards,
1013 but as we all know, us Unix types don't have to write special code to access
1014 the modem. :-) Anyway, when a user hits the <tt><b>*</b></tt> (doorway)
1015 command, Citadel does...</p>
1017 <pre>USERNAME=(username); export USERNAME<br>./subsystem (user-number) (screen-width) (access level)<br></pre>
1019 <p>...so you can put whatever you want in there. I suggest putting in a menu
1020 program to allow the users to pick one of a number of programs, etc. Do
1021 be aware that door programs will only be available when the client and server
1022 programs are running on the <i>same</i> computer, and when the user is running
1023 the text-mode client. Because of these restrictions, Door programs are being
1024 utilized less and less every day.</p>
1026 <h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and getting
1029 <p>That's just about all the information you need to install the system.
1030 But if you get stuck, you can visit UNCENSORED! BBS and report a problem or
1031 ask for help. But if you intend to report a problem getting the Citadel server
1032 to run, <i>please</i> double-check the following things first: </p>
1035 <li>Did you do <tt>./configure && make && make install</tt>
1037 <li>Did you run setup? </li>
1038 <li>Did you start the server? </li>
1042 <p>To report a problem, you can log on to UNCENSORED! or any other BBS on
1043 the Citadel network which carries the <tt>Citadel/UX></tt> room. Please
1044 DO NOT e-mail the developers directly. Post a request for help on the
1045 BBS, with all of the following information: </p>
1048 <li>The exact nature of your difficulty </li>
1049 <li>A transcript of the error message(s) if possible </li>
1050 <li>The version of Citadel you are running </li>
1051 <li>The version of Berkeley DB present on your system </li>
1052 <li>Which operating system you are running, and what version </li>
1053 <li>If you are running a Linux system, we need to know which distribution,
1054 and the version of the kernel, libc, and pthreads you are using (it would
1055 help to post the output of a <tt>ldd ./citserver</tt> command). </li>
1060 <div align="center">
1061 <hr width="100%" size="2">
1062 <h2><a name="sysop"></a>System Administration</h2>
1065 <div align="justify">
1066 <h3><a name="Overview_"></a>Overview</h3>
1068 <p>Citadel/UX, when installed properly, will do most of its maintenance by
1069 itself. It is intended to be run unattended for extended periods of
1070 time, and most installations do just that without any software failures.</p>
1072 <p>The system has seven access levels. Most users are at the bottom and have
1073 no special privileges. Aides are selected people who have special access within
1074 the Citadel program. Room Aides only have this access in a certain room.
1075 Preferred users can be selected by Aides for access to preferred only rooms.
1076 A sysop is anyone who has access to the various sysop utilities - these
1077 are in their own executable files, which should have their permissions set
1078 to allow only sysops to run them. You should either create a sysops group
1079 in /etc/group, or use some other existing group for this purpose.</p>
1081 <p>Aides have access to EVERY room on the system, public and private (all
1082 types). They also have access to commands starting with <tt>.<b>A</b>ide</tt>
1083 in addition to being able to delete and move messages. The system room,
1084 <tt>Aide></tt>, is accessible only by those users designated as Aides.</p>
1086 <h3><a name="Aide_commands"></a>Aide commands</h3>
1088 <p>Aides have the following commands available to them that are not available
1089 to normal users. They are:</p>
1094 <td width="30%"><tt> .<b>A</b>ide <b>K</b>ill this room </tt></td>
1095 <td> Deletes the current room from the system. </td>
1098 <td width="30%"><tt> .<b>A</b>ide <b>E</b>dit this room </tt></td>
1099 <td> Allows editing of the properties of the current room.
1100 This is explained in greater detail below. </td>
1103 <td width="30%"><tt> .<b>A</b>ide <b>W</b>ho knows room </tt></td>
1104 <td> For private rooms with access controls, or mailbox rooms,
1105 this command displays a list of users who have access to the current room.
1109 <td width="30%"><tt> .<b>A</b>ide edit <b>U</b>ser </tt></td>
1110 <td> Allows editing of the properties of any user account on
1114 <td width="30%"><tt> .<b>A</b>ide <b>V</b>alidate new users
1116 <td> For public access systems, this command reviews all new
1117 user registrations and allows you to set each new user's access level (or
1118 simply delete the accounts). </td>
1121 <td width="30%"><tt> .<b>A</b>ide enter <b>I</b>nfo file </tt></td>
1122 <td> Each room may contain a short textual description of its
1123 purpose, which is displayed to users upon entering the room for the first
1124 time (or in the room banner, for users of the Web client). This command
1125 allows you to enter or edit that description. </td>
1128 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite
1130 <td> Access control command to grant any specific user access
1131 to a private room. </td>
1134 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick out
1136 <td> Access control command to revoke any specifc user's access
1137 to the current room. This works regardless of whether the room is public
1141 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>D</b>elete
1143 <td> If the current room has an associated file directory, this
1144 command may be used to delete files from it. </td>
1147 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end over
1149 <td> If the current room has an associated file directory, this
1150 command may be used to transmit a copy of any file in that directory to
1151 another node on a Citadel network. </td>
1154 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>M</b>ove </tt></td>
1155 <td> If the current room has an associated file directory, this
1156 command may be used to move any file in that directory to another room.
1157 The target room must also have an associated file directory. </td>
1160 <td width="30%"><tt> .<b>A</b>ide <b>M</b>essage edit </tt></td>
1161 <td> This command allows editing of any of the various system
1162 banners and messages which are displayed to users. Type the name of the
1163 banner or message you wish to edit. </td>
1166 <td width="30%"><tt> .<b>A</b>ide <b>P</b>ost </tt></td>
1167 <td> This is the functional equivalent of the <tt><b>E</b>nter
1168 message</tt> command available to all users, except that it allows you
1169 to post using any user name. </td>
1172 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1173 <b>G</b>eneral </tt></td>
1174 <td> This command allows configuration of a large number of
1175 global settings for your Citadel system. These settings will be explained
1176 in greater detail below. </td>
1179 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1180 <b>I</b>nternet </tt></td>
1181 <td> This command allows configuration of settings which affect
1182 how your Citadel system sends and receives messages on the Internet. </td>
1185 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1186 check <b>M</b>essage base </tt></td>
1187 <td> Perform a consistency check on your message store. This
1188 is a very time-consuming operation which should not be performed unless
1189 you have reason to believe there is trouble with your database. </td>
1192 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1193 <b>N</b>etwork </tt></td>
1194 <td> Configure networking (e-mail, room sharing, etc.) with
1195 other Citadel nodes. </td>
1198 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1199 network <b>F</b>ilter list </tt></td>
1200 <td> If you are on a large public or semi-public network of
1201 Citadel nodes and you find content from certain systems or individuals
1202 objectionable, you can use this command to define a rule set to automatically
1203 reject those messages when they arrive on your system. </td>
1206 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>N</b>ow
1208 <td> Immediately shut down the Citadel service, disconnecting
1209 any users who are logged in. Please keep in mind that it will start right
1210 back up again if you are running the service from <tt>/etc/inittab</tt>,
1211 so in practice this command will probably not get much use. </td>
1214 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>S</b>cheduled
1216 <td> Shut down the Citadel service the next time there are zero
1217 users connected. This allows you to automatically wait until all users
1218 are logged out. </td>
1221 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients
1223 <td> Any room may be made into a mailing list. Enter this command
1224 to open an editor window containing the list of Internet e-mail addresses
1225 to which every message posted in the room will be sent. </td>
1228 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest
1229 recipients </tt></td>
1230 <td> Similar to the regular mailing list command, except the
1231 messages will be sent out in 'digest' form -- recipients will see messages
1232 from the address of the room itself rather than the address of the author
1233 of each message, and a digest may contain more than one message. Each room
1234 may have any combination of List and Digest recipients. </td>
1237 <td width="30%"><tt> .<b>A</b>ide <b>N</b>etwork room sharing
1239 <td> Configures the sharing of the current room's contents with
1240 other Citadel nodes. Messages posted in this room on any Citadel system
1241 will automatically be replicated to other Citadel systems carrying the
1248 <h3><a name="Editing_rooms"></a>Editing rooms</h3>
1250 <p>This command allows any aide to change the parameters of a room. Go to
1251 the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit
1252 room</tt> command. A series of prompts will be displayed. The existing
1253 parameters will be displayed in brackets; simply press return if you want
1254 to leave any or all of them unchanged.</p>
1256 <pre> <br>Room name [IG's Fun Room]:<br></pre>
1258 <p>...the name of the room.</p>
1260 <pre>Private room [Yes]? <br></pre>
1262 <p>...enter Yes if you wish to restrict access to the room, or no if the room
1263 is to be accessible by all users. Note that Citadel doesn't bother users
1264 about access to rooms every time they need to access the room. Once a user
1265 gains access to a private room, it then behaves like a public room to them.
1266 The following four questions will only be asked if you selected Private...</p>
1268 <pre>Accessible by guessing room name [No]?<br></pre>
1270 <p>...if you enter Yes, the room will not show up in users' <tt><b>K</b>nown
1271 rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing
1272 the room's full name), they will gain access to the room.</p>
1274 <pre>Accessible by entering a password [No]?<br>Room password [mypasswd]: <br></pre>
1276 <p>...this adds an additional layer of security to the room, prompting users
1277 for a password before they can gain access to the room.</p>
1279 <p>If you did not select guessname or passworded, then the only way users
1280 can access the room is if an Aide explicitly invites them to the room using
1281 the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt> command.</p>
1283 <pre>Cause current users to forget room [No] ? No<br></pre>
1285 <p>Enter Yes if you wish to kick out anyone who currently has access to the
1288 <pre>Preferred users only [No]? No<br></pre>
1290 <p>Enter Yes if you wish to restrict the room to only users who have level
1291 5 (Preferred User) status (and Aides too, of course). You should make
1292 the room public if you intend to do this, otherwise the two restrictions
1293 will be COMBINED.</p>
1295 <pre>Read-only room [No]? No<br></pre>
1297 <p>If you set a room to Read-Only, then normal users will not be allowed to
1298 post messages in it. Messages may only be posted by Aides, and by utility
1299 programs such as the networker and the "aidepost" utility. This is useful
1300 in situations where a room is used exclusively for important announcements,
1301 or if you've set up a room to receive an Internet mailing list and posting
1302 wouldn't make sense. Other uses will, of course, become apparent as
1303 the need arises.</p>
1305 <p>Now for a few other attributes...</p>
1307 <pre>Directory room [Yes]? Yes<br></pre>
1309 <p>...enter Yes if you wish to associate a directory with this room. This
1310 can be used as a small file repository for files relevant to the topic
1311 of the room. If you enter Yes, you will also be prompted with the following
1314 <pre>Directory name [mydirname]: <br></pre>
1316 <p>...the name of the subdirectory to put this room's files in. The name
1317 of the directory created will be <tt><i><your BBS directory></i>/files/<i><room
1318 dir name></i></tt>.</p>
1320 <pre>Uploading allowed [Yes]? Yes<br></pre>
1322 <p>...enter Yes if users are allowed to upload to this room.</p>
1324 <pre>Downloading allowed [Yes]? Yes<br></pre>
1326 <p>...enter Yes if users are allowed to download from this room.</p>
1328 <pre>Visible directory [Yes]? Yes<br></pre>
1330 <p>...enter Yes if users can read the directory of this room.</p>
1332 <pre>Network shared room [No]? No<br></pre>
1334 <p>...you can share a room over a network without setting this flag, and
1335 vice versa, but what this flag does is twofold: </p>
1338 <li>It prevents people with no network access from entering messages
1340 <li>Messages are displayed with the name of their originating system
1341 in the header. </li>
1345 <pre>Permanent room [No]? No<br></pre>
1347 <p>Citadel contains an 'auto purger' which is capable of removing rooms which
1348 have not been posted in for a pre-defined period of time (by default
1349 this is set to two weeks). If you wish to keep this from happening to
1350 a particular room, you can set this option. (Keep in mind that <tt>Lobby></tt>,
1351 <tt>Aide></tt>, any private mailbox rooms, any network shared rooms,
1352 and any rooms with a file directory are automatically permanent.)</p>
1354 <pre>Anonymous messages [No]? No<br>Ask users whether to make messages anonymous [No]? No<br></pre>
1356 <p>...you can have rooms in which all messages are automatically anonymous,
1357 and you can have rooms in which users are prompted whether to make a
1358 message anonymous when they enter it. The real identity of the author
1359 of each message is still revealed to the Room Aide for this room, as well
1360 as any system-wide Aides.</p>
1362 <pre>Room aide [Joe Responsible]: <br></pre>
1364 <p>...on larger systems, it helps to designate a person to be responsible
1365 for a room. Room Aides have access to a restricted set of Aide commands,
1366 ONLY when they are in the room in which they have this privilege. They
1367 can edit the room, delete the room, delete and move messages, and invite
1368 or kick out users (if it is a private room), but they cannot perform aide
1369 commands that are not room-related (such as changing users access levels).</p>
1371 <pre>Listing order [64]: <br></pre>
1373 <p>This is just a simple way to try to control the order rooms are listed
1374 in when users call up a <tt><b>K</b>nown Rooms</tt> listing. Rooms with
1375 a lower listing order are displayed prior to rooms with a higher listing
1376 order. It has no other effect. For users who list rooms in floor order,
1377 the display will sort first by floor, then by listing order.</p>
1379 <pre>Message expire policy (? for list) [0]:<br></pre>
1381 <p>This provides you with the opportunity to select how long each message
1382 will remain in a room before automatically being deleted. Press <tt><b>?</b></tt>
1383 for a list of options. You can choose to keep messages around forever
1384 (or until they are manually deleted), until they become a certain number
1385 of days old, or until a certain number of additional messages are posted
1386 in the room, at which time the oldest ones will scroll out.</p>
1388 <p>You will notice that you can also fall back to the default expire policy
1389 for the floor upon which the room resides. This is the default setting.
1390 You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit
1391 floor</tt> command. The default setting for the floor default, in turn,
1392 is the system default setting, which can be changed using the <tt><b>.A</b>ide
1393 <b>S</b>ystem configuration <b>G</b>eneral</tt> command.</p>
1395 <pre>Save changes (y/n)? Yes<br></pre>
1397 <p>...this gives you an opportunity to back out, if you feel you really messed
1398 things up while editing.</p>
1400 <h3><a name="File_directories"></a>File directories</h3>
1402 <p>If you have created any directory rooms, you can attach file descriptions
1403 to the filenames through a special file called <tt>filedir</tt>. Each line
1404 contains the name of a file in the directory, followed by a space and
1405 then a description of the file, such as:</p>
1407 <pre>myfile.txt This is a description of my file.<br>phluff A phile phull of phluff!<br></pre>
1409 <p>...this would create file descriptions for the files <tt>myfile.txt</tt>
1410 and <tt>phluff</tt> which would be displayed along with the directory.
1411 It should also be noted that when users upload files to your system, they
1412 will be prompted for file descriptions, which will be added to the <tt>filedir</tt>
1413 file. If one does not exist, it will be created.</p>
1415 <h3><a name="Creating_and_editing_user_accounts"></a>Creating and editing
1418 <p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1419 command to create and/or edit user accounts. There are several parameters
1420 which can be set here.</p>
1422 <p>To create a user:</p>
1424 <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>
1426 <p>At this point, the new user account has been created, and the command will
1427 continue as if you were editing an existing account. Therefore the remainder
1428 of this procedure is the same for creating and editing:</p>
1430 <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>
1432 <p>The blank lines are the user's 'registration' information -- personal
1433 information such as full name, address, telephone number, etc. This information
1434 will comprise the user's vCard in both their user profile and in the Global
1437 <pre>Change password [No]: No<br></pre>
1439 <p>...answer Yes to set or change the password for this account.</p>
1441 <pre>Access level [4]: <br></pre>
1443 <p>...this allows you to set or change the access level for this account.
1444 The access levels available are as follows: </p>
1447 <li>0 - Deleted. (This immediately deletes the account.) </li>
1448 <li>1 - New, unvalidated user </li>
1449 <li>2 - Problem user (severely restricts account - use for probationary
1451 <li>3 - User with no network privileges. Same access as a normal
1452 user except cannot post messages in rooms shared on a network. </li>
1453 <li>4 - Normal user </li>
1454 <li>5 - Preferred user (access is granted to privileged rooms) </li>
1455 <li>6 - Aide (administrative access to the whole system) </li>
1459 <pre>Permission to send/receive Internet mail [ No]? No<br></pre>
1461 <p>If your system is configured to only allow Internet mail privileges to
1462 certain users, this is where you can grant or revoke that privilege.</p>
1464 <pre>Ask user to register again [Yes]: Yes<br></pre>
1466 <p>If you answer Yes to this question, the user will be presented with a
1467 'registration' screen or set of prompts, the next time they log in using
1468 a Citadel client. This will prompt them for their full name, address, telephone
1471 <pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1473 <p>These statistics are available for informational purposes only, so there
1474 is normally no need to change them.</p>
1476 <pre>Set last call to now [No]: No<br>Purge time (in days, 0 for system default [0]: <br></pre>
1478 <p>Citadel contains an auto-purger which is capable of automatically deleting
1479 accounts which have not been accessed in a predefined period of time.
1480 If you choose to perform this operation, you can 'touch' the account of
1481 a wayward user by setting their 'last call' time to 'now'. You can also
1482 adjust, on a per-user basis, the amount of time which must pass before
1483 their account is purged by the system. This time is set in days. You
1484 can also specify 0 days to indicate that you wish to use the system default
1487 <h3><a name="Deleting_and_moving_messages"></a>Deleting and moving messages</h3>
1489 <p>Aides and Room Aides have the ability to delete and move messages. After
1490 each message, the normal prompt appears:</p>
1492 <pre>(8) <B>ack <A>gain <Q>uote <R>eply <N>ext <S>top m<Y> next <?>help -><br></pre>
1494 <p>Entering <tt><b>D</b>elete</tt> will delete the message. A <tt>(y/n)</tt>
1495 prompt will appear to confirm that you really want to delete the message.
1496 Entering <tt><b>M</b>ove</tt> will prompt for a room to which the message
1497 should be moved.</p>
1499 <h3><a name="Customizing_the_help_files"></a>Customizing the help files</h3>
1501 <p>The subdirectory called <tt>help</tt> contains your system's help files.
1502 There's nothing hard-coded into the system that dictates what files should
1503 be there. Whenever a user types the command <tt><b>.H</b>elp</tt> followed
1504 by the name of a help file, it displays the contents of that help file.</p>
1506 <p>The help files that come with the system, of course, are enough to guide
1507 a user through its operation. But you can add, change, or remove help
1508 files to suit whatever is appropriate for your system.</p>
1510 <p>There are several strings that you can put in help files that will be automatically
1511 substituted with other strings. They are:</p>
1513 <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>
1515 <p>So, for example, you could create a help file which looked like:</p>
1517 <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>
1519 <h3><a name="Site_configuration"></a>Site configuration</h3>
1521 <p>Once your Citadel server is up and running, the first thing you'll want
1522 to do is customize and tune it. This can be done from the text-based client
1523 with the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1524 command, or from WebCit (if you have it installed) by clicking 'Advanced
1525 Options' followed by 'Edit site-wide configuration.' Either method will
1526 offer the same configuration options. This document shows the text mode
1527 client being used.</p>
1529 <p>The first set of options deal with the identification of your system.</p>
1531 <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
1532 !="" more="" text="" on="" the="" next="" screen="">]: <br></jinkies></pre>
1534 <p>'Node name' refers to the short, unqualified node name by which your system
1535 is known on a Citadel network. Generally it will be the same as the unqualified
1536 host name of your computer; this is, in fact, the default setting.</p>
1538 <p>Then enter the fully-qualified domain name (FQDN) of your system. If you
1539 are not on the Internet, you can simply set it to the same as your unqualified
1540 host name. Otherwise you should set this value to the host name by which
1541 your system is most commonly known.</p>
1543 <p>The field called 'Human-readable node name' (also known as the 'node title'
1544 or 'organization name' in other software) is used solely for display purposes.
1545 Set it to the actual name of your system as you want it to appear in banners,
1548 <p>If you have a modem or bank of modems answering data calls for your system,
1549 enter it in the field marked 'Modem dialup number.' Otherwise you may
1552 <p>'Geographic location of this system' is another display field. Enter a
1553 city and state, or city and country. </p>
1555 <p>'Name of system administrator' is important! Any user who logs on with
1556 the name you enter here will automatically be granted Aide privileges.
1557 This is one of two ways for the system administrator to grant himself/herself
1558 Aide access to the system when initially setting it up. (The other is simply
1559 to have the first account created on a new installation.)</p>
1561 <p>The next set of options are your system's security settings. Before delving
1562 into the actual options, we should review the various access levels available
1563 on the system. Citadel has seven access levels:</p>
1566 <li>0 (Deleted). A user whose access level is set to 0 will automatically
1567 be deleted by the system. </li>
1568 <li>1 (New User). Users at this level may only read messages.
1569 Entering messages is prohibited, except in the <tt>Mail></tt> room,
1570 where a message to 'sysop' may be entered. </li>
1571 <li>2 (Problem User). Also known as 'Twit.' </li>
1572 <li>3 (Local User). May enter messages, except in rooms shared
1573 on a Citadel network. </li>
1574 <li>4 (Network User). May enter messages in every accessible room.
1576 <li>5 (Preferred User). Use of this level is up to the whim of
1577 the system administrator. </li>
1578 <li>6 (Aide). Access is granted to the administrative functions
1579 of the system. (This access level may also be granted to a user only for
1580 a specific room, please see 'Room Aide' for more information.) </li>
1584 <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>
1586 <p>'Registration' refers to the process of a user entering various personal
1587 contact information (real name, address, telephone number, etc.) into
1588 the system. When enabled, this information is stored as a vCard object
1589 on the system in two places: the user's <tt>My Citadel Config></tt> room,
1590 and in the <tt>Global Address Book></tt> room. (Note: the latter should
1591 be made private on publicly-accessible systems, for obvious reasons.)</p>
1593 <p>If you answer Yes to 'Require registration for new users' then each new
1594 user, upon creating a new account, will immediately be entered into the
1595 registration process. On the other hand, if you answer Yes to 'Disable
1596 self-service user account creation' then new users will not be able to log
1597 in at all -- all accounts must be created by an Aide.</p>
1599 <p>'Initial access level for new users' should be set to 1 (New User) if you
1600 would like to review each new user's registration info before granting
1601 them higher access. This would be done periodically with the <tt><b>.A</b>ide
1602 <b>V</b>alidate new users</tt> command. If you do not require registration,
1603 you should set the initial access level to 4 (Network User).</p>
1605 <p>Given the above options, it then becomes clear that there are generally
1606 two ways you can set up your Citadel system, depending on its purpose:</p>
1609 <li><b>A public access BBS or message board</b> - since you do not
1610 know who might want to log in, self-service account creation needs to
1611 stay enabled. If you want to be strict about users identifying themselves,
1612 then you should also require users to register (just remember to post
1613 a privacy policy if you're going to collect personal information) -- then
1614 set the initial access level to 1 (New User), so new users cannot post messages
1615 until after you've validated them. For a more lax environment, you can
1616 remove the registration requirement and grant new accounts level 4 (Normal
1617 User) access on the first visit. </li>
1618 <li><b>A private email/groupware system for your organization</b>
1619 - in this case, disable self-service account creation; you don't want
1620 strangers welcoming themselves to your system. You'll probably also want
1621 to disable registration, because you or some other site administrator
1622 will be entering users' contact info when you create their accounts.
1623 Since this is also how you assign their Internet e-mail addresses, it's
1624 probably a good idea to do it yourself instead of expecting them to do it.
1629 <p>'Access level required to create rooms' is up to you. You might wish to
1630 restrict the creation of new rooms only to Aides, or you might wish to allow
1631 anyone to create a room. The latter is one of the Citadel culture's most
1632 long-standing traditions; the former may be appropriate if users are abusing
1635 <p>You have the ability to 'Automatically give room aide privs to a user who
1636 creates a private room.' If you answer Yes, then any user who creates a
1637 guess-name, passworded, or invitation-only room will automatically become
1638 the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1639 command set while in that room. If you would rather grant this permission
1640 manually, answer No.</p>
1642 <p>Another tradition in the Citadel culture is to refrain from deleting
1643 problem users, but instead to 'twit' them (reduce their access level to 2
1644 [Problem User]). You can then 'Automatically move problem user messages
1645 to twit room' (answer Yes, then specify 'Name of twit room' and remember
1646 to create that room). If you employ this logic, any user with level 2 (Problem
1647 User) access will continue to have access to the same set of rooms, but all
1648 messages posted will automatically be routed to the Trashcan (or whatever
1649 you call your twit room).</p>
1651 <p>If you have Internet mail configured, you have the option of restricting
1652 its use on a user-by-user basis. If you wish to do this, answer Yes to
1653 'Restrict Internet mail to only those with that privilege.' Obviously this
1654 makes no sense for an internal e-mail system, but for a public BBS it might
1657 <p>Normally, Aides have access to every room, public or private, except for
1658 user mailboxes. They are also forbidden from <tt><b>Z</b>ap</tt>ping rooms,
1659 because the review of content is considered one of their roles. If you
1660 wish to change these policies, the next two options allow you to. You
1661 may 'Allow Aides to Zap (forget) rooms', in which case they may use the
1662 <tt><b>Z</b>ap</tt> command just like any other user. Furthermore, if
1663 you 'Allow system Aides access to user mailboxes', then they may <tt><b>.G</b>oto</tt>
1664 any private mailbox belonging to any user, using a special room name format.</p>
1666 <p>If your local security and/or privacy policy dictates that you keep a
1667 log of all pages (instant messages) that go through the system, then answer
1668 Yes to 'Log all pages'. If you answer Yes, you will be prompted for the
1669 name of a room to which all pages will be logged. If you answer No, then
1670 only the sender and recipient of each individual message will receive a copy.</p>
1672 <p>The next set of options deals with the tuning of your system. It is usually
1673 safe to leave these untouched.</p>
1675 <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>
1677 <p>The 'Server connection idle timeout' is for the connection between client
1678 and server software. It is <b>not</b> an idle timer for the user interface.
1679 900 seconds (15 minutes) is the default and a sane setting.</p>
1681 <p>'Maximum concurrent sessions' is the highest number of user sessions you
1682 wish to allow on your system at any given time. Citadel can scale to
1683 hundreds of concurrent users, but if you have limited hardware or (more
1684 likely) limited bandwidth, you might wish to set a maximum. You can also
1685 set it to zero for no limit.</p>
1687 <p>'Maximum message length' is just that. This could be a good way to prevent
1688 enormous multimedia files from finding their way into your message base.
1689 This maximum is enforced in all protocols and is also advertised by the
1692 <p>The minimum and maximum number of worker threads can be tuned to your
1693 liking. Citadel will attempt to keep one worker thread running per session,
1694 within these constraints. You should be aware that due to the use of the
1695 worker thread model, Citadel can handle a large number of concurrent sessions
1696 with a much smaller thread pool. If you don't know the programming theory
1697 behind multithreaded servers, you should leave these parameters alone.</p>
1699 <p>The next set of options affect how Citadel behaves on a network.</p>
1701 <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>
1703 <p>'How often to run network jobs' refers to the sharing of content on a
1704 Citadel network. If your system is on a Citadel network, this configuration
1705 item dictates how often the Citadel server will contact other Citadel servers
1706 to send and receive messages. In reality, this will happen more frequently
1707 than you specify, because other Citadel servers will be contacting yours
1708 at regular intervals as well.</p>
1710 <p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP services.
1711 For a system being used primarily for Internet e-mail, these are essential,
1712 so you'll want to specify the standard port numbers: 25, 110, and 143.
1713 If Citadel is running alongside some other mail system, though, then you
1714 might want to choose other, unused port numbers, or enter -1 for any protocol
1715 to disable it entirely.</p>
1717 <p>The final set of options configures system-wide defaults for the auto-purger:</p>
1719 <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>
1721 <p>Any user who does not log in for the period specified in 'Default user
1722 purge time' will be deleted the next time a purge is run. This setting
1723 may be modified on a per-user basis.</p>
1725 <p>'Default room purge time' behaves the same way, and may also be modified
1726 on a per-room basis.</p>
1728 <p>'System default message expire policy' defines the way in which old messages
1729 are expired (purged) off the system. You can specify any of:</p>
1732 <li>Purge by age (specify in days) </li>
1733 <li>Purge by message count in the room (specify number of messages)
1735 <li>Do not purge at all </li>
1739 <p>Again, this setting may be overridden on a per-floor basis, and the floor
1740 setting may be overridden on a per-room basis.</p>
1742 <pre>Save this configuration? No<br></pre>
1744 <p>When you're done, enter 'Yes' to confirm the changes, or 'No' to discard
1748 <hr width="100%" size="2">
1749 <h2 align="center"><a name="Configuring_Citadel_for_Internet_e-mail"></a>Configuring
1750 Citadel for Internet e-mail</h2>
1752 <div align="justify">
1753 <h3><a name="Introduction"></a>Introduction</h3>
1754 As you know by now, Citadel is a completely self-contained, full-featured
1755 Internet e-mail system. When you run Citadel you do not need any other
1756 mail software on your host system. This eliminates the need for tedious
1757 mucking about with sendmail, qmail, postfix, Cyrus, the UW IMAP server,
1758 or any of countless other needlessly complex programs that lead some people
1759 to the false assumption that Unix systems are difficult to administer.<br>
1761 Some of the many features supported by Citadel are:<br>
1764 <li>Built-in SMTP and ESMTP service, for delivering and receiving
1765 e-mail on the Internet</li>
1766 <li>Built-in POP3 service, for remote fetching of messages</li>
1767 <li>Built-in IMAP service, for access to mail using any standard mail
1769 <li>Web mail (implemented using the "WebCit" middleware, which is
1770 installed separately)</li>
1771 <li>Support for mailing lists, in both "individual message" and "digest"
1773 <li>Multiple/virtual domain support</li>
1774 <li>Any user may have multiple Internet e-mail addresses, in multiple
1776 <li>Global address book (Users with addresses in a domain may be spread
1777 out across many servers on a Citadel network)</li>
1778 <li>Easy-to-configure integration with <a
1779 href="http://www.spamassassin.org/">SpamAssassin</a> can block spam <i>before</i>
1780 it enters the mail system</li>
1783 This section of the documentation will demonstrate how to configure
1787 <h3><a name="Basic_site_configuration"></a>Basic site configuration</h3>
1789 <p>Basic configuration of your Citadel system for Internet e-mail begins with
1790 the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>I</b>nternet</tt> command:</p>
1792 <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>
1794 <p>This is a "clean" setup. For a simple, standalone e-mail system you simply
1795 have to enter the <tt><b>A</b>dd</tt> command:</p>
1797 <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>
1799 <p><b>localhost:</b> Basically what you're doing here is telling Citadel
1800 what any aliases for your machine are. If your machine were <tt>schmeep.splorph.com</tt>
1801 and you also had a DNS entry set up for <tt>blah.com</tt>, you might want
1802 to enter '1' and enter <tt>blah.com</tt> as your alias, so that e-mail
1803 sent to that address won't bounce.</p>
1805 <p><i>Important tip:</i> if your system is known by one name and <i>only</i>
1806 one domain, you might not even need to do this at all. You will recall
1807 that you entered your system's fully qualified domain name earlier when you
1808 went through the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1809 command. The domain name you entered there is automatically considered
1810 by Citadel to be a 'localhost' entry in your Internet mail configuration.
1811 It does not hurt to enter it in both locations, though.</p>
1813 <p><b>gateway domain:</b> this is a simple way of mapping various Citadel
1814 hosts in an Internet domain. For example, if you enter <tt>bar.com</tt>
1815 as a gateway domain, then mail to users at <tt>foo.bar.com</tt> will be forwarded
1816 to the host called <tt>foo</tt> on a Citadel network, mail to users at <tt>kunst.bar.com</tt>
1817 will be delivered to the Citadel server called <tt>kunst</tt>, etc. This
1818 feature has limited usefulness; if you are operating a network of Citadel
1819 servers, it is more likely that you will use the 'directory' feature, explained
1822 <p><b>smart-host:</b> Normally, Citadel sends outbound Internet e-mail directly
1823 to its destination. This may not be appropriate for some sites; you may
1824 require (due to local convention, security policy, or whatever) that all
1825 outbound mail be sent to an SMTP relay or forwarder. To configure this
1826 functionality, simply enter the domain name or IP address of your relay
1827 as a 'smart-host' entry.</p>
1829 <p><b>directory:</b> a domain for which you are participating in directory
1830 services across any number of Citadel nodes. For example, if users who
1831 have addresses in the domain <tt>citadel.org</tt> are spread out across multiple
1832 Citadel servers on your network, then enter <tt>citadel.org</tt> as a 'directory'
1833 entry. <i>For this to work, all Citadel servers participating in directory
1834 service <b>must</b> carry and share the <tt>Global Address Book></tt>
1837 <p><b>spamassassin:</b> if you are running a <a
1838 href="http://www.spamassassin.org">SpamAssassin</a> service anywhere on your
1839 <b>local</b> network, enter its name or IP address as a 'spamassassin' entry.
1840 This may be (and, in fact, will usually be) <tt>127.0.0.1</tt> to specify
1841 that the service is running on the same host computer as the Citadel server.</p>
1843 <p>Please install SpamAssassin as per its own documentation. You will want
1844 to run SpamAssassin in client/server mode, where a <tt>spamd</tt> daemon
1845 is always running on your computer. Citadel does not utilize the <tt>spamc</tt>
1846 client; instead, it implements SpamAssassin's protocol on its own.</p>
1848 <p>Connecting to a SpamAssassin service across a wide area network is strongly
1849 discouraged. In order to determine whether an incoming e-mail is spam,
1850 Citadel must feed the <i>entire message</i> to the SpamAssassin service.
1851 Doing this over a wide area network would consume time and bandwidth, which
1852 would affect performance.</p>
1854 <p>Citadel invokes the SpamAssassin service when incoming messages are arriving
1855 via SMTP. Before a message is accepted, it is submitted to SpamAssassin.
1856 If SpamAssassin determines that the message is spam, the Citadel SMTP
1857 service <i>rejects the message,</i> causing a delivery failure on the sending
1858 host. This is superior to software which files away spam in a separate
1859 folder, because delivery failures will cause some spammers to assume the
1860 address is invalid and remove it from their mailing lists.</p>
1862 <p>Now select <tt><b>S</b>ave</tt> and you are just about ready for Internet
1865 <h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the Internet
1868 <p>As previously mentioned, Citadel contains its own SMTP, POP3, and IMAP
1869 services. Enabling them is simple.</p>
1871 <p>Check for the existance of a current MTA (sendmail, qmail, etc.) by connecting
1872 to port 25 on your host. If you see something similar to the following
1873 you're running an MTA already and you'll need to shut it down:</p>
1875 <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>
1877 <p>In the above example, we see that the host already has Sendmail listening
1878 on port 25. Before Citadel can use port 25, Sendmail must be shut off.
1879 Please consult the documentation for your operating system for instructions
1880 on how to do this. (On a Red Hat Linux system, for example, you can run the
1881 <tt>ntsysv</tt> utility, un-checking <tt>sendmail</tt> to disable it at the
1882 next reboot; then, run <tt>service sendmail stop</tt> to shut off the currently
1883 running service.)</p>
1885 <p>If you get a 'connection refused' message when you telnet to port 25 there's
1886 nothing running and you should be able to continue. You might also want
1887 to turn off POP (try the above test substituting 110 for 25) and IMAP (port
1888 143) and use Citadel's POP and IMAP services.</p>
1890 <p>Citadel will look for an existing pop/smtp server on startup. If they
1891 don't exist (and you've configured them properly) then Citadel should enable
1892 them at startup. You can check your logs to be sure, or you can start the
1893 server from a shell and watch it load. It might look something like this:</p>
1894 <font size="-2"> </font>
1895 <pre><font size="-2">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><br>Registered a new service (TCP port 0)<br>Registered a new session function (type 50)<br>Loaded module: $Id$<br><b>citserver: Can't bind: Address already in use<br>ERROR: could not bind to TCP port 110.</b><br>Registered a new session function (type 0)<br>Loaded module: $Id$<br>Registered a new message function (type 202)Loaded module: $Id$<br>Registered server command RWHO (Display who is online)<br>Registered server command HCHG (Masquerade hostname)<br>Registered server command RCHG (Masquerade roomname)<br>Registered server command UCHG (Masquerade username)<br>Registered server command STEL (Enter/exit stealth mode)<br>Loaded module: $Id$<br>Changing uid to 513<br>Starting housekeeper thread<br></font></pre>
1897 <p>The lines emphasized in boldface in the above log output tell you that
1898 Citadel "can't bind" to various ports. The error 'address already in use'
1899 generally means that something else is already running on the requested
1900 port. Make SURE you've followed the above steps to remove sendmail/pop and
1901 start your Citadel server again.</p>
1903 <h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
1905 <p>Occationally it is not practical to remove a non-Citadel MTA on your host
1906 system. For example, you might have multiple groups of users, some of
1907 which are using Citadel and some of which are using a legacy Unix mail
1908 spool. This type of configuration is discouraged, but a tool is provided
1911 <p>The tool is called <tt>citmail</tt> and it is, quite simply, a local MDA
1912 (Mail Delivery Agent) which you can configure into your MTA for final delivery
1913 of incoming messages to Citadel users. A full discussion of the finer
1914 points of complex Sendmail configurations is beyond the scope of this document;
1915 however, you might want to visit <a
1916 href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some useful
1917 HOWTO documents are provided.</p>
1919 <p>For outbound mail, you can either allow Citadel to perform deliveries directly
1920 (this won't affect your other mail system because outbound mail doesn't tie
1921 up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which will tell
1922 Citadel to forward all of its outbound mail to your other mail system.</p>
1924 <h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet mailing
1927 <p>Citadel has built in mailing list service (known in the 'net vernacular
1928 as "listserv") functionality. You can turn any room into a mailing
1929 list. Users can then choose how they participate -- by logging on to
1930 your Citadel server directly, or by having the room's contents mailed to them
1931 somewhere else. Configuring this is easy.</p>
1933 <p>Citadel supports two modes of mailing list delivery: </p>
1936 <li>"List mode" -- each individual message is delivered as a single
1937 e-mail to each list mode recipient. The "From:" header will display
1938 the address of the message's original author.</li>
1939 <li>"Digest mode" -- groups of one or more messages are delivered to
1940 digest mode recipients. The number of messages in the group depends
1941 on how many new messages arrived since the last batch was delivered. The
1942 "From:" header will display the address of the room itself, which allows
1943 replies to be posted back to the room.</li>
1946 A room may have any combination of list mode and digest mode recipients.
1948 <p>As alluded to above, every room on your Citadel system has an Internet
1949 e-mail address of its own. Messages sent to that address will be posted
1950 in the room (and sent back out to mailing list recipients, as well as to
1951 any other Citadels you share the room with). The address format is
1952 <tt>room_</tt> plus the name of the room, with any spaces replaced by underscores,
1953 followed by <tt>@</tt> and your hostname. For example, if your system is
1954 known as <tt>phlargmalb.orc.org</tt> on the Internet, and you have a room
1955 called <tt>Bubblegum Collectors</tt>, you can post to that room from anywhere
1956 on the Internet simply by sending an e-mail to <tt>room_bubblegum_collectors@phlargmalb.orc.org</tt>.
1957 When the message arrives, it's automatically posted in that room.</p>
1959 <p>To manually edit the list of "list mode" recipients, simply enter the <tt><b>.A</b>ide
1960 mailing <b>L</b>ist management</tt> command. Your text editor will open
1961 up and you will be able to create or edit a list of recipients, one per line.
1962 Lines beginning with a hash (<tt>#</tt>) are comments.</p>
1964 <p>To manually edit the list of "digest mode" recipients, enter the <tt><b>.A</b>ide
1965 mailing list <b>D</b>igest recipients</tt> command. As with the previous
1966 command, the text editor will open up and you can edit the list of digest
1967 mode recipients, one per line.</p>
1969 <p>Citadel also has a facility which allows users to subscribe or unsubscribe
1970 to mailing lists using a web browser. In order to do this, WebCit must also
1971 be running on your server in addition to Citadel. WebCit is obtained and
1972 installed separately from the rest of the Citadel system.</p>
1974 <p>In order to prevent "just anyone" from subscribing to any room on your
1975 system, there is a setting in the <tt><b>.A</b>ide <b>E</b>dit room</tt>
1978 <pre>CitaNews} . Aide Edit this room<br>Room name [CitaNews]:<br><br><i>(lots of other stuff omitted for brevity...)</i><br><br>Self-service list subscribe/unsubscribe [No]: Yes<br></pre>
1980 <p>When you answer "Yes" to self-service list subscribe/unsubscribe, you are
1981 enabling that feature. Now, all you have to do is tell the world about the
1982 web page they need to visit. It looks like this:</p>
1984 <center><tt>http://foobar.baz.org:2000/listsub</tt></center>
1986 <p>In this example, the server is called <tt>foobar.baz.org</tt> and WebCit
1987 is running on port 2000. Edit appropriately.</p>
1989 <p>Citadel offers a subscribe/unsubscribe facility that is more intuitive
1990 than other listservs. With most systems, sending commands to the listserv
1991 requires that you e-mail it commands in a special format. It's easy to get
1992 it wrong. Citadel simply uses your web browser. You select the list you
1993 want to subscribe or unsubscribe (hint: it's the list of rooms you've enabled
1994 self-service for), select whether you want list mode or digest mode, and
1995 enter your e-mail address. For security purposes, a confirmation message
1996 is sent to the address you enter. But you don't have to reply to the message
1997 in a weird format, either: the confirmation contains another URL which you
1998 simply click on (or paste into your browser if you can't click on URL's
1999 in your e-mail software) and the confirmation is automatically completed.</p>
2001 <hr width="100%" size="2">
2003 <h2><a name="Building_or_joining_a_Citadel_network"></a>Building or joining
2004 a Citadel network</h2>
2007 <h3><a name="Overview__"></a>Overview</h3>
2009 <p>If you are running Citadel as a BBS or other forum type of application,
2010 one way to 'keep the conversation going' is to share rooms with other Citadel
2011 systems. In a shared room, a message posted to the room is automatically
2012 propagated to every system on the network. It's kind of like a UseNet newsgroup,
2013 but without the spam.</p>
2015 <p>If you are using Citadel as the e-mail and groupware platform for a large
2016 organization, you can use its networking features to build a large network
2017 of Citadel servers which share content (think of rooms as public folders),
2018 redistribute e-mail throughout the organization, and integrate the global
2019 address book. It might make sense, for example, in a large corporation
2020 to give each department or location its own Citadel server. Thanks
2021 to Citadel's global address book features, you could still have all of the
2022 users share a single e-mail domain.</p>
2024 <p>Obviously, the first thing you have to do is find another Citadel to share
2025 rooms with, and make arrangements with them. The following Citadels are
2026 a good place to start:</p>
2029 <li>UNCENSORED! - <a href="http://uncensored.citadel.org">uncensored.citadel.org</a>
2031 <li>The Dog Pound II - <a href="http://dogpound2.citadel.org">dogpound2.citadel.org</a>
2033 <li>PixelBBS - <a href="http://pixel.citadel.org">pixel.citadel.org</a>
2038 <p>You don't have to be a part of the citadel.org domain to participate in
2039 the public Citadel network, but the DNS service is provided free of charge
2040 by the Citadel community if you wish to do this.</p>
2042 <h3><a name="Conventions_and_etiquette_when"></a>Conventions and etiquette
2043 when connecting to the public Citadel network</h3>
2045 <p>Before we get into the technical nitty gritty, there are two points of
2046 etiquette to keep in mind. The first thing to keep in mind is that the
2047 operator of any particular Citadel may not be willing to share some of his/her
2048 rooms. Some sites are proud to offer exclusive content in certain areas.
2049 Chances are, if a room is already being shared on the network, it's available
2050 for anyone to share; if not, it can't hurt to ask -- but take care not to
2051 demand it of them. Ask if you may share the room instead of telling them
2052 that you wish to share the room. When looking at a <tt><b>K</b></tt>nown
2053 rooms list, network rooms are the ones ending in parentheses instead of angle
2054 brackets. For example, <tt>Gateway)</tt> would be a network room, <tt>Lobby></tt>
2057 <p>The other point of etiquette to remember is that you should be making
2058 the arrangements in advance, and then set it up. It is extremely rude to
2059 simply begin networking with another Citadel, or unilaterally start sharing
2060 a new room, without first obtaining permission from its operator. Always
2061 ask first. Most Citadel operators are more than happy to network with you.
2062 Also, if later on you decide to take your system down, please take the time
2063 to notify the operators of any other Citadels you network with, so they can
2064 unconfigure their end.</p>
2066 <h3><a name="Getting_ready_to_join_the_network"></a>Getting ready to join
2069 <p>Ok, first things first. On a Citadel room sharing network, the first
2070 thing you need to know is your own system's node name. Presumably you set
2071 this up during installation, but if you want to change it you can do so using
2072 the <tt><b>.A</b>ide <b>S</b>ysconfig <b>G</b>eneral</tt> command:</p>
2074 <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>
2076 <p>The "node name" is important, it's how the network identifies messages
2077 coming from your system. The "human readable node name" is simply a label;
2078 it shows up in messages coming from your system. "Fully qualified domain
2079 name" is your DNS name; it's used for routing messages on the Internet.
2080 In the above example, the node name is "uncnsrd".</p>
2082 <h3><a name="Defining_neighbor_nodes"></a>Defining neighbor nodes</h3>
2084 <p>The next thing you need to do is configure your neighbor node(s). You
2085 need to do this for each node you network with. Let's say you wanted to
2086 talk to a Citadel system called "frobozz". Use the <tt><b>.A</b>ide <b>S</b>ysconfig
2087 <b>N</b>etwork</tt> command:</p>
2089 <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>
2091 <p>As you can see in the above example, you have to enter the Citadel node
2092 name, the DNS name or IP address of the server, and the port number the
2093 Citadel service is running on. The "shared secret" is a password to allow
2094 the two Citadel nodes to connect to each other to exchange network data.
2095 The password must be <i>identical</i> on both ends of the connection --
2096 when the operator of the other Citadel node sets up the connection with
2097 your system, he/she must use the same password.</p>
2099 <h3><a name="Sharing_rooms"></a>Sharing rooms</h3>
2101 <p>Now you're ready to share rooms. You have to do this for each room you
2102 want to share, and you have to do it from BOTH ENDS -- again, when you
2103 share a room with another Citadel, they must share it with you as well.
2104 Let's say you have a room called "Quiche Recipes>" and you want to share
2105 it with the node you set up above. First, edit the room and flag it as a
2108 <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>
2110 <p>Notice how the prompt changed? It was > before, but it's ) now. That
2111 means it's a network room. Now you can tell Citadel that you want to share
2112 the room with frobozz. Enter this command:</p>
2114 <pre>Quiche Recipes) . Aide Network room sharing<br></pre>
2116 <p>Your text editor will pop up (you <i>did</i> configure Citadel to use
2117 your favorite text editor, right?) with a screen that looks like this:</p>
2119 <pre># Configuration for room: Quiche Recipes<br># Nodes with which we share this room<br># Specify one per line.<br></pre>
2121 <p>All you have to do is enter the name of the other Citadel node (i.e. "frobozz"
2122 in our example) on a line by itself. As usual, lines starting with a "#"
2123 are comments. Just go to the end of the file, type "frobozz" (without
2124 the quotes), save the file... and you're done!</p>
2126 <p>At this point, you just sit back and enjoy. Your Citadel and the other
2127 one will begin polling each other at regular intervals (once per hour by
2128 default) and sharing messages.</p>
2130 <h3><a name="Sending_mail"></a>Sending mail</h3>
2132 <p>You can send mail to any user on any node of your Citadel network. It
2133 may take a little while for your system to learn the entire node list, though,
2134 as this is done by watching incoming messages on the network and learning
2135 which nodes are out there.</p>
2137 <p>To send a private message, just enter <tt>user @ host</tt> as the recipient:</p>
2139 <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>
2141 <h3><a name="Changing_the_polling_interval"></a>Changing the polling interval</h3>
2143 <p>As previously mentioned, Citadel will poll other Citadel nodes for messages
2144 once per hour. If this is not an acceptable interval, you can change it
2145 using the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
2146 command. Enter this command and look for the option:</p>
2148 <pre>How often to run network jobs (in seconds) [3600]:<br></pre>
2150 <p>Change it to whatever you like. For example, 15 minutes is 900 seconds.
2151 So if you changed the default value to 900, network polling would occur
2152 every 15 minutes.</p>
2155 <h2 align="center"><a name="Database_maintenance"></a>Database maintenance</h2>
2157 <h3><a name="Introduction_"></a>Introduction</h3>
2158 The data store used by Citadel is reliable and self-maintaining. It
2159 requires very little maintenance. This is primarily due to its use
2160 of the <a href="http://www.sleepycat.com">Berkeley DB</a> record manager.
2161 It is robust, high-performance, and transactional.<br>
2163 A few small data files are kept in your main Citadel directory, but the
2164 databases are in the <tt>data/</tt> subdirectory. The files with names
2165 that begin with "cdb" are the databases themselves; the files with names that
2166 begin with "log" are the journals. Journal files will come and go as
2167 you use your system; when the database engine has determined that a particular
2168 log file is no longer needed, the file will automatically be deleted. Nevertheless,
2169 you should always ensure that there is ample disk space for the files to
2172 There is no need to shut down Citadel during backups. The data store
2173 may be backed up "hot." The makers of Berkeley DB suggest that you should
2174 back up the data files <i>first</i> and the log files <i>second</i>. This
2175 is the only method that will guarantee that a database which is being changed
2176 while you back it up will still be usable when you restore it from the tape
2180 <h3><a name="Database_repair"></a>Database repair</h3>
2181 Although Citadel's data store is quite reliable, database corruption can
2182 occur in rare instances. External factors such as an operating system
2183 crash or an unexpected loss of power might leave the database in an unknown
2184 state. A utility is provided which may be able to repair your database
2185 if this occurs. If you find that your Citadel server is not running,
2186 and reading the logs shows that it is crashing because of an inability to
2187 validate a database, follow these steps:<br>
2190 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from "respawn"
2191 to "off." Type <tt>init q</tt> to make this setting permanent.</li>
2192 <li><b>Make a backup of your data.</b> Either write it out to tape
2193 or copy it to another directory, or a tarball.<br>
2195 <li><tt>cd</tt> to your Citadel directory and type <tt>./database_cleanup.sh</tt></li>
2196 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from "off"
2197 to "respawn". Type <tt>init q</tt> to activate your changes.</li>
2200 If this procedure does not work, you must restore from your most recent
2204 <h3><a name="ImportingExporting_your_Citadel"></a>Importing/Exporting your
2205 Citadel database<br>
2208 <p>Citadel/UX now contains an importer/exporter module, affectionaly known
2209 as the "Art Vandelay" module (a not-so-obscure Seinfeld reference). It
2210 allows you to export the entire contents of your Citadel databases to a
2211 flat file, which may then be imported on another system. (This procedure
2212 is also known as "dump and load" to some database gurus.)</p>
2214 <p>Why would you want to do this? Here are some scenarios: </p>
2217 <li>You are moving a Citadel installation to another computer, which uses
2218 a different CPU. Since Citadel stores data in an architecture-dependent
2219 format, the data files wouldn't work on the new computer as-is. </li>
2220 <li>Your computer crashed, lost power, etc. and you suspect that your
2221 databases have become corrupted. </li>
2222 <li>You want to switch to a different back-end data store. (For example,
2223 from GDBM to Berkeley DB) </li>
2227 <p>So ... how do we work this magic? Follow these steps <i>exactly</i> as
2228 documented and you should be able to do it all with very little trouble.</p>
2231 <li>This should be obvious, but it's still worth mentioning: MAKE SURE
2232 YOU TAKE A BACKUP OF EVERYTHING BEFORE YOU START THIS!! You're performing
2233 a major operation here. Don't risk it. </li>
2234 <li>First, get all the users logged off from your system. Disconnect
2235 it from the network if possible. You don't want anyone logging in while
2236 you're doing this. </li>
2237 <li>Log on as root, or some other user that has read/write access to
2238 all relevant files. </li>
2239 <li>Go to the directory that Citadel is installed in. For example, issue
2240 a command like <tt>cd /usr/local/citadel</tt> </li>
2241 <li>Export the databases with the following command:<br>
2243 <tt>./sendcommand "ARTV export" >exported.dat</tt><br>
2245 This command may run for a while. On a very large system it could take
2246 an hour or more. Please be patient! </li>
2247 <li>When the export completes, check to make sure that <tt>exported.dat</tt>
2248 exists and has some data in it. (Type "ls -l exported.dat") </li>
2249 <li>Shut down the Citadel server. If you have a line in <tt>/etc/inittab</tt>
2250 that reads like this:<br>
2252 <tt>c1:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel</tt>
2254 ...then you should change the <tt>respawn</tt> to <tt>off</tt> and then
2255 type <tt>/sbin/init q</tt> to make the changes take effect. </li>
2256 <li>Now it's time to delete your current binary databases. Type:<br>
2258 <tt>rm -f citadel.config citadel.control data/*</tt> </li>
2259 <li>If you're moving Citadel to another computer, you should move the
2260 <i>entire</i> directory over at this time. <tt>exported.dat</tt> only
2261 contains the information that was in the binary databases. Information which
2262 was stored in portable formats doesn't need to be exported/imported, so you
2263 must bring it all over in its current form. </li>
2264 <li>Now get Citadel running on the new computer (or whatever). Run <tt>setup</tt>
2265 and turn the service back on (from <tt>/etc/inittab</tt>) but DO NOT log
2267 <li>As root, run the import command:<br>
2269 <tt>./sendcommand "ARTV import" <exported.dat</tt><br>
2271 This will import your databases. Again, it may run for a long time.
2273 <li>Restart the Citadel server. You can do this any way you like. From
2274 the command line, you can do it with a command like:<br>
2276 <tt>./sendcommand "DOWN"</tt> <br>
2278 <li>Now you're finished. Log in and test everything. You may delete
2279 exported.dat at this time, or you might want to save it somewhere as a sort
2280 of pseudo-backup. </li>
2285 <center><h2><a name="utilities"></a>Utilities</center></h2>
2287 <h3><a name="overview"></a>Overview</h3>
2289 <P>The following utilities will be discussed:
2291 <LI><b>aidepost</b> - Post standard input to the Aide> room
2292 <LI><b>whobbs</b> - Who is on the system
2293 <LI><b>stats</b> - Print the calling statistics & graph
2294 <LI><b>msgform</b> - Format a binary message to the screen (stdin or in a file)
2295 <LI><b>userlist</b> - Print the userlist
2296 <LI><b>readlog</b> - Read the caller log
2297 <LI><b>sendcommand</b> - Send a server command
2300 <p>It is up to you to decide which utilities should be made accessible only
2301 to system administrators.
2302 It is important that you set the file permissions correctly. All
2303 utilities should have access to the Citadel data files. We will attempt to
2304 address each program individually.</p>
2306 <h3><a name="aidepost"></a>aidepost</h3>
2308 <p>The nature of this program is rather simple. Standard input (stdin) is
2309 converted into a message, filed in the main message store, and posted
2310 in the Aide> room. This is useful for keeping transcripts of system
2311 activity that has to do with Citadel operations.
2312 You might even elect to send all of your system
2313 logs there, too.</p>
2315 <p><tt>aidepost</tt> also accepts the usage <tt>aidepost -rTargetRoom</tt>,
2317 is the name of a room to which you'd like the message to be sent.</p>
2319 <h3><a name="whobbs"></a>whobbs</h3>
2321 <p>This program is similar to the <tt>who</tt> command.
2322 It lists all of the users
2323 who are currently connected to your Citadel server, either locally or across a
2324 network. Unless you're running a standalone system,
2325 <tt>who</tt> and <tt>whobbs</tt> will
2326 probably not have a one-to-one correspondence. Remember that you will see
2327 sessions for SMTP, POP, and IMAP users, as well as users running a
2330 <p>One thing to keep in mind is that the <tt>whobbs</tt> utility
2332 connection to the server. If the server is maxed out,
2333 <tt>whobbs</tt> will still be
2334 able to provide a listing, because it doesn't need to log in to execute the
2335 <tt>RWHO</tt> command. Note that whobbs does not list its own session.</p>
2337 <p>The <tt>whobbs</tt> utility is smart enough
2338 to know when it is being invoked by a
2339 web server as a CGI program. In this situation, it will output its listing as
2340 a nicely formatted web page instead of plain text. This makes it easy to just
2341 put a link to the whobbs binary in your cgi-bin directory, allowing a quick and
2342 easy way for web surfers to see who is online.</p>
2344 <p>Running the <tt><b>W</b>ho is online</tt> command
2345 from the Citadel client does <b>not</b> call this
2346 utility. It has this functionality built in.</p>
2348 <h3><a name="stats"></a>stats</h3>
2350 <p>This program displays
2351 various statistics on the screen based on the calllog file, such as number
2352 of connects, number of logins, number of logouts, number of disconnects,
2353 bad password attempts, etc. All statistics are provided in three figures:
2354 times per call, times per day, and total times.</p>
2356 <p>After this screen appears, you may press return for the next screen. This
2357 is a graphic representation of system usage, broken down into 20 minute
2358 segments of the day. This will show you when your peak usage is.</p>
2360 <p>Press return again and the stats program will list your system's top
2363 <p>The final screen lists the twenty users with the highest post per call
2364 ratios. Unline the other screens, this statistic is extracted from the user
2365 file itself rather than the call log.</p>
2367 <p><tt>stats</tt> may be called with the <tt>-b</tt> option to
2368 run in batch mode. In this case,
2369 it skips all the prompts and just prints everything out in one bulk output.
2370 Or it may be called with the <tt>-p</tt> option to only print the Post-to-Call
2371 ratios and nothing else. These options may be useful for embedding the
2372 output of <tt>stats</tt> in a batch report or a web page.</p>
2374 <p>Nearly all of the statistics displayed by the <tt>stats</tt> utility
2375 are completely wrong.</p>
2377 <h3><a name="msgform"></a>msgform</h3>
2379 <p>The <tt>msgform</tt> utility reads its standard input (stdin) looking for
2380 Citadel messages stored in the internal format used on disk and over the
2381 network, and sends them in a human-readable format to standard output
2382 (stdout). There is no longer much use for this program, but it is included
2385 <h3><a name="userlist"></a>userlist</h3>
2387 <p>This is a program to print the userlist. There are two flags that may be
2388 set when running this program. When called without any arguments,
2389 <tt>userlist</tt> will display all users (except those who have chosen to
2390 be unlisted), their user numbers, times called, messages posted, screen
2391 width, and date of their most recent call.</p>
2393 <p><tt>userlist</tt> is simply the same user listing code that is in the
2394 client, made into a standalone utility for convenience.</p>
2396 <h3><a name="readlog"></a>readlog</h3>
2398 <p>Called without any arguments, <tt>readlog</tt> dumps the contents of the
2399 call log file. This file records all logins to the Citadel server, as
2400 well as some other statistics.</p>
2402 <h3><a name="sendcommand"></a>sendcommand</h3>
2404 <p><tt>sendcommand</tt> will interpret its arguments (except for
2405 <tt>-hDIRNAME</tt>) as a server command, which is sent to the server.
2406 Commands which require textual input will read it from stdin. Commands
2407 which generate textual output will be sent to stdout.</p>
2409 <p>This utility is intended to be used to enable Citadel server commands to
2410 be executed from shell scripts. Review the script called <tt>weekly</tt>
2411 which ships with the Citadel distribution for an example of how this can
2414 <p><b>NOTE:</b> be sure that this utility is not world-executable. It
2415 connects to the server in privileged mode, and therefore could present a
2416 security hole if not properly restricted.</p>
projects / citadel.git / blob