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