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