1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <title>Citadel/UX Documentation</title>
6 <meta http-equiv="content-type"
7 content="text/html; charset=ISO-8859-1">
14 <h2>a messaging and collaboration platform for BBS and groupware applications</h2>
15 Copyright ©1987-2003 by the Citadel development team:<br>
18 <table cellpadding="2" cellspacing="2" border="0" align="center">
21 <td valign="top">Clint Adams<br>
23 <td valign="top"><i>portability enhancements<br>
27 <td valign="top">Steven M. Bellovin<br>
29 <td valign="top"><i>author of public domain 'parsedate'
34 <td valign="top">Nathan Bryant<br>
36 <td valign="top"><i>build system, security, database
37 access, and others<br>
41 <td valign="top">Art Cancro<br>
43 <td valign="top"><i>overall system design and lead
48 <td valign="top">Brian Costello<br>
50 <td valign="top"><i>cosmetics, additional commands<br>
54 <td valign="top">Nick Georbit<br>
56 <td valign="top"><i>additional client features<br>
60 <td valign="top">Michael Hampton<br>
62 <td valign="top"><i>client software development<br>
66 <td valign="top">Andru Luvisi<br>
68 <td valign="top"><i>troubleshooting and development
73 <td valign="top">Daniel Malament<br>
75 <td valign="top"><i>string compare function for IMAP
80 <td valign="top">Stu Mark<br>
82 <td valign="top"><i>additional client features, IGnet
87 <td valign="top">Ben Mehlman<br>
89 <td valign="top"><i>additional client features<br>
93 <td valign="top">Ari Samson<br>
95 <td valign="top"><i>assistance with project management<br>
99 <td valign="top">John Walker<br>
101 <td valign="top"><i>author of public domain base64
106 <td valign="top">Steve Williams<br>
108 <td valign="top"><i>documentation<br>
112 <td valign="top">Ethan Young<br>
114 <td valign="top"><i>IGnet protocol design<br>
123 <div align="justify">The entire package is open source; you can redistribute
124 and/or modify it under the terms of the GNU General Public License
125 as published by the Free Software Foundation; either version 2 of the
126 License, or (at your option) any later version.<br>
128 This program is distributed in the hope that it will be useful,
129 but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
130 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
131 License for more details. </div>
133 <div align="justify"><br>
134 For more information, visit either of these locations on
138 <li>The Citadel home page: <a
139 href="http://www.citadel.org">http://www.citadel.org</a></li>
140 <li>UNCENSORED! BBS, the home of Citadel: <a
141 href="http://uncensored.citadel.org">http://uncensored.citadel.org</a></li>
145 <hr width="100%" size="2">
146 <h2 align="center">Table of Contents</h2>
149 <li><a href="#GPL">License</a></li>
150 <li><a href="#Installation">Installation</a></li>
153 <li><a href="#Everything_in_its_place...">Everything in its
155 <li><a href="#The_BBS_Login">Creating a system account for Citadel</a></li>
156 <li><a href="#Bypassing_the_login:_prompt">Bypassing the login:
158 <li><a href="#Compiling_the_programs">Compiling the programs</a></li>
159 <li><a href="#Upgrading">Upgrading</a></li>
160 <li><a href="#The_citadel.rc_file">The citadel.rc file</a></li>
161 <li><a href="#Using_an_external_editor_for_message">Using an
162 external editor for message composition</a></li>
163 <li><a href="#Printing_messages">Printing messages</a></li>
164 <li><a href="#URL_viewing">URL viewing</a></li>
165 <li><a href="#Setup_and_login">Setup and login</a></li>
166 <li><a href="#Configuring_your_host_system_to_start">Configuring
167 your host system to start the service</a></li>
168 <li><a href="#Logging_in_for_the_first_time">Logging in for
169 the first time</a></li>
170 <li><a href="#Welcoming_new_users">Welcoming new users</a></li>
171 <li><a href="#Space_for_adding_your_own_client">Space for adding
172 your own client features (doors)</a></li>
173 <li><a href="#Troubleshooting_and_getting_help">Troubleshooting
174 and getting help</a><br>
178 <li><a href="#sysop">System Administration</a></li>
181 <li><a href="#Overview_">Overview</a></li>
182 <li><a href="#Aide_commands">Aide commands</a></li>
183 <li><a href="#Editing_rooms">Editing rooms</a></li>
184 <li><a href="#File_directories">File directories</a></li>
185 <li><a href="#Creating_and_editing_user_accounts">Creating and
186 editing user accounts</a></li>
187 <li><a href="#Deleting_and_moving_messages">Deleting and moving
189 <li><a href="#Customizing_the_help_files">Customizing the help
191 <li><a href="#Site_configuration">Site configuration</a><br>
195 <li> <a href="#Configuring_Citadel_for_Internet_e-mail">Configuring
196 Citadel for Internet e-mail</a></li>
199 <li><a href="#Introduction">Introduction</a></li>
200 <li><a href="#Basic_site_configuration">Basic site configuration</a></li>
201 <li><a href="#Enabling_the_Internet_mail_protocols">Enabling the
202 Internet mail protocols</a></li>
203 <li><a href="#Hosting_an_Internet_mailing_list">Hosting an Internet
206 <li><a href="#citmail">Using Citadel in conjunction with another
210 <li><a href="#Building_or_joining_a_Citadel_network">Building or
211 joining a Citadel network</a></li>
214 <li><a href="#Overview__">Overview</a></li>
215 <li><a href="#Conventions_and_etiquette_when">Conventions and etiquette
216 when connecting to the public Citadel network</a></li>
217 <li><a href="#Getting_ready_to_join_the_network">Getting ready
218 to join the network</a></li>
219 <li><a href="#Defining_neighbor_nodes">Defining neighbor nodes</a></li>
220 <li><a href="#Sharing_rooms">Sharing rooms</a></li>
221 <li><a href="#Sending_mail">Sending mail</a></li>
222 <li><a href="#Changing_the_polling_interval">Changing the polling
226 <li><a href="#Database_maintenance">Database maintenance</a></li>
229 <li><a href="#Introduction_">Introduction</a></li>
230 <li><a href="#Database_repair">Database repair</a></li>
231 <li><a href="#ImportingExporting_your_Citadel">Importing/Exporting
232 your Citadel database</a><br>
236 <li><a href="#utilities">Included utilities</a></li>
239 <li><a href="#overview">Overview</a></li>
240 <li><a href="#aidepost">aidepost</a></li>
241 <li><a href="#whobbs">whobbs</a></li>
242 <li><a href="#stats">stats</a></li>
243 <li><a href="#msgform">msgform</a></li>
244 <li><a href="#userlist">userlist</a></li>
245 <li><a href="#readlog">readlog</a></li>
246 <li><a href="#sendcommand">sendcommand</a></li>
253 <hr width="100%" size="2"><br>
255 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
259 <p> Version 2, June 1991 </p>
261 <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>
263 <h3 align="justify">Preamble</h3>
265 <div align="justify"> </div>
267 <p align="justify"> The licenses for most software are designed to take
268 away your freedom to share and change it. By contrast, the GNU General
269 Public License is intended to guarantee your freedom to share and change
270 free software--to make sure the software is free for all its users.
271 This General Public License applies to most of the Free Software Foundation's
272 software and to any other program whose authors commit to using it.
273 (Some other Free Software Foundation software is covered by the GNU Library
274 General Public License instead.) You can apply it to your programs, too.
277 <div align="justify"> </div>
279 <p align="justify"> When we speak of free software, we are referring to
280 freedom, not price. Our General Public Licenses are designed to make
281 sure that you have the freedom to distribute copies of free software
282 (and charge for this service if you wish), that you receive source code
283 or can get it if you want it, that you can change the software or use pieces
284 of it in new free programs; and that you know you can do these things.
287 <div align="justify"> </div>
289 <p align="justify"> To protect your rights, we need to make restrictions
290 that forbid anyone to deny you these rights or to ask you to surrender
291 the rights. These restrictions translate to certain responsibilities
292 for you if you distribute copies of the software, or if you modify it.
295 <div align="justify"> </div>
297 <p align="justify"> For example, if you distribute copies of such a program,
298 whether gratis or for a fee, you must give the recipients all the rights
299 that you have. You must make sure that they, too, receive or can get
300 the source code. And you must show them these terms so they know their
303 <div align="justify"> </div>
305 <p align="justify"> We protect your rights with two steps: (1) copyright
306 the software, and (2) offer you this license which gives you legal
307 permission to copy, distribute and/or modify the software. </p>
309 <div align="justify"> </div>
311 <p align="justify"> Also, for each author's protection and ours, we want
312 to make certain that everyone understands that there is no warranty
313 for this free software. If the software is modified by someone else
314 and passed on, we want its recipients to know that what they have is not
315 the original, so that any problems introduced by others will not reflect
316 on the original authors' reputations. </p>
318 <div align="justify"> </div>
320 <p align="justify"> Finally, any free program is threatened constantly by
321 software patents. We wish to avoid the danger that redistributors of a free
322 program will individually obtain patent licenses, in effect making the program
323 proprietary. To prevent this, we have made it clear that any patent must
324 be licensed for everyone's free use or not licensed at all. </p>
326 <div align="justify"> </div>
328 <p align="justify"> The precise terms and conditions for copying, distribution
329 and modification follow. </p>
331 <div align="justify"> </div>
333 <h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
335 <div align="justify"> </div>
337 <p align="justify"> <strong>0.</strong> This License applies to any program
338 or other work which contains a notice placed by the copyright holder
339 saying it may be distributed under the terms of this General Public
340 License. The "Program", below, refers to any such program or work, and
341 a "work based on the Program" means either the Program or any derivative
342 work under copyright law: that is to say, a work containing the Program
343 or a portion of it, either verbatim or with modifications and/or translated
344 into another language. (Hereinafter, translation is included without limitation
345 in the term "modification".) Each licensee is addressed as "you". </p>
347 <p align="justify"> Activities other than copying, distribution and modification
348 are not covered by this License; they are outside its scope. The act
349 of running the Program is not restricted, and the output from the Program
350 is covered only if its contents constitute a work based on the Program
351 (independent of having been made by running the Program). Whether that
352 is true depends on what the Program does. </p>
354 <p align="justify"> <strong>1.</strong> You may copy and distribute verbatim
355 copies of the Program's source code as you receive it, in any medium,
356 provided that you conspicuously and appropriately publish on each copy
357 an appropriate copyright notice and disclaimer of warranty; keep intact
358 all the notices that refer to this License and to the absence of any
359 warranty; and give any other recipients of the Program a copy of this
360 License along with the Program. </p>
362 <p align="justify"> You may charge a fee for the physical act of transferring
363 a copy, and you may at your option offer warranty protection in exchange
366 <p align="justify"> <strong>2.</strong> You may modify your copy or copies
367 of the Program or any portion of it, thus forming a work based on the
368 Program, and copy and distribute such modifications or work under the
369 terms of Section 1 above, provided that you also meet all of these conditions:
372 <p align="justify"> </p>
374 <div align="justify">
376 <li><strong>a)</strong> You must cause the modified
377 files to carry prominent notices stating that you changed the files
378 and the date of any change.
382 <li><strong>b)</strong> You must cause any work that
383 you distribute or publish, that in whole or in part contains
384 or is derived from the Program or any part thereof, to be licensed
385 as a whole at no charge to all third parties under the terms of this
390 <li><strong>c)</strong> If the modified program normally
391 reads commands interactively when run, you must cause it, when
392 started running for such interactive use in the most ordinary way,
393 to print or display an announcement including an appropriate copyright
394 notice and a notice that there is no warranty (or else, saying that
395 you provide a warranty) and that users may redistribute the program
396 under these conditions, and telling the user how to view a copy of
397 this License. (Exception: if the Program itself is interactive but
398 does not normally print such an announcement, your work based on
399 the Program is not required to print an announcement.) </li>
402 These requirements apply to the modified work as a whole.
403 If identifiable sections of that work are not derived from the Program,
404 and can be reasonably considered independent and separate works in
405 themselves, then this License, and its terms, do not apply to those
406 sections when you distribute them as separate works. But when you
407 distribute the same sections as part of a whole which is a work based
408 on the Program, the distribution of the whole must be on the terms of
409 this License, whose permissions for other licensees extend to the entire
410 whole, and thus to each and every part regardless of who wrote it. </div>
412 <p align="justify"> Thus, it is not the intent of this section to claim rights
413 or contest your rights to work written entirely by you; rather, the intent
414 is to exercise the right to control the distribution of derivative or collective
415 works based on the Program. </p>
417 <p align="justify"> In addition, mere aggregation of another work not based
418 on the Program with the Program (or with a work based on the Program)
419 on a volume of a storage or distribution medium does not bring the other
420 work under the scope of this License. </p>
422 <p align="justify"> <strong>3.</strong> You may copy and distribute the
423 Program (or a work based on it, under Section 2) in object code or
424 executable form under the terms of Sections 1 and 2 above provided that
425 you also do one of the following: <!-- we use this doubled UL to get the sub-sections indented, -->
426 <!-- while making the bullets as unobvious as possible. --> </p>
428 <div align="justify">
430 <li><strong>a)</strong> Accompany it with the complete
431 corresponding machine-readable source code, which must be distributed
432 under the terms of Sections 1 and 2 above on a medium customarily
433 used for software interchange; or,
437 <li><strong>b)</strong> Accompany it with a written
438 offer, valid for at least three years, to give any third party,
439 for a charge no more than your cost of physically performing source
440 distribution, a complete machine-readable copy of the corresponding
441 source code, to be distributed under the terms of Sections 1 and
442 2 above on a medium customarily used for software interchange; or,
447 <li><strong>c)</strong> Accompany it with the information
448 you received as to the offer to distribute corresponding source
449 code. (This alternative is allowed only for noncommercial distribution
450 and only if you received the program in object code or executable
451 form with such an offer, in accord with Subsection b above.) </li>
454 The source code for a work means the preferred form of the
455 work for making modifications to it. For an executable work, complete
456 source code means all the source code for all modules it contains, plus
457 any associated interface definition files, plus the scripts used to
458 control compilation and installation of the executable. However, as
459 a special exception, the source code distributed need not include anything
460 that is normally distributed (in either source or binary form) with the
461 major components (compiler, kernel, and so on) of the operating system
462 on which the executable runs, unless that component itself accompanies
463 the executable. </div>
465 <p align="justify"> If distribution of executable or object code is made
466 by offering access to copy from a designated place, then offering equivalent
467 access to copy the source code from the same place counts as distribution
468 of the source code, even though third parties are not compelled to
469 copy the source along with the object code. </p>
471 <p align="justify"> <strong>4.</strong> You may not copy, modify, sublicense,
472 or distribute the Program except as expressly provided under this License.
473 Any attempt otherwise to copy, modify, sublicense or distribute the
474 Program is void, and will automatically terminate your rights under
475 this License. However, parties who have received copies, or rights, from
476 you under this License will not have their licenses terminated so long
477 as such parties remain in full compliance. </p>
479 <p align="justify"> <strong>5.</strong> You are not required to accept
480 this License, since you have not signed it. However, nothing else
481 grants you permission to modify or distribute the Program or its derivative
482 works. These actions are prohibited by law if you do not accept this
483 License. Therefore, by modifying or distributing the Program (or any
484 work based on the Program), you indicate your acceptance of this License
485 to do so, and all its terms and conditions for copying, distributing or modifying
486 the Program or works based on it. </p>
488 <p align="justify"> <strong>6.</strong> Each time you redistribute the Program
489 (or any work based on the Program), the recipient automatically receives a
490 license from the original licensor to copy, distribute or modify the Program
491 subject to these terms and conditions. You may not impose any further
492 restrictions on the recipients' exercise of the rights granted herein.
493 You are not responsible for enforcing compliance by third parties to
496 <p align="justify"> <strong>7.</strong> If, as a consequence of a court
497 judgment or allegation of patent infringement or for any other reason
498 (not limited to patent issues), conditions are imposed on you (whether
499 by court order, agreement or otherwise) that contradict the conditions
500 of this License, they do not excuse you from the conditions of this
501 License. If you cannot distribute so as to satisfy simultaneously your
502 obligations under this License and any other pertinent obligations, then
503 as a consequence you may not distribute the Program at all. For example,
504 if a patent license would not permit royalty-free redistribution of the
505 Program by all those who receive copies directly or indirectly through
506 you, then the only way you could satisfy both it and this License would
507 be to refrain entirely from distribution of the Program. </p>
509 <p align="justify"> If any portion of this section is held invalid or unenforceable
510 under any particular circumstance, the balance of the section is intended
511 to apply and the section as a whole is intended to apply in other circumstances.
514 <p align="justify"> It is not the purpose of this section to induce you to
515 infringe any patents or other property right claims or to contest validity
516 of any such claims; this section has the sole purpose of protecting
517 the integrity of the free software distribution system, which is implemented
518 by public license practices. Many people have made generous contributions
519 to the wide range of software distributed through that system in reliance
520 on consistent application of that system; it is up to the author/donor
521 to decide if he or she is willing to distribute software through any other
522 system and a licensee cannot impose that choice. </p>
524 <p align="justify"> This section is intended to make thoroughly clear what
525 is believed to be a consequence of the rest of this License. </p>
527 <p align="justify"> <strong>8.</strong> If the distribution and/or use of
528 the Program is restricted in certain countries either by patents or by copyrighted
529 interfaces, the original copyright holder who places the Program under this
530 License may add an explicit geographical distribution limitation excluding
531 those countries, so that distribution is permitted only in or among countries
532 not thus excluded. In such case, this License incorporates the limitation
533 as if written in the body of this License. </p>
535 <p align="justify"> <strong>9.</strong> The Free Software Foundation may
536 publish revised and/or new versions of the General Public License from
537 time to time. Such new versions will be similar in spirit to the present
538 version, but may differ in detail to address new problems or concerns.
541 <p align="justify"> Each version is given a distinguishing version number.
542 If the Program specifies a version number of this License which applies
543 to it and "any later version", you have the option of following the
544 terms and conditions either of that version or of any later version published
545 by the Free Software Foundation. If the Program does not specify a version
546 number of this License, you may choose any version ever published by
547 the Free Software Foundation. </p>
549 <p align="justify"> <strong>10.</strong> If you wish to incorporate parts
550 of the Program into other free programs whose distribution conditions
551 are different, write to the author to ask for permission. For software
552 which is copyrighted by the Free Software Foundation, write to the Free
553 Software Foundation; we sometimes make exceptions for this. Our decision
554 will be guided by the two goals of preserving the free status of all
555 derivatives of our free software and of promoting the sharing and reuse
556 of software generally. </p>
558 <p align="justify"><strong>NO WARRANTY</strong></p>
560 <div align="justify"> </div>
562 <p align="justify"> <strong>11.</strong> BECAUSE THE PROGRAM IS LICENSED
563 FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT
564 PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING
565 THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
566 WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
567 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
568 FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE
569 OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU
570 ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. </p>
572 <p align="justify"> <strong>12.</strong> IN NO EVENT UNLESS REQUIRED BY
573 APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
574 ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED
575 ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
576 INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY
577 TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
578 BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
579 OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN
580 IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
583 <p align="justify"> </p>
585 <h3>END OF TERMS AND CONDITIONS</h3>
588 <hr width="100%" size="2"><br>
591 <h2><a name="Installation"></a>Installation</h2>
594 <div align="justify">
597 <p>Citadel/UX is an advanced, multiuser, client/server messaging system suitable
598 for BBS, e-mail, and groupware applications. It is designed to handle the
599 needs of both small dialup systems and large-scale Internet-connected systems.
600 It was originally developed on an Altos system running Xenix, and has been
601 installed and tested on various Unix and Unix-like platforms. The current
602 development environment (and public BBS) is an ordinary Linux system. The
603 current distribution includes: </p>
606 <li>The Citadel/UX server (this is the back end that does all
608 <li>A text-based client program designed with the traditional
609 Citadel "look and feel" (room prompts, dot commands, and the like)
611 <li>Setup programs </li>
612 <li>A set of utilities for system administration and maintenance
614 <li>Documentation </li>
618 <p>Some knowledge of the Unix system is necessary to install and manage the
619 system. It is mandatory that the sysop have "root" access to the operating
620 system. The following are required to install Citadel/UX: </p>
623 <li>A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX)
625 <li>C compiler (<a href="http://gcc.gnu.org/">GCC</a> with
626 <a href="http://www.gnu.org/software/make/make.html">gmake</a> is the
627 recommended build environment) </li>
628 <li>POSIX threads (already present on most systems) </li>
630 <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1
632 <li><a href="http://softwarestudio.org/libical/">libical</a> v0.24 or
633 newer (if you want the calendar service to work)<br>
635 <li>Enough disk space to hold all of the programs and data
640 <p>If you are running Citadel/UX on a Linux system, it is STRONGLY recommended
641 that you run it on a recent distribution (such as <a
642 href="http://www.redhat.com">Red Hat</a> 7.3 or newer). A new-ish distribution
643 will have most or all of the prerequisite tools and libraries already
644 integrated for you.</p>
646 <h3>Now available:</h3>
649 <li>"WebCit", a gateway program to allow full access to Citadel
650 via the World Wide Web. Interactive access through any Web browser.
652 <li>Access to Citadel via <i>any</i> standards-compliant e-mail
653 program, thanks to Citadel's built-in SMTP, POP, and IMAP services.
654 You can use Netscape/Mozilla, Evolution, Eudora, Pine, or even Microsoft
655 VirusSpreader (better known as "Outlook") with Citadel. </li>
659 <h3>Coming soon:</h3>
662 <li>Newer and better GUI-based clients.</li>
666 <h3><a name="Everything_in_its_place..."></a>Everything in its place...</h3>
668 <p>Hopefully you've unpacked the distribution archive into its own directory.
669 This is the directory in which all Citadel files are located and in
670 which all activity will take place. Several subdirectories have already
671 been created during the unpacking process, and others may be created
672 by the software if needed. Make sure you have Berkeley DB installed on
673 your system, and that you have all the development libraries and headers
674 in place so that you can compile against them. If you don't, you can
675 get the latest Berkeley DB at <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
676 If your operating system uses a separate library to support POSIX threads
677 (pthreads), make sure that library is installed as well. This is almost
678 never the case with Linux, but some commercial Unix flavors might need
683 <h3><a name="The_BBS_Login"></a>Creating a system account for Citadel</h3>
685 <p>As with many Unix programs, Citadel wants to run under its own user ID.
686 Unlike other programs, however, this user ID will do double-duty as a public
687 login for your system if you are running a BBS. This account is typically
688 called "bbs" or "citadel" or something to that effect. You will tell Citadel
689 what the user-id of that account is, and when someone logs in under that
690 account, Citadel will prompt for a user name.</p>
692 <p>The Citadel user should have a unique uid. The home directory should be
693 the one your Citadel installation resides in (in this example we will use
694 <tt>/usr/local/citadel</tt>) and the shell should be either "citadel" in
695 that directory, or a script that will start up the citadel client. Example:</p>
697 <pre>bbs::100:1:Citadel Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
699 <p>When you run setup later, you will be required to tell it the username
700 or user ID of the account you created is, so it knows what user to run as.
701 If you create an account called <tt>bbs</tt>, <tt>guest</tt>, or <tt>citadel</tt>,
702 the setup program will automatically pick up the user ID by default.</p>
704 <p>For all other users in /etc/passwd, Citadel will automatically set up
705 an account using the full name (or 'gecos' in Unixspeak) of the user. It'll
706 also ignore any password you supply, because it uses the user's password
707 on the host system. This allows a 'single sign on' type of environment.
708 Note that this does have to be enabled at compile time -- it's the configure
709 option called <tt>--enable-autologin</tt>. Keep in mind that these users
710 can use *either* their Citadel login name or their login name on the host
711 computer, and their password on the host computer.<br>
715 <h3><a name="Bypassing_the_login:_prompt"></a>Bypassing the <tt>login:</tt>
718 <p>If you normally log in to your host system using some method other than
719 telnet (such as ssh), you might want the telnet service to go straight
720 into Citadel, instead of displaying the <tt>login:</tt> prompt first. You
721 can do this by having telnetd start citadel directly instead of <tt>/bin/login</tt>.
722 This is actually very simple to implement; all you need to do is make a
723 simple change to your <tt>inetd</tt> or <tt>xinetd</tt> configuration. Here
724 are some configuration examples.</p>
726 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
727 replacing any existing telnet configuration line already there):</p>
729 <pre>telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel<br></pre>
731 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
732 then simply replace that file with this one):</p>
734 <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>
736 <p>Please make sure you know what you're doing before you install this! If
737 you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
738 then change the directory name accordingly. If you know of any other local
739 peculiarities which need to be observed, edit the above configuration
740 accordingly as well. And, of course, if you're working remotely, make
741 sure you can successfully log in using SSH <b>before</b> you start changing
742 your telnet configuration, otherwise you could lock yourself out of your
743 system (ask any networking specialist about the dangers of "working inband"
744 -- then pull up a chair and get a fresh cup of coffee, because you're going
745 to hear some war stories).<br>
749 <h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
751 <p>You can easily compile the Citadel system with the following commands:</p>
753 <pre>./configure<br>make<br>make install<br></pre>
755 <p>The 'configure' script will generate a Makefile from the Makefile.in,
756 and it will also write the file "sysdep.h" to your Citadel directory. Please
757 do not edit sysdep.h or Makefile.in yourself. The configure script will
758 figure out your system dependencies and set everything correctly.</p>
760 <p>Mac OS X 10.1 and later are now supported. (Sorry, 10.0 cannot be supported,
761 now or in the future.) You need to install the Developer Tools CD, which
762 you can purchase or download for free from <a
763 href="http://developer.apple.com">http://developer.apple.com</a>. Then run
764 configure like this:</p>
766 <pre>env CC=/usr/bin/cc ./configure (options - see below)<br></pre>
768 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
769 If you wish to place it in a different directory, you can instead do:</p>
771 <pre>./configure --prefix=/export/home/citadel (or whatever)<br></pre>
773 <p>If you've got Berkeley DB installed in a non-standard location, you can
774 help the configure script find it by doing something like this:</p>
776 <pre>./configure --with-db=/usr/local/BerkeleyDB-4.1<br></pre>
778 <p>The configure script prefers Berkeley DB if it is available, but will fall
779 back to GDBM if it has to.</p>
781 <p>File permissions are always a bother to work with. You don't want Citadel
782 to crash because someone couldn't access a file, but you also don't want
783 shell users peeking into the binaries to do things like reading others'
784 mail, finding private rooms, etc. The Citadel server needs to be started
785 as root in order to bind to privileged ports, but as soon as its initialization
786 is finished, it changes its user ID to your Citadel user in order to avoid
789 <h3><a name="Upgrading"></a>Upgrading</h3>
791 <p>Any existing Citadel installation which is at version 5.50 or newer may
792 be upgraded in place without the need to discard your existing data files.</p>
794 <p>Upgrading to a new version uses the same build procedure as compiling
795 the program for a fresh install, except that you want to do <tt>make install-exec</tt>
796 instead of <tt>make install</tt>. This will overwrite the programs but
797 not your data. <b>Be sure to shut down citserver during this process!</b>
798 If Citadel is running while you upgrade, you may face data corruption
802 <p>After doing <tt>make install-exec</tt>, you should run <tt>setup</tt>
803 again to bring your data files up to date. Please see the setup section
804 below for more information on this.</p>
806 <h3><a name="The_citadel.rc_file"></a>The <tt>citadel.rc</tt> file</h3>
808 <p>The text-based client included with Citadel is suitable for BBS applications.
809 Much of its command set and other behavior is configurable through a Run
810 Control (RC) file. The standard client looks for this file in the following
814 <li><tt>$HOME/.citadelrc</tt></li>
815 <li><tt>/usr/local/lib/citadel.rc</tt></li>
816 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
819 The next couple of sections deal with client-side configuration.
821 <h3><a name="Using_an_external_editor_for_message"></a>Using an external editor
822 for message composition</h3>
824 <p>Citadel/UX has a built-in message editor. However, you can also use your
825 favorite text editor to write messages. To do this you simply put a line
826 in your citadel.rc file like this:</p>
828 <pre>editor=/usr/bin/vi<br></pre>
830 <p>The above example would make Citadel call the vi editor when using the
831 <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make it the
832 default editor for the <tt><b>E</b>nter</tt> command by editing the <tt>citadel.rc</tt>
833 file. <b>But be warned:</b> external editors on public systems can
834 be a security hole, because they usually provide users with the ability
835 to drop into a shell on the host system, or save files using names other
836 than the name of the temporary file they are editing. If you intend to
837 use an external editor on a public BBS, make sure you use one that has been
838 hardened for such a purpose -- one which has had the 'shell' and 'save as'
839 commands disabled, as well as any other functions which a destructive
840 user could use to gain unauthorized access to your host system.</p>
842 <h3><a name="Printing_messages"></a>Printing messages</h3>
844 <p>Citadel/UX can send messages to a printer, or just about anywhere else
845 in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt>
846 specifies what command you use to print. Text is sent to the standard
847 input (stdin) of the print command.</p>
849 <p>So if you did this:</p>
851 <pre>printcmd="nl|pr|lpr -Plocal"<br></pre>
853 <p>...that would add line numbers, then paginate, then print on the printer
854 named "local". There's tons of stuff you can do with this feature. For
855 example, you could use a command like <tt>cat <<$HOME/archive</tt>
856 to save copies of important messages in a textfile. Again, this is probably
857 something you don't want to configure for a public BBS host -- most system
858 administrators don't want remote users sending arbitrary things to local
861 <h3><a name="URL_viewing"></a>URL viewing</h3>
863 <p>This is one more feature which is appropriate for local users. While reading
864 a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
865 command, and it will perform some pre-defined action (usually, this is
866 to open up the URL in a web browser). For example:</p>
868 <pre>urlcmd=netscape -remote "openURL(%s)"<br></pre>
870 <p>In the above example, it would open up the URL in an open <a
871 href="http://www.netscape.com/download">Netscape</a> window.<br>
875 <h3><a name="Setup_and_login"></a>Setup and login</h3>
877 <p>Before logging in for the first time, you must run the setup program.
878 To begin this procedure, enter the following commands:</p>
880 <pre>cd /usr/local/citadel<br>./setup<br></pre>
882 <p>The setup program will guide you through a simple configuration procedure.
883 It will ask you what directory to place your data files in -- the default
884 is the current directory, which is usually the sensible thing to select.
885 If you want to run more than one instance of Citadel on the same host,
886 however, you can specify a different directory here -- just remember to
887 specify the directory name again when you start up the server later on.</p>
889 <p><tt>setup</tt> will then shut down the Citadel service if it is found to
892 <p>You will then be prompted for the name of the system administrator. This
893 is not merely a cosmetic option -- when you log in to your system a little
894 while from now, you'll log in with this name, and it will automatically
895 assign your account the highest access level.</p>
897 <p>Next, you will be prompted for the User ID of the Citadel account on your
898 host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
899 or <tt>citadel</tt>, that account's UID will be the default. If you
900 are upgrading or reconfiguring an existing system, the existing value
901 will be preserved.</p>
903 <p>Then you will be prompted for a server port number. This is the TCP port
904 which Citadel clients use to connect to your Citadel server. In almost
905 all cases, you want to use the default -- port 504, which is the official
906 port number assigned by the IANA for Citadel implementations.</p>
908 <p>The Citadel service will then be started, and you will see the following
911 <pre>Setup is finished. You may now log in.<br></pre>
913 <p>Setup is now complete, on most systems, anyway. Please see below to find
914 out if you need to do anything else:</p>
916 <h3><a name="Configuring_your_host_system_to_start"></a>Configuring your host
917 system to start the service</h3>
919 <p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
920 and <tt>/etc/inittab</tt> in order to configure your host system to automatically
921 start the Citadel service. <tt>setup</tt> will automatically perform
922 these steps if it can, and if you allow it to -- just answer 'Yes' when
923 prompted, and everything will be taken care of for you. If you answer
924 'No' -- or if your system is a little bit odd (for example, BSD systems
925 don't have <tt>/etc/inittab</tt>) -- read this section and do what you need
926 to in order to get things configured.</p>
928 <p>Before you can use Citadel, you must define the "citadel" service to your
929 system. This is accomplished by adding a line to your /etc/services
930 file that looks something like this:</p>
932 <pre>citadel 504/tcp # Citadel/UX Server<br></pre>
934 <p>504 is the port number officially designated by the IANA for use by Citadel.
935 There should not be any need to use a different port number, unless you
936 are running multiple Citadels on the same computer and therefore need
937 a different port for each one.</p>
939 <p>The next step is to arrange for the server to start. The <tt>citserver</tt>
940 program is the main Citadel server. Before we cover the recommended
941 method of starting the server, let's examine its usage options:</p>
943 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-d] [-f]<br></pre>
945 <p>The options are as follows:</p>
947 <p><tt>-hHomeDir</tt> - the directory your Citadel data files live in. This
948 should, of course, be a directory that you've run the <tt>setup</tt> program
949 against to set up some data files. If a directory is not specified, the directory
950 name which was specified in the <tt>Makefile</tt> will be used.</p>
952 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed. The
953 available debugging levels are: </p>
956 <li>1 - Internal errors (failed thread creation, malloc problems,
958 <li>2 - Network errors (broken sockets, failed socket creation)
960 <li>3 - Begin and end of sessions, startup/shutdown of server
962 <li>5 - Server commands being sent from clients </li>
963 <li>7 - Entry and exit of various functions </li>
964 <li>9 - Various debugging checkpoints (insanely verbose) </li>
968 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace output.
969 Normally it is sent to stdout.</p>
971 <p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch would
972 be necessary if you were starting the Citadel server, for example, from
973 an rc.local script (which is not recommended, because this won't allow
974 the server to automatically restart when it is shut down).</p>
976 <p><tt>-f</tt> - Defragment all the databases upon startup. This currently
977 has no effect, as it is a vestige from the old data store.</p>
979 <p>The preferred method of starting the Citadel server is to place an entry
980 in your /etc/inittab file. This will conveniently bring the server up
981 when your system is up, and terminate it gracefully when your system is
982 shutting down. The exact syntax for your system may vary, but here's
983 an entry that could be used on a Linux system:</p>
985 <pre>cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x3<br></pre>
987 <p>In this example, we've chosen debugging level 3, and have the trace stuff
988 output to one of the virtual consoles. It's important to remember to
989 turn off any getty that is set up on that virtual console, if you do this.
990 After making this change, the command <tt>init q</tt> works on most systems
991 to tell init to re-read the file. If in doubt, just reboot the computer.<br>
995 <h3><a name="Logging_in_for_the_first_time"></a>Logging in for the first time</h3>
997 <p>At this point, your system is ready to run. Run the <tt>citadel</tt> program
998 from the shell and log in as a new user. NOTE: the first user account
999 to be created will automatically be set to access level 6 (Aide). This
1000 overcomes some obvious logistical problems - normally, Aide access is given
1001 by another Aide, but since there aren't any on your system yet, this isn't
1006 <h3><a name="Welcoming_new_users"></a>Welcoming new users</h3>
1008 <p>Sometimes you might decide that you want a welcome message (or several
1009 different messages) automatically mailed to new users upon their first
1010 login. Now there is a way to do this. If you create a room called <tt>New
1011 User Greetings</tt>, and it is a <i>private</i> room (invitation-only probably
1012 makes the most sense), any messages you enter into that room will automatically
1013 be delivered to all new users upon registration.</p>
1015 <p>You can put anything you want there: a welcome message, system policies,
1016 special information, etc. You can also put as many messages there as
1017 you want to (although it really doesn't make sense to clutter new users'
1018 mailboxes with lots of junk).</p>
1020 <p>Don't worry about wasting disk space, either. Citadel has a single-instance
1021 message store, so all the new users are actually looking at the same
1022 copy of the message on disk.<br>
1026 <h3><a name="Space_for_adding_your_own_client"></a>Space for adding your own
1027 client features (doors)</h3>
1029 <p><b>Please take note!</b> This function really represents the "old" way
1030 of doing things, and it doesn't fit in well with the client/server paradigm.
1031 Please consider it "deprecated" because it may be removed someday.</p>
1033 <p>The "doorway" feature is just a generic way to add features to the system.
1034 It is called "Doorway" to make it resemble the doors on non-Unix boards,
1035 but as we all know, us Unix types don't have to write special code to access
1036 the modem. :-) Anyway, when a user hits the <tt><b>*</b></tt> (doorway)
1037 command, Citadel does...</p>
1039 <pre>USERNAME=(username); export USERNAME<br>./subsystem (user-number) (screen-width) (access level)<br></pre>
1041 <p>...so you can put whatever you want in there. I suggest putting in a menu
1042 program to allow the users to pick one of a number of programs, etc. Do
1043 be aware that door programs will only be available when the client and server
1044 programs are running on the <i>same</i> computer, and when the user is running
1045 the text-mode client. Because of these restrictions, Door programs are being
1046 utilized less and less every day.<br>
1050 <h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and getting
1053 <p>That's just about all the information you need to install the system.
1054 But if you get stuck, you can visit <a
1055 href="http://uncensored.citadel.org">UNCENSORED! BBS</a> and report a problem
1056 or ask for help. But if you intend to report a problem getting the Citadel
1057 server to run, <i>please</i> double-check the following things first: </p>
1060 <li>Did you do <tt>./configure && make && make
1061 install</tt> ?? </li>
1062 <li>Did you run setup? </li>
1063 <li>Did you start the server? </li>
1067 <p>To report a problem, you can log on to <a
1068 href="http://uncensored.citadel.org">UNCENSORED!</a> or any other BBS on
1069 the Citadel network which carries the <tt>Citadel/UX></tt> room. Please
1070 DO NOT e-mail the developers directly. Post a request for help on the
1071 BBS, with all of the following information: </p>
1074 <li>The exact nature of your difficulty </li>
1075 <li>A transcript of the error message(s) if possible </li>
1076 <li>The version of Citadel you are running </li>
1077 <li>The version of Berkeley DB present on your system </li>
1078 <li>Which operating system you are running, and what version
1080 <li>If you are running a Linux system, we need to know which
1081 distribution, and the version of the kernel, libc, and pthreads you
1082 are using (it would help to post the output of a <tt>ldd ./citserver</tt>
1088 <div align="center">
1089 <hr width="100%" size="2">
1090 <h2><a name="sysop"></a>System Administration</h2>
1093 <div align="justify">
1094 <h3><a name="Overview_"></a>Overview</h3>
1096 <p>Citadel/UX, when installed properly, will do most of its maintenance by
1097 itself. It is intended to be run unattended for extended periods of
1098 time, and most installations do just that without any software failures.</p>
1100 <p>The system has seven access levels. Most users are at the bottom and have
1101 no special privileges. Aides are selected people who have special access within
1102 the Citadel program. Room Aides only have this access in a certain room.
1103 Preferred users can be selected by Aides for access to preferred only rooms.
1104 A sysop is anyone who has access to the various sysop utilities - these
1105 are in their own executable files, which should have their permissions set
1106 to allow only sysops to run them. You should either create a sysops group
1107 in /etc/group, or use some other existing group for this purpose.</p>
1109 <p>Aides have access to EVERY room on the system, public and private (all
1110 types). They also have access to commands starting with <tt>.<b>A</b>ide</tt>
1111 in addition to being able to delete and move messages. The system room,
1112 <tt>Aide></tt>, is accessible only by those users designated as Aides.</p>
1114 <h3><a name="Aide_commands"></a>Aide commands</h3>
1116 <p>Aides have the following commands available to them that are not available
1117 to normal users. They are:</p>
1122 <td width="30%"><tt> .<b>A</b>ide <b>K</b>ill this room </tt></td>
1123 <td> Deletes the current room from the system. </td>
1126 <td width="30%"><tt> .<b>A</b>ide <b>E</b>dit this room </tt></td>
1127 <td> Allows editing of the properties of the current room.
1128 This is explained in greater detail below. </td>
1131 <td width="30%"><tt> .<b>A</b>ide <b>W</b>ho knows room </tt></td>
1132 <td> For private rooms with access controls, or mailbox rooms,
1133 this command displays a list of users who have access to the current room.
1137 <td width="30%"><tt> .<b>A</b>ide edit <b>U</b>ser </tt></td>
1138 <td> Allows editing of the properties of any user account
1139 on the system. </td>
1142 <td width="30%"><tt> .<b>A</b>ide <b>V</b>alidate new users
1144 <td> For public access systems, this command reviews all new
1145 user registrations and allows you to set each new user's access level
1146 (or simply delete the accounts). </td>
1149 <td width="30%"><tt> .<b>A</b>ide enter <b>I</b>nfo file </tt></td>
1150 <td> Each room may contain a short textual description of
1151 its purpose, which is displayed to users upon entering the room for the
1152 first time (or in the room banner, for users of the Web client). This
1153 command allows you to enter or edit that description. </td>
1156 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite
1158 <td> Access control command to grant any specific user access
1159 to a private room. </td>
1162 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick
1164 <td> Access control command to revoke any specifc user's access
1165 to the current room. This works regardless of whether the room is public
1169 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>D</b>elete
1171 <td> If the current room has an associated file directory,
1172 this command may be used to delete files from it. </td>
1175 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end
1177 <td> If the current room has an associated file directory,
1178 this command may be used to transmit a copy of any file in that directory
1179 to another node on a Citadel network. </td>
1182 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>M</b>ove
1184 <td> If the current room has an associated file directory,
1185 this command may be used to move any file in that directory to another
1186 room. The target room must also have an associated file directory. </td>
1189 <td width="30%"><tt> .<b>A</b>ide <b>M</b>essage edit </tt></td>
1190 <td> This command allows editing of any of the various system
1191 banners and messages which are displayed to users. Type the name of
1192 the banner or message you wish to edit. </td>
1195 <td width="30%"><tt> .<b>A</b>ide <b>P</b>ost </tt></td>
1196 <td> This is the functional equivalent of the <tt><b>E</b>nter
1197 message</tt> command available to all users, except that it allows you
1198 to post using any user name. </td>
1201 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1202 <b>G</b>eneral </tt></td>
1203 <td> This command allows configuration of a large number of
1204 global settings for your Citadel system. These settings will be explained
1205 in greater detail below. </td>
1208 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1209 <b>I</b>nternet </tt></td>
1210 <td> This command allows configuration of settings which affect
1211 how your Citadel system sends and receives messages on the Internet.
1215 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1216 check <b>M</b>essage base </tt></td>
1217 <td> Perform a consistency check on your message store. This
1218 is a very time-consuming operation which should not be performed unless
1219 you have reason to believe there is trouble with your database. </td>
1222 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1223 <b>N</b>etwork </tt></td>
1224 <td> Configure networking (e-mail, room sharing, etc.) with
1225 other Citadel nodes. </td>
1228 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1229 network <b>F</b>ilter list </tt></td>
1230 <td> If you are on a large public or semi-public network of
1231 Citadel nodes and you find content from certain systems or individuals
1232 objectionable, you can use this command to define a rule set to automatically
1233 reject those messages when they arrive on your system. </td>
1236 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server
1237 <b>N</b>ow </tt></td>
1238 <td> Immediately shut down the Citadel service, disconnecting
1239 any users who are logged in. Please keep in mind that it will start
1240 right back up again if you are running the service from <tt>/etc/inittab</tt>,
1241 so in practice this command will probably not get much use. </td>
1244 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server
1245 <b>S</b>cheduled </tt></td>
1246 <td> Shut down the Citadel service the next time there are
1247 zero users connected. This allows you to automatically wait until all users
1248 are logged out. </td>
1251 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients
1253 <td> Any room may be made into a mailing list. Enter this
1254 command to open an editor window containing the list of Internet e-mail
1255 addresses to which every message posted in the room will be sent. </td>
1258 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest
1259 recipients </tt></td>
1260 <td> Similar to the regular mailing list command, except the
1261 messages will be sent out in 'digest' form -- recipients will see messages
1262 from the address of the room itself rather than the address of the author
1263 of each message, and a digest may contain more than one message. Each room
1264 may have any combination of List and Digest recipients. </td>
1267 <td width="30%"><tt> .<b>A</b>ide <b>N</b>etwork room sharing
1269 <td> Configures the sharing of the current room's contents
1270 with other Citadel nodes. Messages posted in this room on any Citadel
1271 system will automatically be replicated to other Citadel systems carrying
1280 <h3><a name="Editing_rooms"></a>Editing rooms</h3>
1282 <p>This command allows any aide to change the parameters of a room. Go to
1283 the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit
1284 room</tt> command. A series of prompts will be displayed. The existing
1285 parameters will be displayed in brackets; simply press return if you want
1286 to leave any or all of them unchanged.</p>
1288 <pre> <br>Room name [IG's Fun Room]:<br></pre>
1290 <p>...the name of the room.</p>
1292 <pre>Private room [Yes]? <br></pre>
1294 <p>...enter Yes if you wish to restrict access to the room, or no if the room
1295 is to be accessible by all users. Note that Citadel doesn't bother users
1296 about access to rooms every time they need to access the room. Once a user
1297 gains access to a private room, it then behaves like a public room to them.
1298 The following four questions will only be asked if you selected Private...</p>
1300 <pre>Accessible by guessing room name [No]?<br></pre>
1302 <p>...if you enter Yes, the room will not show up in users' <tt><b>K</b>nown
1303 rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing
1304 the room's full name), they will gain access to the room.</p>
1306 <pre>Accessible by entering a password [No]?<br>Room password [mypasswd]: <br></pre>
1308 <p>...this adds an additional layer of security to the room, prompting users
1309 for a password before they can gain access to the room.</p>
1311 <p>If you did not select guessname or passworded, then the only way users
1312 can access the room is if an Aide explicitly invites them to the room
1313 using the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt> command.</p>
1315 <pre>Cause current users to forget room [No] ? No<br></pre>
1317 <p>Enter Yes if you wish to kick out anyone who currently has access to the
1320 <pre>Preferred users only [No]? No<br></pre>
1322 <p>Enter Yes if you wish to restrict the room to only users who have level
1323 5 (Preferred User) status (and Aides too, of course). You should make
1324 the room public if you intend to do this, otherwise the two restrictions
1325 will be COMBINED.</p>
1327 <pre>Read-only room [No]? No<br></pre>
1329 <p>If you set a room to Read-Only, then normal users will not be allowed to
1330 post messages in it. Messages may only be posted by Aides, and by utility
1331 programs such as the networker and the "aidepost" utility. This is
1332 useful in situations where a room is used exclusively for important
1333 announcements, or if you've set up a room to receive an Internet mailing
1334 list and posting wouldn't make sense. Other uses will, of course, become
1335 apparent as the need arises.</p>
1337 <p>Now for a few other attributes...</p>
1339 <pre>Directory room [Yes]? Yes<br></pre>
1341 <p>...enter Yes if you wish to associate a directory with this room. This
1342 can be used as a small file repository for files relevant to the topic
1343 of the room. If you enter Yes, you will also be prompted with the following
1346 <pre>Directory name [mydirname]: <br></pre>
1348 <p>...the name of the subdirectory to put this room's files in. The name
1349 of the directory created will be <tt><i><your Citadel directory></i>/files/<i><room
1350 dir name></i></tt>.</p>
1352 <pre>Uploading allowed [Yes]? Yes<br></pre>
1354 <p>...enter Yes if users are allowed to upload to this room.</p>
1356 <pre>Downloading allowed [Yes]? Yes<br></pre>
1358 <p>...enter Yes if users are allowed to download from this room.</p>
1360 <pre>Visible directory [Yes]? Yes<br></pre>
1362 <p>...enter Yes if users can read the directory of this room.</p>
1364 <pre>Network shared room [No]? No<br></pre>
1366 <p>...you can share a room over a network without setting this flag, and
1367 vice versa, but what this flag does is twofold: </p>
1370 <li>It prevents people with no network access from entering messages
1372 <li>Messages are displayed with the name of their originating
1373 system in the header. </li>
1377 <pre>Permanent room [No]? No<br></pre>
1379 <p>Citadel contains an 'auto purger' which is capable of removing rooms which
1380 have not been posted in for a pre-defined period of time (by default
1381 this is set to two weeks). If you wish to keep this from happening to
1382 a particular room, you can set this option. (Keep in mind that <tt>Lobby></tt>,
1383 <tt>Aide></tt>, any private mailbox rooms, any network shared rooms,
1384 and any rooms with a file directory are automatically permanent.)</p>
1386 <pre>Anonymous messages [No]? No<br>Ask users whether to make messages anonymous [No]? No<br></pre>
1388 <p>...you can have rooms in which all messages are automatically anonymous,
1389 and you can have rooms in which users are prompted whether to make a
1390 message anonymous when they enter it. The real identity of the author
1391 of each message is still revealed to the Room Aide for this room, as well
1392 as any system-wide Aides.</p>
1394 <pre>Room aide [Joe Responsible]: <br></pre>
1396 <p>...on larger systems, it helps to designate a person to be responsible
1397 for a room. Room Aides have access to a restricted set of Aide commands,
1398 ONLY when they are in the room in which they have this privilege. They
1399 can edit the room, delete the room, delete and move messages, and invite
1400 or kick out users (if it is a private room), but they cannot perform aide
1401 commands that are not room-related (such as changing users access levels).</p>
1403 <pre>Listing order [64]: <br></pre>
1405 <p>This is just a simple way to try to control the order rooms are listed
1406 in when users call up a <tt><b>K</b>nown Rooms</tt> listing. Rooms with
1407 a lower listing order are displayed prior to rooms with a higher listing
1408 order. It has no other effect. For users who list rooms in floor order,
1409 the display will sort first by floor, then by listing order.</p>
1411 <pre>Message expire policy (? for list) [0]:<br></pre>
1413 <p>This provides you with the opportunity to select how long each message
1414 will remain in a room before automatically being deleted. Press <tt><b>?</b></tt>
1415 for a list of options. You can choose to keep messages around forever
1416 (or until they are manually deleted), until they become a certain number
1417 of days old, or until a certain number of additional messages are posted
1418 in the room, at which time the oldest ones will scroll out.</p>
1420 <p>You will notice that you can also fall back to the default expire policy
1421 for the floor upon which the room resides. This is the default setting.
1422 You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit
1423 floor</tt> command. The default setting for the floor default, in turn,
1424 is the system default setting, which can be changed using the <tt><b>.A</b>ide
1425 <b>S</b>ystem configuration <b>G</b>eneral</tt> command.</p>
1427 <pre>Save changes (y/n)? Yes<br></pre>
1429 <p>...this gives you an opportunity to back out, if you feel you really messed
1430 things up while editing.<br>
1434 <h3><a name="File_directories"></a>File directories</h3>
1436 <p>If you have created any directory rooms, you can attach file descriptions
1437 to the filenames through a special file called <tt>filedir</tt>. Each
1438 line contains the name of a file in the directory, followed by a space
1439 and then a description of the file, such as:</p>
1441 <pre>myfile.txt This is a description of my file.<br>phluff A phile phull of phluff!<br></pre>
1443 <p>...this would create file descriptions for the files <tt>myfile.txt</tt>
1444 and <tt>phluff</tt> which would be displayed along with the directory.
1445 It should also be noted that when users upload files to your system, they
1446 will be prompted for file descriptions, which will be added to the <tt>filedir</tt>
1447 file. If one does not exist, it will be created.<br>
1451 <h3><a name="Creating_and_editing_user_accounts"></a>Creating and editing
1454 <p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1455 command to create and/or edit user accounts. There are several parameters
1456 which can be set here.</p>
1458 <p>To create a user:</p>
1460 <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>
1462 <p>At this point, the new user account has been created, and the command will
1463 continue as if you were editing an existing account. Therefore the remainder
1464 of this procedure is the same for creating and editing:</p>
1466 <pre>Lobby> . Aide edit User <br>User name: person of significance<br>User #70 - Person of Significance PW: <br><br>,<br><br>Current access level: 4 (Network User)<br></pre>
1468 <p>The blank lines are the user's 'registration' information -- personal
1469 information such as full name, address, telephone number, etc. This information
1470 will comprise the user's vCard in both their user profile and in the Global
1473 <pre>Change password [No]: No<br></pre>
1475 <p>...answer Yes to set or change the password for this account.</p>
1477 <pre>Access level [4]: <br></pre>
1479 <p>...this allows you to set or change the access level for this account.
1480 The access levels available are as follows: </p>
1483 <li>0 - Deleted. (This immediately deletes the account.) </li>
1484 <li>1 - New, unvalidated user </li>
1485 <li>2 - Problem user (severely restricts account - use for probationary
1487 <li>3 - User with no network privileges. Same access as a normal
1488 user except cannot post messages in rooms shared on a network. </li>
1489 <li>4 - Normal user </li>
1490 <li>5 - Preferred user (access is granted to privileged rooms)
1492 <li>6 - Aide (administrative access to the whole system) </li>
1496 <pre>Permission to send/receive Internet mail [ No]? No<br></pre>
1498 <p>If your system is configured to only allow Internet mail privileges to
1499 certain users, this is where you can grant or revoke that privilege.</p>
1501 <pre>Ask user to register again [Yes]: Yes<br></pre>
1503 <p>If you answer Yes to this question, the user will be presented with a
1504 'registration' screen or set of prompts, the next time they log in using
1505 a Citadel client. This will prompt them for their full name, address, telephone
1508 <pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1510 <p>These statistics are available for informational purposes only, so there
1511 is normally no need to change them.</p>
1513 <pre>Set last call to now [No]: No<br>Purge time (in days, 0 for system default [0]: <br></pre>
1515 <p>Citadel contains an auto-purger which is capable of automatically deleting
1516 accounts which have not been accessed in a predefined period of time.
1517 If you choose to perform this operation, you can 'touch' the account
1518 of a wayward user by setting their 'last call' time to 'now'. You can
1519 also adjust, on a per-user basis, the amount of time which must pass before
1520 their account is purged by the system. This time is set in days. You
1521 can also specify 0 days to indicate that you wish to use the system default
1526 <h3><a name="Deleting_and_moving_messages"></a>Deleting and moving messages</h3>
1528 <p>Aides and Room Aides have the ability to delete and move messages. After
1529 each message, the normal prompt appears:</p>
1531 <pre>(8) <B>ack <A>gain <Q>uote <R>eply <N>ext <S>top m<Y> next <?>help -><br></pre>
1533 <p>Entering <tt><b>D</b>elete</tt> will delete the message. A <tt>(y/n)</tt>
1534 prompt will appear to confirm that you really want to delete the message.
1535 Entering <tt><b>M</b>ove</tt> will prompt for a room to which the message
1536 should be moved.<br>
1540 <h3><a name="Customizing_the_help_files"></a>Customizing the help files</h3>
1542 <p>The subdirectory called <tt>help</tt> contains your system's help files.
1543 There's nothing hard-coded into the system that dictates what files
1544 should be there. Whenever a user types the command <tt><b>.H</b>elp</tt>
1545 followed by the name of a help file, it displays the contents of that
1548 <p>The help files that come with the system, of course, are enough to guide
1549 a user through its operation. But you can add, change, or remove help
1550 files to suit whatever is appropriate for your system.</p>
1552 <p>There are several strings that you can put in help files that will be automatically
1553 substituted with other strings. They are:</p>
1555 <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 software you're running<br> ^bbsdir = The directory on the host system in which you have<br> installed the Citadel system.<br></pre>
1557 <p>So, for example, you could create a help file which looked like:</p>
1559 <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><br></pre>
1561 <h3><a name="Site_configuration"></a>Site configuration</h3>
1563 <p>Once your Citadel server is up and running, the first thing you'll want
1564 to do is customize and tune it. This can be done from the text-based
1565 client with the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1566 command, or from WebCit (if you have it installed) by clicking 'Advanced
1567 Options' followed by 'Edit site-wide configuration.' Either method will
1568 offer the same configuration options. This document shows the text mode
1569 client being used.</p>
1571 <p>The first set of options deal with the identification of your system.</p>
1573 <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
1574 !="" more="" text="" on="" the="" next="" screen="">]: <br></jinkies></pre>
1576 <p>'Node name' refers to the short, unqualified node name by which your system
1577 is known on a Citadel network. Generally it will be the same as the unqualified
1578 host name of your computer; this is, in fact, the default setting.</p>
1580 <p>Then enter the fully-qualified domain name (FQDN) of your system. If you
1581 are not on the Internet, you can simply set it to the same as your unqualified
1582 host name. Otherwise you should set this value to the host name by which
1583 your system is most commonly known.</p>
1585 <p>The field called 'Human-readable node name' (also known as the 'node title'
1586 or 'organization name' in other software) is used solely for display purposes.
1587 Set it to the actual name of your system as you want it to appear in
1588 banners, messages, etc.</p>
1590 <p>If you have a modem or bank of modems answering data calls for your system,
1591 enter it in the field marked 'Modem dialup number.' Otherwise you may
1594 <p>'Geographic location of this system' is another display field. Enter a
1595 city and state, or city and country. </p>
1597 <p>'Name of system administrator' is important! Any user who logs on with
1598 the name you enter here will automatically be granted Aide privileges.
1599 This is one of two ways for the system administrator to grant himself/herself
1600 Aide access to the system when initially setting it up. (The other is
1601 simply to have the first account created on a new installation.)</p>
1603 <p>The next set of options are your system's security settings. Before delving
1604 into the actual options, we should review the various access levels available
1605 on the system. Citadel has seven access levels:</p>
1608 <li>0 (Deleted). A user whose access level is set to 0 will automatically
1609 be deleted by the system. </li>
1610 <li>1 (New User). Users at this level may only read messages.
1611 Entering messages is prohibited, except in the <tt>Mail></tt> room,
1612 where a message to 'sysop' may be entered. </li>
1613 <li>2 (Problem User). Also known as 'Twit.' </li>
1614 <li>3 (Local User). May enter messages, except in rooms shared
1615 on a Citadel network. </li>
1616 <li>4 (Network User). May enter messages in every accessible
1618 <li>5 (Preferred User). Use of this level is up to the whim of
1619 the system administrator. </li>
1620 <li>6 (Aide). Access is granted to the administrative functions
1621 of the system. (This access level may also be granted to a user only
1622 for a specific room, please see 'Room Aide' for more information.) </li>
1626 <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>
1628 <p>'Registration' refers to the process of a user entering various personal
1629 contact information (real name, address, telephone number, etc.) into
1630 the system. When enabled, this information is stored as a vCard object
1631 on the system in two places: the user's <tt>My Citadel Config></tt>
1632 room, and in the <tt>Global Address Book></tt> room. (Note: the latter
1633 should be made private on publicly-accessible systems, for obvious reasons.)</p>
1635 <p>If you answer Yes to 'Require registration for new users' then each new
1636 user, upon creating a new account, will immediately be entered into
1637 the registration process. On the other hand, if you answer Yes to 'Disable
1638 self-service user account creation' then new users will not be able to
1639 log in at all -- all accounts must be created by an Aide.</p>
1641 <p>'Initial access level for new users' should be set to 1 (New User) if you
1642 would like to review each new user's registration info before granting
1643 them higher access. This would be done periodically with the <tt><b>.A</b>ide
1644 <b>V</b>alidate new users</tt> command. If you do not require registration,
1645 you should set the initial access level to 4 (Network User).</p>
1647 <p>Given the above options, it then becomes clear that there are generally
1648 two ways you can set up your Citadel system, depending on its purpose:</p>
1651 <li><b>A public access BBS or message board</b> - since you do
1652 not know who might want to log in, self-service account creation needs to
1653 stay enabled. If you want to be strict about users identifying themselves,
1654 then you should also require users to register (just remember to post a
1655 privacy policy if you're going to collect personal information) -- then set
1656 the initial access level to 1 (New User), so new users cannot post messages
1657 until after you've validated them. For a more lax environment, you can
1658 remove the registration requirement and grant new accounts level 4 (Normal
1659 User) access on the first visit. </li>
1660 <li><b>A private email/groupware system for your organization</b>
1661 - in this case, disable self-service account creation; you don't want
1662 strangers welcoming themselves to your system. You'll probably also want
1663 to disable registration, because you or some other site administrator
1664 will be entering users' contact info when you create their accounts.
1665 Since this is also how you assign their Internet e-mail addresses, it's
1666 probably a good idea to do it yourself instead of expecting them to do it.
1671 <p>'Access level required to create rooms' is up to you. You might wish to
1672 restrict the creation of new rooms only to Aides, or you might wish to allow
1673 anyone to create a room. The latter is one of the Citadel culture's most
1674 long-standing traditions; the former may be appropriate if users are abusing
1677 <p>You have the ability to 'Automatically give room aide privs to a user who
1678 creates a private room.' If you answer Yes, then any user who creates a
1679 guess-name, passworded, or invitation-only room will automatically become
1680 the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1681 command set while in that room. If you would rather grant this permission
1682 manually, answer No.</p>
1684 <p>Another tradition in the Citadel culture is to refrain from deleting
1685 problem users, but instead to 'twit' them (reduce their access level to 2
1686 [Problem User]). You can then 'Automatically move problem user messages
1687 to twit room' (answer Yes, then specify 'Name of twit room' and remember
1688 to create that room). If you employ this logic, any user with level 2 (Problem
1689 User) access will continue to have access to the same set of rooms, but all
1690 messages posted will automatically be routed to the Trashcan (or whatever
1691 you call your twit room).</p>
1693 <p>If you have Internet mail configured, you have the option of restricting
1694 its use on a user-by-user basis. If you wish to do this, answer Yes to
1695 'Restrict Internet mail to only those with that privilege.' Obviously this
1696 makes no sense for an internal e-mail system, but for a public BBS it
1697 might be appropriate.</p>
1699 <p>Normally, Aides have access to every room, public or private, except for
1700 user mailboxes. They are also forbidden from <tt><b>Z</b>ap</tt>ping
1701 rooms, because the review of content is considered one of their roles.
1702 If you wish to change these policies, the next two options allow you to.
1703 You may 'Allow Aides to Zap (forget) rooms', in which case they may use
1704 the <tt><b>Z</b>ap</tt> command just like any other user. Furthermore,
1705 if you 'Allow system Aides access to user mailboxes', then they may <tt><b>.G</b>oto</tt>
1706 any private mailbox belonging to any user, using a special room name format.</p>
1708 <p>If your local security and/or privacy policy dictates that you keep a
1709 log of all pages (instant messages) that go through the system, then answer
1710 Yes to 'Log all pages'. If you answer Yes, you will be prompted for the
1711 name of a room to which all pages will be logged. If you answer No, then
1712 only the sender and recipient of each individual message will receive a copy.</p>
1714 <p>The next set of options deals with the tuning of your system. It is usually
1715 safe to leave these untouched.</p>
1717 <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>
1719 <p>The 'Server connection idle timeout' is for the connection between client
1720 and server software. It is <b>not</b> an idle timer for the user interface.
1721 900 seconds (15 minutes) is the default and a sane setting.</p>
1723 <p>'Maximum concurrent sessions' is the highest number of user sessions you
1724 wish to allow on your system at any given time. Citadel can scale to
1725 hundreds of concurrent users, but if you have limited hardware or (more
1726 likely) limited bandwidth, you might wish to set a maximum. You can also
1727 set it to zero for no limit.</p>
1729 <p>'Maximum message length' is just that. This could be a good way to prevent
1730 enormous multimedia files from finding their way into your message base.
1731 This maximum is enforced in all protocols and is also advertised by the
1734 <p>The minimum and maximum number of worker threads can be tuned to your
1735 liking. Citadel will attempt to keep one worker thread running per session,
1736 within these constraints. You should be aware that due to the use of the
1737 worker thread model, Citadel can handle a large number of concurrent sessions
1738 with a much smaller thread pool. If you don't know the programming theory
1739 behind multithreaded servers, you should leave these parameters alone.</p>
1741 <p>The next set of options affect how Citadel behaves on a network.</p>
1743 <pre>How often to run network jobs (in seconds) [3600]: <br><br>POP3 server port (-1 to disable) [110]:<br><br>IMAP server port (-1 to disable) [143]:<br><br>SMTP server port (-1 to disable) [25]: <br><br>Correct forged From: lines during authenticated SMTP [Yes]:<br><br></pre>
1745 <p>"How often to run network jobs" refers to the sharing of content on a
1746 Citadel network. If your system is on a Citadel network, this configuration
1747 item dictates how often the Citadel server will contact other Citadel servers
1748 to send and receive messages. In reality, this will happen more frequently
1749 than you specify, because other Citadel servers will be contacting yours
1750 at regular intervals as well.</p>
1752 <p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP services.
1753 For a system being used primarily for Internet e-mail, these are essential,
1754 so you'll want to specify the standard port numbers: 25, 110, and 143. If
1755 Citadel is running alongside some other mail system, though, then you might
1756 want to choose other, unused port numbers, or enter -1 for any protocol
1757 to disable it entirely.</p>
1759 <p>The question about correcting forged From: lines affects how Citadel behaves
1760 with authenticated SMTP clients. Citadel does not ever allow third-party
1761 SMTP relaying from unauthenticated clients -- any incoming messages must be
1762 addressed to a user on the system or somewhere in a Citadel network. To
1763 use Citadel with SMTP client software such as Netscape, Outlook, Eudora, or
1764 whatever, users must log in with a username and password. In order to prevent
1765 message forgeries, Citadel discards the <tt>From:</tt> line in any message
1766 entered by an authenticated user, and replaces it with a <tt>From:</tt> line
1767 containing the user's genuine name and e-mail address. Technically, this
1768 violates RFC822, because headers are never supposed to be altered, but common
1769 sense dictates that this is a good idea. Nevertheless, if you want to suppress
1770 this behavior, answer 'No' at the prompt (the default is 'Yes') and the headers
1771 will never be altered.</p>
1773 <p>The final set of options configures system-wide defaults for the auto-purger:</p>
1775 <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>
1777 <p>Any user who does not log in for the period specified in 'Default user
1778 purge time' will be deleted the next time a purge is run. This setting
1779 may be modified on a per-user basis.</p>
1781 <p>'Default room purge time' behaves the same way, and may also be modified
1782 on a per-room basis.</p>
1784 <p>'System default message expire policy' defines the way in which old messages
1785 are expired (purged) off the system. You can specify any of:</p>
1788 <li>Purge by age (specify in days) </li>
1789 <li>Purge by message count in the room (specify number of messages)
1791 <li>Do not purge at all </li>
1795 <p>Again, this setting may be overridden on a per-floor basis, and the floor
1796 setting may be overridden on a per-room basis.</p>
1798 <pre>Save this configuration? No<br></pre>
1800 <p>When you're done, enter 'Yes' to confirm the changes, or 'No' to discard
1804 <hr width="100%" size="2">
1805 <h2 align="center"><a name="Configuring_Citadel_for_Internet_e-mail"></a>Configuring
1806 Citadel for Internet e-mail</h2>
1808 <div align="justify">
1809 <h3><a name="Introduction"></a>Introduction</h3>
1810 As you know by now, Citadel is a completely self-contained, full-featured
1811 Internet e-mail system. When you run Citadel you do not need any
1812 other mail software on your host system. This eliminates the need
1813 for tedious mucking about with sendmail, qmail, postfix, Cyrus, the UW IMAP
1814 server, or any of countless other needlessly complex programs that lead
1815 some people to the false assumption that Unix systems are difficult to administer.<br>
1817 Some of the many features supported by Citadel are:<br>
1820 <li>Built-in SMTP and ESMTP service, for delivering and receiving
1821 e-mail on the Internet</li>
1822 <li>Built-in POP3 service, for remote fetching of messages</li>
1823 <li>Built-in IMAP service, for access to mail using any standard
1824 mail client program</li>
1825 <li>Web mail (implemented using the "WebCit" middleware, which is
1826 installed separately)</li>
1827 <li>Support for mailing lists, in both "individual message" and
1828 "digest" formats</li>
1829 <li>Multiple/virtual domain support</li>
1830 <li>Any user may have multiple Internet e-mail addresses, in multiple
1832 <li>Global address book (Users with addresses in a domain may be
1833 spread out across many servers on a Citadel network)</li>
1834 <li>Easy-to-configure integration with <a
1835 href="http://www.spamassassin.org/">SpamAssassin</a> can block spam <i>before</i>
1836 it enters the mail system</li>
1837 <li>Easy-to-configuration integration with most Realtime Blackhole
1838 Lists (RBL) provide further defense against spammers</li>
1841 This section of the documentation will demonstrate how to configure
1845 <h3><a name="Basic_site_configuration"></a>Basic site configuration</h3>
1847 <p>Basic configuration of your Citadel system for Internet e-mail begins with
1848 the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>I</b>nternet</tt> command:</p>
1850 <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>
1852 <p>This is a "clean" setup. For a simple, standalone e-mail system you simply
1853 have to enter the <tt><b>A</b>dd</tt> command:</p>
1855 <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> (6) RBL (domain suffix of spam hunting RBL)<br><br>Which one [1]:<br></pre>
1857 <p><b>localhost:</b> Basically what you're doing here is telling Citadel
1858 what any aliases for your machine are. If your machine were <tt>schmeep.splorph.com</tt>
1859 and you also had a DNS entry set up for <tt>blah.com</tt>, you might want
1860 to enter '1' and enter <tt>blah.com</tt> as your alias, so that e-mail
1861 sent to that address won't bounce.</p>
1863 <p><i>Important tip:</i> if your system is known by one name and <i>only</i>
1864 one domain, you might not even need to do this at all. You will recall
1865 that you entered your system's fully qualified domain name earlier when
1866 you went through the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1867 command. The domain name you entered there is automatically considered
1868 by Citadel to be a 'localhost' entry in your Internet mail configuration.
1869 It does not hurt to enter it in both locations, though.</p>
1871 <p><b>gateway domain:</b> this is a simple way of mapping various Citadel
1872 hosts in an Internet domain. For example, if you enter <tt>bar.com</tt>
1873 as a gateway domain, then mail to users at <tt>foo.bar.com</tt> will be
1874 forwarded to the host called <tt>foo</tt> on a Citadel network, mail to users
1875 at <tt>kunst.bar.com</tt> will be delivered to the Citadel server called
1876 <tt>kunst</tt>, etc. This feature has limited usefulness; if you are operating
1877 a network of Citadel servers, it is more likely that you will use the 'directory'
1878 feature, explained below.</p>
1880 <p><b>smart-host:</b> Normally, Citadel sends outbound Internet e-mail directly
1881 to its destination. This may not be appropriate for some sites; you may
1882 require (due to local convention, security policy, or whatever) that all
1883 outbound mail be sent to an SMTP relay or forwarder. To configure this
1884 functionality, simply enter the domain name or IP address of your relay
1885 as a 'smart-host' entry.</p>
1887 <p><b>directory:</b> a domain for which you are participating in directory
1888 services across any number of Citadel nodes. For example, if users who
1889 have addresses in the domain <tt>citadel.org</tt> are spread out across
1890 multiple Citadel servers on your network, then enter <tt>citadel.org</tt>
1891 as a 'directory' entry. <i>For this to work, all Citadel servers participating
1892 in directory service <b>must</b> carry and share the <tt>Global Address Book></tt>
1895 <p><b>spamassassin:</b> if you are running a <a
1896 href="http://www.spamassassin.org">SpamAssassin</a> service anywhere on your
1897 <b>local</b> network, enter its name or IP address as a 'spamassassin' entry.
1898 This may be (and, in fact, will usually be) <tt>127.0.0.1</tt> to specify
1899 that the service is running on the same host computer as the Citadel server.</p>
1901 <p>Please install SpamAssassin as per its own documentation. You will want
1902 to run SpamAssassin in client/server mode, where a <tt>spamd</tt> daemon
1903 is always running on your computer. Citadel does not utilize the <tt>spamc</tt>
1904 client; instead, it implements SpamAssassin's protocol on its own.</p>
1906 <p>Connecting to a SpamAssassin service across a wide area network is strongly
1907 discouraged. In order to determine whether an incoming e-mail is spam,
1908 Citadel must feed the <i>entire message</i> to the SpamAssassin service.
1909 Doing this over a wide area network would consume time and bandwidth,
1910 which would affect performance.</p>
1912 <p>Citadel invokes the SpamAssassin service when incoming messages are arriving
1913 via SMTP. Before a message is accepted, it is submitted to SpamAssassin.
1914 If SpamAssassin determines that the message is spam, the Citadel SMTP
1915 service <i>rejects the message,</i> causing a delivery failure on the sending
1916 host. This is superior to software which files away spam in a separate
1917 folder, because delivery failures will cause some spammers to assume the
1918 address is invalid and remove it from their mailing lists.</p>
1920 <p><b>RBL:</b> Realtime Blackhole Lists (RBL's) provide defense against spammers
1921 based on their source IP address. There are many such lists available on
1922 the Internet, some of which may be utilized free of charge. Since they are
1923 DNS based, the lists do not require storage on your server -- they are queried
1924 during the SMTP conversation.</p>
1926 <p>Citadel can utilize any RBL that uses the <tt>z.y.x.w.nameoflist.org</tt>
1927 syntax, where <tt>w.x.y.z</tt> is the source IP address which is attempting
1928 to deliver mail to your server. For example, <a
1929 href="http://www.spamcop.net">SpamCop</a> would use the query <tt>2.0.0.127.bl.spamcop.net</tt>
1930 to determine whether the host at <tt>127.0.0.2</tt> is a known spammer or
1931 open relay. In this case, you simply select option '6' to add an RBL entry,
1932 and provide it with the domain suffix of <tt>bl.spamcop.net</tt> (the IP address
1933 and extra dot will be automatically prepended for each query).</p>
1935 <p>Now select <tt><b>S</b>ave</tt> and you are just about ready for Internet
1938 <h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the Internet
1941 <p>As previously mentioned, Citadel contains its own SMTP, POP3, and IMAP
1942 services. Enabling them is simple.</p>
1944 <p>Check for the existance of a current MTA (sendmail, qmail, etc.) by connecting
1945 to port 25 on your host. If you see something similar to the following
1946 you're running an MTA already and you'll need to shut it down:</p>
1948 <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>
1950 <p>In the above example, we see that the host already has Sendmail listening
1951 on port 25. Before Citadel can use port 25, Sendmail must be shut off.
1952 Please consult the documentation for your operating system for instructions
1953 on how to do this. (On a Red Hat Linux system, for example, you can run
1954 the <tt>ntsysv</tt> utility, un-checking <tt>sendmail</tt> to disable it at
1955 the next reboot; then, run <tt>service sendmail stop</tt> to shut off the
1956 currently running service.)</p>
1958 <p>If you get a 'connection refused' message when you telnet to port 25 there's
1959 nothing running and you should be able to continue. You might also want
1960 to turn off POP (try the above test substituting 110 for 25) and IMAP (port
1961 143) and use Citadel's POP and IMAP services.</p>
1963 <p>Citadel will look for an existing pop/smtp server on startup. If they
1964 don't exist (and you've configured them properly) then Citadel should enable
1965 them at startup. You can check your logs to be sure, or you can start the
1966 server from a shell and watch it load. It might look something like this:</p>
1967 <font size="-2"> </font>
1968 <pre><font size="-2">smw @ pixel % ./citserver<br><br>Multithreaded message server for Citadel/UX<br>Copyright (C) 1987-2003 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>
1970 <p>The lines emphasized in boldface in the above log output tell you that
1971 Citadel "can't bind" to various ports. The error 'address already in use'
1972 generally means that something else is already running on the requested
1973 port. Make SURE you've followed the above steps to remove sendmail/pop and
1974 start your Citadel server again.</p>
1976 <h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
1978 <p>Occationally it is not practical to remove a non-Citadel MTA on your host
1979 system. For example, you might have multiple groups of users, some of
1980 which are using Citadel and some of which are using a legacy Unix mail
1981 spool. This type of configuration is discouraged, but a tool is provided
1984 <p>The tool is called <tt>citmail</tt> and it is, quite simply, a local MDA
1985 (Mail Delivery Agent) which you can configure into your MTA for final delivery
1986 of incoming messages to Citadel users. A full discussion of the finer points
1987 of complex Sendmail configurations is beyond the scope of this document;
1988 however, you might want to visit <a
1989 href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some useful
1990 HOWTO documents are provided.</p>
1992 <p>For outbound mail, you can either allow Citadel to perform deliveries directly
1993 (this won't affect your other mail system because outbound mail doesn't tie
1994 up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which will tell
1995 Citadel to forward all of its outbound mail to your other mail system.</p>
1997 <h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet mailing
2000 <p>Citadel has built in mailing list service (known in the 'net vernacular
2001 as "listserv") functionality. You can turn any room into a mailing
2002 list. Users can then choose how they participate -- by logging on to
2003 your Citadel server directly, or by having the room's contents mailed to
2004 them somewhere else. Configuring this is easy.</p>
2006 <p>Citadel supports two modes of mailing list delivery: </p>
2009 <li>"List mode" -- each individual message is delivered as a single
2010 e-mail to each list mode recipient. The "From:" header will display
2011 the address of the message's original author.</li>
2012 <li>"Digest mode" -- groups of one or more messages are delivered
2013 to digest mode recipients. The number of messages in the group depends
2014 on how many new messages arrived since the last batch was delivered. The
2015 "From:" header will display the address of the room itself, which allows
2016 replies to be posted back to the room.</li>
2019 A room may have any combination of list mode and digest mode recipients.
2021 <p>As alluded to above, every room on your Citadel system has an Internet
2022 e-mail address of its own. Messages sent to that address will be
2023 posted in the room (and sent back out to mailing list recipients, as well
2024 as to any other Citadels you share the room with). The address format
2025 is <tt>room_</tt> plus the name of the room, with any spaces replaced by
2026 underscores, followed by <tt>@</tt> and your hostname. For example, if your
2027 system is known as <tt>phlargmalb.orc.org</tt> on the Internet, and you have
2028 a room called <tt>Bubblegum Collectors</tt>, you can post to that room from
2029 anywhere on the Internet simply by sending an e-mail to <tt>room_bubblegum_collectors@phlargmalb.orc.org</tt>.
2030 When the message arrives, it's automatically posted in that room.</p>
2032 <p>To manually edit the list of "list mode" recipients, simply enter the <tt><b>.A</b>ide
2033 mailing <b>L</b>ist management</tt> command. Your text editor will open
2034 up and you will be able to create or edit a list of recipients, one per line.
2035 Lines beginning with a hash (<tt>#</tt>) are comments.</p>
2037 <p>To manually edit the list of "digest mode" recipients, enter the <tt><b>.A</b>ide
2038 mailing list <b>D</b>igest recipients</tt> command. As with the previous
2039 command, the text editor will open up and you can edit the list of digest
2040 mode recipients, one per line.</p>
2042 <p>Citadel also has a facility which allows users to subscribe or unsubscribe
2043 to mailing lists using a web browser. In order to do this, WebCit must
2044 also be running on your server in addition to Citadel. WebCit is obtained
2045 and installed separately from the rest of the Citadel system.</p>
2047 <p>In order to prevent "just anyone" from subscribing to any room on your
2048 system, there is a setting in the <tt><b>.A</b>ide <b>E</b>dit room</tt>
2051 <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>
2053 <p>When you answer "Yes" to self-service list subscribe/unsubscribe, you are
2054 enabling that feature. Now, all you have to do is tell the world about the
2055 web page they need to visit. It looks like this:</p>
2057 <center><tt>http://foobar.baz.org:2000/listsub</tt></center>
2059 <p>In this example, the server is called <tt>foobar.baz.org</tt> and WebCit
2060 is running on port 2000. Edit appropriately.</p>
2062 <p>Citadel offers a subscribe/unsubscribe facility that is more intuitive
2063 than other listservs. With most systems, sending commands to the listserv
2064 requires that you e-mail it commands in a special format. It's easy to
2065 get it wrong. Citadel simply uses your web browser. You select the list
2066 you want to subscribe or unsubscribe (hint: it's the list of rooms you've
2067 enabled self-service for), select whether you want list mode or digest mode,
2068 and enter your e-mail address. For security purposes, a confirmation message
2069 is sent to the address you enter. But you don't have to reply to the message
2070 in a weird format, either: the confirmation contains another URL which
2071 you simply click on (or paste into your browser if you can't click on URL's
2072 in your e-mail software) and the confirmation is automatically completed.</p>
2074 <hr width="100%" size="2">
2076 <h2><a name="Building_or_joining_a_Citadel_network"></a>Building or joining
2077 a Citadel network</h2>
2080 <h3><a name="Overview__"></a>Overview</h3>
2082 <p>If you are running Citadel as a BBS or other forum type of application,
2083 one way to 'keep the conversation going' is to share rooms with other Citadel
2084 systems. In a shared room, a message posted to the room is automatically
2085 propagated to every system on the network. It's kind of like a UseNet newsgroup,
2086 but without the spam.</p>
2088 <p>If you are using Citadel as the e-mail and groupware platform for a large
2089 organization, you can use its networking features to build a large network
2090 of Citadel servers which share content (think of rooms as public folders),
2091 redistribute e-mail throughout the organization, and integrate the global
2092 address book. It might make sense, for example, in a large corporation
2093 to give each department or location its own Citadel server. Thanks
2094 to Citadel's global address book features, you could still have all of the
2095 users share a single e-mail domain.</p>
2097 <p>Obviously, the first thing you have to do is find another Citadel to share
2098 rooms with, and make arrangements with them. The following Citadels are
2099 a good place to start:</p>
2102 <li>UNCENSORED! - <a href="http://uncensored.citadel.org">uncensored.citadel.org</a>
2104 <li>The Dog Pound II - <a href="http://dogpound2.citadel.org">dogpound2.citadel.org</a>
2106 <li>PixelBBS - <a href="http://pixel.citadel.org">pixel.citadel.org</a>
2111 <p>You don't have to be a part of the citadel.org domain to participate in
2112 the public Citadel network, but the DNS service is provided free of charge
2113 by the Citadel community if you wish to do this.</p>
2115 <h3><a name="Conventions_and_etiquette_when"></a>Conventions and etiquette
2116 when connecting to the public Citadel network</h3>
2118 <p>Before we get into the technical nitty gritty, there are two points of
2119 etiquette to keep in mind. The first thing to keep in mind is that the
2120 operator of any particular Citadel may not be willing to share some of his/her
2121 rooms. Some sites are proud to offer exclusive content in certain areas.
2122 Chances are, if a room is already being shared on the network, it's available
2123 for anyone to share; if not, it can't hurt to ask -- but take care not to
2124 demand it of them. Ask if you may share the room instead of telling them
2125 that you wish to share the room. When looking at a <tt><b>K</b></tt>nown
2126 rooms list, network rooms are the ones ending in parentheses instead of angle
2127 brackets. For example, <tt>Gateway)</tt> would be a network room, <tt>Lobby></tt>
2130 <p>The other point of etiquette to remember is that you should be making
2131 the arrangements in advance, and then set it up. It is extremely rude to
2132 simply begin networking with another Citadel, or unilaterally start sharing
2133 a new room, without first obtaining permission from its operator. Always
2134 ask first. Most Citadel operators are more than happy to network with you.
2135 Also, if later on you decide to take your system down, please take the time
2136 to notify the operators of any other Citadels you network with, so they can
2137 unconfigure their end.</p>
2139 <h3><a name="Getting_ready_to_join_the_network"></a>Getting ready to join
2142 <p>Ok, first things first. On a Citadel room sharing network, the first
2143 thing you need to know is your own system's node name. Presumably you set
2144 this up during installation, but if you want to change it you can do so using
2145 the <tt><b>.A</b>ide <b>S</b>ysconfig <b>G</b>eneral</tt> command:</p>
2147 <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>
2149 <p>The "node name" is important, it's how the network identifies messages
2150 coming from your system. The "human readable node name" is simply a label;
2151 it shows up in messages coming from your system. "Fully qualified domain
2152 name" is your DNS name; it's used for routing messages on the Internet.
2153 In the above example, the node name is "uncnsrd".</p>
2155 <h3><a name="Defining_neighbor_nodes"></a>Defining neighbor nodes</h3>
2157 <p>The next thing you need to do is configure your neighbor node(s). You
2158 need to do this for each node you network with. Let's say you wanted
2159 to talk to a Citadel system called "frobozz". Use the <tt><b>.A</b>ide
2160 <b>S</b>ysconfig <b>N</b>etwork</tt> command:</p>
2162 <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>
2164 <p>As you can see in the above example, you have to enter the Citadel node
2165 name, the DNS name or IP address of the server, and the port number the
2166 Citadel service is running on. The "shared secret" is a password to allow
2167 the two Citadel nodes to connect to each other to exchange network data.
2168 The password must be <i>identical</i> on both ends of the connection --
2169 when the operator of the other Citadel node sets up the connection with
2170 your system, he/she must use the same password.</p>
2172 <h3><a name="Sharing_rooms"></a>Sharing rooms</h3>
2174 <p>Now you're ready to share rooms. You have to do this for each room you
2175 want to share, and you have to do it from BOTH ENDS -- again, when you
2176 share a room with another Citadel, they must share it with you as well.
2177 Let's say you have a room called "Quiche Recipes>" and you want to share
2178 it with the node you set up above. First, edit the room and flag it as a
2181 <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>
2183 <p>Notice how the prompt changed? It was > before, but it's ) now. That
2184 means it's a network room. Now you can tell Citadel that you want to
2185 share the room with frobozz. Enter this command:</p>
2187 <pre>Quiche Recipes) . Aide Network room sharing<br></pre>
2189 <p>Your text editor will pop up (you <i>did</i> configure Citadel to use
2190 your favorite text editor, right?) with a screen that looks like this:</p>
2192 <pre># Configuration for room: Quiche Recipes<br># Nodes with which we share this room<br># Specify one per line.<br></pre>
2194 <p>All you have to do is enter the name of the other Citadel node (i.e. "frobozz"
2195 in our example) on a line by itself. As usual, lines starting with a
2196 "#" are comments. Just go to the end of the file, type "frobozz" (without
2197 the quotes), save the file... and you're done!</p>
2199 <p>At this point, you just sit back and enjoy. Your Citadel and the other
2200 one will begin polling each other at regular intervals (once per hour
2201 by default) and sharing messages.</p>
2203 <h3><a name="Sending_mail"></a>Sending mail</h3>
2205 <p>You can send mail to any user on any node of your Citadel network. It
2206 may take a little while for your system to learn the entire node list,
2207 though, as this is done by watching incoming messages on the network and
2208 learning which nodes are out there.</p>
2210 <p>To send a private message, just enter <tt>user @ host</tt> as the recipient:</p>
2212 <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><br></pre>
2214 <h3><a name="Changing_the_polling_interval"></a>Changing the polling interval</h3>
2216 <p>As previously mentioned, Citadel will poll other Citadel nodes for messages
2217 once per hour. If this is not an acceptable interval, you can change it
2218 using the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
2219 command. Enter this command and look for the option:</p>
2221 <pre>How often to run network jobs (in seconds) [3600]:<br></pre>
2223 <p>Change it to whatever you like. For example, 15 minutes is 900 seconds.
2224 So if you changed the default value to 900, network polling would occur
2225 every 15 minutes.</p>
2228 <h2 align="center"><a name="Database_maintenance"></a>Database maintenance</h2>
2230 <h3><a name="Introduction_"></a>Introduction</h3>
2231 The data store used by Citadel is reliable and self-maintaining. It
2232 requires very little maintenance. This is primarily due to its use
2233 of the <a href="http://www.sleepycat.com">Berkeley DB</a> record manager.
2234 It is robust, high-performance, and transactional.<br>
2236 A few small data files are kept in your main Citadel directory, but the
2237 databases are in the <tt>data/</tt> subdirectory. The files with names
2238 that begin with "cdb" are the databases themselves; the files with names
2239 that begin with "log" are the journals. Journal files will come and
2240 go as you use your system; when the database engine has determined that a
2241 particular log file is no longer needed, the file will automatically be deleted.
2242 Nevertheless, you should always ensure that there is ample disk space
2243 for the files to grow.<br>
2245 There is no need to shut down Citadel during backups. The data store
2246 may be backed up "hot." The makers of Berkeley DB suggest that you
2247 should back up the data files <i>first</i> and the log files <i>second</i>.
2248 This is the only method that will guarantee that a database which is
2249 being changed while you back it up will still be usable when you restore it
2250 from the tape later.<br>
2253 <h3><a name="Database_repair"></a>Database repair</h3>
2254 Although Citadel's data store is quite reliable, database corruption
2255 can occur in rare instances. External factors such as an operating
2256 system crash or an unexpected loss of power might leave the database in
2257 an unknown state. A utility is provided which may be able to repair
2258 your database if this occurs. If you find that your Citadel server
2259 is not running, and reading the logs shows that it is crashing because of
2260 an inability to validate a database, follow these steps:<br>
2263 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from "respawn"
2264 to "off." Type <tt>init q</tt> to make this setting permanent.</li>
2265 <li><b>Make a backup of your data.</b> Either write it out to
2266 tape or copy it to another directory, or a tarball.<br>
2268 <li><tt>cd</tt> to your Citadel directory and type <tt>./database_cleanup.sh</tt></li>
2269 <li>Let the cleanup script run. <b>Do not interrupt this process
2270 for any reason.</b><br>
2272 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from "off"
2273 to "respawn". Type <tt>init q</tt> to activate your changes.</li>
2276 If this procedure does not work, you must restore from your most recent
2280 <h3><a name="ImportingExporting_your_Citadel"></a>Importing/Exporting your
2281 Citadel database<br>
2284 <p>Citadel/UX contains an importer/exporter module, affectionately known
2285 as the "Art Vandelay" module (a not-so-obscure Seinfeld reference). It
2286 allows you to export the entire contents of your Citadel databases to a
2287 flat file, which may then be imported on another system. (This procedure
2288 is also known as "dump and load" to database gurus.)</p>
2290 <p>Why would you want to do this? Here are some scenarios: </p>
2293 <li>You are moving a Citadel installation to another computer, which
2294 uses a different CPU. Since Citadel stores data in an architecture-dependent
2295 format, the data files wouldn't work on the new computer as-is. </li>
2296 <li>Your computer crashed, lost power, etc. and you suspect that your
2297 databases have become corrupted. </li>
2298 <li>You want to switch to a different back-end data store. (For example,
2299 from GDBM to Berkeley DB) </li>
2303 <p>So ... how do we work this magic? Follow these steps <i>exactly</i> as
2304 documented and you should be able to do it all with very little trouble.</p>
2307 <li>This should be obvious, but it's still worth mentioning: <b>Make
2308 sure you have a backup of everything before you start this! </b> You're
2309 performing a major operation here. Don't risk it. </li>
2310 <li>First, get all the users logged off from your system. Disconnect
2311 it from the network if possible. You don't want anyone logging in while
2312 you're doing this. </li>
2313 <li>Log on as root, or some other user that has read/write access to
2314 all relevant files. </li>
2315 <li>Go to the directory that Citadel is installed in. For example,
2316 issue a command like <tt>cd /usr/local/citadel</tt> </li>
2317 <li>Export the databases with the following command:<br>
2319 <tt>./sendcommand "ARTV export" >exported.dat</tt><br>
2321 This command may run for a while. On a very large system it could take
2322 an hour or more. Please be patient! </li>
2323 <li>When the export completes, check to make sure that <tt>exported.dat</tt>
2324 exists and has some data in it. (Type "ls -l exported.dat") </li>
2325 <li>Shut down the Citadel server. If you have a line in <tt>/etc/inittab</tt>
2326 that reads like this:<br>
2328 <tt>c1:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel</tt>
2330 ...then you should change the <tt>respawn</tt> to <tt>off</tt> and then
2331 type <tt>/sbin/init q</tt> to make the changes take effect. </li>
2332 <li>Now it's time to delete your current binary databases. Type:<br>
2334 <tt>rm -f citadel.config citadel.control data/*</tt> </li>
2335 <li>If you're moving Citadel to another computer, you should move the
2336 <i>entire</i> directory over at this time. <tt>exported.dat</tt> only
2337 contains the information that was in the binary databases. Information which
2338 was stored in portable formats doesn't need to be exported/imported, so
2339 you must bring it all over in its current form. </li>
2340 <li>Now get Citadel running on the new computer (or whatever). Run
2341 <tt>setup</tt> and turn the service back on (from <tt>/etc/inittab</tt>)
2342 but DO NOT log in. </li>
2343 <li>As root, run the import command:<br>
2345 <tt>./sendcommand "ARTV import" <exported.dat</tt><br>
2347 This will import your databases. Again, it may run for a long time.
2349 <li>Restart the Citadel server. You can do this any way you like.
2350 From the command line, you can do it with a command like:<br>
2352 <tt>./sendcommand "DOWN"</tt> <br>
2354 <li>Now you're finished. Log in and test everything. You may delete
2355 exported.dat at this time, or you might want to save it somewhere as a sort
2356 of pseudo-backup. </li>
2362 <h2><a name="utilities"></a>Utilities</h2>
2365 <h3><a name="overview"></a>Overview</h3>
2367 <p>The following utilities will be discussed: </p>
2370 <li><b>aidepost</b> - Post standard input to the Aide> room </li>
2371 <li><b>whobbs</b> - Who is on the system </li>
2372 <li><b>msgform</b> - Format a binary message to the screen (stdin or in
2374 <li><b>userlist</b> - Print the userlist </li>
2375 <li><b>sendcommand</b> - Send a server command </li>
2379 <p>It is up to you to decide which utilities should be made accessible only
2380 to system administrators. It is important that you set the file permissions
2381 correctly. All utilities should have access to the Citadel data files. We
2382 will attempt to address each program individually.</p>
2384 <h3><a name="aidepost"></a>aidepost</h3>
2386 <p>The nature of this program is rather simple. Standard input (stdin) is
2387 converted into a message, filed in the main message store, and posted in
2388 the Aide> room. This is useful for keeping transcripts of system activity
2389 that has to do with Citadel operations. You might even elect to send all of
2390 your system logs there, too.</p>
2392 <p><tt>aidepost</tt> also accepts the usage <tt>aidepost -rTargetRoom</tt>,
2393 where TargetRoom is the name of a room to which you'd like the message to
2396 <h3><a name="whobbs"></a>whobbs</h3>
2398 <p>This program is similar to the <tt>who</tt> command. It lists all of the
2399 users who are currently connected to your Citadel server, either locally or
2400 across a network. Unless you're running a standalone system, <tt>who</tt>
2401 and <tt>whobbs</tt> will probably not have a one-to-one correspondence. Remember
2402 that you will see sessions for SMTP, POP, and IMAP users, as well as users
2403 running a Citadel client.</p>
2405 <p>One thing to keep in mind is that the <tt>whobbs</tt> utility actually
2406 opens a connection to the server. If the server is maxed out, <tt>whobbs</tt>
2407 will still be able to provide a listing, because it doesn't need to log in
2408 to execute the <tt>RWHO</tt> command. Note that whobbs does not list its
2411 <p>The <tt>whobbs</tt> utility is smart enough to know when it is being invoked
2412 by a web server as a CGI program. In this situation, it will output its listing
2413 as a nicely formatted web page instead of plain text. This makes it easy
2414 to just put a link to the whobbs binary in your cgi-bin directory, allowing
2415 a quick and easy way for web surfers to see who is online.</p>
2417 <p>Running the <tt><b>W</b>ho is online</tt> command from the Citadel client
2418 does <b>not</b> call this utility. It has this functionality built in.<br>
2422 <h3><a name="msgform"></a>msgform</h3>
2424 <p>The <tt>msgform</tt> utility reads its standard input (stdin) looking for
2425 Citadel messages stored in the internal format used on disk and over the
2426 network, and sends them in a human-readable format to standard output (stdout).
2427 There is no longer much use for this program, but it is included for hack
2430 <h3><a name="userlist"></a>userlist</h3>
2432 <p>This is a program to print the userlist. There are two flags that may be
2433 set when running this program. When called without any arguments, <tt>userlist</tt>
2434 will display all users (except those who have chosen to be unlisted), their
2435 user numbers, times called, messages posted, screen width, and date of their
2436 most recent call.</p>
2438 <p><tt>userlist</tt> is simply the same user listing code that is in the
2439 client, made into a standalone utility for convenience.<br>
2442 <h3><a name="sendcommand"></a>sendcommand</h3>
2444 <p><tt>sendcommand</tt> will interpret its arguments (except for <tt>-hDIRNAME</tt>)
2445 as a server command, which is sent to the server. Commands which require
2446 textual input will read it from stdin. Commands which generate textual output
2447 will be sent to stdout.</p>
2449 <p>This utility is intended to be used to enable Citadel server commands to
2450 be executed from shell scripts. Review the script called <tt>weekly</tt>
2451 which ships with the Citadel distribution for an example of how this can
2454 <p><b>NOTE:</b> be sure that this utility is not world-executable. It connects
2455 to the server in privileged mode, and therefore could present a security hole
2456 if not properly restricted.</p>
projects / citadel.git / blob