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