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