1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <title>Citadel Documentation</title>
5 <meta http-equiv="content-type"
6 content="text/html; charset=ISO-8859-1">
10 <h1>C I T A D E L</h1>
11 <h2>a messaging and collaboration platform for BBS and groupware
13 Copyright ©1987-2005 by the Citadel development team:<br>
15 <table align="center" border="0" cellpadding="2" cellspacing="2">
18 <td valign="top">Clint Adams<br>
20 <td valign="top"><i>portability enhancements<br>
24 <td valign="top">Steven M. Bellovin<br>
26 <td valign="top"><i>author of public domain 'parsedate' function<br>
30 <td valign="top">Nathan Bryant<br>
32 <td valign="top"><i>build system, security, database access, and
37 <td valign="top">Art Cancro<br>
39 <td valign="top"><i>overall system design and lead
44 <td valign="top">Brian Costello<br>
46 <td valign="top"><i>cosmetics, additional commands<br>
50 <td valign="top">Nick Georbit<br>
52 <td valign="top"><i>additional client features<br>
56 <td valign="top">David Given<br>
58 <td valign="top"><i>IMAP and build patches<br>
62 <td valign="top">Michael Hampton<br>
64 <td valign="top"><i>client software development<br>
68 <td style="vertical-align: top;">Urs Jannsen<br>
70 <td style="vertical-align: top;"><span style="font-style: italic;">text
71 search algorithm</span><br>
75 <td valign="top">Andru Luvisi<br>
77 <td valign="top"><i>troubleshooting and development assistance<br>
81 <td valign="top">Daniel Malament<br>
83 <td valign="top"><i>string compare function for IMAP server<br>
87 <td valign="top">Stu Mark<br>
89 <td valign="top"><i>additional client features, IGnet protocol
94 <td valign="top">Ben Mehlman<br>
96 <td valign="top"><i>additional client features<br>
100 <td valign="top">Ari Samson<br>
102 <td valign="top"><i>assistance with project management<br>
106 <td valign="top">Trey Van Riper<br>
108 <td valign="top"><i>portability enhancements<br>
112 <td valign="top">John Walker<br>
114 <td valign="top"><i>author of public domain base64
119 <td valign="top">Steve Williams<br>
121 <td valign="top"><i>documentation<br>
125 <td valign="top">Ethan Young<br>
127 <td valign="top"><i>IGnet protocol design<br>
134 <div align="justify">The entire package is open source; you can
135 redistribute and/or modify it under the terms of the GNU General Public
136 License as published by the Free Software Foundation; either version 2
137 of the License, or (at your option) any later version.<br>
139 This program is distributed in the hope that it will be useful, but
140 WITHOUT ANY WARRANTY; without even the implied warranty of
141 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
142 General Public License for more details. </div>
143 <div align="justify"><br>
144 For more information, visit either of these locations on
147 <li>The Citadel home page: <a href="http://www.citadel.org">http://www.citadel.org</a></li>
148 <li>UNCENSORED! BBS, the home of Citadel: <a
149 href="http://uncensored.citadel.org">http://uncensored.citadel.org</a></li>
151 <hr size="2" width="100%">
152 <h2 align="center">Table of Contents</h2>
154 <li><a href="#GPL">License</a></li>
155 <li><a href="#Installation">Installation</a></li>
157 <li><a href="#Everything_in_its_place...">Everything in its
159 <li><a href="#ctdl_login_acct">Creating a system account for Citadel</a></li>
160 <li><a href="#bypassing_login">Bypassing the login:
162 <li><a href="#Compiling_the_programs">Compiling the programs</a></li>
163 <li><a href="#Upgrading">Upgrading</a></li>
164 <li><a href="#rc_file">The citadel.rc file</a></li>
165 <li><a href="#Using_an_external_editor_for_message">Using an
166 external editor for message composition</a></li>
167 <li><a href="#Printing_messages">Printing messages</a></li>
168 <li><a href="#URL_viewing">URL viewing</a></li>
169 <li><a href="#Setup_and_login">Setup and login</a></li>
170 <li><a href="#Configuring_your_host_system_to_start">Configuring
171 your host system to start the service</a></li>
172 <li><a href="#first_time_login">Logging in for
173 the first time</a></li>
174 <li><a href="#Welcoming_new_users">Welcoming new users</a></li>
175 <li><a href="#adding_doors">Space for adding
176 your own client features (doors)</a></li>
177 <li><a href="#Troubleshooting_and_getting_help">Troubleshooting and
181 <li><a href="#sysop">System Administration</a></li>
183 <li><a href="#Overview_">Overview</a></li>
184 <li><a href="#Aide_commands">Aide commands</a></li>
185 <li><a href="#Editing_rooms">Editing rooms</a></li>
186 <li><a href="#File_directories">File directories</a></li>
187 <li><a href="#Creating_and_editing_user_accounts">Creating and
188 editing user accounts</a></li>
189 <li><a href="#Deleting_and_moving_messages">Deleting and moving
191 <li><a href="#Customizing_the_help_files">Customizing the help files</a></li>
192 <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>
198 <li><a href="#Introduction">Introduction</a></li>
199 <li><a href="#Basic_site_configuration">Basic site configuration</a></li>
200 <li><a href="#Enabling_the_Internet_mail_protocols">Enabling the
201 Internet mail protocols</a></li>
202 <li><a href="#Hosting_an_Internet_mailing_list">Hosting an Internet
205 <li><a href="#citmail">Using Citadel in conjunction with another MTA</a></li>
207 <li><a href="#Building_or_joining_a_Citadel_network">Building or
208 joining a Citadel network</a></li>
210 <li><a href="#Overview__">Overview</a></li>
211 <li><a href="#Conventions_and_etiquette_when">Conventions and
212 etiquette when connecting to the public Citadel network</a></li>
213 <li><a href="#Getting_ready_to_join_the_network">Getting ready
214 to join the network</a></li>
215 <li><a href="#Defining_neighbor_nodes">Defining neighbor nodes</a></li>
216 <li><a href="#Sharing_rooms">Sharing rooms</a></li>
217 <li><a href="#Sending_mail">Sending mail</a></li>
218 <li><a href="#Changing_the_polling_interval">Changing the polling
221 <li><a href="#Database_maintenance">Database maintenance</a></li>
223 <li><a href="#Introduction_">Introduction</a></li>
224 <li><a href="#Backing_up_your_Citadel_database">Backing up your
225 Citadel database</a><br>
227 <li><a href="#Database_repair">Database repair</a></li>
228 <li><a href="#ImportingExporting_your_Citadel">Importing/Exporting
229 your Citadel database</a><br>
232 <li><a href="#crypto">Cryptography support (TLS/SSL)</a></li>
234 <li><a href="#crypto_intro">Overview</a></li>
235 <li><a href="#real_cert">Generating and installing a Trusted
238 <li><a href="#LDAP_Directory_Support">LDAP directory support</a></li>
240 <li><a href="#Introduction_ldap">Introduction</a></li>
241 <li><a href="#Preparing_your_LDAP_server_for_Citadel">Preparing
242 your LDAP server for Citadel connections</a><br>
244 <li><a href="#Configuring_the_LDAP_Connector_for">Configuring the
245 LDAP Connector for Citadel</a><br>
248 <li><a href="#utilities">Included utilities</a></li>
250 <li><a href="#overview">Overview</a></li>
251 <li><a href="#aidepost">aidepost</a></li>
252 <li><a href="#whobbs">whobbs</a></li>
253 <li><a href="#msgform">msgform</a></li>
254 <li><a href="#userlist">userlist</a></li>
255 <li><a href="#sendcommand">sendcommand</a></li>
259 <hr size="2" width="100%"><br>
260 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
263 <p> Version 2, June 1991 </p>
264 <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>
265 <h3 align="justify">Preamble</h3>
266 <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
270 change free software--to make sure the software is free for all its
271 users. This General Public License applies to most of the Free Software
272 Foundation's software and to any other program whose authors commit to
273 using it. (Some other Free Software Foundation software is covered by
274 the GNU Library General Public License instead.) You can apply it to
275 your programs, too. </p>
276 <div align="justify"> </div>
277 <p align="justify"> When we speak of free software, we are referring to
278 freedom, not price. Our General Public Licenses are designed to make
279 sure that you have the freedom to distribute copies of free software
280 (and charge for this service if you wish), that you receive source code
281 or can get it if you want it, that you can change the software or use
282 pieces of it in new free programs; and that you know you can do these
284 <div align="justify"> </div>
285 <p align="justify"> To protect your rights, we need to make
286 restrictions that forbid anyone to deny you these rights or to ask you
287 to surrender the rights. These restrictions translate to certain
288 responsibilities for you if you distribute copies of the software, or
289 if you modify it. </p>
290 <div align="justify"> </div>
291 <p align="justify"> For example, if you distribute copies of such a
292 program, whether gratis or for a fee, you must give the recipients all
293 the rights that you have. You must make sure that they, too, receive or
294 can get the source code. And you must show them these terms so they
295 know their rights. </p>
296 <div align="justify"> </div>
297 <p align="justify"> We protect your rights with two steps: (1)
298 copyright the software, and (2) offer you this license which gives you
299 legal permission to copy, distribute and/or modify the software. </p>
300 <div align="justify"> </div>
301 <p align="justify"> Also, for each author's protection and ours, we
302 want to make certain that everyone understands that there is no
303 warranty for this free software. If the software is modified by someone
304 else and passed on, we want its recipients to know that what they have
306 the original, so that any problems introduced by others will not
308 on the original authors' reputations. </p>
309 <div align="justify"> </div>
310 <p align="justify"> Finally, any free program is threatened constantly
312 software patents. We wish to avoid the danger that redistributors of a
314 program will individually obtain patent licenses, in effect making the
316 proprietary. To prevent this, we have made it clear that any patent
318 be licensed for everyone's free use or not licensed at all. </p>
319 <div align="justify"> </div>
320 <p align="justify"> The precise terms and conditions for copying,
321 distribution and modification follow. </p>
322 <div align="justify"> </div>
323 <h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
324 <div align="justify"> </div>
325 <p align="justify"> <strong>0.</strong> This License applies to any
326 program or other work which contains a notice placed by the copyright
327 holder saying it may be distributed under the terms of this General
328 Public License. The "Program", below, refers to any such program or
329 work, and a "work based on the Program" means either the Program or any
330 derivative work under copyright law: that is to say, a work containing
331 the Program or a portion of it, either verbatim or with modifications
332 and/or translated into another language. (Hereinafter, translation is
333 included without limitation in the term "modification".) Each licensee
334 is addressed as "you". </p>
335 <p align="justify"> Activities other than copying, distribution and
336 modification are not covered by this License; they are outside its
337 scope. The act of running the Program is not restricted, and the output
338 from the Program is covered only if its contents constitute a work
339 based on the Program (independent of having been made by running the
340 Program). Whether that is true depends on what the Program does. </p>
341 <p align="justify"> <strong>1.</strong> You may copy and distribute
342 verbatim copies of the Program's source code as you receive it, in any
343 medium, provided that you conspicuously and appropriately publish on
344 each copy an appropriate copyright notice and disclaimer of warranty;
345 keep intact all the notices that refer to this License and to the
346 absence of any warranty; and give any other recipients of the Program a
347 copy of this License along with the Program. </p>
348 <p align="justify"> You may charge a fee for the physical act of
349 transferring a copy, and you may at your option offer warranty
350 protection in exchange for a fee. </p>
351 <p align="justify"> <strong>2.</strong> You may modify your copy or
352 copies of the Program or any portion of it, thus forming a work based
353 on the Program, and copy and distribute such modifications or work
354 under the terms of Section 1 above, provided that you also meet all of
355 these conditions: </p>
356 <p align="justify"> </p>
357 <div align="justify">
359 <li><strong>a)</strong> You must cause the modified files to carry
360 prominent notices stating that you changed the files
361 and the date of any change.
364 <li><strong>b)</strong> You must cause any work that you distribute
365 or publish, that in whole or in part contains
366 or is derived from the Program or any part thereof, to be licensed
367 as a whole at no charge to all third parties under the terms of this
371 <li><strong>c)</strong> If the modified program normally reads
372 commands interactively when run, you must cause it, when started
373 running for such interactive use in the most ordinary way, to print or
374 display an announcement including an appropriate copyright notice and a
375 notice that there is no warranty (or else, saying that you provide a
376 warranty) and that users may redistribute the program under these
377 conditions, and telling the user how to view a copy of this License.
378 (Exception: if the Program itself is interactive but does not normally
379 print such an announcement, your work based on the Program is not
380 required to print an announcement.) </li>
382 These requirements apply to the modified work as a whole. If
383 identifiable sections of that work are not derived from the Program,
384 and can be reasonably considered independent and separate works in
385 themselves, then this License, and its terms, do not apply to those
386 sections when you distribute them as separate works. But when you
387 distribute the same sections as part of a whole which is a work based
388 on the Program, the distribution of the whole must be on the terms of
389 this License, whose permissions for other licensees extend to the
391 whole, and thus to each and every part regardless of who wrote it. </div>
392 <p align="justify"> Thus, it is not the intent of this section to claim
394 or contest your rights to work written entirely by you; rather, the
396 is to exercise the right to control the distribution of derivative or
398 works based on the Program. </p>
399 <p align="justify"> In addition, mere aggregation of another work not
400 based on the Program with the Program (or with a work based on the
401 Program) on a volume of a storage or distribution medium does not bring
402 the other work under the scope of this License. </p>
403 <p align="justify"> <strong>3.</strong> You may copy and distribute
404 the Program (or a work based on it, under Section 2) in object code or
405 executable form under the terms of Sections 1 and 2 above provided that
406 you also do one of the following:<!-- we use this doubled UL to get the sub-sections indented, --><!-- while making the bullets as unobvious as possible. -->
408 <div align="justify">
410 <li><strong>a)</strong> Accompany it with the complete corresponding
411 machine-readable source code, which must be distributed under the terms
412 of Sections 1 and 2 above on a medium customarily used for software
416 <li><strong>b)</strong> Accompany it with a written offer, valid for
417 at least three years, to give any third party, for a charge no more
418 than your cost of physically performing source distribution, a complete
419 machine-readable copy of the corresponding source code, to be
420 distributed under the terms of Sections 1 and 2 above on a medium
421 customarily used for software interchange; or,
424 <li><strong>c)</strong> Accompany it with the information you
425 received as to the offer to distribute corresponding source code. (This
426 alternative is allowed only for noncommercial distribution and only if
427 you received the program in object code or executable form with such an
428 offer, in accord with Subsection b above.) </li>
430 The source code for a work means the preferred form of the work for
431 making modifications to it. For an executable work, complete source
432 code means all the source code for all modules it contains, plus any
433 associated interface definition files, plus the scripts used to control
434 compilation and installation of the executable. However, as a special
435 exception, the source code distributed need not include anything that
436 is normally distributed (in either source or binary form) with the
437 major components (compiler, kernel, and so on) of the operating system
438 on which the executable runs, unless that component itself accompanies
439 the executable. </div>
440 <p align="justify"> If distribution of executable or object code is
441 made by offering access to copy from a designated place, then offering
442 equivalent access to copy the source code from the same place counts as
443 distribution of the source code, even though third parties are not
445 copy the source along with the object code. </p>
446 <p align="justify"> <strong>4.</strong> You may not copy, modify,
447 sublicense, or distribute the Program except as expressly provided
448 under this License. Any attempt otherwise to copy, modify, sublicense
449 or distribute the Program is void, and will automatically terminate
450 your rights under this License. However, parties who have received
451 copies, or rights, from
452 you under this License will not have their licenses terminated so long
453 as such parties remain in full compliance. </p>
454 <p align="justify"> <strong>5.</strong> You are not required to accept
455 this License, since you have not signed it. However, nothing else
456 grants you permission to modify or distribute the Program or its
457 derivative works. These actions are prohibited by law if you do not
458 accept this License. Therefore, by modifying or distributing the
459 Program (or any work based on the Program), you indicate your
460 acceptance of this License to do so, and all its terms and conditions
461 for copying, distributing or modifying the Program or works based on
463 <p align="justify"> <strong>6.</strong> Each time you redistribute the
465 (or any work based on the Program), the recipient automatically
467 license from the original licensor to copy, distribute or modify the
468 Program subject to these terms and conditions. You may not impose any
469 further restrictions on the recipients' exercise of the rights granted
470 herein. You are not responsible for enforcing compliance by third
471 parties to this License. </p>
472 <p align="justify"> <strong>7.</strong> If, as a consequence of a
473 court judgment or allegation of patent infringement or for any other
474 reason (not limited to patent issues), conditions are imposed on you
475 (whether by court order, agreement or otherwise) that contradict the
476 conditions of this License, they do not excuse you from the conditions
477 of this License. If you cannot distribute so as to satisfy
478 simultaneously your obligations under this License and any other
479 pertinent obligations, then as a consequence you may not distribute the
480 Program at all. For example, if a patent license would not permit
481 royalty-free redistribution of the Program by all those who receive
482 copies directly or indirectly through you, then the only way you could
483 satisfy both it and this License would be to refrain entirely from
484 distribution of the Program. </p>
485 <p align="justify"> If any portion of this section is held invalid or
486 unenforceable under any particular circumstance, the balance of the
487 section is intended to apply and the section as a whole is intended to
488 apply in other circumstances. </p>
489 <p align="justify"> It is not the purpose of this section to induce you
491 infringe any patents or other property right claims or to contest
492 validity of any such claims; this section has the sole purpose of
493 protecting the integrity of the free software distribution system,
494 which is implemented by public license practices. Many people have made
495 generous contributions to the wide range of software distributed
496 through that system in reliance on consistent application of that
497 system; it is up to the author/donor to decide if he or she is willing
498 to distribute software through any other system and a licensee cannot
499 impose that choice. </p>
500 <p align="justify"> This section is intended to make thoroughly clear
501 what is believed to be a consequence of the rest of this License. </p>
502 <p align="justify"> <strong>8.</strong> If the distribution and/or use
504 the Program is restricted in certain countries either by patents or by
506 interfaces, the original copyright holder who places the Program under
508 License may add an explicit geographical distribution limitation
510 those countries, so that distribution is permitted only in or among
512 not thus excluded. In such case, this License incorporates the
514 as if written in the body of this License. </p>
515 <p align="justify"> <strong>9.</strong> The Free Software Foundation
516 may publish revised and/or new versions of the General Public License
517 from time to time. Such new versions will be similar in spirit to the
518 present version, but may differ in detail to address new problems or
520 <p align="justify"> Each version is given a distinguishing version
521 number. If the Program specifies a version number of this License which
522 applies to it and "any later version", you have the option of following
523 the terms and conditions either of that version or of any later version
524 published by the Free Software Foundation. If the Program does not
525 specify a version number of this License, you may choose any version
527 the Free Software Foundation. </p>
528 <p align="justify"> <strong>10.</strong> If you wish to incorporate
529 parts of the Program into other free programs whose distribution
530 conditions are different, write to the author to ask for permission.
531 For software which is copyrighted by the Free Software Foundation,
532 write to the Free Software Foundation; we sometimes make exceptions for
533 this. Our decision will be guided by the two goals of preserving the
535 derivatives of our free software and of promoting the sharing and reuse
536 of software generally. </p>
537 <p align="justify"><strong>NO WARRANTY</strong></p>
538 <div align="justify"> </div>
539 <p align="justify"> <strong>11.</strong> BECAUSE THE PROGRAM IS
540 LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE
541 EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN
542 WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
543 "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
544 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
545 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK
546 AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
547 THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
548 SERVICING, REPAIR OR CORRECTION. </p>
549 <p align="justify"> <strong>12.</strong> IN NO EVENT UNLESS REQUIRED
550 BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
551 ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS
552 PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
554 INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY
555 TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
556 BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
557 OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN
558 IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
561 <p align="justify"> </p>
562 <h3>END OF TERMS AND CONDITIONS</h3>
564 <hr size="2" width="100%"><br>
566 <h2><a name="Installation"></a>Installation</h2>
568 <div align="justify">
570 <p>Citadel is an advanced, multiuser, client/server messaging system
571 suitable for BBS, e-mail, and groupware applications. It is designed to
572 handle the needs of both small dialup systems and large-scale
573 Internet-connected systems. It was originally developed on an Altos
574 system running Xenix, and has been installed and tested on various Unix
575 and Unix-like platforms. The current development environment (and
576 public BBS) is an ordinary Linux system. The current distribution
579 <li>The Citadel server (this is the back end that does all
581 <li>A text-based client program designed with the traditional Citadel
582 "look and feel" (room prompts, dot commands, and the like) </li>
583 <li>Setup programs </li>
584 <li>A set of utilities for system administration and maintenance </li>
585 <li>Documentation </li>
587 <p>Some knowledge of the Unix system is necessary to install and manage
588 the system. It is mandatory that the sysop have "root" access to the
589 operating system. The following are required to install Citadel: </p>
591 <li>A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX) </li>
592 <li>C compiler (<a href="http://gcc.gnu.org/">GCC</a> with <a
593 href="http://www.gnu.org/software/make/make.html">gmake</a> is the
594 recommended build environment) </li>
595 <li>POSIX threads (already present on most systems) </li>
597 <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1 or newer</li>
598 <li><a href="http://softwarestudio.org/libical/">libical</a> v0.24 or
599 newer (if you want the calendar service to work)<br>
601 <li>Enough disk space to hold all of the programs and data </li>
603 <p>If you are running Citadel on a Linux system, it is STRONGLY
604 recommended that you run it on a recent distribution (such as <a
605 href="http://www.redhat.com">Red Hat</a> 7.3 or newer). A new-ish
606 distribution will have most or all of the prerequisite tools and
607 libraries already integrated for you.</p>
608 <h3>Now available:</h3>
610 <li>"WebCit", a gateway program to allow full access to Citadel via
611 the World Wide Web. Interactive access through any Web browser. </li>
612 <li>Access to Citadel via <i>any</i> standards-compliant e-mail
613 program, thanks to Citadel's built-in SMTP, POP, and IMAP services.
614 You can use Mozilla, Netscape, Evolution, Eudora, Pine, Outlook, etc.
617 <h3>Coming soon:</h3>
619 <li>Newer and better GUI-based clients.</li>
621 <h3><a name="Everything_in_its_place..."></a>Everything in its place...</h3>
622 <p>Hopefully you've unpacked the distribution archive into its own
623 directory. This is the directory in which all Citadel files are located
625 which all activity will take place. Several subdirectories have already
626 been created during the unpacking process, and others may be created
627 by the software if needed. Make sure you have Berkeley DB installed on
628 your system, and that you have all the development libraries and
630 in place so that you can compile against them. If you don't, you can
631 get the latest Berkeley DB at <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
632 If your operating system uses a separate library to support POSIX
633 threads (pthreads), make sure that library is installed as well. This
634 is almost never the case with Linux, but some commercial Unix flavors
638 <h3><a name="ctdl_login_acct"></a>Creating a system account for Citadel</h3>
639 <p>As with many Unix programs, Citadel wants to run under its own user
640 ID. Unlike other programs, however, this user ID will do double-duty as
641 a public login for your system if you are running a BBS. This account
642 is typically called "bbs" or "citadel" or something to that effect. You
643 will tell Citadel what the user-id of that account is, and when someone
644 logs in under that account, Citadel will prompt for a user name.</p>
645 <p>The Citadel user should have a unique uid. The home directory should
646 be the one your Citadel installation resides in (in this example we
647 will use <tt>/usr/local/citadel</tt>) and the shell should be either
649 that directory, or a script that will start up the citadel client.
651 <pre>bbs::100:1:Citadel Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
652 <p>When you run setup later, you will be required to tell it the
653 username or user ID of the account you created is, so it knows what
654 user to run as. If you create an account called <tt>bbs</tt>, <tt>guest</tt>,
655 or <tt>citadel</tt>, the setup program will automatically pick up the
656 user ID by default.</p>
657 <p>For all other users in /etc/passwd (or in some other name service
658 such as NIS), Citadel will automatically set up
659 an account using the full name (or 'gecos' in Unixspeak) of the user.
660 It'll also ignore any password you supply, because it uses the user's
662 on the host system. This allows a 'single sign on' type of environment.
663 Note that this does have to be enabled at compile time -- it's the
665 option called <tt>--enable-autologin</tt>. Keep in mind that these
667 can use *either* their Citadel login name or their login name on the
669 computer, and their password on the host computer.<br>
672 <h3><a name="bypassing_login"></a>Bypassing the <tt>login:</tt>
674 <p>If you normally log in to your host system using some method other
675 than telnet (such as ssh), you might want the telnet service to go
676 straight into Citadel, instead of displaying the <tt>login:</tt>
678 can do this by having telnetd start citadel directly instead of
679 <tt>/bin/login</tt>. The <tt>setup</tt> program will offer to
681 this automatically for you if it sees a configuration it understands.
682 If you would prefer to configure it manually, all you need to do is
684 simple change to your <tt>inetd</tt> or <tt>xinetd</tt>
685 configuration. Here are some configuration examples.</p>
686 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
687 replacing any existing telnet configuration line already there):</p>
688 <pre>telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel<br></pre>
689 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
690 then simply replace that file with this one):</p>
691 <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>
692 <p>Please make sure you know what you're doing before you install this!
694 you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
695 then change the directory name accordingly. If you know of any other
696 local peculiarities which need to be observed, edit the above
698 accordingly as well. And, of course, if you're working remotely, make
699 sure you can successfully log in using SSH <b>before</b> you start
701 changes to telnet, because if you accidentally break telnet and don't
703 SSH running, you'll have effectively locked yourself out of your system
704 until you can get physical access to the console.<br>
707 <h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
708 <p>You can easily compile the Citadel system with the following
710 <pre>./configure<br>make<br>make install<br></pre>
711 <p>The 'configure' script will generate a Makefile from the
713 and it will also write the file "sysdep.h" to your Citadel directory.
714 Please do not edit sysdep.h or Makefile.in yourself. The configure
716 figure out your system dependencies and set everything correctly.</p>
717 <p>Mac OS X 10.1 and later are now supported. (Sorry, 10.0 cannot be
718 supported, now or in the future.) You need to install the Developer
719 Tools CD, which you can purchase or download for free from <a
720 href="http://developer.apple.com">http://developer.apple.com</a>. Then
721 run configure like this:</p>
722 <pre>env CC=/usr/bin/cc ./configure (options - see below)<br></pre>
723 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
724 If you wish to place it in a different directory, you can instead do:</p>
725 <pre>./configure --prefix=/export/home/citadel (or whatever)<br></pre>
726 <p>If you've got Berkeley DB installed in a non-standard location, you
727 can help the configure script find it by doing something like this:</p>
728 <pre>./configure --with-db=/usr/local/BerkeleyDB-4.1<br></pre>
729 <p>Keep in mind that if you're using Berkeley DB from a non-standard
731 you'll have to make sure that location is available at runtime.</p>
732 <p>File permissions are always a bother to work with. You don't want
733 Citadel to crash because someone couldn't access a file, but you also
734 don't want shell users peeking into the binaries to do things like
735 reading others' mail, finding private rooms, etc. The Citadel server
736 needs to be started as root in order to bind to privileged ports, but
737 as soon as its initialization is finished, it changes its user ID to
738 your Citadel user in order to avoid security holes.</p>
739 <h3><a name="Upgrading"></a>Upgrading</h3>
740 <p>Any existing Citadel installation which is at version 5.50 or newer
741 may be upgraded in place without the need to discard your existing data
743 <p>Upgrading to a new version uses the same build procedure as
745 the program for a fresh install, except that you want to do <tt>make
746 upgrade</tt> instead of <tt>make install</tt>. This will
747 overwrite the programs but not your data. <b>Be sure to shut down
748 citserver during this process!</b> If Citadel is running while you
749 upgrade, you may face data corruption issues.<br>
751 <p>After doing <tt>make upgrade</tt>, you should run <tt>setup</tt>
752 again to bring your data files up to date. Please see the setup section
753 below for more information on this.</p>
754 <h3><a name="rc_file"></a>The <tt>citadel.rc</tt> file</h3>
755 <p>The text-based client included with Citadel is suitable for BBS
756 applications. Much of its command set and other behavior is
757 configurable through a Run Control (RC) file. The standard client looks
758 for this file in the following locations: </p>
760 <li><tt>$HOME/.citadelrc</tt></li>
761 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
762 <li><tt>/etc/citadel.rc</tt></li>
763 <li><i>current-directory</i><tt>/citadel.rc</tt></li>
765 The next couple of sections deal with client-side configuration.
766 <h3><a name="Using_an_external_editor_for_message"></a>Using an
768 for message composition</h3>
769 <p>Citadel has a built-in message editor. However, you can also use
770 your favorite text editor to write messages. To do this you simply put
771 a line in your citadel.rc file like this:</p>
772 <pre>editor=/usr/bin/vi<br></pre>
773 <p>The above example would make Citadel call the vi editor when using
774 the <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make
775 it the default editor for the <tt><b>E</b>nter</tt> command by editing
776 the <tt>citadel.rc</tt> file. <b>But be warned:</b> external editors
777 on public systems can
778 be a security hole, because they usually provide users with the ability
779 to drop into a shell on the host system, or save files using names
781 than the name of the temporary file they are editing. If you intend to
782 use an external editor on a public BBS, make sure you use one that has
784 hardened for such a purpose -- one which has had the 'shell' and 'save
786 commands disabled, as well as any other functions which a destructive
787 user could use to gain unauthorized access to your host system.</p>
788 <h3><a name="Printing_messages"></a>Printing messages</h3>
789 <p>Citadel can send messages to a printer, or just about anywhere
790 else in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt>
791 specifies what command you use to print. Text is sent to the standard
792 input (stdin) of the print command.</p>
793 <p>So if you did this:</p>
794 <pre>printcmd="nl|pr|lpr -Plocal"<br></pre>
795 <p>...that would add line numbers, then paginate, then print on the
796 printer named "local". There's tons of stuff you can do with this
797 feature. For example, you could use a command like <tt>cat
798 <<$HOME/archive</tt> to save copies of important messages in a
799 textfile. Again, this is probably something you don't want to configure
800 for a public BBS host -- most system administrators don't want remote
801 users sending arbitrary things to local printers.</p>
802 <h3><a name="URL_viewing"></a>URL viewing</h3>
803 <p>This is one more feature which is appropriate for local users. While
805 a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
806 command, and it will perform some pre-defined action (usually, this is
807 to open up the URL in a web browser). For example:</p>
808 <pre>urlcmd=netscape -remote "openURL(%s)"<br></pre>
809 <p>In the above example, it would open up the URL in an open <a
810 href="http://www.netscape.com/download">Netscape</a> window.<br>
813 <h3><a name="Setup_and_login"></a>Setup and login</h3>
814 <p>Before logging in for the first time, you must run the setup
815 program. To begin this procedure, enter the following commands:</p>
816 <pre>cd /usr/local/citadel<br>./setup<br></pre>
817 <p>The setup program will guide you through a simple configuration
818 procedure. It will ask you what directory to place your data files in
819 -- the default is the current directory, which is usually the sensible
820 thing to select. If you want to run more than one instance of Citadel
821 on the same host, however, you can specify a different directory here
822 -- just remember to specify the directory name again when you start up
823 the server later on.</p>
824 <p><tt>setup</tt> will then shut down the Citadel service if it is
827 <p>You will then be prompted for the name of the system administrator.
828 This is not merely a cosmetic option -- when you log in to your system
829 a little while from now, you'll log in with this name, and it will
830 automatically assign your account the highest access level.</p>
831 <p>Next, you will be prompted for the User ID of the Citadel account on
832 your host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
833 or <tt>citadel</tt>, that account's UID will be the default. If you
834 are upgrading or reconfiguring an existing system, the existing value
835 will be preserved.</p>
836 <p>Then you will be prompted for a server port number. This is the TCP
837 port which Citadel clients use to connect to your Citadel server. In
838 almost all cases, you want to use the default -- port 504, which is the
839 official port number assigned by the IANA for Citadel implementations.</p>
840 <p>The Citadel service will then be started, and you will see the
841 following message:</p>
842 <pre>Setup is finished. You may now log in.<br></pre>
843 <p>Setup is now complete, on most systems, anyway. Please see below to
844 find out if you need to do anything else:</p>
845 <h3><a name="Configuring_your_host_system_to_start"></a>Configuring
847 system to start the service</h3>
848 <p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
849 and <tt>/etc/inittab</tt> in order to configure your host system to
850 automatically start the Citadel service. <tt>setup</tt> will
851 automatically perform these steps if it can, and if you allow it to --
852 just answer 'Yes' when prompted, and everything will be taken care of
853 for you. If you answer 'No' -- or if your system is a little bit odd
854 (for example, BSD systems don't have <tt>/etc/inittab</tt>) -- read
855 this section and do what you need to in order to get things configured.</p>
856 <p>Before you can use Citadel, you must define the "citadel" service to
857 your system. This is accomplished by adding a line to your
858 /etc/services file that looks something like this:</p>
859 <pre>citadel 504/tcp # Citadel Server<br></pre>
860 <p>504 is the port number officially designated by the IANA for use by
861 Citadel. There should not be any need to use a different port number,
862 unless you are running multiple Citadels on the same computer and
864 a different port for each one.</p>
865 <p>The next step is to arrange for the server to start. The <tt>citserver</tt>
866 program is the main Citadel server. Before we cover the recommended
867 method of starting the server, let's examine its usage options:</p>
868 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-lLogFacility] [-d] [-f]<br></pre>
869 <p>The options are as follows:</p>
870 <p><tt>-hHomeDir</tt> - the directory your Citadel data files live in.
871 This should, of course, be a directory that you've run the <tt>setup</tt>
872 program against to set up some data files. If a directory is not
873 specified, the directory
874 name which was specified in the <tt>Makefile</tt> will be used.</p>
875 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed.
876 When -x is used, it will suppress messages sent to syslog (see below).
878 other words, syslog will never see certain messages if -x is used.
880 you should configure logging through syslog, but -x may still be useful
882 some circumstances. The available debugging levels are: </p>
884 <li>0 - Emergency condition; Citadel will exit immediately </li>
885 <li>1 - Severe errors; Citadel may be unable to continue without
887 <li>2 - Critical errors; Citadel will continue with degraded
889 <li>3 - Error conditions; Citadel will recover and continue normally </li>
890 <li>4 - Warning messages; Citadel will continue normally </li>
891 <li>5 - Normal operational messages </li>
892 <li>6 - Informational messages, progress reports, etc. </li>
893 <li>7 - Debugging messages; extremely verbose </li>
895 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace
896 output. Normally it is sent to stdout.</p>
897 <p><tt>-lLogFacility</tt> - Tell the server to send its debug/trace
899 to the <tt>syslog</tt> service on the host system <i>instead of</i>
901 trace file. <tt>LogFacility</tt> must be one of: <tt><i>kern, user,
903 daemon, auth, syslog, lpr, news, uucp, local0, local1, local2, local3,
904 local4, local5, local6, local7</i></tt>. Please note that use of the
905 <tt>-l</tt> option will cancel any use of the <tt>-t</tt> option; that
907 if you specify a trace file <i>and</i> a syslog facility, log output
909 only go to the syslog facility.
911 <p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch
912 would be necessary if you were starting the Citadel server, for
913 example, from an rc.local script (which is not recommended, because
914 this won't allow the server to automatically restart when it is shut
916 <p><tt>-f</tt> - Defragment all the databases upon startup. This
917 currently has no effect, as it is a vestige from the old data store.</p>
918 <p>The preferred method of starting the Citadel server is to place an
919 entry in your /etc/inittab file. This will conveniently bring the
920 server up when your system is up, and terminate it gracefully when your
921 system is shutting down. The exact syntax for your system may vary, but
922 here's an entry that could be used on a Linux system:</p>
923 <pre>cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x6<br></pre>
924 <p>In this example, we've chosen debugging level 6, and have the trace
925 stuff output to one of the virtual consoles. It's important to remember
926 to turn off any getty that is set up on that virtual console, if you do
927 this. After making this change, the command <tt>init q</tt> works on
928 most systems to tell init to re-read the file. If in doubt, just reboot
932 <h3><a name="first_time_login"></a>Logging in for the
934 <p>At this point, your system is ready to run. Run the <tt>citadel</tt>
935 program from the shell and log in as a new user. NOTE: the first user
936 account to be created will automatically be set to access level 6
937 (Aide). This overcomes some obvious logistical problems - normally,
938 Aide access is given by another Aide, but since there aren't any on
939 your system yet, this isn't possible.<br>
942 <h3><a name="Welcoming_new_users"></a>Welcoming new users</h3>
943 <p>Sometimes you might decide that you want a welcome message (or
944 several different messages) automatically mailed to new users upon
945 their first login. Now there is a way to do this. If you create a room
946 called <tt>New User Greetings</tt>, and it is a <i>private</i> room
947 (invitation-only probably makes the most sense), any messages you enter
948 into that room will automatically be delivered to all new users upon
950 <p>You can put anything you want there: a welcome message, system
951 policies, special information, etc. You can also put as many messages
952 there as you want to (although it really doesn't make sense to clutter
953 new users' mailboxes with lots of junk).</p>
954 <p>Don't worry about wasting disk space, either. Citadel has a
955 single-instance message store, so all the new users are actually
956 looking at the same copy of the message on disk.<br>
959 <h3><a name="adding_doors"></a>Space for adding
961 client features (doors)</h3>
962 <p><b>Please take note!</b> This function really represents the "old"
963 way of doing things, and it doesn't fit in well with the client/server
964 paradigm. Please consider it "deprecated" because it may be removed
966 <p>The "doorway" feature is just a generic way to add features to the
967 system. It is called "Doorway" to make it resemble the doors on
968 non-Unix boards, but as we all know, us Unix types don't have to write
969 special code to access the modem. :-) Anyway, when a user hits the <tt><b>*</b></tt>
970 (doorway) command, Citadel does...</p>
971 <pre>USERNAME=(username); export USERNAME<br>./subsystem (user-number) (screen-width) (access level)<br></pre>
972 <p>...so you can put whatever you want in there. I suggest putting in a
974 program to allow the users to pick one of a number of programs, etc. Do
975 be aware that door programs will only be available when the client and
977 programs are running on the <i>same</i> computer, and when the user is
979 the text-mode client. Because of these restrictions, Door programs are
981 utilized less and less every day.<br>
984 <h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and
986 <p>That's just about all the information you need to install the
987 system. But if you get stuck, you can visit <a
988 href="http://uncensored.citadel.org">UNCENSORED! BBS</a> and report a
989 problem or ask for help. But if you intend to report a problem getting
990 the Citadel server to run, <i>please</i> double-check the following
993 <li>Did you do <tt>./configure && make && make
994 install</tt> ?? </li>
995 <li>Did you run setup? </li>
996 <li>Did you start the server? </li>
998 <p>To report a problem, you can log on to <a
999 href="http://uncensored.citadel.org">UNCENSORED!</a> or any other BBS
1000 on the Citadel network which carries the <tt>Citadel></tt> room.
1001 Please DO NOT e-mail the developers directly. Post a request for help
1002 on the BBS, with all of the following information: </p>
1004 <li>The exact nature of your difficulty </li>
1005 <li>A transcript of the error message(s) if possible </li>
1006 <li>The version of Citadel you are running </li>
1007 <li>The version of Berkeley DB present on your system </li>
1008 <li>Which operating system you are running, and what version </li>
1009 <li>If you are running a Linux system, we need to know which
1010 distribution, and the version of the kernel, libc, and pthreads you
1011 are using (it would help to post the output of a <tt>ldd ./citserver</tt>
1015 <div align="center">
1016 <hr size="2" width="100%">
1017 <h2><a name="sysop"></a>System Administration</h2>
1019 <div align="justify">
1020 <h3><a name="Overview_"></a>Overview</h3>
1021 <p>Citadel, when installed properly, will do most of its maintenance
1022 by itself. It is intended to be run unattended for extended periods of
1023 time, and most installations do just that without any software failures.</p>
1024 <p>The system has seven access levels. Most users are at the bottom and
1026 no special privileges. Aides are selected people who have special
1028 the Citadel program. Room Aides only have this access in a certain
1029 room. Preferred users can be selected by Aides for access to preferred
1030 only rooms. A sysop is anyone who has access to the various sysop
1032 are in their own executable files, which should have their permissions
1034 to allow only sysops to run them. You should either create a sysops
1036 in /etc/group, or use some other existing group for this purpose.</p>
1037 <p>Aides have access to EVERY room on the system, public and private
1038 (all types). They also have access to commands starting with <tt>.<b>A</b>ide</tt>
1039 in addition to being able to delete and move messages. The system room,
1040 <tt>Aide></tt>, is accessible only by those users designated as
1042 <h3><a name="Aide_commands"></a>Aide commands</h3>
1043 <p>Aides have the following commands available to them that are not
1044 available to normal users. They are:</p>
1048 <td width="30%"><tt> .<b>A</b>ide <b>K</b>ill this room </tt></td>
1049 <td> Deletes the current room from the system. </td>
1052 <td width="30%"><tt> .<b>A</b>ide <b>E</b>dit this room </tt></td>
1053 <td> Allows editing of the properties of the current room. This
1054 is explained in greater detail below. </td>
1057 <td width="30%"><tt> .<b>A</b>ide <b>W</b>ho knows room </tt></td>
1058 <td> For private rooms with access controls, or mailbox rooms,
1059 this command displays a list of users who have access to the current
1063 <td width="30%"><tt> .<b>A</b>ide edit <b>U</b>ser </tt></td>
1064 <td> Allows editing of the properties of any user account
1065 on the system. </td>
1068 <td width="30%"><tt> .<b>A</b>ide <b>V</b>alidate new users </tt></td>
1069 <td> For public access systems, this command reviews all new user
1070 registrations and allows you to set each new user's access level (or
1071 simply delete the accounts). </td>
1074 <td width="30%"><tt> .<b>A</b>ide enter <b>I</b>nfo file </tt></td>
1075 <td> Each room may contain a short textual description of
1076 its purpose, which is displayed to users upon entering the room for the
1077 first time (or in the room banner, for users of the Web client). This
1078 command allows you to enter or edit that description. </td>
1081 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite
1083 <td> Access control command to grant any specific user access to
1084 a private room. </td>
1087 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick
1089 <td> Access control command to revoke any specifc user's access
1090 to the current room. This works regardless of whether the room is
1091 public or private. </td>
1094 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>D</b>elete </tt></td>
1095 <td> If the current room has an associated file directory, this
1096 command may be used to delete files from it. </td>
1099 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end
1101 <td> If the current room has an associated file directory, this
1102 command may be used to transmit a copy of any file in that directory to
1103 another node on a Citadel network. </td>
1106 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>M</b>ove </tt></td>
1107 <td> If the current room has an associated file directory, this
1108 command may be used to move any file in that directory to another room.
1109 The target room must also have an associated file directory. </td>
1112 <td width="30%"><tt> .<b>A</b>ide <b>M</b>essage edit </tt></td>
1113 <td> This command allows editing of any of the various system
1114 banners and messages which are displayed to users. Type the name of
1115 the banner or message you wish to edit. </td>
1118 <td width="30%"><tt> .<b>A</b>ide <b>P</b>ost </tt></td>
1119 <td> This is the functional equivalent of the <tt><b>E</b>nter
1120 message</tt> command available to all users, except that it allows you
1121 to post using any user name. </td>
1124 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>G</b>eneral
1126 <td> This command allows configuration of a large number of
1127 global settings for your Citadel system. These settings will be
1128 explained in greater detail below. </td>
1131 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>I</b>nternet
1133 <td> This command allows configuration of settings which affect
1134 how your Citadel system sends and receives messages on the Internet. </td>
1137 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1138 check <b>M</b>essage base </tt></td>
1139 <td> Perform a consistency check on your message store. This is a
1140 very time-consuming operation which should not be performed unless you
1141 have reason to believe there is trouble with your database. </td>
1144 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>N</b>etwork
1146 <td> Configure networking (e-mail, room sharing, etc.) with other
1147 Citadel nodes. </td>
1150 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1151 network <b>F</b>ilter list </tt></td>
1152 <td> If you are on a large public or semi-public network of
1153 Citadel nodes and you find content from certain systems or individuals
1154 objectionable, you can use this command to define a rule set to
1155 automatically reject those messages when they arrive on your system. </td>
1158 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>N</b>ow
1160 <td> Immediately shut down the Citadel service, disconnecting any
1161 users who are logged in. Please keep in mind that it will start
1162 right back up again if you are running the service from <tt>/etc/inittab</tt>,
1163 so in practice this command will probably not get much use. </td>
1166 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>S</b>cheduled
1168 <td> Shut down the Citadel service the next time there are zero
1169 users connected. This allows you to automatically wait until all users
1170 are logged out. </td>
1173 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients
1175 <td> Any room may be made into a mailing list. Enter this command
1176 to open an editor window containing the list of Internet e-mail
1177 addresses to which every message posted in the room will be sent. </td>
1180 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest
1181 recipients </tt></td>
1182 <td> Similar to the regular mailing list command, except the
1183 messages will be sent out in 'digest' form -- recipients will see
1184 messages from the address of the room itself rather than the address of
1185 the author of each message, and a digest may contain more than one
1186 message. Each room may have any combination of List and Digest
1190 <td width="30%"><tt> .<b>A</b>ide <b>N</b>etwork room sharing </tt></td>
1191 <td> Configures the sharing of the current room's contents with
1192 other Citadel nodes. Messages posted in this room on any Citadel system
1193 will automatically be replicated to other Citadel systems carrying the
1200 <h3><a name="Editing_rooms"></a>Editing rooms</h3>
1201 <p>This command allows any aide to change the parameters of a room. Go
1202 to the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit
1203 room</tt> command. A series of prompts will be displayed. The existing
1204 parameters will be displayed in brackets; simply press return if you
1206 to leave any or all of them unchanged.</p>
1207 <pre> <br>Room name [IG's Fun Room]:<br></pre>
1208 <p>...the name of the room.</p>
1209 <pre>Private room [Yes]? <br></pre>
1210 <p>...enter Yes if you wish to restrict access to the room, or no if
1212 is to be accessible by all users. Note that Citadel doesn't bother
1214 about access to rooms every time they need to access the room. Once a
1216 gains access to a private room, it then behaves like a public room to
1218 The following four questions will only be asked if you selected
1220 <pre>Accessible by guessing room name [No]?<br></pre>
1221 <p>...if you enter Yes, the room will not show up in users' <tt><b>K</b>nown
1222 rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing
1223 the room's full name), they will gain access to the room.</p>
1224 <pre>Accessible by entering a password [No]?<br>Room password [mypasswd]: <br></pre>
1225 <p>...this adds an additional layer of security to the room, prompting
1226 users for a password before they can gain access to the room.</p>
1227 <p>If you did not select guessname or passworded, then the only way
1228 users can access the room is if an Aide explicitly invites them to the
1229 room using the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt>
1231 <pre>Cause current users to forget room [No] ? No<br></pre>
1232 <p>Enter Yes if you wish to kick out anyone who currently has access to
1234 <pre>Preferred users only [No]? No<br></pre>
1235 <p>Enter Yes if you wish to restrict the room to only users who have
1236 level 5 (Preferred User) status (and Aides too, of course). You should
1237 make the room public if you intend to do this, otherwise the two
1238 restrictions will be COMBINED.</p>
1239 <pre>Read-only room [No]? No<br></pre>
1240 <p>If you set a room to Read-Only, then normal users will not be
1242 post messages in it. Messages may only be posted by Aides, and by
1243 utility programs such as the networker and the "aidepost" utility. This
1245 useful in situations where a room is used exclusively for important
1246 announcements, or if you've set up a room to receive an Internet
1248 list and posting wouldn't make sense. Other uses will, of course,
1250 apparent as the need arises.</p>
1251 <p>Now for a few other attributes...</p>
1252 <pre>Directory room [Yes]? Yes<br></pre>
1253 <p>...enter Yes if you wish to associate a directory with this room.
1254 This can be used as a small file repository for files relevant to the
1255 topic of the room. If you enter Yes, you will also be prompted with the
1256 following four questions:</p>
1257 <pre>Directory name [mydirname]: <br></pre>
1258 <p>...the name of the subdirectory to put this room's files in. The
1259 name of the directory created will be <tt><i><your Citadel
1260 directory></i>/files/<i><room dir name></i></tt>.</p>
1261 <pre>Uploading allowed [Yes]? Yes<br></pre>
1262 <p>...enter Yes if users are allowed to upload to this room.</p>
1263 <pre>Downloading allowed [Yes]? Yes<br></pre>
1264 <p>...enter Yes if users are allowed to download from this room.</p>
1265 <pre>Visible directory [Yes]? Yes<br></pre>
1266 <p>...enter Yes if users can read the directory of this room.</p>
1267 <pre>Network shared room [No]? No<br></pre>
1268 <p>...you can share a room over a network without setting this flag,
1270 vice versa, but what this flag does is twofold: </p>
1272 <li>It prevents people with no network access from entering messages
1274 <li>Messages are displayed with the name of their originating
1275 system in the header. </li>
1277 <pre>Permanent room [No]? No<br></pre>
1278 <p>Citadel contains an 'auto purger' which is capable of removing rooms
1279 which have not been posted in for a pre-defined period of time (by
1281 this is set to two weeks). If you wish to keep this from happening to
1282 a particular room, you can set this option. (Keep in mind that <tt>Lobby></tt>,
1283 <tt>Aide></tt>, any private mailbox rooms, any network shared rooms,
1284 and any rooms with a file directory are automatically permanent.)</p>
1285 <pre>Anonymous messages [No]? No<br>Ask users whether to make messages anonymous [No]? No<br></pre>
1286 <p>...you can have rooms in which all messages are automatically
1287 anonymous, and you can have rooms in which users are prompted whether
1289 message anonymous when they enter it. The real identity of the author
1290 of each message is still revealed to the Room Aide for this room, as
1292 as any system-wide Aides.</p>
1293 <pre>Room aide [Joe Responsible]: <br></pre>
1294 <p>...on larger systems, it helps to designate a person to be
1295 responsible for a room. Room Aides have access to a restricted set of
1296 Aide commands, ONLY when they are in the room in which they have this
1297 privilege. They can edit the room, delete the room, delete and move
1298 messages, and invite or kick out users (if it is a private room), but
1299 they cannot perform aide commands that are not room-related (such as
1300 changing users access levels).</p>
1301 <pre>Listing order [64]: <br></pre>
1302 <p>This is just a simple way to try to control the order rooms are
1303 listed in when users call up a <tt><b>K</b>nown Rooms</tt> listing.
1304 Rooms with a lower listing order are displayed prior to rooms with a
1305 higher listing order. It has no other effect. For users who list rooms
1306 in floor order, the display will sort first by floor, then by listing
1308 <pre>Message expire policy (? for list) [0]:<br></pre>
1309 <p>This provides you with the opportunity to select how long each
1310 message will remain in a room before automatically being deleted. Press
1311 <tt><b>?</b></tt> for a list of options. You can choose to keep
1312 messages around forever (or until they are manually deleted), until
1313 they become a certain number of days old, or until a certain number of
1314 additional messages are posted in the room, at which time the oldest
1315 ones will scroll out.</p>
1316 <p>When a new Citadel system is first installed, the default
1318 expire policy is set to 'manual' -- no automatic purging of messages
1319 takes place anywhere. For public message boards, you will probably want
1320 to set some sort of automatic expire policy, in order to prevent your
1321 message base from growing forever.</p>
1322 <p>You will notice that you can also fall back to the default expire
1323 policy for the floor upon which the room resides. This is the default
1324 setting. You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit
1325 floor</tt> command. The default setting for the floor default, in turn,
1326 is the system default setting, which can be changed using the <tt><b>.A</b>ide
1327 <b>S</b>ystem configuration <b>G</b>eneral</tt> command.</p>
1328 <pre>Save changes (y/n)? Yes<br></pre>
1329 <p>...this gives you an opportunity to back out, if you feel you really
1330 messed things up while editing.<br>
1333 <h3><a name="File_directories"></a>File directories</h3>
1334 <p>If you have created any directory rooms, you can attach file
1335 descriptions to the filenames through a special file called <tt>filedir</tt>.
1336 Each line contains the name of a file in the directory, followed by a
1337 space and then a description of the file, such as:</p>
1338 <pre>myfile.txt This is a description of my file.<br>phluff A phile phull of phluff!<br></pre>
1339 <p>...this would create file descriptions for the files <tt>myfile.txt</tt>
1340 and <tt>phluff</tt> which would be displayed along with the directory.
1341 It should also be noted that when users upload files to your system,
1342 they will be prompted for file descriptions, which will be added to the
1343 <tt>filedir</tt> file. If one does not exist, it will be created.<br>
1346 <h3><a name="Creating_and_editing_user_accounts"></a>Creating and
1347 editing user accounts</h3>
1348 <p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1349 command to create and/or edit user accounts. There are several
1350 parameters which can be set here.</p>
1351 <p>To create a user:</p>
1352 <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>
1353 <p>At this point, the new user account has been created, and the
1355 continue as if you were editing an existing account. Therefore the
1357 of this procedure is the same for creating and editing:</p>
1358 <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>
1359 <p>The blank lines are the user's 'registration' information --
1361 information such as full name, address, telephone number, etc. This
1363 will comprise the user's vCard in both their user profile and in the
1366 <pre>Change password [No]: No<br></pre>
1367 <p>...answer Yes to set or change the password for this account.</p>
1368 <pre>Access level [4]: <br></pre>
1369 <p>...this allows you to set or change the access level for this
1370 account. The access levels available are as follows: </p>
1372 <li>0 - Deleted. (This immediately deletes the account.) </li>
1373 <li>1 - New, unvalidated user </li>
1374 <li>2 - Problem user (severely restricts account - use for
1375 probationary access) </li>
1376 <li>3 - User with no network privileges. Same access as a normal user
1377 except cannot post messages in rooms shared on a network. </li>
1378 <li>4 - Normal user </li>
1379 <li>5 - Preferred user (access is granted to privileged rooms) </li>
1380 <li>6 - Aide (administrative access to the whole system) </li>
1382 <pre>Permission to send/receive Internet mail [ No]? No<br></pre>
1383 <p>If your system is configured to only allow Internet mail privileges
1384 to certain users, this is where you can grant or revoke that privilege.</p>
1385 <pre>Ask user to register again [Yes]: Yes<br></pre>
1386 <p>If you answer Yes to this question, the user will be presented with
1388 'registration' screen or set of prompts, the next time they log in
1390 a Citadel client. This will prompt them for their full name, address,
1393 <pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1394 <p>These statistics are available for informational purposes only, so
1395 there is normally no need to change them.</p>
1396 <pre>Set last call to now [No]: No<br>Purge time (in days, 0 for system default [0]: <br></pre>
1397 <p>Citadel contains an auto-purger which is capable of automatically
1398 deleting accounts which have not been accessed in a predefined period
1399 of time. If you choose to perform this operation, you can 'touch' the
1401 of a wayward user by setting their 'last call' time to 'now'. You can
1402 also adjust, on a per-user basis, the amount of time which must pass
1404 their account is purged by the system. This time is set in days. You
1405 can also specify 0 days to indicate that you wish to use the system
1410 <h3><a name="Deleting_and_moving_messages"></a>Deleting and moving
1412 <p>Aides and Room Aides have the ability to delete and move messages.
1413 After each message, the normal prompt appears:</p>
1414 <pre>(8) <B>ack <A>gain <Q>uote <R>eply <N>ext <S>top m<Y> next <?>help -><br></pre>
1415 <p>Entering <tt><b>D</b>elete</tt> will delete the message. A <tt>(y/n)</tt>
1416 prompt will appear to confirm that you really want to delete the
1417 message. Entering <tt><b>M</b>ove</tt> will prompt for a room to which
1418 the message should be moved.<br>
1421 <h3><a name="Customizing_the_help_files"></a>Customizing the help files</h3>
1422 <p>The subdirectory called <tt>help</tt> contains your system's help
1423 files. There's nothing hard-coded into the system that dictates what
1425 should be there. Whenever a user types the command <tt><b>.H</b>elp</tt>
1426 followed by the name of a help file, it displays the contents of that
1428 <p>The help files that come with the system, of course, are enough to
1429 guide a user through its operation. But you can add, change, or remove
1430 help files to suit whatever is appropriate for your system.</p>
1431 <p>There are several strings that you can put in help files that will
1433 substituted with other strings. They are:</p>
1434 <pre> <br> ^nodename = The node name of your system on a Citadel 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>
1435 <p>So, for example, you could create a help file which looked like:</p>
1436 <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>
1437 <h3><a name="Site_configuration"></a>Site configuration</h3>
1438 <p>Once your Citadel server is up and running, the first thing you'll
1439 want to do is customize and tune it. This can be done from the
1440 text-based client with the <tt><b>.A</b>ide <b>S</b>ystem
1441 configuration <b>G</b>eneral</tt> command, or from WebCit (if you have
1442 it installed) by clicking 'Advanced Options' followed by 'Edit
1443 site-wide configuration.' Either method will offer the same
1444 configuration options. This document shows the text mode client being
1446 <p>The first set of options deal with the identification of your system.</p>
1447 <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
1448 !="" more="" text="" on="" the="" next="" screen="">]: <br></jinkies></pre>
1449 <p>'Node name' refers to the short, unqualified node name by which your
1450 system is known on a Citadel network. Generally it will be the same as
1451 the unqualified host name of your computer; this is, in fact, the
1452 default setting.</p>
1453 <p>Then enter the fully-qualified domain name (FQDN) of your system. If
1455 are not on the Internet, you can simply set it to the same as your
1456 unqualified host name. Otherwise you should set this value to the host
1457 name by which your system is most commonly known.</p>
1458 <p>The field called 'Human-readable node name' (also known as the 'node
1459 title' or 'organization name' in other software) is used solely for
1460 display purposes. Set it to the actual name of your system as you want
1462 banners, messages, etc.</p>
1463 <p>If you have a modem or bank of modems answering data calls for your
1464 system, enter it in the field marked 'Modem dialup number.' Otherwise
1465 you may leave it blank.</p>
1466 <p>'Geographic location of this system' is another display field. Enter
1467 a city and state, or city and country. </p>
1468 <p>'Name of system administrator' is important! Any user who logs on
1469 with the name you enter here will automatically be granted Aide
1470 privileges. This is one of two ways for the system administrator to
1471 grant himself/herself Aide access to the system when initially setting
1472 it up. (The other is simply to have the first account created on a new
1474 <p>The next set of options are your system's security settings. Before
1475 delving into the actual options, we should review the various access
1476 levels available on the system. Citadel has seven access levels:</p>
1478 <li>0 (Deleted). A user whose access level is set to 0 will
1479 automatically be deleted by the system. </li>
1480 <li>1 (New User). Users at this level may only read messages.
1481 Entering messages is prohibited, except in the <tt>Mail></tt> room,
1482 where a message to 'sysop' may be entered. </li>
1483 <li>2 (Problem User). Also known as 'Twit.' </li>
1484 <li>3 (Local User). May enter messages, except in rooms shared on a
1485 Citadel network. </li>
1486 <li>4 (Network User). May enter messages in every accessible
1488 <li>5 (Preferred User). Use of this level is up to the whim of the
1489 system administrator. </li>
1490 <li>6 (Aide). Access is granted to the administrative functions of
1491 the system. (This access level may also be granted to a user only for a
1492 specific room, please see 'Room Aide' for more information.) </li>
1494 <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>Log all pages [No]: No<br></pre>
1495 <p>'Registration' refers to the process of a user entering various
1496 personal contact information (real name, address, telephone number,
1497 etc.) into the system. When enabled, this information is stored as a
1498 vCard object on the system in two places: the user's <tt>My Citadel
1500 room, and in the <tt>Global Address Book></tt> room. (Note: the
1502 should be made private on publicly-accessible systems, for obvious
1504 <p>If you answer Yes to 'Require registration for new users' then each
1505 new user, upon creating a new account, will immediately be entered into
1506 the registration process. On the other hand, if you answer Yes to
1507 'Disable self-service user account creation' then new users will not be
1509 log in at all -- all accounts must be created by an Aide.</p>
1510 <p>'Initial access level for new users' should be set to 1 (New User)
1511 if you would like to review each new user's registration info before
1512 granting them higher access. This would be done periodically with the <tt><b>.A</b>ide
1513 <b>V</b>alidate new users</tt> command. If you do not require
1514 registration, you should set the initial access level to 4 (Network
1516 <p>Given the above options, it then becomes clear that there are
1517 generally two ways you can set up your Citadel system, depending on its
1520 <li><b>A public access BBS or message board</b> - since you do
1521 not know who might want to log in, self-service account creation needs
1523 stay enabled. If you want to be strict about users identifying
1525 then you should also require users to register (just remember to post a
1526 privacy policy if you're going to collect personal information) -- then
1528 the initial access level to 1 (New User), so new users cannot post
1530 until after you've validated them. For a more lax environment, you can
1531 remove the registration requirement and grant new accounts level 4
1533 User) access on the first visit. </li>
1534 <li><b>A private email/groupware system for your organization</b> -
1535 in this case, disable self-service account creation; you don't want
1536 strangers welcoming themselves to your system. You'll probably also
1538 to disable registration, because you or some other site administrator
1539 will be entering users' contact info when you create their accounts.
1540 Since this is also how you assign their Internet e-mail addresses, it's
1541 probably a good idea to do it yourself instead of expecting them to do
1544 <p>'Access level required to create rooms' is up to you. You might wish
1546 restrict the creation of new rooms only to Aides, or you might wish to
1548 anyone to create a room. The latter is one of the Citadel culture's
1550 long-standing traditions; the former may be appropriate if users are
1553 <p>You have the ability to 'Automatically give room aide privs to a
1554 user who creates a private room.' If you answer Yes, then any user who
1556 guess-name, passworded, or invitation-only room will automatically
1557 become the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1558 command set while in that room. If you would rather grant this
1559 permission manually, answer No.</p>
1560 <p>Another tradition in the Citadel culture is to refrain from deleting
1561 problem users, but instead to 'twit' them (reduce their access level to
1563 [Problem User]). You can then 'Automatically move problem user messages
1564 to twit room' (answer Yes, then specify 'Name of twit room' and
1566 to create that room). If you employ this logic, any user with level 2
1568 User) access will continue to have access to the same set of rooms, but
1570 messages posted will automatically be routed to the Trashcan (or
1572 you call your twit room).</p>
1573 <p>If you have Internet mail configured, you have the option of
1574 restricting its use on a user-by-user basis. If you wish to do this,
1575 answer Yes to 'Restrict Internet mail to only those with that
1576 privilege.' Obviously this makes no sense for an internal e-mail
1577 system, but for a public BBS it
1578 might be appropriate.</p>
1579 <p>Normally, Aides have access to every room, public or private.
1580 They are also forbidden from <tt><b>Z</b>ap</tt>ping
1581 rooms, because the review of content is considered one of their roles.
1582 If you wish to change these policies, the next two options allow you
1583 to. You may 'Allow Aides to Zap (forget) rooms', in which case they may
1584 use the <tt><b>Z</b>ap</tt> command just like any other user.
1585 Aides may also <tt><b>.G</b>oto</tt> any private mailbox belonging to
1587 user, using a special room name format.</p>
1588 <p>If your local security and/or privacy policy dictates that you keep
1590 log of all pages (instant messages) that go through the system, then
1592 Yes to 'Log all pages'. If you answer Yes, you will be prompted for the
1593 name of a room to which all pages will be logged. If you answer No,
1595 only the sender and recipient of each individual message will receive a
1597 <p>The next set of options deals with the tuning of your system. It is
1598 usually safe to leave these untouched.</p>
1599 <pre>Server connection idle timeout (in seconds) [900]: <br>Maximum concurrent sessions [20]: <br>Maximum message length [10000000]: <br>Minimum number of worker threads [5]: <br>Maximum number of worker threads [256]: <br>Automatically delete committed database logs [Yes]:<br></pre>
1600 <p>The 'Server connection idle timeout' is for the connection between
1601 client and server software. It is <b>not</b> an idle timer for the
1602 user interface. 900 seconds (15 minutes) is the default and a sane
1604 <p>'Maximum concurrent sessions' is the highest number of user sessions
1605 you wish to allow on your system at any given time. Citadel can scale
1606 to hundreds of concurrent users, but if you have limited hardware or
1607 (more likely) limited bandwidth, you might wish to set a maximum. You
1608 can also set it to zero for no limit.</p>
1609 <p>'Maximum message length' is just that. This could be a good way to
1610 prevent enormous multimedia files from finding their way into your
1611 message base. This maximum is enforced in all protocols and is also
1612 advertised by the ESMTP service.</p>
1613 <p>The minimum and maximum number of worker threads can be tuned to
1615 liking. Citadel will attempt to keep one worker thread running per
1617 within these constraints. You should be aware that due to the use of
1619 worker thread model, Citadel can handle a large number of concurrent
1621 with a much smaller thread pool. If you don't know the programming
1623 behind multithreaded servers, you should leave these parameters alone.<br>
1625 <p>'Automatically delete committed database logs' is a <span
1626 style="font-style: italic;">crucial</span> setting which affects your
1627 system's disk utilization and backup recoverability. Please refer
1628 to the <a href="#Database_maintenance">database maintenance</a>
1629 section of this document to learn how the presence or absence of
1630 database logs affect your ability to reliably backup your Citadel
1633 <p>The next set of options affect how Citadel behaves on a network.</p>
1634 <pre>Server IP address (0.0.0.0 for 'any') [0.0.0.0]:<br>POP3 server port (-1 to disable) [110]:<br>POP3S server port (-1 to disable) [995]:<br>IMAP server port (-1 to disable) [143]:<br>IMAPS server port (-1 to disable) [993]:<br>SMTP MTA server port (-1 to disable) [25]:<br>SMTP MSA server port (-1 to disable) [587]:<br>SMTPS server port (-1 to disable) [465]:<br>Correct forged From: lines during authenticated SMTP [Yes]:<br></pre>
1635 <p>"Server IP address" refers to the IP address on <span
1636 style="font-style: italic;">your server</span> to which Citadel's
1637 protocol services should be bound. Normally you will leave this
1638 set to 0.0.0.0, which will cause Citadel to listen on all of your
1639 server's interfaces. However, if you are running multiple
1640 Citadels on a server with multiple IP addresses, this is where you
1641 would specify which one to bind this instance of Citadel to.</p>
1642 <p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP
1643 services. For a system being used primarily for Internet e-mail, these
1644 are essential, so you'll want to specify the standard port numbers: 25,
1645 110, and 143. If Citadel is running alongside some other mail system,
1646 though, then you might want to choose other, unused port numbers, or
1647 enter -1 for any protocol
1648 to disable it entirely.</p>
1649 <p>You'll also notice that you can specify two port numbers for SMTP:
1651 for MTA (Mail Transport Agent) and one for MSA (Mail Submission Agent).
1653 traditional ports to use for these purposes are 25 and 587. If you are
1654 running an external MTA, such as Postfix (which submits mail to Citadel
1656 LMTP) or Sendmail (which submits mail to Citadel using the 'citmail'
1657 delivery agent), that external MTA will be running on port 25, and you
1659 specify "-1" for the Citadel MTA port to disable it. The MSA port
1661 usually 587) would be the port used by end-user mail client programs
1663 Aethera, Thunderbird, Eudora, or Outlook, to submit mail into the
1665 All connections to the MSA port <b>must</b> use Authenticated SMTP.<br>
1667 <p>The protocols ending in "S" (POP3S, IMAPS, and SMTPS) are
1668 SSL-encrypted. Although all of these protocols support the
1669 STARTTLS command, older client software sometimes requires connecting
1670 to "always encrypted" server ports. Usually when you are looking
1671 at a client program that gives you a choice of "SSL or TLS," the SSL
1672 option will connect to one of these dedicated ports, while the TLS
1673 option will connect to the unencrypted port and then issue a STARTTLS
1674 command to begin encryption. (It is worth noting that this is <span
1675 style="font-style: italic;">not</span> the proper use of the acronyms
1676 SSL and TLS, but that's how they're usually used in many client
1679 <p>All of the default port numbers, including the encrypted ones, are
1680 the standard ones.<br>
1682 <p>The question about correcting forged From: lines affects how Citadel
1683 behaves with authenticated SMTP clients. Citadel does not ever allow
1684 third-party SMTP relaying from unauthenticated clients -- any incoming
1686 addressed to a user on the system or somewhere in a Citadel network. To
1687 use Citadel with SMTP client software such as Netscape, Outlook,
1689 whatever, users must log in with a username and password. In order to
1691 message forgeries, Citadel discards the <tt>From:</tt> line in any
1693 entered by an authenticated user, and replaces it with a <tt>From:</tt>
1695 containing the user's genuine name and e-mail address. Technically,
1697 violates RFC822, because headers are never supposed to be altered, but
1699 sense dictates that this is a good idea. Nevertheless, if you want to
1701 this behavior, answer 'No' at the prompt (the default is 'Yes') and the
1703 will never be altered.<br>
1704 <span style="font-family: monospace;"><br>
1705 Connect this Citadel to an LDAP directory [No]: No</span><br>
1707 <p>The LDAP configuration options are discussed elsewhere in this
1710 <p>The final set of options configures system-wide defaults for the
1712 <pre>Default user purge time (days) [120]: <br>Default room purge time (days) [30]: <br>System default message expire policy (? for list) [0]: <br>Keep how many messages online? [150]:<br>Mailbox default message expire policy (? for list) [0]:<br>How often to run network jobs (in seconds) [1800]:<br>Enable full text search index (warning: resource intensive) [Yes]: Yes<br>Hour to run purges (0-23) [4]:<br></pre>
1713 <p>Any user who does not log in for the period specified in 'Default
1714 user purge time' will be deleted the next time a purge is run. This
1715 setting may be modified on a per-user basis.</p>
1716 <p>'Default room purge time' behaves the same way, and may also be
1717 modified on a per-room basis.</p>
1718 <p>'System default message expire policy' defines the way in which old
1719 messages are expired (purged) off the system. You can specify any of:</p>
1721 <li>Purge by age (specify in days) </li>
1722 <li>Purge by message count in the room (specify number of messages) </li>
1723 <li>Do not purge at all </li>
1725 <p>Again, this setting may be overridden on a per-floor basis, and the
1726 floor setting may be overridden on a per-room basis. You'll also notice
1727 that you can set a <i>different</i> default for mailbox rooms if you
1729 to. This can allow you, for example, to set a policy under which old
1730 messages scroll out of public rooms, but private mail stays online
1732 until deleted by the mailbox owners.<br>
1734 <p>"How often to run network jobs" refers to the sharing of content on
1736 Citadel network. If your system is on a Citadel network, this
1738 item dictates how often the Citadel server will contact other Citadel
1739 servers to send and receive messages. In reality, this will happen more
1740 frequently than you specify, because other Citadel servers will be
1741 contacting yours at regular intervals as well.<br>
1743 <p>"Hour to run purges" determines when expired and/or deleted objects
1744 are purged from the database. These purge operations are
1745 typically run overnight and automatically, sometime during whatever
1746 hour you specify. If your site is much busier at night than
1747 during the day, you may choose to have the auto-purger run during the
1749 <p>"Enable full text search index," if enabled, instructs the server to
1750 build and maintain a searchable index of all messages on the
1751 system. This is a time and resource intensive process -- it could
1752 take days to build the index if you enable it on a large
1753 database. Once enabled, however, it will be updated incrementally
1754 and will not have any noticeable impact on the interactive response
1755 time of your system. The full text index is currently only
1756 searchable when using IMAP clients; other search facilities will be
1757 made available in the near future.<br>
1758 <span style="font-family: monospace;"></span></p>
1759 <p><span style="font-family: monospace;">Save this configuration? No</span><br>
1761 <p>When you're done, enter 'Yes' to confirm the changes, or 'No' to
1762 discard the changes.</p>
1764 <hr size="2" width="100%">
1765 <h2 align="center"><a name="Configuring_Citadel_for_Internet_e-mail"></a>Configuring
1766 Citadel for Internet e-mail</h2>
1767 <div align="justify">
1768 <h3><a name="Introduction"></a>Introduction</h3>
1769 As you know by now, Citadel is a completely self-contained,
1770 full-featured Internet e-mail system. When you run Citadel you do
1771 not need any other mail software on your host system. This
1772 eliminates the need for tedious mucking about with sendmail, qmail,
1773 postfix, Cyrus, the UW IMAP
1774 server, or any of countless other needlessly complex programs that lead
1775 some people to the false assumption that Unix systems are difficult to
1778 Some of the many features supported by Citadel are:<br>
1780 <li>Built-in SMTP and ESMTP service, for delivering and receiving
1781 e-mail on the Internet</li>
1782 <li>Built-in POP3 service, for remote fetching of messages</li>
1783 <li>Built-in IMAP service, for access to mail using any standard mail
1785 <li>Web mail (implemented using the "WebCit" middleware, which is
1786 installed separately)</li>
1787 <li>Support for mailing lists, in both "individual message" and
1788 "digest" formats</li>
1789 <li>Multiple/virtual domain support</li>
1790 <li>Any user may have multiple Internet e-mail addresses, in multiple
1792 <li>Global address book (Users with addresses in a domain may be
1793 spread out across many servers on a Citadel network)</li>
1794 <li>Easy-to-configure integration with <a
1795 href="http://www.spamassassin.org/">SpamAssassin</a> can block spam <i>before</i>
1796 it enters the mail system</li>
1797 <li>Easy-to-configure integration with most Realtime Blackhole
1798 Lists (RBL) provide further defense against spammers</li>
1800 This section of the documentation will demonstrate how to configure
1803 <h3><a name="Basic_site_configuration"></a>Basic site configuration</h3>
1804 <p>Basic configuration of your Citadel system for Internet e-mail
1806 the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>I</b>nternet</tt>
1808 <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>
1809 <p>This is a "clean" setup. For a simple, standalone e-mail system you
1810 simply have to enter the <tt><b>A</b>dd</tt> command:</p>
1811 <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>
1812 <p><b>localhost:</b> Basically what you're doing here is telling
1814 what any aliases for your machine are. If your machine were <tt>schmeep.splorph.com</tt>
1815 and you also had a DNS entry set up for <tt>blah.com</tt>, you might
1816 want to enter '1' and enter <tt>blah.com</tt> as your alias, so that
1818 sent to that address won't bounce.</p>
1819 <p><i>Important tip:</i> if your system is known by one name and <i>only</i>
1820 one domain, you might not even need to do this at all. You will recall
1821 that you entered your system's fully qualified domain name earlier when
1822 you went through the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1823 command. The domain name you entered there is automatically considered
1824 by Citadel to be a 'localhost' entry in your Internet mail
1825 configuration. It does not hurt to enter it in both locations, though.</p>
1826 <p><b>gateway domain:</b> this is a simple way of mapping various
1827 Citadel hosts in an Internet domain. For example, if you enter <tt>bar.com</tt>
1828 as a gateway domain, then mail to users at <tt>foo.bar.com</tt> will
1829 be forwarded to the host called <tt>foo</tt> on a Citadel network,
1831 at <tt>kunst.bar.com</tt> will be delivered to the Citadel server
1833 <tt>kunst</tt>, etc. This feature has limited usefulness; if you are
1835 a network of Citadel servers, it is more likely that you will use the
1837 feature, explained below.</p>
1838 <p><b>smart-host:</b> Normally, Citadel sends outbound Internet e-mail
1839 directly to its destination. This may not be appropriate for some
1840 sites; you may require (due to local convention, security policy, or
1841 whatever) that all outbound mail be sent to an SMTP relay or forwarder.
1843 functionality, simply enter the domain name or IP address of your relay
1844 as a 'smart-host' entry.</p>
1845 <p><b>directory:</b> a domain for which you are participating in
1846 directory services across any number of Citadel nodes. For example, if
1847 users who have addresses in the domain <tt>citadel.org</tt> are spread
1848 out across multiple Citadel servers on your network, then enter <tt>citadel.org</tt>
1849 as a 'directory' entry. <i>For this to work, all Citadel servers
1850 participating in directory service <b>must</b> carry and share the <tt>Global
1851 Address Book></tt> room.</i></p>
1852 <p><b>spamassassin:</b> if you are running a <a
1853 href="http://www.spamassassin.org">SpamAssassin</a> service anywhere
1855 <b>local</b> network, enter its name or IP address as a 'spamassassin'
1856 entry. This may be (and, in fact, will usually be) <tt>127.0.0.1</tt>
1858 that the service is running on the same host computer as the Citadel
1860 <p>Please install SpamAssassin as per its own documentation. You will
1861 want to run SpamAssassin in client/server mode, where a <tt>spamd</tt>
1862 daemon is always running on your computer. Citadel does not utilize the
1863 <tt>spamc</tt> client; instead, it implements SpamAssassin's protocol
1865 <p>Connecting to a SpamAssassin service across a wide area network is
1866 strongly discouraged. In order to determine whether an incoming e-mail
1867 is spam, Citadel must feed the <i>entire message</i> to the
1868 SpamAssassin service. Doing this over a wide area network would consume
1870 which would affect performance.</p>
1871 <p>Citadel invokes the SpamAssassin service when incoming messages are
1872 arriving via SMTP. Before a message is accepted, it is submitted to
1873 SpamAssassin. If SpamAssassin determines that the message is spam, the
1875 service <i>rejects the message,</i> causing a delivery failure on the
1877 host. This is superior to software which files away spam in a separate
1878 folder, because delivery failures will cause some spammers to assume
1880 address is invalid and remove it from their mailing lists.</p>
1881 <p><b>RBL:</b> Realtime Blackhole Lists (RBL's) provide defense against
1882 spammers based on their source IP address. There are many such lists
1883 available on the Internet, some of which may be utilized free of
1884 charge. Since they are DNS based, the lists do not require storage on
1885 your server -- they are queried during the SMTP conversation.</p>
1886 <p>Citadel can utilize any RBL that uses the <tt>z.y.x.w.nameoflist.org</tt>
1887 syntax, where <tt>w.x.y.z</tt> is the source IP address which is
1888 attempting to deliver mail to your server. For example, <a
1889 href="http://www.spamcop.net">SpamCop</a> would use the query <tt>2.0.0.127.bl.spamcop.net</tt>
1890 to determine whether the host at <tt>127.0.0.2</tt> is a known spammer
1891 or open relay. In this case, you simply select option '6' to add an RBL
1892 entry, and provide it with the domain suffix of <tt>bl.spamcop.net</tt>
1894 and extra dot will be automatically prepended for each query).</p>
1895 <p>Now select <tt><b>S</b>ave</tt> and you are just about ready for
1896 Internet e-mail.</p>
1897 <h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the
1898 Internet mail protocols</h3>
1899 <p>As previously mentioned, Citadel contains its own SMTP, POP3, and
1900 IMAP services. Enabling them is simple.</p>
1901 <p>Check for the existance of a current MTA (sendmail, qmail, etc.) by
1902 connecting to port 25 on your host. If you see something similar to the
1904 you're running an MTA already and you'll need to shut it down:</p>
1905 <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>
1906 <p>In the above example, we see that the host already has Sendmail
1907 listening on port 25. Before Citadel can use port 25, Sendmail must be
1908 shut off. Please consult the documentation for your operating system
1909 for instructions on how to do this. (On a Red Hat Linux system, for
1910 example, you can run the <tt>ntsysv</tt> utility, un-checking <tt>sendmail</tt>
1912 the next reboot; then, run <tt>service sendmail stop</tt> to shut off
1914 currently running service.)</p>
1915 <p>If you get a 'connection refused' message when you telnet to port 25
1916 there's nothing running and you should be able to continue. You might
1917 also want to turn off POP (try the above test substituting 110 for 25)
1918 and IMAP (port 143) and use Citadel's POP and IMAP services.</p>
1919 <p>Citadel will look for an existing pop/smtp server on startup. If
1921 don't exist (and you've configured them properly) then Citadel should
1923 them at startup. You can check your logs to be sure, or you can start
1925 server from a shell and watch it load. It might look something like
1927 <font size="-2"> </font>
1928 <pre><font size="-2">smw @ pixel % ./citserver<br><br>Multithreaded message server for Citadel<br>Copyright (C) 1987-2003 by the Citadel development team.<br>Citadel 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 instant messages)<br>Registered server command GEXP (Get instant messages)<br>Registered server command SEXP (Send an instant message)<br>Registered server command DEXP (Disable instant 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>
1929 <p>The lines emphasized in boldface in the above log output tell you
1930 that Citadel "can't bind" to various ports. The error 'address already
1931 in use' generally means that something else is already running on the
1932 requested port. Make SURE you've followed the above steps to remove
1933 sendmail/pop and start your Citadel server again.</p>
1934 <h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
1935 <p>Occationally it is not practical to remove a non-Citadel MTA on your
1936 host system. For example, you might have multiple groups of users, some
1938 which are using Citadel and some of which are using a legacy Unix mail
1939 spool. This type of configuration is discouraged, but two tools are
1942 <p>The tool is called <tt>citmail</tt> and it is, quite simply, a
1943 local MDA (Mail Delivery Agent) which you can configure into your MTA
1944 for final delivery of incoming messages to Citadel users. A full
1945 discussion of the finer points of complex Sendmail configurations is
1946 beyond the scope of this document; however, you might want to visit <a
1947 href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some
1948 useful HOWTO documents are provided.<br>
1950 <p>The other tool is an <a href="http://www.faqs.org/rfcs/rfc2033.html">RFC2033</a>
1951 compliant LMTP service running on a local socket. If you're
1952 running a mailer that speaks LMTP (such as <a
1953 href="http://www.postfix.org/">Postfix</a>), you can simply point your
1954 mailer at the socket called <span style="font-family: monospace;">citadel.socket</span>
1955 in your Citadel directory. For example, in Postfix you might put
1956 the following line into <span style="font-family: monospace;">main.cf</span>
1957 in order to tell it to use Citadel to deliver mail to local recipients:<br>
1959 <pre>local_transport = lmtp:unix:/usr/local/citadel/lmtp.socket<br></pre>
1960 <p>Postfix also has something called a "fallback transport" which can
1961 be used to implement Citadel as a "secondary" mail system on your
1962 server, while keeping the existing Unix mailboxes intact.
1963 However, it is beyond the scope of this document to detail the finer
1964 points of the configuration of Postfix or any other mailer, so refer to
1965 the documentation to those programs and keep in mind that Citadel has
1966 LMTP support.<span style="font-family: monospace;"></span></p>
1967 <p>There are actually <i>two</i> LMTP sockets. One is called
1968 <tt>lmtp.socket</tt> and the other is called <tt>lmtp-unfiltered.socket</tt>
1969 (both are found in your Citadel directory). The difference should be
1970 obvious: messages submitted via <tt>lmtp.socket</tt> are subject to
1972 spam filtering you may have configured (such as SpamAssassin), while
1974 submitted via <tt>lmtp-unfiltered.socket</tt> will bypass the filters.
1976 would use the filtered socket when receiving mail from an external MTA
1978 as Postfix, but you might want to use the unfiltered socket with
1980 such as fetchmail.</p>
1982 <p>For outbound mail, you
1983 can either allow Citadel to perform
1985 (this won't affect your other mail system because outbound mail doesn't
1987 up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which will
1989 Citadel to forward all of its outbound mail to your other mail system.</p>
1990 <h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet
1992 <p>Citadel has built in mailing list service (known in the 'net
1993 vernacular as "listserv") functionality. You can turn any room
1994 into a mailing list. Users can then choose how they participate
1995 -- by logging on to your Citadel server directly, or by having the
1996 room's contents mailed to
1997 them somewhere else. Configuring this is easy.</p>
1998 <p>Citadel supports two modes of mailing list delivery: </p>
2000 <li>"List mode" -- each individual message is delivered as a single
2001 e-mail to each list mode recipient. The "From:" header will
2002 display the address of the message's original author.</li>
2003 <li>"Digest mode" -- groups of one or more messages are delivered
2004 to digest mode recipients. The number of messages in the group
2005 depends on how many new messages arrived since the last batch was
2006 delivered. The "From:" header will display the address of the
2007 room itself, which allows replies to be posted back to the room.</li>
2009 A room may have any combination of list mode and digest mode
2011 <p>As alluded to above, every room on your Citadel system has an
2012 Internet e-mail address of its own. Messages sent to that address
2014 posted in the room (and sent back out to mailing list recipients, as
2016 as to any other Citadels you share the room with). The address
2018 is <tt>room_</tt> plus the name of the room, with any spaces replaced
2020 underscores, followed by <tt>@</tt> and your hostname. For example, if
2022 system is known as <tt>phlargmalb.orc.org</tt> on the Internet, and
2024 a room called <tt>Bubblegum Collectors</tt>, you can post to that room
2026 anywhere on the Internet simply by sending an e-mail to <tt>room_bubblegum_collectors@phlargmalb.orc.org</tt>.
2027 When the message arrives, it's automatically posted in that room.</p>
2028 <p>To manually edit the list of "list mode" recipients, simply enter
2029 the <tt><b>.A</b>ide
2030 mailing <b>L</b>ist management</tt> command. Your text editor will
2032 up and you will be able to create or edit a list of recipients, one per
2033 line. Lines beginning with a hash (<tt>#</tt>) are comments.</p>
2034 <p>To manually edit the list of "digest mode" recipients, enter the <tt><b>.A</b>ide
2035 mailing list <b>D</b>igest recipients</tt> command. As with the
2036 previous command, the text editor will open up and you can edit the
2037 list of digest mode recipients, one per line.</p>
2038 <p>Citadel also has a facility which allows users to subscribe or
2039 unsubscribe to mailing lists using a web browser. In order to do this,
2040 WebCit must also be running on your server in addition to Citadel.
2041 WebCit is obtained and installed separately from the rest of the
2043 <p>In order to prevent "just anyone" from subscribing to any room on
2044 your system, there is a setting in the <tt><b>.A</b>ide <b>E</b>dit
2045 room</tt> command:</p>
2046 <pre>CitaNews} . Aide Edit this room<br>
2047 Room name [CitaNews]:<br>
2049 <i>(lots of other stuff omitted for brevity...)</i><br>
2051 Self-service list subscribe/unsubscribe [No]: Yes<br></pre>
2052 <p>When you answer "Yes" to self-service list subscribe/unsubscribe,
2054 enabling that feature. Now, all you have to do is tell the world about
2056 web page they need to visit. It looks like this:</p>
2057 <center><tt>http://foobar.baz.org:2000/listsub</tt></center>
2058 <p>In this example, the server is called <tt>foobar.baz.org</tt> and
2059 WebCit is running on port 2000. Edit appropriately.</p>
2060 <p>Citadel offers a subscribe/unsubscribe facility that is more
2061 intuitive than other listservs. With most systems, sending commands to
2062 the listserv requires that you e-mail it commands in a special format.
2063 It's easy to get it wrong. Citadel simply uses your web browser. You
2064 select the list you want to subscribe or unsubscribe (hint: it's the
2065 list of rooms you've enabled self-service for), select whether you want
2066 list mode or digest mode, and enter your e-mail address. For security
2067 purposes, a confirmation message is sent to the address you enter. But
2068 you don't have to reply to the message in a weird format, either: the
2069 confirmation contains another URL which
2070 you simply click on (or paste into your browser if you can't click on
2072 in your e-mail software) and the confirmation is automatically
2074 <hr size="2" width="100%">
2076 <h2><a name="Building_or_joining_a_Citadel_network"></a>Building or
2077 joining a Citadel network</h2>
2079 <h3><a name="Overview__"></a>Overview</h3>
2080 <p>If you are running Citadel as a BBS or other forum type of
2081 application, one way to 'keep the conversation going' is to share rooms
2082 with other Citadel systems. In a shared room, a message posted to the
2083 room is automatically
2084 propagated to every system on the network. It's kind of like a UseNet
2086 but without the spam.</p>
2087 <p>If you are using Citadel as the e-mail and groupware platform for a
2088 large organization, you can use its networking features to build a
2089 large network of Citadel servers which share content (think of rooms as
2090 public folders), redistribute e-mail throughout the organization, and
2091 integrate the global address book. It might make sense, for
2092 example, in a large corporation to give each department or location its
2093 own Citadel server. Thanks
2094 to Citadel's global address book features, you could still have all of
2096 users share a single e-mail domain.</p>
2097 <p>Obviously, the first thing you have to do is find another Citadel to
2098 share rooms with, and make arrangements with them. The following
2099 Citadels are a good place to start:</p>
2101 <li>UNCENSORED! - <a href="http://uncensored.citadel.org">uncensored.citadel.org</a>
2103 <li>The Dog Pound II - <a href="http://dogpound2.citadel.org">dogpound2.citadel.org</a>
2105 <li>PixelBBS - <a href="http://pixel.citadel.org">pixel.citadel.org</a>
2108 <p>You don't have to be a part of the citadel.org domain to participate
2109 in the public Citadel network, but the DNS service is provided free of
2110 charge by the Citadel community if you wish to do this.</p>
2111 <h3><a name="Conventions_and_etiquette_when"></a>Conventions and
2112 etiquette when connecting to the public Citadel network</h3>
2113 <p>Before we get into the technical nitty gritty, there are two points
2114 of etiquette to keep in mind. The first thing to keep in mind is that
2115 the operator of any particular Citadel may not be willing to share some
2116 of his/her rooms. Some sites are proud to offer exclusive content in
2117 certain areas. Chances are, if a room is already being shared on the
2118 network, it's available for anyone to share; if not, it can't hurt to
2119 ask -- but take care not to demand it of them. Ask if you may share the
2120 room instead of telling them that you wish to share the room. When
2121 looking at a <tt><b>K</b></tt>nown rooms list, network rooms are the
2122 ones ending in parentheses instead of angle brackets. For example, <tt>Gateway)</tt>
2123 would be a network room, <tt>Lobby></tt> would not.</p>
2124 <p>The other point of etiquette to remember is that you should be
2126 the arrangements in advance, and then set it up. It is extremely rude
2128 simply begin networking with another Citadel, or unilaterally start
2130 a new room, without first obtaining permission from its operator.
2132 ask first. Most Citadel operators are more than happy to network with
2133 you. Also, if later on you decide to take your system down, please take
2135 to notify the operators of any other Citadels you network with, so they
2137 unconfigure their end.</p>
2138 <h3><a name="Getting_ready_to_join_the_network"></a>Getting ready to
2139 join the network</h3>
2140 <p>Ok, first things first. On a Citadel room sharing network, the first
2141 thing you need to know is your own system's node name. Presumably you
2143 this up during installation, but if you want to change it you can do so
2145 the <tt><b>.A</b>ide <b>S</b>ysconfig <b>G</b>eneral</tt> command:</p>
2146 <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>
2147 <p>The "node name" is important, it's how the network identifies
2148 messages coming from your system. The "human readable node name" is
2149 simply a label; it shows up in messages coming from your system. "Fully
2150 qualified domain name" is your DNS name; it's used for routing messages
2151 on the Internet. In the above example, the node name is "uncnsrd".</p>
2152 <h3><a name="Defining_neighbor_nodes"></a>Defining neighbor nodes</h3>
2153 <p>The next thing you need to do is configure your neighbor node(s).
2154 You need to do this for each node you network with. Let's say you
2156 to talk to a Citadel system called "frobozz". Use the <tt><b>.A</b>ide
2157 <b>S</b>ysconfig <b>N</b>etwork</tt> command:</p>
2158 <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>
2159 <p>As you can see in the above example, you have to enter the Citadel
2160 node name, the DNS name or IP address of the server, and the port
2161 number the Citadel service is running on. The "shared secret" is a
2162 password to allow the two Citadel nodes to connect to each other to
2163 exchange network data. The password must be <i>identical</i> on both
2164 ends of the connection -- when the operator of the other Citadel node
2165 sets up the connection with
2166 your system, he/she must use the same password.</p>
2167 <h3><a name="Sharing_rooms"></a>Sharing rooms</h3>
2168 <p>Now you're ready to share rooms. You have to do this for each room
2169 you want to share, and you have to do it from BOTH ENDS -- again, when
2171 share a room with another Citadel, they must share it with you as well.
2172 Let's say you have a room called "Quiche Recipes>" and you want to
2174 it with the node you set up above. First, edit the room and flag it as
2177 <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>
2178 <p>Notice how the prompt changed? It was > before, but it's ) now.
2179 That means it's a network room. Now you can tell Citadel that you want
2181 share the room with frobozz. Enter this command:</p>
2182 <pre>Quiche Recipes) . Aide Network room sharing<br></pre>
2183 <p>Your text editor will pop up (you <i>did</i> configure Citadel to
2185 your favorite text editor, right?) with a screen that looks like this:</p>
2186 <pre># Configuration for room: Quiche Recipes<br># Nodes with which we share this room<br># Specify one per line.<br></pre>
2187 <p>All you have to do is enter the name of the other Citadel node (i.e.
2188 "frobozz" in our example) on a line by itself. As usual, lines starting
2190 "#" are comments. Just go to the end of the file, type "frobozz"
2192 the quotes), save the file... and you're done!</p>
2193 <p>At this point, you just sit back and enjoy. Your Citadel and the
2194 other one will begin polling each other at regular intervals (once per
2196 by default) and sharing messages.</p>
2197 <h3><a name="Sending_mail"></a>Sending mail</h3>
2198 <p>You can send mail to any user on any node of your Citadel network.
2199 It may take a little while for your system to learn the entire node
2200 list, though, as this is done by watching incoming messages on the
2201 network and learning which nodes are out there.</p>
2202 <p>To send a private message, just enter <tt>user @ host</tt> as the
2204 <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>
2205 <h3><a name="Changing_the_polling_interval"></a>Changing the polling
2207 <p>As previously mentioned, Citadel will poll other Citadel nodes for
2208 messages once per hour. If this is not an acceptable interval, you can
2209 change it using the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
2210 command. Enter this command and look for the option:</p>
2211 <pre>How often to run network jobs (in seconds) [3600]:<br></pre>
2212 <p>Change it to whatever you like. For example, 15 minutes is 900
2213 seconds. So if you changed the default value to 900, network polling
2214 would occur every 15 minutes.</p>
2216 <h2 align="center"><a name="Database_maintenance"></a>Database
2218 <h3><a name="Introduction_"></a>Introduction</h3>
2219 The data store used by Citadel is reliable and self-maintaining.
2220 It requires very little maintenance. This is primarily due
2221 to its use of the <a href="http://www.sleepycat.com">Berkeley DB</a>
2222 record manager. It is robust, high-performance, and transactional.<br>
2224 A few small data files are kept in your main Citadel directory, but the
2225 databases are in the <tt>data/</tt> subdirectory. The files with
2226 names that begin with "cdb" are the databases themselves; the files
2227 with names that begin with "log" are the logs (sometimes referred to as
2228 "journals"). Log files will continue to appear as you use your
2229 system; each will grow to approximately 10 megabytes in size before a
2230 new one is started. There is a system configuration setting
2231 (found in <span style="font-family: monospace;"><span
2232 style="font-weight: bold;">.A</span>ide <span
2233 style="font-weight: bold;">S</span>ystem-configuration <span
2234 style="font-weight: bold;">G</span>eneral</span> in the text mode
2235 client, or in <span style="font-family: monospace;">Administration
2236 --> Edit site-wide configuration --> Tuning</span> in the WebCit
2237 client) which specifies "Automatically delete committed database
2238 logs." If you have this option enabled, Citadel will
2239 automatically delete any log files whose contents have been fully
2240 committed to the database files.<br>
2242 For more insight into how the database and log files work, you may wish
2244 href="http://www.sleepycat.com/docs/ref/transapp/archival.html">Berkeley
2245 DB documentation</a> on this subject.<br>
2247 <h3><a name="Backing_up_your_Citadel_database"></a>Backing up your
2248 Citadel database</h3>
2249 <span style="font-weight: bold;">Please read this section carefully.</span><br>
2251 There are two backup strategies you can use, depending on your site's
2252 availability requirements and disk space availability.<br>
2253 <h5>Strategy #1: Standard backup</h5>
2254 The standard (or "offline") backup is used when your Citadel server is
2255 configured to automatically delete committed database logs. The
2256 backup procedure is as follows:<br>
2258 <li>Shut down the Citadel server.</li>
2259 <li>Back up all files (database files, log files, etc.) to tape or
2260 some other backup media.</li>
2261 <li>Start the Citadel server.</li>
2263 <span style="font-style: italic;">Advantage:</span> very little disk
2264 space is consumed by the logs.<br>
2265 <span style="font-style: italic;">Disadvantage:</span> Citadel is not
2266 available during backups.<br>
2268 <h5>Strategy #2: "Hot" backup</h5>
2269 The "hot backup" procedure is used when your Citadel server is
2270 configured <span style="font-weight: bold;">not</span> to
2271 automatically delete committed database logs. The backup
2272 procedure is as follows:<br>
2274 <li>Back up all files. Make sure the database files (<span
2275 style="font-family: monospace;">cdb.*</span>) are backed up <span
2276 style="font-style: italic;">before</span> the log files (<span
2277 style="font-family: monospace;">log.*</span>). This will usually
2278 be the case, because the database files tend to appear first in both
2279 alphabetical and on-disk ordering of the <span
2280 style="font-family: monospace;">data/</span> directory.</li>
2281 <li>After verifying that your backup completed successfully, delete
2282 the committed log files with a command like this:</li>
2284 <span style="font-family: monospace;">/usr/local/citadel/sendcommand "CULL"</span><br>
2286 <span style="font-style: italic;">Advantage:</span> Citadel continues
2287 to run normally during backups.<span style="font-style: italic;"><br>
2288 Disadvantage:</span> Much disk space is consumed by the log files,
2289 particularly if the full text indexer is turned on.<br>
2292 It is up to you to decide which backup strategy to use. <span
2293 style="font-weight: bold;">Warning: if you configure Citadel to
2294 automatically delete committed database logs, and do not shut the
2295 Citadel service down during backups, there is no guarantee that your
2296 backups will be usable!</span><br>
2298 <h3><a name="Database_repair"></a>Database repair</h3>
2299 Although Citadel's data store is quite reliable, database corruption
2300 can occur in rare instances. External factors such as an
2302 system crash or an unexpected loss of power might leave the database in
2303 an unknown state. A utility is provided which may be able to
2305 your database if this occurs. If you find that your Citadel
2307 is not running, and reading the logs shows that it is crashing because
2309 an inability to validate a database, follow these steps:<br>
2311 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2312 "respawn" to "off." Type <tt>init q</tt> to make this setting
2314 <li><b>Make a backup of your data.</b> Either write it out to
2315 tape or copy it to another directory, or a tarball.<br>
2317 <li><tt>cd</tt> to your Citadel directory and type <tt>./database_cleanup.sh</tt></li>
2318 <li>Let the cleanup script run. <b>Do not interrupt this
2319 process for any reason.</b><br>
2321 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2322 "off" to "respawn". Type <tt>init q</tt> to activate your
2325 If this procedure does not work, you must restore from your most recent
2328 <h3><a name="ImportingExporting_your_Citadel"></a>Importing/Exporting
2329 your Citadel database<br>
2331 <p>Citadel contains an importer/exporter module, affectionately
2332 known as the "Art Vandelay" module (a not-so-obscure Seinfeld
2334 allows you to export the entire contents of your Citadel databases to a
2335 flat file, which may then be imported on another system. (This
2337 is also known as "dump and load" to database gurus.)</p>
2338 <p>Why would you want to do this? Here are some scenarios: </p>
2340 <li>You are moving a Citadel installation to another computer, which
2341 uses a different CPU. Since Citadel stores data in an
2342 architecture-dependent format, the data files wouldn't work on the new
2343 computer as-is. </li>
2344 <li>Your computer crashed, lost power, etc. and you suspect that your
2345 databases have become corrupted. </li>
2346 <li>You want to switch to a different back-end data store. (For
2347 example, from GDBM to Berkeley DB) </li>
2349 <p>So ... how do we work this magic? Follow these steps <i>exactly</i>
2350 as documented and you should be able to do it all with very little
2353 <li>This should be obvious, but it's still worth mentioning: <b>Make
2354 sure you have a backup of everything before you start this! </b>
2355 You're performing a major operation here. Don't risk it. </li>
2356 <li>First, get all the users logged off from your system. Disconnect
2357 it from the network if possible. You don't want anyone logging in while
2358 you're doing this. </li>
2359 <li>Log on as root, or some other user that has read/write access to
2360 all relevant files. </li>
2361 <li>Go to the directory that Citadel is installed in. For example,
2362 issue a command like <tt>cd /usr/local/citadel</tt> </li>
2363 <li>Export the databases with the following command:<br>
2365 <tt>./sendcommand "ARTV export" >exported.dat</tt><br>
2367 This command may run for a while. On a very large system it could take
2368 an hour or more. Please be patient! </li>
2369 <li>When the export completes, check to make sure that <tt>exported.dat</tt>
2370 exists and has some data in it. (Type "ls -l exported.dat") </li>
2371 <li>Shut down the Citadel server. If you have a line in <tt>/etc/inittab</tt>
2372 that reads like this:<br>
2374 <tt>c1:2345:respawn:/usr/local/citadel/citserver
2375 -h/usr/local/citadel</tt> <br>
2376 ...then you should change the <tt>respawn</tt> to <tt>off</tt> and
2377 then type <tt>/sbin/init q</tt> to make the changes take effect. </li>
2378 <li>Now it's time to delete your current binary databases. Type:<br>
2380 <tt>rm -f citadel.config citadel.control data/*</tt> </li>
2381 <li>If you're moving Citadel to another computer, you should move the
2382 <i>entire</i> directory over at this time. <tt>exported.dat</tt>
2383 only contains the information that was in the binary databases.
2384 Information which was stored in portable formats doesn't need to be
2385 exported/imported, so
2386 you must bring it all over in its current form. </li>
2387 <li>Now get Citadel running on the new computer (or whatever). Run <tt>setup</tt>
2388 and turn the service back on (from <tt>/etc/inittab</tt>) but DO NOT
2390 <li>As root, run the import command:<br>
2392 <tt>./sendcommand "ARTV import" <exported.dat</tt><br>
2394 This will import your databases. Again, it may run for a long time. </li>
2395 <li>Restart the Citadel server. You can do this any way you like.
2396 From the command line, you can do it with a command like:<br>
2398 <tt>./sendcommand "DOWN"</tt> <br>
2400 <li>Now you're finished. Log in and test everything. You may delete
2401 exported.dat at this time, or you might want to save it somewhere as a
2402 sort of pseudo-backup. </li>
2406 <h2><a name="crypto"></a>Cryptography support (TLS/SSL)</h2>
2408 <h3><a name="crypto_intro"></a>Overview</h3>
2409 <p>Citadel provides built-in support for encryption using Transport
2410 Layer Security (TLS) for ESMTP, IMAP, POP3, and the Citadel client
2412 A simple cryptographic configuration is installed automatically when
2414 bring the system online. The remainder of this section describes how
2416 configuration is built, and what you can do to make changes to it.</p>
2417 <p>Encryption files are kept in the <tt>keys/</tt> directory. The
2419 files used by Citadel are:</p>
2421 <li><tt>citadel.key</tt> - Contains your system's RSA private key.
2423 generates a new key automatically if one is not found. </li>
2424 <li><tt>citadel.csr</tt> - Contains a Certificate Signing Request
2426 for your system. Citadel generates a new CSR automatically, using your
2427 private key, if one is not found. </li>
2428 <li><tt>citadel.cer</tt> - Contains the public certificate for your
2429 system. The public key in the certificate <b>must</b> correspond with
2431 private key in <tt>citadel.key</tt>, otherwise encryption will not
2432 function properly. Citadel will generate a self-signed certificate,
2434 using your private key, if a certificate is not found. </li>
2436 <h3><a name="real_cert"></a>Generating and installing a Trusted
2438 <p>If you wish to interact with 3rd party clients
2439 that have hard coded lists of acceptable Certificate Authorities, and
2441 do not want annoying dialog boxes popping up for the user on the first
2443 all) connections, then you will have to have your key signed by a valid
2444 Certificate Authority.</p>
2445 <p>It is beyond the scope of this document to provide a complete
2447 on SSL certificates. Here are the general rules to follow:</p>
2449 <li>Generally, the Certificate Signing Requeste which is
2451 generated by Citadel will not contain enough information for any
2453 Authority to sign it. Generate a new CSR with the following commands:<br>
2455 <tt>cd keys</tt><br>
2456 <tt>openssl req -new -key citadel.key -out citadel.csr</tt><br>
2458 Answer all questions (your geographic location, organization name,
2460 and then send the new <tt>citadel.csr</tt> to your Certificate
2462 when you order the certificate. </li>
2463 <li>When the certificate is received, simply save it as <tt>citadel.cer</tt>
2464 and restart the Citadel server. </li>
2465 <li>If your certificate authority delivers a 'chained' certificate
2467 with intermediate certificate authorities), simply append the
2469 certificate after your server's own certificate in the <tt>citadel.cer</tt>
2473 <hr style="width: 100%; height: 2px;">
2474 <div style="text-align: center;">
2475 <h2><a name="LDAP_Directory_Support"></a>LDAP (Directory) Support</h2>
2476 <div style="text-align: justify;">
2477 <h3><a name="Introduction_ldap"></a>Introduction</h3>
2478 LDAP (Lightweight Directory Access Protocol) has become the open
2479 standard protocol for directory access. There are many client
2480 programs which are capable of making use of an LDAP directory
2481 service. Therefore it may be beneficial for some sites to have a
2482 directory available which is populated with Citadel user information.<br>
2484 Citadel does not contain its own LDAP service, because that would
2485 eliminate its ability to coexist with any existing directory you may
2486 already have in place at your organization. Instead, we provide
2487 the LDAP Connector for Citadel, which allows the Citadel service to
2488 populate an external LDAP directory. If you do not already have
2489 an LDAP directory in place, you can use the OpenLDAP server, which is
2490 probably already present in your operating system, or at least can be
2491 loaded from the installation CD's. The supplied configuration
2492 file <tt>citadel-slapd.conf</tt> can be used as a starting
2493 point to get your LDAP server running.<br>
2495 <h3><a name="Preparing_your_LDAP_server_for_Citadel"></a>Preparing your
2496 LDAP server for Citadel connections</h3>
2497 It is difficult to find a commonly accepted LDAP scheme. It seems, most
2498 real life LDAP installations go for the domain oriented apporach
2499 and lay out the structure after an existing domain/subdomain structure.
2500 <p> The most widely accepted and standardized object for storing
2502 clearly is "inetOrgPerson". Citadel therefore attempts to follow
2503 this type of schema.<br>
2505 <p>If you are using OpenLDAP as your directory server, you should
2506 choose options similar to the following:<br>
2508 <pre>database ldbm<br>schemacheck off<br>allow bind_v2<br>suffix "dc=servername,dc=domain,dc=org"<br>rootdn "cn=manager,dc=servername,dc=domain,dc=org"<br>rootpw secret<br></pre>
2510 <li>Obviously, you can make your suffix and rootdn whatever you wish,
2511 but in most cases you'd simply follow a DC path that looks similar to
2512 your DNS domain.</li>
2513 <li>If you don't want LDBM, feel free to choose any backend available
2514 on your system.</li>
2515 <li><span style="font-family: monospace;">bind_v2</span> is <span
2516 style="font-style: italic;">required</span> because Citadel will make
2517 v2 protocol connections.</li>
2518 <li><span style="font-family: monospace;">schemacheck off</span> is <span
2519 style="font-style: italic;">recommended</span> because Citadel uses
2520 fields that do not necessarily exist in your system's default
2521 schema. If you don't like that idea, your other option is to
2522 reference the included <span style="font-family: monospace;">citadel-openldap.schema</span>
2523 in your configuration.</li>
2524 <li>Your <span style="font-family: monospace;">rootdn</span> and <span
2525 style="font-family: monospace;">rootpw</span> can be whatever you
2526 want. Usually the rootdn is <span style="font-family: monospace;">cn=manager,</span>
2527 followed by your usual suffix. Please don't use <span
2528 style="font-family: monospace;">secret</span> as your password, as in
2529 this example. Select a new password for your site.</li>
2532 Your LDAP service <span style="font-weight: bold;">must</span> be up
2533 and running before you attempt to connect Citadel to it.<br>
2535 <h3><a name="Configuring_the_LDAP_Connector_for"></a>Configuring the
2536 LDAP Connector for Citadel</h3>
2537 Once you've located or installed your LDAP server, connecting Citadel
2538 to it is easily completed with the <span style="font-weight: bold;"><span
2539 style="font-family: monospace;">.A</span></span><span
2540 style="font-family: monospace;">ide <span style="font-weight: bold;">S</span>ystem-configuration
2541 <span style="font-weight: bold;">G</span>eneral command:<br>
2543 <pre>Lobby> . Aide System configuration General<br><br><span
2544 style="font-style: italic;">(lots of other stuff omitted for brevity...)</span><br><br>Connect this Citadel to an LDAP directory [Yes]: <span
2545 style="font-weight: bold;">Yes</span><br>Host name of LDAP server []: <span
2546 style="font-weight: bold;">127.0.0.1</span><br>Port number of LDAP service [389]: <span
2547 style="font-weight: bold;">389</span><br>Base DN []: <span
2548 style="font-weight: bold;">dc=servername,dc=domain,dc=org</span><br>Bind DN []: <span
2549 style="font-weight: bold;">cn=manager,dc=servername,dc=domain,dc=org</span><br>Password for bind DN []: <span
2550 style="font-weight: bold;">secret</span><br style="font-weight: bold;"><br><span
2551 style="font-style: italic;">(more questions omitted...)</span><br><br>Save this configuration? <span
2552 style="font-weight: bold;">Yes</span><br></pre>
2553 Once you've done this, restart your Citadel service with the <span
2554 style="font-weight: bold;"><span style="font-family: monospace;">.A</span></span><span
2555 style="font-family: monospace;">ide <span style="font-weight: bold;">T</span>erminate-server
2556 <span style="font-weight: bold;">N</span>ow</span> command. When
2557 Citadel restarts, it will connect to your LDAP directory. Note
2558 that we gave Citadel the same Base DN, Bind DN, and password that was
2559 in our LDAP server configuration example. Obviously, everything
2560 needs to be identical on both sides or the connection will be
2561 refused. 127.0.0.1 is the loopback address, and 389 is the
2562 standard port number for LDAP, so this would be the proper host and
2563 port combination for an LDAP service running on your local
2564 server. It could just as easily be on another server, for example
2565 an organization-wide directory server.<br>
2567 You can also configure the LDAP Connector for Citadel from a WebCit
2568 session. Log on as an Aide and click on Advanced Options -->
2569 Edit Site-Wide Configuration --> Directory, and you will be
2570 presented with the same set of questions.<br>
2572 So, what kind of information will be entered into LDAP? As a
2573 rule, anything that gets saved to your Global Address Book room will
2574 also be saved to LDAP. Citadel will set up OU's (Organizational
2575 Units) for each node on your Citadel network, so if you are running
2576 multiple Citadel servers in an organization, you will automatically
2577 have a hierarchial view built for you. Below the OU's will be an
2578 entry for each user who has a vCard registered on the system.
2579 Citadel automatically translates vCard information to LDAP.<br>
2581 If you already have a Global Address Book full of existing information,
2582 you can execute an <span style="font-family: monospace;">IGAB</span>
2583 (Initialize Global Address Book) server command to rebuild it. In
2584 addition to performing its usual function of rebuilding the internal
2585 Internet e-mail address mapping table, Citadel will also repopulate
2586 LDAP with all existing vCards. You should be aware, however, that
2587 existing LDAP entries will not be cleared from your directory
2588 server. If your directory contains only Citadel data, you can
2589 safely delete your database and start over, because it will be
2590 repopulated. Otherwise, Citadel will merely update any existing
2591 records with fresh information.<br>
2593 The LDAP Connector for Citadel is a recent development, so expect more
2594 functionality in this space in the near future.<br>
2600 <h2><a name="utilities"></a>Utilities</h2>
2602 <h3><a name="overview"></a>Overview</h3>
2603 <p>The following utilities will be discussed: </p>
2605 <li><b>aidepost</b> - Post standard input to the Aide> room </li>
2606 <li><b>whobbs</b> - Who is on the system </li>
2607 <li><b>msgform</b> - Format a binary message to the screen (stdin or
2609 <li><b>userlist</b> - Print the userlist </li>
2610 <li><b>sendcommand</b> - Send a server command </li>
2612 <p>It is up to you to decide which utilities should be made accessible
2613 only to system administrators. It is important that you set the file
2614 permissions correctly. All utilities should have access to the Citadel
2616 will attempt to address each program individually.</p>
2617 <h3><a name="aidepost"></a>aidepost</h3>
2618 <p>The nature of this program is rather simple. Standard input (stdin)
2619 is converted into a message, filed in the main message store, and
2620 posted in the Aide> room. This is useful for keeping transcripts of
2621 system activity that has to do with Citadel operations. You might even
2622 elect to send all of
2623 your system logs there, too.</p>
2624 <p><tt>aidepost</tt> also accepts the usage <tt>aidepost -rTargetRoom</tt>,
2625 where TargetRoom is the name of a room to which you'd like the message
2627 <h3><a name="whobbs"></a>whobbs</h3>
2628 <p>This program is similar to the <tt>who</tt> command. It lists all
2629 of the users who are currently connected to your Citadel server, either
2631 across a network. Unless you're running a standalone system, <tt>who</tt>
2632 and <tt>whobbs</tt> will probably not have a one-to-one
2633 correspondence. Remember
2634 that you will see sessions for SMTP, POP, and IMAP users, as well as
2636 running a Citadel client.</p>
2637 <p>One thing to keep in mind is that the <tt>whobbs</tt> utility
2638 actually opens a connection to the server. If the server is maxed out, <tt>whobbs</tt>
2639 will still be able to provide a listing, because it doesn't need to log
2640 in to execute the <tt>RWHO</tt> command. Note that whobbs does not
2641 list its own session.</p>
2642 <p>The <tt>whobbs</tt> utility is smart enough to know when it is
2643 being invoked by a web server as a CGI program. In this situation, it
2644 will output its listing
2645 as a nicely formatted web page instead of plain text. This makes it
2647 to just put a link to the whobbs binary in your cgi-bin directory,
2649 a quick and easy way for web surfers to see who is online.</p>
2650 <p>Running the <tt><b>W</b>ho is online</tt> command from the Citadel
2651 client does <b>not</b> call this utility. It has this functionality
2655 <h3><a name="msgform"></a>msgform</h3>
2656 <p>The <tt>msgform</tt> utility reads its standard input (stdin)
2658 Citadel messages stored in the internal format used on disk and over
2660 network, and sends them in a human-readable format to standard output
2661 (stdout). There is no longer much use for this program, but it is
2664 <h3><a name="userlist"></a>userlist</h3>
2665 <p>This is a program to print the userlist. There are two flags that
2667 set when running this program. When called without any arguments, <tt>userlist</tt>
2668 will display all users (except those who have chosen to be unlisted),
2669 their user numbers, times called, messages posted, screen width, and
2670 date of their most recent call.</p>
2671 <p><tt>userlist</tt> is simply the same user listing code that is in
2673 client, made into a standalone utility for convenience.<br>
2675 <h3><a name="sendcommand"></a>sendcommand</h3>
2676 <p><tt>sendcommand</tt> will interpret its arguments (except for <tt>-hDIRNAME</tt>)
2677 as a server command, which is sent to the server. Commands which
2678 require textual input will read it from stdin. Commands which generate
2679 textual output will be sent to stdout.</p>
2680 <p>This utility is intended to be used to enable Citadel server
2682 be executed from shell scripts. Review the script called <tt>weekly</tt>
2683 which ships with the Citadel distribution for an example of how this
2686 <p><b>NOTE:</b> be sure that this utility is not world-executable. It
2687 connects to the server in privileged mode, and therefore could present
2689 if not properly restricted.</p>
projects / citadel.git / blob