citadel/docs/citadel.html

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