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-2007 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">Dave West<br>
62 <td valign="top"><i>server features<br>
66 <td valign="top">Wilfried Goesgens<br>
68 <td valign="top"><i>build system patches<br>
72 <td valign="top">Michael Hampton<br>
74 <td valign="top"><i>client software development<br>
78 <td valign="top">Andru Luvisi<br>
80 <td valign="top"><i>troubleshooting and development assistance<br>
84 <td valign="top">Daniel Malament<br>
86 <td valign="top"><i>string compare function for IMAP server<br>
90 <td valign="top">Stu Mark<br>
92 <td valign="top"><i>additional client features, IGnet protocol design<br>
96 <td valign="top">Edward S. Marshall<br>
98 <td valign="top"><i>RBL checking function design<br>
102 <td valign="top">Ben Mehlman<br>
104 <td valign="top"><i>additional client features<br>
108 <td valign="top">Matt Pfleger<br>
110 <td valign="top"><i>additional client features<br>
114 <td valign="top">Ari Samson<br>
116 <td valign="top"><i>assistance with project management<br>
120 <td valign="top">Trey Van Riper<br>
122 <td valign="top"><i>QA and portability enhancements<br>
126 <td valign="top">John Walker<br>
128 <td valign="top"><i>author of public domain base64 encoder/decoder<br>
132 <td valign="top">Steve Williams<br>
134 <td valign="top"><i>documentation<br>
138 <td valign="top">Ethan Young<br>
140 <td valign="top"><i>IGnet protocol design<br>
147 <div align="justify">The entire package is open source software. You may
148 redistribute and/or modify it under the terms of the GNU General Public
149 License, version 3, which is included in this manual.<br>
151 This program is distributed in the hope that it will be useful, but
152 WITHOUT ANY WARRANTY; without even the implied warranty of
153 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
154 General Public License for more details. </div>
155 <div align="justify"><br>
156 For more information, visit either of these locations on
159 <li>The Citadel home page: <a href="http://www.citadel.org">http://www.citadel.org</a></li>
160 <li>UNCENSORED! BBS, the home of Citadel: <a
161 href="http://uncensored.citadel.org">http://uncensored.citadel.org</a></li>
163 <hr size="2" width="100%">
164 <h2 align="center">Table of Contents</h2>
166 <li><a href="#GPL">License</a></li>
167 <li><a href="#Installation">Installation</a></li>
169 <li><a href="#Everything_in_its_place...">Everything in its
171 <li><a href="#ctdl_login_acct">Creating a system account for Citadel</a></li>
172 <li><a href="#bypassing_login">Bypassing the login:
174 <li><a href="#Compiling_the_programs">Compiling the programs</a></li>
175 <li><a href="#Upgrading">Upgrading</a></li>
176 <li><a href="#rc_file">The citadel.rc file</a></li>
177 <li><a href="#Using_an_external_editor_for_message">Using an
178 external editor for message composition</a></li>
179 <li><a href="#Printing_messages">Printing messages</a></li>
180 <li><a href="#URL_viewing">URL viewing</a></li>
181 <li><a href="#Setup_and_login">Setup and login</a></li>
182 <li><a href="#Configuring_your_host_system_to_start">Configuring
183 your host system to start the service</a></li>
184 <li><a href="#first_time_login">Logging in for
185 the first time</a></li>
186 <li><a href="#Welcoming_new_users">Welcoming new users</a></li>
187 <li><a href="#adding_doors">Space for adding
188 your own client features (doors)</a></li>
189 <li><a href="#Troubleshooting_and_getting_help">Troubleshooting and
193 <li><a href="#sysop">System Administration</a></li>
195 <li><a href="#Overview_">Overview</a></li>
196 <li><a href="#Aide_commands">Aide commands</a></li>
197 <li><a href="#Editing_rooms">Editing rooms</a></li>
198 <li><a href="#File_directories">File directories</a></li>
199 <li><a href="#Creating_and_editing_user_accounts">Creating and
200 editing user accounts</a></li>
201 <li><a href="#Deleting_and_moving_messages">Deleting and moving
203 <li><a href="#Customizing_the_help_files">Customizing the help files</a></li>
204 <li><a href="#Site_configuration">Site configuration</a><br>
207 <li> <a href="#Configuring_Citadel_for_Internet_e-mail">Configuring
208 Citadel for Internet e-mail</a></li>
210 <li><a href="#Introduction">Introduction</a></li>
211 <li><a href="#Basic_site_configuration">Basic site configuration</a></li>
212 <li><a href="#Enabling_the_Internet_mail_protocols">Enabling the
213 Internet mail protocols</a></li>
214 <li><a href="#Hosting_an_Internet_mailing_list">Hosting an Internet
217 <li><a href="#citmail">Using Citadel in conjunction with another MTA</a></li>
219 <li><a href="#Building_or_joining_a_Citadel_network">Building or
220 joining a Citadel network</a></li>
222 <li><a href="#Overview__">Overview</a></li>
223 <li><a href="#Conventions_and_etiquette_when">Conventions and
224 etiquette when connecting to the public Citadel network</a></li>
225 <li><a href="#Getting_ready_to_join_the_network">Getting ready
226 to join the network</a></li>
227 <li><a href="#Defining_neighbor_nodes">Defining neighbor nodes</a></li>
228 <li><a href="#Sharing_rooms">Sharing rooms</a></li>
229 <li><a href="#Sending_mail">Sending mail</a></li>
230 <li><a href="#Changing_the_polling_interval">Changing the polling
233 <li><a href="#Database_maintenance">Database maintenance</a></li>
235 <li><a href="#Introduction_">Introduction</a></li>
236 <li><a href="#Backing_up_your_Citadel_database">Backing up your
237 Citadel database</a><br>
239 <li><a href="#Database_repair">Database repair</a></li>
240 <li><a href="#ImportingExporting_your_Citadel">Importing/Exporting
241 your Citadel database</a><br>
244 <li><a href="#crypto">Cryptography support (TLS/SSL)</a></li>
246 <li><a href="#crypto_intro">Overview</a></li>
247 <li><a href="#real_cert">Generating and installing a Trusted
250 <li><a href="#LDAP_Directory_Support">LDAP directory support</a></li>
252 <li><a href="#Introduction_ldap">Introduction</a></li>
253 <li><a href="#Preparing_your_LDAP_server_for_Citadel">Preparing
254 your LDAP server for Citadel connections</a><br>
256 <li><a href="#Configuring_the_LDAP_Connector_for">Configuring the
257 LDAP Connector for Citadel</a><br>
260 <li><a href="#utilities">Included utilities</a></li>
262 <li><a href="#overview">Overview</a></li>
263 <li><a href="#aidepost">aidepost</a></li>
264 <li><a href="#whobbs">whobbs</a></li>
265 <li><a href="#msgform">msgform</a></li>
266 <li><a href="#userlist">userlist</a></li>
267 <li><a href="#sendcommand">sendcommand</a></li>
271 <hr size="2" width="100%"><br>
272 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
276 <p style="text-align: center;">Version 3, 29 June 2007</p>
278 <p>Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/></p><p>
280 Everyone is permitted to copy and distribute verbatim copies
281 of this license document, but changing it is not allowed.</p>
283 <h3><a name="preamble"></a>Preamble</h3>
285 <p>The GNU General Public License is a free, copyleft license for
286 software and other kinds of works.</p>
288 <p>The licenses for most software and other practical works are designed
289 to take away your freedom to share and change the works. By contrast,
290 the GNU General Public License is intended to guarantee your freedom to
291 share and change all versions of a program--to make sure it remains free
292 software for all its users. We, the Free Software Foundation, use the
293 GNU General Public License for most of our software; it applies also to
294 any other work released this way by its authors. You can apply it to
295 your programs, too.</p>
297 <p>When we speak of free software, we are referring to freedom, not
298 price. Our General Public Licenses are designed to make sure that you
299 have the freedom to distribute copies of free software (and charge for
300 them if you wish), that you receive source code or can get it if you
301 want it, that you can change the software or use pieces of it in new
302 free programs, and that you know you can do these things.</p>
304 <p>To protect your rights, we need to prevent others from denying you
305 these rights or asking you to surrender the rights. Therefore, you have
306 certain responsibilities if you distribute copies of the software, or if
307 you modify it: responsibilities to respect the freedom of others.</p>
309 <p>For example, if you distribute copies of such a program, whether
310 gratis or for a fee, you must pass on to the recipients the same
311 freedoms that you received. You must make sure that they, too, receive
312 or can get the source code. And you must show them these terms so they
313 know their rights.</p>
315 <p>Developers that use the GNU GPL protect your rights with two steps:
316 (1) assert copyright on the software, and (2) offer you this License
317 giving you legal permission to copy, distribute and/or modify it.</p>
319 <p>For the developers' and authors' protection, the GPL clearly explains
320 that there is no warranty for this free software. For both users' and
321 authors' sake, the GPL requires that modified versions be marked as
322 changed, so that their problems will not be attributed erroneously to
323 authors of previous versions.</p>
325 <p>Some devices are designed to deny users access to install or run
326 modified versions of the software inside them, although the manufacturer
327 can do so. This is fundamentally incompatible with the aim of
328 protecting users' freedom to change the software. The systematic
329 pattern of such abuse occurs in the area of products for individuals to
330 use, which is precisely where it is most unacceptable. Therefore, we
331 have designed this version of the GPL to prohibit the practice for those
332 products. If such problems arise substantially in other domains, we
333 stand ready to extend this provision to those domains in future versions
334 of the GPL, as needed to protect the freedom of users.</p>
336 <p>Finally, every program is threatened constantly by software patents.
337 States should not allow patents to restrict development and use of
338 software on general-purpose computers, but in those that do, we wish to
339 avoid the special danger that patents applied to a free program could
340 make it effectively proprietary. To prevent this, the GPL assures that
341 patents cannot be used to render the program non-free.</p>
343 <p>The precise terms and conditions for copying, distribution and
344 modification follow.</p>
346 <h3><a name="terms"></a>TERMS AND CONDITIONS</h3>
348 <h4><a name="section0"></a>0. Definitions.</h4>
350 <p>“This License” refers to version 3 of the GNU General Public License.</p>
352 <p>“Copyright” also means copyright-like laws that apply to other kinds of
353 works, such as semiconductor masks.</p>
356 <p>“The Program” refers to any copyrightable work licensed under this
357 License. Each licensee is addressed as “you”. “Licensees” and
358 “recipients” may be individuals or organizations.</p>
360 <p>To “modify” a work means to copy from or adapt all or part of the work
361 in a fashion requiring copyright permission, other than the making of an
362 exact copy. The resulting work is called a “modified version” of the
363 earlier work or a work “based on” the earlier work.</p>
365 <p>A “covered work” means either the unmodified Program or a work based
368 <p>To “propagate” a work means to do anything with it that, without
369 permission, would make you directly or secondarily liable for
370 infringement under applicable copyright law, except executing it on a
371 computer or modifying a private copy. Propagation includes copying,
372 distribution (with or without modification), making available to the
373 public, and in some countries other activities as well.</p>
375 <p>To “convey” a work means any kind of propagation that enables other
376 parties to make or receive copies. Mere interaction with a user through
377 a computer network, with no transfer of a copy, is not conveying.</p>
379 <p>An interactive user interface displays “Appropriate Legal Notices”
380 to the extent that it includes a convenient and prominently visible
381 feature that (1) displays an appropriate copyright notice, and (2)
382 tells the user that there is no warranty for the work (except to the
383 extent that warranties are provided), that licensees may convey the
384 work under this License, and how to view a copy of this License. If
385 the interface presents a list of user commands or options, such as a
386 menu, a prominent item in the list meets this criterion.</p>
388 <h4><a name="section1"></a>1. Source Code.</h4>
390 <p>The “source code” for a work means the preferred form of the work
391 for making modifications to it. “Object code” means any non-source
394 <p>A “Standard Interface” means an interface that either is an official
395 standard defined by a recognized standards body, or, in the case of
396 interfaces specified for a particular programming language, one that
397 is widely used among developers working in that language.</p>
399 <p>The “System Libraries” of an executable work include anything, other
400 than the work as a whole, that (a) is included in the normal form of
401 packaging a Major Component, but which is not part of that Major
402 Component, and (b) serves only to enable use of the work with that
403 Major Component, or to implement a Standard Interface for which an
404 implementation is available to the public in source code form. A
405 “Major Component”, in this context, means a major essential component
406 (kernel, window system, and so on) of the specific operating system
407 (if any) on which the executable work runs, or a compiler used to
408 produce the work, or an object code interpreter used to run it.</p>
410 <p>The “Corresponding Source” for a work in object code form means all
411 the source code needed to generate, install, and (for an executable
412 work) run the object code and to modify the work, including scripts to
413 control those activities. However, it does not include the work's
414 System Libraries, or general-purpose tools or generally available free
415 programs which are used unmodified in performing those activities but
416 which are not part of the work. For example, Corresponding Source
417 includes interface definition files associated with source files for
418 the work, and the source code for shared libraries and dynamically
419 linked subprograms that the work is specifically designed to require,
420 such as by intimate data communication or control flow between those
421 subprograms and other parts of the work.</p>
423 <p>The Corresponding Source need not include anything that users
424 can regenerate automatically from other parts of the Corresponding
427 <p>The Corresponding Source for a work in source code form is that
430 <h4><a name="section2"></a>2. Basic Permissions.</h4>
432 <p>All rights granted under this License are granted for the term of
433 copyright on the Program, and are irrevocable provided the stated
434 conditions are met. This License explicitly affirms your unlimited
435 permission to run the unmodified Program. The output from running a
436 covered work is covered by this License only if the output, given its
437 content, constitutes a covered work. This License acknowledges your
438 rights of fair use or other equivalent, as provided by copyright law.</p>
440 <p>You may make, run and propagate covered works that you do not
441 convey, without conditions so long as your license otherwise remains
442 in force. You may convey covered works to others for the sole purpose
443 of having them make modifications exclusively for you, or provide you
444 with facilities for running those works, provided that you comply with
445 the terms of this License in conveying all material for which you do
446 not control copyright. Those thus making or running the covered works
447 for you must do so exclusively on your behalf, under your direction
448 and control, on terms that prohibit them from making any copies of
449 your copyrighted material outside their relationship with you.</p>
451 <p>Conveying under any other circumstances is permitted solely under
452 the conditions stated below. Sublicensing is not allowed; section 10
453 makes it unnecessary.</p>
455 <h4><a name="section3"></a>3. Protecting Users' Legal Rights From Anti-Circumvention Law.</h4>
457 <p>No covered work shall be deemed part of an effective technological
458 measure under any applicable law fulfilling obligations under article
459 11 of the WIPO copyright treaty adopted on 20 December 1996, or
460 similar laws prohibiting or restricting circumvention of such
463 <p>When you convey a covered work, you waive any legal power to forbid
464 circumvention of technological measures to the extent such circumvention
465 is effected by exercising rights under this License with respect to
466 the covered work, and you disclaim any intention to limit operation or
467 modification of the work as a means of enforcing, against the work's
468 users, your or third parties' legal rights to forbid circumvention of
469 technological measures.</p>
471 <h4><a name="section4"></a>4. Conveying Verbatim Copies.</h4>
473 <p>You may convey verbatim copies of the Program's source code as you
474 receive it, in any medium, provided that you conspicuously and
475 appropriately publish on each copy an appropriate copyright notice;
476 keep intact all notices stating that this License and any
477 non-permissive terms added in accord with section 7 apply to the code;
478 keep intact all notices of the absence of any warranty; and give all
479 recipients a copy of this License along with the Program.</p>
481 <p>You may charge any price or no price for each copy that you convey,
482 and you may offer support or warranty protection for a fee.</p>
484 <h4><a name="section5"></a>5. Conveying Modified Source Versions.</h4>
486 <p>You may convey a work based on the Program, or the modifications to
487 produce it from the Program, in the form of source code under the
488 terms of section 4, provided that you also meet all of these conditions:</p>
491 <li>a) The work must carry prominent notices stating that you modified
492 it, and giving a relevant date.</li>
494 <li>b) The work must carry prominent notices stating that it is
495 released under this License and any conditions added under section
496 7. This requirement modifies the requirement in section 4 to
497 “keep intact all notices”.</li>
499 <li>c) You must license the entire work, as a whole, under this
500 License to anyone who comes into possession of a copy. This
501 License will therefore apply, along with any applicable section 7
502 additional terms, to the whole of the work, and all its parts,
503 regardless of how they are packaged. This License gives no
504 permission to license the work in any other way, but it does not
505 invalidate such permission if you have separately received it.</li>
507 <li>d) If the work has interactive user interfaces, each must display
508 Appropriate Legal Notices; however, if the Program has interactive
509 interfaces that do not display Appropriate Legal Notices, your
510 work need not make them do so.</li>
513 <p>A compilation of a covered work with other separate and independent
514 works, which are not by their nature extensions of the covered work,
515 and which are not combined with it such as to form a larger program,
516 in or on a volume of a storage or distribution medium, is called an
517 “aggregate” if the compilation and its resulting copyright are not
518 used to limit the access or legal rights of the compilation's users
519 beyond what the individual works permit. Inclusion of a covered work
520 in an aggregate does not cause this License to apply to the other
521 parts of the aggregate.</p>
523 <h4><a name="section6"></a>6. Conveying Non-Source Forms.</h4>
525 <p>You may convey a covered work in object code form under the terms
526 of sections 4 and 5, provided that you also convey the
527 machine-readable Corresponding Source under the terms of this License,
528 in one of these ways:</p>
531 <li>a) Convey the object code in, or embodied in, a physical product
532 (including a physical distribution medium), accompanied by the
533 Corresponding Source fixed on a durable physical medium
534 customarily used for software interchange.</li>
536 <li>b) Convey the object code in, or embodied in, a physical product
537 (including a physical distribution medium), accompanied by a
538 written offer, valid for at least three years and valid for as
539 long as you offer spare parts or customer support for that product
540 model, to give anyone who possesses the object code either (1) a
541 copy of the Corresponding Source for all the software in the
542 product that is covered by this License, on a durable physical
543 medium customarily used for software interchange, for a price no
544 more than your reasonable cost of physically performing this
545 conveying of source, or (2) access to copy the
546 Corresponding Source from a network server at no charge.</li>
548 <li>c) Convey individual copies of the object code with a copy of the
549 written offer to provide the Corresponding Source. This
550 alternative is allowed only occasionally and noncommercially, and
551 only if you received the object code with such an offer, in accord
552 with subsection 6b.</li>
554 <li>d) Convey the object code by offering access from a designated
555 place (gratis or for a charge), and offer equivalent access to the
556 Corresponding Source in the same way through the same place at no
557 further charge. You need not require recipients to copy the
558 Corresponding Source along with the object code. If the place to
559 copy the object code is a network server, the Corresponding Source
560 may be on a different server (operated by you or a third party)
561 that supports equivalent copying facilities, provided you maintain
562 clear directions next to the object code saying where to find the
563 Corresponding Source. Regardless of what server hosts the
564 Corresponding Source, you remain obligated to ensure that it is
565 available for as long as needed to satisfy these requirements.</li>
567 <li>e) Convey the object code using peer-to-peer transmission, provided
568 you inform other peers where the object code and Corresponding
569 Source of the work are being offered to the general public at no
570 charge under subsection 6d.</li>
573 <p>A separable portion of the object code, whose source code is excluded
574 from the Corresponding Source as a System Library, need not be
575 included in conveying the object code work.</p>
577 <p>A “User Product” is either (1) a “consumer product”, which means any
578 tangible personal property which is normally used for personal, family,
579 or household purposes, or (2) anything designed or sold for incorporation
580 into a dwelling. In determining whether a product is a consumer product,
581 doubtful cases shall be resolved in favor of coverage. For a particular
582 product received by a particular user, “normally used” refers to a
583 typical or common use of that class of product, regardless of the status
584 of the particular user or of the way in which the particular user
585 actually uses, or expects or is expected to use, the product. A product
586 is a consumer product regardless of whether the product has substantial
587 commercial, industrial or non-consumer uses, unless such uses represent
588 the only significant mode of use of the product.</p>
590 <p>“Installation Information” for a User Product means any methods,
591 procedures, authorization keys, or other information required to install
592 and execute modified versions of a covered work in that User Product from
593 a modified version of its Corresponding Source. The information must
594 suffice to ensure that the continued functioning of the modified object
595 code is in no case prevented or interfered with solely because
596 modification has been made.</p>
598 <p>If you convey an object code work under this section in, or with, or
599 specifically for use in, a User Product, and the conveying occurs as
600 part of a transaction in which the right of possession and use of the
601 User Product is transferred to the recipient in perpetuity or for a
602 fixed term (regardless of how the transaction is characterized), the
603 Corresponding Source conveyed under this section must be accompanied
604 by the Installation Information. But this requirement does not apply
605 if neither you nor any third party retains the ability to install
606 modified object code on the User Product (for example, the work has
607 been installed in ROM).</p>
609 <p>The requirement to provide Installation Information does not include a
610 requirement to continue to provide support service, warranty, or updates
611 for a work that has been modified or installed by the recipient, or for
612 the User Product in which it has been modified or installed. Access to a
613 network may be denied when the modification itself materially and
614 adversely affects the operation of the network or violates the rules and
615 protocols for communication across the network.</p>
617 <p>Corresponding Source conveyed, and Installation Information provided,
618 in accord with this section must be in a format that is publicly
619 documented (and with an implementation available to the public in
620 source code form), and must require no special password or key for
621 unpacking, reading or copying.</p>
623 <h4><a name="section7"></a>7. Additional Terms.</h4>
625 <p>“Additional permissions” are terms that supplement the terms of this
626 License by making exceptions from one or more of its conditions.
627 Additional permissions that are applicable to the entire Program shall
628 be treated as though they were included in this License, to the extent
629 that they are valid under applicable law. If additional permissions
630 apply only to part of the Program, that part may be used separately
631 under those permissions, but the entire Program remains governed by
632 this License without regard to the additional permissions.</p>
634 <p>When you convey a copy of a covered work, you may at your option
635 remove any additional permissions from that copy, or from any part of
636 it. (Additional permissions may be written to require their own
637 removal in certain cases when you modify the work.) You may place
638 additional permissions on material, added by you to a covered work,
639 for which you have or can give appropriate copyright permission.</p>
641 <p>Notwithstanding any other provision of this License, for material you
642 add to a covered work, you may (if authorized by the copyright holders of
643 that material) supplement the terms of this License with terms:</p>
646 <li>a) Disclaiming warranty or limiting liability differently from the
647 terms of sections 15 and 16 of this License; or</li>
649 <li>b) Requiring preservation of specified reasonable legal notices or
650 author attributions in that material or in the Appropriate Legal
651 Notices displayed by works containing it; or</li>
653 <li>c) Prohibiting misrepresentation of the origin of that material, or
654 requiring that modified versions of such material be marked in
655 reasonable ways as different from the original version; or</li>
657 <li>d) Limiting the use for publicity purposes of names of licensors or
658 authors of the material; or</li>
660 <li>e) Declining to grant rights under trademark law for use of some
661 trade names, trademarks, or service marks; or</li>
663 <li>f) Requiring indemnification of licensors and authors of that
664 material by anyone who conveys the material (or modified versions of
665 it) with contractual assumptions of liability to the recipient, for
666 any liability that these contractual assumptions directly impose on
667 those licensors and authors.</li>
670 <p>All other non-permissive additional terms are considered “further
671 restrictions” within the meaning of section 10. If the Program as you
672 received it, or any part of it, contains a notice stating that it is
673 governed by this License along with a term that is a further
674 restriction, you may remove that term. If a license document contains
675 a further restriction but permits relicensing or conveying under this
676 License, you may add to a covered work material governed by the terms
677 of that license document, provided that the further restriction does
678 not survive such relicensing or conveying.</p>
680 <p>If you add terms to a covered work in accord with this section, you
681 must place, in the relevant source files, a statement of the
682 additional terms that apply to those files, or a notice indicating
683 where to find the applicable terms.</p>
685 <p>Additional terms, permissive or non-permissive, may be stated in the
686 form of a separately written license, or stated as exceptions;
687 the above requirements apply either way.</p>
689 <h4><a name="section8"></a>8. Termination.</h4>
691 <p>You may not propagate or modify a covered work except as expressly
692 provided under this License. Any attempt otherwise to propagate or
693 modify it is void, and will automatically terminate your rights under
694 this License (including any patent licenses granted under the third
695 paragraph of section 11).</p>
697 <p>However, if you cease all violation of this License, then your
698 license from a particular copyright holder is reinstated (a)
699 provisionally, unless and until the copyright holder explicitly and
700 finally terminates your license, and (b) permanently, if the copyright
701 holder fails to notify you of the violation by some reasonable means
702 prior to 60 days after the cessation.</p>
704 <p>Moreover, your license from a particular copyright holder is
705 reinstated permanently if the copyright holder notifies you of the
706 violation by some reasonable means, this is the first time you have
707 received notice of violation of this License (for any work) from that
708 copyright holder, and you cure the violation prior to 30 days after
709 your receipt of the notice.</p>
711 <p>Termination of your rights under this section does not terminate the
712 licenses of parties who have received copies or rights from you under
713 this License. If your rights have been terminated and not permanently
714 reinstated, you do not qualify to receive new licenses for the same
715 material under section 10.</p>
717 <h4><a name="section9"></a>9. Acceptance Not Required for Having Copies.</h4>
719 <p>You are not required to accept this License in order to receive or
720 run a copy of the Program. Ancillary propagation of a covered work
721 occurring solely as a consequence of using peer-to-peer transmission
722 to receive a copy likewise does not require acceptance. However,
723 nothing other than this License grants you permission to propagate or
724 modify any covered work. These actions infringe copyright if you do
725 not accept this License. Therefore, by modifying or propagating a
726 covered work, you indicate your acceptance of this License to do so.</p>
728 <h4><a name="section10"></a>10. Automatic Licensing of Downstream Recipients.</h4>
730 <p>Each time you convey a covered work, the recipient automatically
731 receives a license from the original licensors, to run, modify and
732 propagate that work, subject to this License. You are not responsible
733 for enforcing compliance by third parties with this License.</p>
735 <p>An “entity transaction” is a transaction transferring control of an
736 organization, or substantially all assets of one, or subdividing an
737 organization, or merging organizations. If propagation of a covered
738 work results from an entity transaction, each party to that
739 transaction who receives a copy of the work also receives whatever
740 licenses to the work the party's predecessor in interest had or could
741 give under the previous paragraph, plus a right to possession of the
742 Corresponding Source of the work from the predecessor in interest, if
743 the predecessor has it or can get it with reasonable efforts.</p>
745 <p>You may not impose any further restrictions on the exercise of the
746 rights granted or affirmed under this License. For example, you may
747 not impose a license fee, royalty, or other charge for exercise of
748 rights granted under this License, and you may not initiate litigation
749 (including a cross-claim or counterclaim in a lawsuit) alleging that
750 any patent claim is infringed by making, using, selling, offering for
751 sale, or importing the Program or any portion of it.</p>
753 <h4><a name="section11"></a>11. Patents.</h4>
755 <p>A “contributor” is a copyright holder who authorizes use under this
756 License of the Program or a work on which the Program is based. The
757 work thus licensed is called the contributor's “contributor version”.</p>
759 <p>A contributor's “essential patent claims” are all patent claims
760 owned or controlled by the contributor, whether already acquired or
761 hereafter acquired, that would be infringed by some manner, permitted
762 by this License, of making, using, or selling its contributor version,
763 but do not include claims that would be infringed only as a
764 consequence of further modification of the contributor version. For
765 purposes of this definition, “control” includes the right to grant
766 patent sublicenses in a manner consistent with the requirements of
769 <p>Each contributor grants you a non-exclusive, worldwide, royalty-free
770 patent license under the contributor's essential patent claims, to
771 make, use, sell, offer for sale, import and otherwise run, modify and
772 propagate the contents of its contributor version.</p>
774 <p>In the following three paragraphs, a “patent license” is any express
775 agreement or commitment, however denominated, not to enforce a patent
776 (such as an express permission to practice a patent or covenant not to
777 sue for patent infringement). To “grant” such a patent license to a
778 party means to make such an agreement or commitment not to enforce a
779 patent against the party.</p>
781 <p>If you convey a covered work, knowingly relying on a patent license,
782 and the Corresponding Source of the work is not available for anyone
783 to copy, free of charge and under the terms of this License, through a
784 publicly available network server or other readily accessible means,
785 then you must either (1) cause the Corresponding Source to be so
786 available, or (2) arrange to deprive yourself of the benefit of the
787 patent license for this particular work, or (3) arrange, in a manner
788 consistent with the requirements of this License, to extend the patent
789 license to downstream recipients. “Knowingly relying” means you have
790 actual knowledge that, but for the patent license, your conveying the
791 covered work in a country, or your recipient's use of the covered work
792 in a country, would infringe one or more identifiable patents in that
793 country that you have reason to believe are valid.</p>
796 <p>If, pursuant to or in connection with a single transaction or
797 arrangement, you convey, or propagate by procuring conveyance of, a
798 covered work, and grant a patent license to some of the parties
799 receiving the covered work authorizing them to use, propagate, modify
800 or convey a specific copy of the covered work, then the patent license
801 you grant is automatically extended to all recipients of the covered
802 work and works based on it.</p>
804 <p>A patent license is “discriminatory” if it does not include within
805 the scope of its coverage, prohibits the exercise of, or is
806 conditioned on the non-exercise of one or more of the rights that are
807 specifically granted under this License. You may not convey a covered
808 work if you are a party to an arrangement with a third party that is
809 in the business of distributing software, under which you make payment
810 to the third party based on the extent of your activity of conveying
811 the work, and under which the third party grants, to any of the
812 parties who would receive the covered work from you, a discriminatory
813 patent license (a) in connection with copies of the covered work
814 conveyed by you (or copies made from those copies), or (b) primarily
815 for and in connection with specific products or compilations that
816 contain the covered work, unless you entered into that arrangement,
817 or that patent license was granted, prior to 28 March 2007.</p>
819 <p>Nothing in this License shall be construed as excluding or limiting
820 any implied license or other defenses to infringement that may
821 otherwise be available to you under applicable patent law.</p>
823 <h4><a name="section12"></a>12. No Surrender of Others' Freedom.</h4>
825 <p>If conditions are imposed on you (whether by court order, agreement or
826 otherwise) that contradict the conditions of this License, they do not
827 excuse you from the conditions of this License. If you cannot convey a
828 covered work so as to satisfy simultaneously your obligations under this
829 License and any other pertinent obligations, then as a consequence you may
830 not convey it at all. For example, if you agree to terms that obligate you
831 to collect a royalty for further conveying from those to whom you convey
832 the Program, the only way you could satisfy both those terms and this
833 License would be to refrain entirely from conveying the Program.</p>
835 <h4><a name="section13"></a>13. Use with the GNU Affero General Public License.</h4>
837 <p>Notwithstanding any other provision of this License, you have
838 permission to link or combine any covered work with a work licensed
839 under version 3 of the GNU Affero General Public License into a single
840 combined work, and to convey the resulting work. The terms of this
841 License will continue to apply to the part which is the covered work,
842 but the special requirements of the GNU Affero General Public License,
843 section 13, concerning interaction through a network will apply to the
844 combination as such.</p>
846 <h4><a name="section14"></a>14. Revised Versions of this License.</h4>
848 <p>The Free Software Foundation may publish revised and/or new versions of
849 the GNU General Public License from time to time. Such new versions will
850 be similar in spirit to the present version, but may differ in detail to
851 address new problems or concerns.</p>
853 <p>Each version is given a distinguishing version number. If the
854 Program specifies that a certain numbered version of the GNU General
855 Public License “or any later version” applies to it, you have the
856 option of following the terms and conditions either of that numbered
857 version or of any later version published by the Free Software
858 Foundation. If the Program does not specify a version number of the
859 GNU General Public License, you may choose any version ever published
860 by the Free Software Foundation.</p>
862 <p>If the Program specifies that a proxy can decide which future
863 versions of the GNU General Public License can be used, that proxy's
864 public statement of acceptance of a version permanently authorizes you
865 to choose that version for the Program.</p>
867 <p>Later license versions may give you additional or different
868 permissions. However, no additional obligations are imposed on any
869 author or copyright holder as a result of your choosing to follow a
872 <h4><a name="section15"></a>15. Disclaimer of Warranty.</h4>
874 <p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
875 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
876 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY
877 OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
878 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
879 PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
880 IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
881 ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p>
883 <h4><a name="section16"></a>16. Limitation of Liability.</h4>
885 <p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
886 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
887 THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
888 GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
889 USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
890 DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
891 PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
892 EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
895 <h4><a name="section17"></a>17. Interpretation of Sections 15 and 16.</h4>
897 <p>If the disclaimer of warranty and limitation of liability provided
898 above cannot be given local legal effect according to their terms,
899 reviewing courts shall apply local law that most closely approximates
900 an absolute waiver of all civil liability in connection with the
901 Program, unless a warranty or assumption of liability accompanies a
902 copy of the Program in return for a fee.</p>
904 <p>END OF TERMS AND CONDITIONS</p>
907 <hr size="2" width="100%"><br>
909 <h2><a name="Installation"></a>Installation</h2>
911 <div align="justify">
913 <p>Citadel is an advanced, multiuser, client/server messaging system
914 suitable for BBS, e-mail, and groupware applications. It is designed to
915 handle the needs of both small dialup systems and large-scale
916 Internet-connected systems. It was originally developed on an Altos
917 system running Xenix, and has been installed and tested on various Unix
918 and Unix-like platforms. The current development environment (and
919 public BBS) is an ordinary Linux system. The current distribution
922 <li>The Citadel server (this is the back end that does all
924 <li>A text-based client program designed with the traditional Citadel
925 "look and feel" (room prompts, dot commands, and the like) </li>
926 <li>Setup programs </li>
927 <li>A set of utilities for system administration and maintenance </li>
928 <li>Documentation </li>
930 <p>Some knowledge of the Unix system is necessary to install and manage
931 the system. It is mandatory that the sysop have "root" access to the
932 operating system. The following are required to install Citadel: </p>
934 <li>A unix-like operating system (Linux, FreeBSD, Solaris, etc.) </li>
935 <li>The GNU build tools (<a href="http://gcc.gnu.org/">GCC</a> with <a
936 href="http://www.gnu.org/software/make/make.html">gmake</a> is the
937 recommended build environment) </li>
938 <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1 or newer</li>
939 <li><a href="http://www.aurore.net/projects/libical/">libical</a> v0.26 or
940 newer (if you want the calendar service to work)</li>
941 <li><a href="http://libsieve.sourceforge.net">libSieve</a> v2.2.3 or newer
942 (if you want mail filtering/scripting to work)</li>
943 <li>Enough disk space to hold all of the programs and data </li>
945 <p>If you are running Citadel on a Linux system, it is STRONGLY
946 recommended that you run it on a recent distribution (such as CentOS
947 4.1 or newer). A new-ish
948 distribution will have many of the prerequisite tools and
949 libraries already integrated for you.</p>
950 <h3>Other pieces which complete the Citadel system:</h3>
952 <li>"WebCit", a gateway program to allow full access to Citadel via
953 the World Wide Web. Interactive access through any Web browser. </li>
954 <li>Access to Citadel via <i>any</i> standards-compliant e-mail
955 program, thanks to Citadel's built-in SMTP, POP, and IMAP services.
956 You can use Mozilla, Netscape, Evolution, Eudora, Pine, Outlook, etc.
958 <li>Access to Citadel's calendar and address book functions using any
959 PIM client that supports Webcal or GroupDAV (requires WebCit).<br>
962 <h3>Coming soon:</h3>
964 <li>More integration with third-party software.<br>
967 <h3><a name="Everything_in_its_place..."></a>Everything in its place...</h3>
968 <p>Hopefully you've unpacked the distribution archive into its own
969 directory. This is the directory in which all Citadel files are located
971 which all activity will take place. Several subdirectories have already
972 been created during the unpacking process, and others may be created
973 by the software if needed. Make sure you have Berkeley DB installed on
974 your system, and that you have all the development libraries and
976 in place so that you can compile against them. If you don't, you can
977 get the latest Berkeley DB at
978 <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
979 If your operating system uses a separate library to support POSIX
980 threads (pthreads), make sure that library is installed as well. This
981 is almost never the case with Linux, but some commercial Unix flavors
985 <h3><a name="ctdl_login_acct"></a>Creating a system account for Citadel</h3>
986 <p>As with many Unix programs, Citadel wants to run under its own user
987 ID. Unlike other programs, however, this user ID will do double-duty as
988 a public login for your system if you are running a BBS. This account
989 is typically called "bbs" or "citadel" or something to that effect. You
990 will tell Citadel what the user-id of that account is, and when someone
991 logs in under that account, Citadel will prompt for a user name.</p>
992 <p>The Citadel user should have a unique uid. The home directory should
993 be the one your Citadel installation resides in (in this example we
994 will use <tt>/usr/local/citadel</tt>) and the shell should be either
996 that directory, or a script that will start up the citadel client.
998 <pre>citadel::100:1:Citadel Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
999 <p>When you run setup later, you will be required to tell it the
1000 username or user ID of the account you created is, so it knows what
1001 user to run as. If you create an account called <tt>citadel, bbs</tt>,
1002 or <tt>guest</tt>, the setup program will automatically pick up the
1003 user ID by default.</p>
1004 <p>For all other users in <tt>/etc/passwd</tt> (or in some other name
1005 service such as NIS), Citadel can automatically set up
1006 such as NIS), Citadel can automatically set up
1007 an account using the full name (or 'gecos' in Unixspeak) of the user.
1008 It'll also ignore any password you supply, because it uses the user's
1009 password on the host system. This allows a 'single sign on' type of
1011 Note that this does have to be enabled at setup time -- it's the
1012 option called "host based authentication mode". Keep in
1013 mind that these users can use *either* their Citadel login name or
1014 their login name on the host computer, and their password on the
1016 <h3><a name="bypassing_login"></a>Bypassing the <tt>login:</tt>
1018 <p>If you normally log in to your host system using some method other
1019 than telnet (such as ssh), you might want the telnet service to go
1020 straight into Citadel, instead of displaying the <tt>login:</tt>
1022 can do this by having telnetd start citadel directly instead of
1023 <tt>/bin/login</tt>. The <tt>setup</tt> program will offer to
1025 this automatically for you if it sees a configuration it understands.
1026 If you would prefer to configure it manually, all you need to do is
1028 simple change to your <tt>inetd</tt> or <tt>xinetd</tt>
1029 configuration. Here are some configuration examples.</p>
1030 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
1031 replacing any existing telnet configuration line already there):</p>
1032 <pre>telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel<br></pre>
1033 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
1034 then simply replace that file with this one):</p>
1035 <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>
1036 <p>Please make sure you know what you're doing before you install this!
1038 you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
1039 then change the directory name accordingly. If you know of any other
1040 local peculiarities which need to be observed, edit the above
1042 accordingly as well. And, of course, if you're working remotely, make
1043 sure you can successfully log in using SSH <b>before</b> you start
1045 changes to telnet, because if you accidentally break telnet and don't
1047 SSH running, you'll have effectively locked yourself out of your system
1048 until you can get physical access to the console.<br>
1051 <h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
1052 <p>You can easily compile the Citadel system with the following
1054 <pre>./configure<br>make<br>make install<br></pre>
1055 <p>The 'configure' script will generate a Makefile from the
1057 and it will also write the file "sysdep.h" to your Citadel directory.
1058 Please do not edit sysdep.h or Makefile.in yourself. The configure
1060 figure out your system dependencies and set everything correctly.</p>
1061 <p>Mac OS X 10.1 and later are now supported. (Sorry, 10.0 cannot be
1062 supported, now or in the future.) You need to install the Developer
1063 Tools CD, which you can purchase or download for free from <a
1064 href="http://developer.apple.com">http://developer.apple.com</a>. Then
1065 run configure like this:</p>
1066 <pre>env CC=/usr/bin/cc ./configure (options - see below)<br></pre>
1067 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
1068 If you wish to place it in a different directory, you can instead do:</p>
1069 <pre>./configure --prefix=/export/home/citadel (or whatever)<br></pre>
1070 <p>If you've got Berkeley DB installed in a non-standard location, you
1071 can help the configure script find it by doing something like this:</p>
1072 <pre>./configure --with-db=/usr/local/BerkeleyDB-4.1<br></pre>
1073 <p>Keep in mind that if you're using Berkeley DB from a non-standard
1075 you'll have to make sure that location is available at runtime.</p>
1076 <p>File permissions are always a bother to work with. You don't want
1077 Citadel to crash because someone couldn't access a file, but you also
1078 don't want shell users peeking into the binaries to do things like
1079 reading others' mail, finding private rooms, etc. The Citadel server
1080 needs to be started as root in order to bind to privileged ports, but
1081 as soon as its initialization is finished, it changes its user ID to
1082 your Citadel user in order to avoid security holes.</p>
1083 <h3><a name="Upgrading"></a>Upgrading</h3>
1084 <p>Any existing Citadel installation which is at version 5.50 or newer
1085 may be upgraded in place without the need to discard your existing data
1087 <p>Upgrading to a new version uses the same build procedure as
1089 the program for a fresh install, except that you want to do <tt>make
1090 upgrade</tt> instead of <tt>make install</tt>. This will
1091 overwrite the programs but not your data. <b>Be sure to shut down
1092 citserver during this process!</b> If Citadel is running while you
1093 upgrade, you may face data corruption issues.<br>
1095 <p>After doing <tt>make upgrade</tt>, you should run <tt>setup</tt>
1096 again to bring your data files up to date. Please see the setup section
1097 below for more information on this.</p>
1098 <h3><a name="rc_file"></a>The <tt>citadel.rc</tt> file</h3>
1099 <p>The text-based client included with Citadel is suitable for BBS
1100 applications. Much of its command set and other behavior is
1101 configurable through a Run Control (RC) file. The standard client looks
1102 for this file in the following locations: </p>
1104 <li><tt>$HOME/.citadelrc</tt></li>
1105 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
1106 <li><tt>/etc/citadel.rc</tt></li>
1107 <li><i>current-directory</i><tt>/citadel.rc</tt></li>
1109 The next couple of sections deal with client-side configuration.
1110 <h3><a name="Using_an_external_editor_for_message"></a>Using an
1112 for message composition</h3>
1113 <p>Citadel has a built-in message editor. However, you can also use
1114 your favorite text editor to write messages. To do this you simply put
1115 a line in your citadel.rc file like this:</p>
1116 <pre>editor=/usr/bin/vi<br></pre>
1117 <p>The above example would make Citadel call the vi editor when using
1118 the <tt><b>.E</b>nter <b>E</b>ditor</tt> command, or when a user
1119 selects the "Always compose messages with the full-screen
1120 editor" option. You can also make
1121 it the default editor for the <tt><b>E</b>nter</tt> command by editing
1122 the <tt>citadel.rc</tt> file. <b>But be warned:</b> external editors
1123 on public systems can
1124 be a security hole, because they usually provide users with the ability
1125 to drop into a shell on the host system, or save files using names
1127 than the name of the temporary file they are editing. If you intend to
1128 use an external editor on a public BBS, make sure you use one that has
1130 hardened for such a purpose -- one which has had the 'shell' and 'save
1132 commands disabled, as well as any other functions which a destructive
1133 user could use to gain unauthorized access to your host system.</p>
1134 <h3><a name="Printing_messages"></a>Printing messages</h3>
1135 <p>Citadel can send messages to a printer, or just about anywhere
1136 else in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt>
1137 specifies what command you use to print. Text is sent to the standard
1138 input (stdin) of the print command.</p>
1139 <p>So if you did this:</p>
1140 <pre>printcmd="a2ps -o - |lpr -Plocal"<br></pre>
1141 <p>...that would convert the printed text to PostScript, then print on
1143 printer named "local". There's tons of stuff you can do with this
1144 feature. For example, you could use a command like <tt>cat
1145 <<$HOME/archive</tt> to save copies of important messages in a
1146 textfile. Again, this is probably something you don't want to configure
1147 for a public BBS host -- most system administrators don't want remote
1148 users sending arbitrary things to local printers.</p>
1149 <h3><a name="URL_viewing"></a>URL viewing</h3>
1150 <p>This is one more feature which is appropriate for local users. While
1152 a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
1153 command, and it will perform some pre-defined action (usually, this is
1154 to open up the URL in a web browser). For example:</p>
1155 <pre>urlcmd=netscape -remote "openURL(%s)"<br></pre>
1156 <p>In the above example, it would open up the URL in an open <a
1157 href="http://www.netscape.com/download">Netscape</a> window.<br>
1160 <h3><a name="Setup_and_login"></a>Setup and login</h3>
1161 <p>Before logging in for the first time, you must run the setup
1162 program. To begin this procedure, enter the following commands:</p>
1163 <pre>cd /usr/local/citadel<br>./setup<br></pre>
1164 <p>The setup program will guide you through a simple configuration
1165 procedure. It will ask you what directory to place your data files in
1166 -- the default is the current directory, which is usually the sensible
1167 thing to select. If you want to run more than one instance of Citadel
1168 on the same host, however, you can specify a different directory here
1169 -- just remember to specify the directory name again when you start up
1170 the server later on.</p>
1171 <p><tt>setup</tt> will then shut down the Citadel service if it is
1174 <p>You will then be prompted for the name of the system administrator.
1175 This is not merely a cosmetic option -- when you log in to your system
1176 a little while from now, you'll log in with this name, and it will
1177 automatically assign your account the highest access level.</p>
1178 <p>Next, you will be prompted for the User ID of the Citadel account on
1179 your host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
1180 or <tt>citadel</tt>, that account's UID will be the default. If you
1181 are upgrading or reconfiguring an existing system, the existing value
1182 will be preserved.</p>
1183 <p>Then you will be prompted for a server port number. This is the TCP
1184 port which Citadel clients use to connect to your Citadel server. In
1185 almost all cases, you want to use the default -- port 504, which is the
1186 official port number assigned by the IANA for Citadel implementations.</p>
1187 <p><tt>setup</tt> will then ask you about authentication mode. <i>Please
1188 understand this question thoroughly before answering it.</i> You have a
1189 choice of two authentication modes:
1191 <li><i>Native authentication</i> - Citadel maintains its own user database.
1192 This is the normal mode of authentication. Citadel operates as a "black
1193 box" and your users do not have to have accounts or home directories on the
1195 <li><i>Host based authentication</i> - access to Citadel is authenticated
1196 against the user database (<tt>/etc/passwd</tt> or perhaps NIS, etc.).
1198 You will be asked if you wish to use host based authentication. If you
1199 wish to do so, answer "Yes" at the prompt. For most installations, "No"
1200 is the appropriate answer.
1202 <p>The Citadel service will then be started, and you will see the
1203 following message:</p>
1204 <pre>Setup is finished. You may now log in.<br></pre>
1205 <p>Setup is now complete, on most systems, anyway. Please see below to
1206 find out if you need to do anything else:</p>
1207 <h3><a name="Configuring_your_host_system_to_start"></a>Configuring
1209 system to start the service</h3>
1210 <p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
1211 and <tt>/etc/inittab</tt> in order to configure your host system to
1212 automatically start the Citadel service. <tt>setup</tt> will
1213 automatically perform these steps if it can, and if you allow it to --
1214 just answer 'Yes' when prompted, and everything will be taken care of
1215 for you. If you answer 'No' -- or if your system is a little bit odd
1216 (for example, BSD systems don't have <tt>/etc/inittab</tt>) -- read
1217 this section and do what you need to in order to get things configured.</p>
1218 <p>Before you can use Citadel, you must define the "citadel" service to
1219 your system. This is accomplished by adding a line to your
1220 /etc/services file that looks something like this:</p>
1221 <pre>citadel 504/tcp # Citadel Server<br></pre>
1222 <p>504 is the port number officially designated by the IANA for use by
1223 Citadel. There should not be any need to use a different port number,
1224 unless you are running multiple Citadels on the same computer and
1226 a different port for each one.</p>
1227 <p>The next step is to arrange for the server to start. The <tt>citserver</tt>
1228 program is the main Citadel server. Before we cover the recommended
1229 method of starting the server, let's examine its usage options:</p>
1230 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-lLogFacility] [-d] [-f]<br></pre>
1231 <p>The options are as follows:</p>
1232 <p><tt>-hHomeDir</tt> - the directory your Citadel data files live in.
1233 This should, of course, be a directory that you've run the <tt>setup</tt>
1234 program against to set up some data files. If a directory is not
1235 specified, the directory
1236 name which was specified in the <tt>Makefile</tt> will be used.</p>
1237 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed.
1238 When -x is used, it will suppress messages sent to syslog (see below).
1240 other words, syslog will never see certain messages if -x is used.
1242 you should configure logging through syslog, but -x may still be useful
1244 some circumstances. The available debugging levels are: </p>
1246 <li>0 - Emergency condition; Citadel will exit immediately </li>
1247 <li>1 - Severe errors; Citadel may be unable to continue without
1249 <li>2 - Critical errors; Citadel will continue with degraded
1251 <li>3 - Error conditions; Citadel will recover and continue normally </li>
1252 <li>4 - Warning messages; Citadel will continue normally </li>
1253 <li>5 - Normal operational messages </li>
1254 <li>6 - Informational messages, progress reports, etc. </li>
1255 <li>7 - Debugging messages; extremely verbose </li>
1257 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace
1258 output. Normally it is sent to stdout.</p>
1259 <p><tt>-lLogFacility</tt> - Tell the server to send its debug/trace
1261 to the <tt>syslog</tt> service on the host system <i>instead of</i>
1263 trace file. <tt>LogFacility</tt> must be one of: <tt><i>kern, user,
1265 daemon, auth, syslog, lpr, news, uucp, local0, local1, local2, local3,
1266 local4, local5, local6, local7</i></tt>. Please note that use of the
1267 <tt>-l</tt> option will cancel any use of the <tt>-t</tt> option; that
1269 if you specify a trace file <i>and</i> a syslog facility, log output
1271 only go to the syslog facility.
1273 <p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch
1274 would be necessary if you were starting the Citadel server, for
1275 example, from an rc.local script (which is not recommended, because
1276 this won't allow the server to automatically restart when it is shut
1278 <p><tt>-f</tt> - Defragment all the databases upon startup. This
1279 currently has no effect, as it is a vestige from the old data store.</p>
1280 <p>The preferred method of starting the Citadel server is to place an
1281 entry in your /etc/inittab file. This will conveniently bring the
1282 server up when your system is up, and terminate it gracefully when your
1283 system is shutting down. The exact syntax for your system may vary, but
1284 here's an entry that could be used on a Linux system:</p>
1285 <pre>cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x6<br></pre>
1286 <p>In this example, we've chosen debugging level 6, and have the trace
1287 stuff output to one of the virtual consoles. It's important to remember
1288 to turn off any getty that is set up on that virtual console, if you do
1289 this. After making this change, the command <tt>init q</tt> works on
1290 most systems to tell init to re-read the file. If in doubt, just reboot
1294 <h3><a name="first_time_login"></a>Logging in for the
1296 <p>At this point, your system is ready to run. Run the <tt>citadel</tt>
1297 program from the shell and log in as a new user. NOTE: the first user
1298 account to be created will automatically be set to access level 6
1299 (Aide). This overcomes some obvious logistical problems - normally,
1300 Aide access is given by another Aide, but since there aren't any on
1301 your system yet, this isn't possible.<br>
1304 <h3><a name="Welcoming_new_users"></a>Welcoming new users</h3>
1305 <p>Sometimes you might decide that you want a welcome message (or
1306 several different messages) automatically mailed to new users upon
1307 their first login. Now there is a way to do this. If you create a room
1308 called <tt>New User Greetings</tt>, and it is a <i>private</i> room
1309 (invitation-only probably makes the most sense), any messages you enter
1310 into that room will automatically be delivered to all new users upon
1312 <p>You can put anything you want there: a welcome message, system
1313 policies, special information, etc. You can also put as many messages
1314 there as you want to (although it really doesn't make sense to clutter
1315 new users' mailboxes with lots of junk).</p>
1316 <p>Don't worry about wasting disk space, either. Citadel has a
1317 single-instance message store, so all the new users are actually
1318 looking at the same copy of the message on disk.<br>
1321 <h3><a name="adding_doors"></a>Space for adding
1323 client features (doors)</h3>
1324 <p><b>Please take note!</b> This function really represents the "old"
1325 way of doing things, and it doesn't fit in well with the client/server
1326 paradigm. Please consider it "deprecated" because it may be removed
1328 <p>The "doorway" feature is just a generic way to add features to the
1329 system. It is called "Doorway" to make it resemble the doors on
1330 non-Unix boards, but as we all know, us Unix types don't have to write
1331 special code to access the modem. :-) Anyway, when a user hits the <tt><b>*</b></tt>
1332 (doorway) command, Citadel does...</p>
1333 <pre>USERNAME=(username); export USERNAME<br>./subsystem (user-number) (screen-width) (access level)<br></pre>
1334 <p>...so you can put whatever you want in there. I suggest putting in a
1336 program to allow the users to pick one of a number of programs, etc. Do
1337 be aware that door programs will only be available when the client and
1339 programs are running on the <i>same</i> computer, and when the user is
1341 the text-mode client. Because of these restrictions, Door programs are
1343 utilized less and less every day.<br>
1346 <h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and
1348 <p>That's just about all the information you need to install the
1349 system. But if you get stuck, you can visit <a
1350 href="http://uncensored.citadel.org">UNCENSORED! BBS</a> and report a
1351 problem or ask for help. But if you intend to report a problem getting
1352 the Citadel server to run, <i>please</i> double-check the following
1355 <li>Did you do <tt>./configure && make && make
1356 install</tt> ?? </li>
1357 <li>Did you run setup? </li>
1358 <li>Did you start the server? </li>
1360 <p>To report a problem, you can log on to <a
1361 href="http://uncensored.citadel.org">UNCENSORED!</a> or any other BBS
1362 on the Citadel network which carries the <tt>Citadel/UX></tt> room.
1363 Please DO NOT e-mail the developers directly. Post a request for help
1364 on the BBS, with all of the following information: </p>
1366 <li>The exact nature of your difficulty </li>
1367 <li>A transcript of the error message(s) if possible </li>
1368 <li>The version of Citadel you are running </li>
1369 <li>The version of Berkeley DB present on your system </li>
1370 <li>Which operating system you are running, and what version </li>
1371 <li>If you are running a Linux system, we need to know which
1372 distribution, and the version of the kernel, libc, and pthreads you
1373 are using (it would help to post the output of a <tt>ldd ./citserver</tt>
1377 <div align="center">
1378 <hr size="2" width="100%">
1379 <h2><a name="sysop"></a>System Administration</h2>
1381 <div align="justify">
1382 <h3><a name="Overview_"></a>Overview</h3>
1383 <p>Citadel, when installed properly, will do most of its maintenance
1384 by itself. It is intended to be run unattended for extended periods of
1385 time, and most installations do just that without any software failures.</p>
1386 <p>The system has seven access levels. Most users are at the bottom and
1388 no special privileges. Aides are selected people who have special
1390 the Citadel program. Room Aides only have this access in a certain
1391 room. Preferred users can be selected by Aides for access to preferred
1392 only rooms. A sysop is anyone who has access to the various sysop
1394 are in their own executable files, which should have their permissions
1396 to allow only sysops to run them. You should either create a sysops
1398 in /etc/group, or use some other existing group for this purpose.</p>
1399 <p>Aides have access to EVERY room on the system, public and private
1400 (all types). They also have access to commands starting with <tt>.<b>A</b>ide</tt>
1401 in addition to being able to delete and move messages. The system room,
1402 <tt>Aide></tt>, is accessible only by those users designated as
1404 <h3><a name="Aide_commands"></a>Aide commands</h3>
1405 <p>Aides have the following commands available to them that are not
1406 available to normal users. They are:</p>
1410 <td width="30%"><tt> .<b>A</b>ide <b>K</b>ill this room </tt></td>
1411 <td> Deletes the current room from the system. </td>
1414 <td width="30%"><tt> .<b>A</b>ide <b>E</b>dit this room </tt></td>
1415 <td> Allows editing of the properties of the current room. This
1416 is explained in greater detail below. </td>
1419 <td width="30%"><tt> .<b>A</b>ide <b>W</b>ho knows room </tt></td>
1420 <td> For private rooms with access controls, or mailbox rooms,
1421 this command displays a list of users who have access to the current
1425 <td width="30%"><tt> .<b>A</b>ide edit <b>U</b>ser </tt></td>
1426 <td> Allows editing of the properties of any user account
1427 on the system. </td>
1430 <td width="30%"><tt> .<b>A</b>ide <b>V</b>alidate new users </tt></td>
1431 <td> For public access systems, this command reviews all new user
1432 registrations and allows you to set each new user's access level (or
1433 simply delete the accounts). </td>
1436 <td width="30%"><tt> .<b>A</b>ide enter <b>I</b>nfo file </tt></td>
1437 <td> Each room may contain a short textual description of
1438 its purpose, which is displayed to users upon entering the room for the
1439 first time (or in the room banner, for users of the Web client). This
1440 command allows you to enter or edit that description. </td>
1443 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite
1445 <td> Access control command to grant any specific user access to
1446 a private room. </td>
1449 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick
1451 <td> Access control command to revoke any specifc user's access
1452 to the current room. This works regardless of whether the room is
1453 public or private. </td>
1456 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>D</b>elete </tt></td>
1457 <td> If the current room has an associated file directory, this
1458 command may be used to delete files from it. </td>
1461 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end
1463 <td> If the current room has an associated file directory, this
1464 command may be used to transmit a copy of any file in that directory to
1465 another node on a Citadel network. </td>
1468 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>M</b>ove </tt></td>
1469 <td> If the current room has an associated file directory, this
1470 command may be used to move any file in that directory to another room.
1471 The target room must also have an associated file directory. </td>
1474 <td width="30%"><tt> .<b>A</b>ide <b>M</b>essage edit </tt></td>
1475 <td> This command allows editing of any of the various system
1476 banners and messages which are displayed to users. Type the name of
1477 the banner or message you wish to edit. </td>
1480 <td width="30%"><tt> .<b>A</b>ide <b>P</b>ost </tt></td>
1481 <td> This is the functional equivalent of the <tt><b>E</b>nter
1482 message</tt> command available to all users, except that it allows you
1483 to post using any user name. </td>
1486 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>G</b>eneral
1488 <td> This command allows configuration of a large number of
1489 global settings for your Citadel system. These settings will be
1490 explained in greater detail below. </td>
1493 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>I</b>nternet
1495 <td> This command allows configuration of settings which affect
1496 how your Citadel system sends and receives messages on the Internet. </td>
1499 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1500 check <b>M</b>essage base </tt></td>
1501 <td> Perform a consistency check on your message store. This is a
1502 very time-consuming operation which should not be performed unless you
1503 have reason to believe there is trouble with your database. </td>
1506 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>N</b>etwork
1508 <td> Configure networking (e-mail, room sharing, etc.) with other
1509 Citadel nodes. </td>
1512 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1513 network <b>F</b>ilter list </tt></td>
1514 <td> If you are on a large public or semi-public network of
1515 Citadel nodes and you find content from certain systems or individuals
1516 objectionable, you can use this command to define a rule set to
1517 automatically reject those messages when they arrive on your system. </td>
1520 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>N</b>ow
1522 <td> Immediately shut down the Citadel service, disconnecting any
1523 users who are logged in. Please keep in mind that it will start
1524 right back up again if you are running the service from <tt>/etc/inittab</tt>,
1525 so in practice this command will probably not get much use. </td>
1528 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>S</b>cheduled
1530 <td> Shut down the Citadel service the next time there are zero
1531 users connected. This allows you to automatically wait until all users
1532 are logged out. </td>
1535 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients
1537 <td> Any room may be made into a mailing list. Enter this command
1538 to open an editor window containing the list of Internet e-mail
1539 addresses to which every message posted in the room will be sent. </td>
1542 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest
1543 recipients </tt></td>
1544 <td> Similar to the regular mailing list command, except the
1545 messages will be sent out in 'digest' form -- recipients will see
1546 messages from the address of the room itself rather than the address of
1547 the author of each message, and a digest may contain more than one
1548 message. Each room may have any combination of List and Digest
1552 <td width="30%"><tt> .<b>A</b>ide <b>N</b>etwork room sharing </tt></td>
1553 <td> Configures the sharing of the current room's contents with
1554 other Citadel nodes. Messages posted in this room on any Citadel system
1555 will automatically be replicated to other Citadel systems carrying the
1562 <h3><a name="Editing_rooms"></a>Editing rooms</h3>
1563 <p>This command allows any aide to change the parameters of a room. Go
1564 to the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit
1565 room</tt> command. A series of prompts will be displayed. The existing
1566 parameters will be displayed in brackets; simply press return if you
1568 to leave any or all of them unchanged.</p>
1569 <pre> <br>Room name [IG's Fun Room]:<br></pre>
1570 <p>...the name of the room.</p>
1571 <pre>Private room [Yes]? <br></pre>
1572 <p>...enter Yes if you wish to restrict access to the room, or no if
1574 is to be accessible by all users. Note that Citadel doesn't bother
1576 about access to rooms every time they need to access the room. Once a
1578 gains access to a private room, it then behaves like a public room to
1580 The following four questions will only be asked if you selected
1582 <pre>Accessible by guessing room name [No]?<br></pre>
1583 <p>...if you enter Yes, the room will not show up in users' <tt><b>K</b>nown
1584 rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing
1585 the room's full name), they will gain access to the room.</p>
1586 <pre>Accessible by entering a password [No]?<br>Room password [mypasswd]: <br></pre>
1587 <p>...this adds an additional layer of security to the room, prompting
1588 users for a password before they can gain access to the room.</p>
1589 <p>If you did not select guessname or passworded, then the only way
1590 users can access the room is if an Aide explicitly invites them to the
1591 room using the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt>
1593 <pre>Cause current users to forget room [No] ? No<br></pre>
1594 <p>Enter Yes if you wish to kick out anyone who currently has access to
1596 <pre>Preferred users only [No]? No<br></pre>
1597 <p>Enter Yes if you wish to restrict the room to only users who have
1598 level 5 (Preferred User) status (and Aides too, of course). You should
1599 make the room public if you intend to do this, otherwise the two
1600 restrictions will be COMBINED.</p>
1601 <pre>Read-only room [No]? No<br></pre>
1602 <p>If you set a room to Read-Only, then normal users will not be
1604 post messages in it. Messages may only be posted by Aides, and by
1605 utility programs such as the networker and the "aidepost" utility. This
1607 useful in situations where a room is used exclusively for important
1608 announcements, or if you've set up a room to receive an Internet
1610 list and posting wouldn't make sense. Other uses will, of course,
1612 apparent as the need arises.</p>
1613 <p>Now for a few other attributes...</p>
1614 <pre>Directory room [Yes]? Yes<br></pre>
1615 <p>...enter Yes if you wish to associate a directory with this room.
1616 This can be used as a small file repository for files relevant to the
1617 topic of the room. If you enter Yes, you will also be prompted with the
1618 following four questions:</p>
1619 <pre>Directory name [mydirname]: <br></pre>
1620 <p>...the name of the subdirectory to put this room's files in. The
1621 name of the directory created will be <tt><i><your Citadel
1622 directory></i>/files/<i><room dir name></i></tt>.</p>
1623 <pre>Uploading allowed [Yes]? Yes<br></pre>
1624 <p>...enter Yes if users are allowed to upload to this room.</p>
1625 <pre>Downloading allowed [Yes]? Yes<br></pre>
1626 <p>...enter Yes if users are allowed to download from this room.</p>
1627 <pre>Visible directory [Yes]? Yes<br></pre>
1628 <p>...enter Yes if users can read the directory of this room.</p>
1629 <pre>Network shared room [No]? No<br></pre>
1630 <p>...you can share a room over a network without setting this flag,
1632 vice versa, but what this flag does is twofold: </p>
1634 <li>It prevents people with no network access from entering messages
1636 <li>Messages are displayed with the name of their originating
1637 system in the header. </li>
1639 <pre>Permanent room [No]? No<br></pre>
1640 <p>Citadel contains an 'auto purger' which is capable of removing rooms
1641 which have not been posted in for a pre-defined period of time (by
1643 this is set to two weeks). If you wish to keep this from happening to
1644 a particular room, you can set this option. (Keep in mind that <tt>Lobby></tt>,
1645 <tt>Aide></tt>, any private mailbox rooms, any network shared rooms,
1646 and any rooms with a file directory are automatically permanent.)</p>
1647 <pre>Anonymous messages [No]? No<br>Ask users whether to make messages anonymous [No]? No<br></pre>
1648 <p>...you can have rooms in which all messages are automatically
1649 anonymous, and you can have rooms in which users are prompted whether
1651 message anonymous when they enter it. The real identity of the author
1652 of each message is still revealed to the Room Aide for this room, as
1654 as any system-wide Aides.</p>
1655 <pre>Room aide [Joe Responsible]: <br></pre>
1656 <p>...on larger systems, it helps to designate a person to be
1657 responsible for a room. Room Aides have access to a restricted set of
1658 Aide commands, ONLY when they are in the room in which they have this
1659 privilege. They can edit the room, delete the room, delete and move
1660 messages, and invite or kick out users (if it is a private room), but
1661 they cannot perform aide commands that are not room-related (such as
1662 changing users access levels).</p>
1663 <pre>Listing order [64]: <br></pre>
1664 <p>This is just a simple way to try to control the order rooms are
1665 listed in when users call up a <tt><b>K</b>nown Rooms</tt> listing.
1666 Rooms with a lower listing order are displayed prior to rooms with a
1667 higher listing order. It has no other effect. For users who list rooms
1668 in floor order, the display will sort first by floor, then by listing
1670 <pre>Message expire policy (? for list) [0]:<br></pre>
1671 <p>This provides you with the opportunity to select how long each
1672 message will remain in a room before automatically being deleted. Press
1673 <tt><b>?</b></tt> for a list of options. You can choose to keep
1674 messages around forever (or until they are manually deleted), until
1675 they become a certain number of days old, or until a certain number of
1676 additional messages are posted in the room, at which time the oldest
1677 ones will scroll out.</p>
1678 <p>When a new Citadel system is first installed, the default
1680 expire policy is set to 'manual' -- no automatic purging of messages
1681 takes place anywhere. For public message boards, you will probably want
1682 to set some sort of automatic expire policy, in order to prevent your
1683 message base from growing forever.</p>
1684 <p>You will notice that you can also fall back to the default expire
1685 policy for the floor upon which the room resides. This is the default
1686 setting. You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit
1687 floor</tt> command. The default setting for the floor default, in turn,
1688 is the system default setting, which can be changed using the <tt><b>.A</b>ide
1689 <b>S</b>ystem configuration <b>G</b>eneral</tt> command.</p>
1690 <pre>Save changes (y/n)? Yes<br></pre>
1691 <p>...this gives you an opportunity to back out, if you feel you really
1692 messed things up while editing.<br>
1695 <h3><a name="File_directories"></a>File directories</h3>
1696 <p>If you have created any directory rooms, you can attach file
1697 descriptions to the filenames through a special file called <tt>filedir</tt>.
1698 Each line contains the name of a file in the directory, followed by a
1699 space and then a description of the file, such as:</p>
1700 <pre>myfile.txt This is a description of my file.<br>phluff A phile phull of phluff!<br></pre>
1701 <p>...this would create file descriptions for the files <tt>myfile.txt</tt>
1702 and <tt>phluff</tt> which would be displayed along with the directory.
1703 It should also be noted that when users upload files to your system,
1704 they will be prompted for file descriptions, which will be added to the
1705 <tt>filedir</tt> file. If one does not exist, it will be created.<br>
1708 <h3><a name="Creating_and_editing_user_accounts"></a>Creating and
1709 editing user accounts</h3>
1710 <p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1711 command to create and/or edit user accounts. There are several
1712 parameters which can be set here.</p>
1713 <p>To create a user:</p>
1714 <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>
1715 <p>At this point, the new user account has been created, and the
1717 continue as if you were editing an existing account. Therefore the
1719 of this procedure is the same for creating and editing:</p>
1720 <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>
1721 <p>The blank lines are the user's 'registration' information --
1723 information such as full name, address, telephone number, etc. This
1725 will comprise the user's vCard in both their user profile and in the
1728 <pre>Change password [No]: No<br></pre>
1729 <p>...answer Yes to set or change the password for this account.</p>
1730 <pre>Access level [4]: <br></pre>
1731 <p>...this allows you to set or change the access level for this
1732 account. The access levels available are as follows: </p>
1734 <li>0 - Deleted. (This immediately deletes the account.) </li>
1735 <li>1 - New, unvalidated user </li>
1736 <li>2 - Problem user (severely restricts account - use for
1737 probationary access) </li>
1738 <li>3 - User with no network privileges. Same access as a normal user
1739 except cannot post messages in rooms shared on a network. </li>
1740 <li>4 - Normal user </li>
1741 <li>5 - Preferred user (access is granted to privileged rooms) </li>
1742 <li>6 - Aide (administrative access to the whole system) </li>
1744 <pre>Permission to send/receive Internet mail [ No]? No<br></pre>
1745 <p>If your system is configured to only allow Internet mail privileges
1746 to certain users, this is where you can grant or revoke that privilege.</p>
1747 <pre>Ask user to register again [Yes]: Yes<br></pre>
1748 <p>If you answer Yes to this question, the user will be presented with
1750 'registration' screen or set of prompts, the next time they log in
1752 a Citadel client. This will prompt them for their full name, address,
1755 <pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1756 <p>These statistics are available for informational purposes only, so
1757 there is normally no need to change them.</p>
1758 <pre>Set last call to now [No]: No<br>Purge time (in days, 0 for system default [0]: <br></pre>
1759 <p>Citadel contains an auto-purger which is capable of automatically
1760 deleting accounts which have not been accessed in a predefined period
1761 of time. If you choose to perform this operation, you can 'touch' the
1763 of a wayward user by setting their 'last call' time to 'now'. You can
1764 also adjust, on a per-user basis, the amount of time which must pass
1766 their account is purged by the system. This time is set in days. You
1767 can also specify 0 days to indicate that you wish to use the system
1772 <h3><a name="Deleting_and_moving_messages"></a>Deleting and moving
1774 <p>Aides and Room Aides have the ability to delete and move messages.
1775 After each message, the normal prompt appears:</p>
1776 <pre>(8) <B>ack <A>gain <Q>uote <R>eply <N>ext <S>top m<Y> next <?>help -><br></pre>
1777 <p>Entering <tt><b>D</b>elete</tt> will delete the message. A <tt>(y/n)</tt>
1778 prompt will appear to confirm that you really want to delete the
1779 message. Entering <tt><b>M</b>ove</tt> will prompt for a room to which
1780 the message should be moved.<br>
1783 <h3><a name="Customizing_the_help_files"></a>Customizing the help files</h3>
1784 <p>The subdirectory called <tt>help</tt> contains your system's help
1785 files. There's nothing hard-coded into the system that dictates what
1787 should be there. Whenever a user types the command <tt><b>.H</b>elp</tt>
1788 followed by the name of a help file, it displays the contents of that
1790 <p>The help files that come with the system, of course, are enough to
1791 guide a user through its operation. But you can add, change, or remove
1792 help files to suit whatever is appropriate for your system.</p>
1793 <p>There are several strings that you can put in help files that will
1795 substituted with other strings. They are:</p>
1796 <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>
1797 <p>So, for example, you could create a help file which looked like:</p>
1798 <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>
1799 <h3><a name="Site_configuration"></a>Site configuration</h3>
1800 <p>Once your Citadel server is up and running, the first thing you'll
1801 want to do is customize and tune it. This can be done from the
1802 text-based client with the <tt><b>.A</b>ide <b>S</b>ystem
1803 configuration <b>G</b>eneral</tt> command, or from WebCit (if you have
1804 it installed) by clicking 'Advanced Options' followed by 'Edit
1805 site-wide configuration.' Either method will offer the same
1806 configuration options. This document shows the text mode client being
1808 <p>The first set of options deal with the identification of your system.</p>
1809 <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
1810 !="" more="" text="" on="" the="" next="" screen="">]: <br></jinkies></pre>
1811 <p>'Node name' refers to the short, unqualified node name by which your
1812 system is known on a Citadel network. Generally it will be the same as
1813 the unqualified host name of your computer; this is, in fact, the
1814 default setting.</p>
1815 <p>Then enter the fully-qualified domain name (FQDN) of your system. If
1817 are not on the Internet, you can simply set it to the same as your
1818 unqualified host name. Otherwise you should set this value to the host
1819 name by which your system is most commonly known.</p>
1820 <p>The field called 'Human-readable node name' (also known as the 'node
1821 title' or 'organization name' in other software) is used solely for
1822 display purposes. Set it to the actual name of your system as you want
1824 banners, messages, etc.</p>
1825 <p>If you have a modem or bank of modems answering data calls for your
1826 system, enter it in the field marked 'Modem dialup number.' Otherwise
1827 you may leave it blank.</p>
1828 <p>'Geographic location of this system' is another display field. Enter
1829 a city and state, or city and country. </p>
1830 <p>'Name of system administrator' is important! Any user who logs on
1831 with the name you enter here will automatically be granted Aide
1832 privileges. This is one of two ways for the system administrator to
1833 grant himself/herself Aide access to the system when initially setting
1834 it up. (The other is simply to have the first account created on a new
1836 <p>The next set of options are your system's security settings. Before
1837 delving into the actual options, we should review the various access
1838 levels available on the system. Citadel has seven access levels:</p>
1840 <li>0 (Deleted). A user whose access level is set to 0 will
1841 automatically be deleted by the system. </li>
1842 <li>1 (New User). Users at this level may only read messages.
1843 Entering messages is prohibited, except in the <tt>Mail></tt> room,
1844 where a message to 'sysop' may be entered. </li>
1845 <li>2 (Problem User). Also known as 'Twit.' </li>
1846 <li>3 (Local User). May enter messages, except in rooms shared on a
1847 Citadel network. </li>
1848 <li>4 (Network User). May enter messages in every accessible
1850 <li>5 (Preferred User). Use of this level is up to the whim of the
1851 system administrator. </li>
1852 <li>6 (Aide). Access is granted to the administrative functions of
1853 the system. (This access level may also be granted to a user only for a
1854 specific room, please see 'Room Aide' for more information.) </li>
1856 <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>
1857 <p>'Registration' refers to the process of a user entering various
1858 personal contact information (real name, address, telephone number,
1859 etc.) into the system. When enabled, this information is stored as a
1860 vCard object on the system in two places: the user's <tt>My Citadel
1862 room, and in the <tt>Global Address Book></tt> room. (Note: the
1864 should be made private on publicly-accessible systems, for obvious
1866 <p>If you answer Yes to 'Require registration for new users' then each
1867 new user, upon creating a new account, will immediately be entered into
1868 the registration process. On the other hand, if you answer Yes to
1869 'Disable self-service user account creation' then new users will not be
1871 log in at all -- all accounts must be created by an Aide.</p>
1872 <p>'Initial access level for new users' should be set to 1 (New User)
1873 if you would like to review each new user's registration info before
1874 granting them higher access. This would be done periodically with the <tt><b>.A</b>ide
1875 <b>V</b>alidate new users</tt> command. If you do not require
1876 registration, you should set the initial access level to 4 (Network
1878 <p>Given the above options, it then becomes clear that there are
1879 generally two ways you can set up your Citadel system, depending on its
1882 <li><b>A public access BBS or message board</b> - since you do
1883 not know who might want to log in, self-service account creation needs
1885 stay enabled. If you want to be strict about users identifying
1887 then you should also require users to register (just remember to post a
1888 privacy policy if you're going to collect personal information) -- then
1890 the initial access level to 1 (New User), so new users cannot post
1892 until after you've validated them. For a more lax environment, you can
1893 remove the registration requirement and grant new accounts level 4
1895 User) access on the first visit. </li>
1896 <li><b>A private email/groupware system for your organization</b> -
1897 in this case, disable self-service account creation; you don't want
1898 strangers welcoming themselves to your system. You'll probably also
1900 to disable registration, because you or some other site administrator
1901 will be entering users' contact info when you create their accounts.
1902 Since this is also how you assign their Internet e-mail addresses, it's
1903 probably a good idea to do it yourself instead of expecting them to do
1906 <p>'Access level required to create rooms' is up to you. You might wish
1908 restrict the creation of new rooms only to Aides, or you might wish to
1910 anyone to create a room. The latter is one of the Citadel culture's
1912 long-standing traditions; the former may be appropriate if users are
1915 <p>You have the ability to 'Automatically give room aide privs to a
1916 user who creates a private room.' If you answer Yes, then any user who
1918 guess-name, passworded, or invitation-only room will automatically
1919 become the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1920 command set while in that room. If you would rather grant this
1921 permission manually, answer No.</p>
1922 <p>Another tradition in the Citadel culture is to refrain from deleting
1923 problem users, but instead to 'twit' them (reduce their access level to
1925 [Problem User]). You can then 'Automatically move problem user messages
1926 to twit room' (answer Yes, then specify 'Name of twit room' and
1928 to create that room). If you employ this logic, any user with level 2
1930 User) access will continue to have access to the same set of rooms, but
1932 messages posted will automatically be routed to the Trashcan (or
1934 you call your twit room).</p>
1935 <p>If you have Internet mail configured, you have the option of
1936 restricting its use on a user-by-user basis. If you wish to do this,
1937 answer Yes to 'Restrict Internet mail to only those with that
1938 privilege.' Obviously this makes no sense for an internal e-mail
1939 system, but for a public BBS it
1940 might be appropriate.</p>
1941 <p>Normally, Aides have access to every room, public or private.
1942 They are also forbidden from <tt><b>Z</b>ap</tt>ping
1943 rooms, because the review of content is considered one of their roles.
1944 If you wish to change these policies, the next two options allow you
1945 to. You may 'Allow Aides to Zap (forget) rooms', in which case they may
1946 use the <tt><b>Z</b>ap</tt> command just like any other user.
1947 Aides may also <tt><b>.G</b>oto</tt> any private mailbox belonging to
1949 user, using a special room name format.</p>
1950 <p>If your local security and/or privacy policy dictates that you keep
1952 log of all pages (instant messages) that go through the system, then
1954 Yes to 'Log all pages'. If you answer Yes, you will be prompted for the
1955 name of a room to which all pages will be logged. If you answer No,
1957 only the sender and recipient of each individual message will receive a
1959 <p>The next set of options deals with the tuning of your system. It is
1960 usually safe to leave these untouched.</p>
1961 <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>
1962 <p>The 'Server connection idle timeout' is for the connection between
1963 client and server software. It is <b>not</b> an idle timer for the
1964 user interface. 900 seconds (15 minutes) is the default and a sane
1966 <p>'Maximum concurrent sessions' is the highest number of user sessions
1967 you wish to allow on your system at any given time. Citadel can scale
1968 to hundreds of concurrent users, but if you have limited hardware or
1969 (more likely) limited bandwidth, you might wish to set a maximum. You
1970 can also set it to zero for no limit.</p>
1971 <p>'Maximum message length' is just that. This could be a good way to
1972 prevent enormous multimedia files from finding their way into your
1973 message base. This maximum is enforced in all protocols and is also
1974 advertised by the ESMTP service.</p>
1975 <p>The minimum and maximum number of worker threads can be tuned to
1976 your liking. Citadel will attempt to keep one worker thread running per
1977 session, within these constraints. You should be aware that due to the use of
1978 the worker thread model, Citadel can handle a large number of concurrent
1979 sessions with a much smaller thread pool. If you don't know the programming
1980 theory behind multithreaded servers, you should leave these parameters alone.<br>
1982 <p>'Automatically delete committed database logs' is a <span
1983 style="font-style: italic;">crucial</span> setting which affects your
1984 system's disk utilization and backup recoverability. Please refer
1985 to the <a href="#Database_maintenance">database maintenance</a>
1986 section of this document to learn how the presence or absence of
1987 database logs affect your ability to reliably backup your Citadel
1990 <p>The next set of options affect how Citadel behaves on a network.</p>
1991 <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>
1992 <p>"Server IP address" refers to the IP address on <span
1993 style="font-style: italic;">your server</span> to which Citadel's
1994 protocol services should be bound. Normally you will leave this
1995 set to 0.0.0.0, which will cause Citadel to listen on all of your
1996 server's interfaces. However, if you are running multiple
1997 Citadels on a server with multiple IP addresses, this is where you
1998 would specify which one to bind this instance of Citadel to.</p>
1999 <p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP
2000 services. For a system being used primarily for Internet e-mail, these
2001 are essential, so you'll want to specify the standard port numbers: 25,
2002 110, and 143. If Citadel is running alongside some other mail system,
2003 though, then you might want to choose other, unused port numbers, or
2004 enter -1 for any protocol
2005 to disable it entirely.</p>
2006 <p>You'll also notice that you can specify two port numbers for SMTP:
2008 for MTA (Mail Transport Agent) and one for MSA (Mail Submission Agent).
2010 traditional ports to use for these purposes are 25 and 587. If you are
2011 running an external MTA, such as Postfix (which submits mail to Citadel
2013 LMTP) or Sendmail (which submits mail to Citadel using the 'citmail'
2014 delivery agent), that external MTA will be running on port 25, and you
2016 specify "-1" for the Citadel MTA port to disable it. The MSA port
2018 usually 587) would be the port used by end-user mail client programs
2020 Aethera, Thunderbird, Eudora, or Outlook, to submit mail into the
2022 All connections to the MSA port <b>must</b> use Authenticated SMTP.<br>
2024 <p>The protocols ending in "S" (POP3S, IMAPS, and SMTPS) are
2025 SSL-encrypted. Although all of these protocols support the
2026 STARTTLS command, older client software sometimes requires connecting
2027 to "always encrypted" server ports. Usually when you are looking
2028 at a client program that gives you a choice of "SSL or TLS," the SSL
2029 option will connect to one of these dedicated ports, while the TLS
2030 option will connect to the unencrypted port and then issue a STARTTLS
2031 command to begin encryption. (It is worth noting that this is <span
2032 style="font-style: italic;">not</span> the proper use of the acronyms
2033 SSL and TLS, but that's how they're usually used in many client
2036 <p>All of the default port numbers, including the encrypted ones, are
2037 the standard ones.<br>
2039 <p>The question about correcting forged From: lines affects how Citadel
2040 behaves with authenticated SMTP clients. Citadel does not ever allow
2041 third-party SMTP relaying from unauthenticated clients -- any incoming
2043 addressed to a user on the system or somewhere in a Citadel network. To
2044 use Citadel with SMTP client software such as Netscape, Outlook,
2046 whatever, users must log in with a username and password. In order to
2048 message forgeries, Citadel discards the <tt>From:</tt> line in any
2050 entered by an authenticated user, and replaces it with a <tt>From:</tt>
2052 containing the user's genuine name and e-mail address. Technically,
2054 violates RFC822, because headers are never supposed to be altered, but
2056 sense dictates that this is a good idea. Nevertheless, if you want to
2058 this behavior, answer 'No' at the prompt (the default is 'Yes') and the
2060 will never be altered.</p>
2061 <p>"Instant expunge" affects what happens when IMAP users delete
2062 messages. As you may already know, messages are not <i>truly</i> deleted
2063 when an IMAP client sends a delete command; they are only <i>marked for
2064 deletion</i>. The IMAP client must also send an "expunge" command
2065 to actually delete the message. The Citadel server automatically expunges
2066 messages when the client logs out or selects a different folder, but if you
2067 select the Instant Expunge option, an expunge operation will automatically
2068 follow any delete operation (and the client will be notified, preventing any
2069 mailbox state problems). This is a good option to select, for example, if you
2070 have users who leave their IMAP client software open all the time and are
2071 wondering why their deleted messages show up again when they log in from a
2072 different location (such as WebCit).</p>
2073 <p>"Allow spoofing" refers to the security level applied to
2074 non-authenticated SMTP clients. Normally, when another host connects to
2075 Citadel via SMTP to deliver mail, Citadel will reject any attempt to send
2076 mail whose sender (From) address matches one of your host's own domains. This
2077 forces your legitimate users to authenticate properly, and prevents foreign
2078 hosts (such as spammers) from forging mail from your domains. If, however,
2079 this behavior is creating a problem for you, you can select this option to
2080 bypass this particular security check.<br>
2081 <span style="font-family: monospace;"><br>
2082 Connect this Citadel to an LDAP directory [No]: No</span><br>
2084 <p>The LDAP configuration options are discussed elsewhere in this
2087 <p>The final set of options configures system-wide defaults for the
2089 <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>
2090 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>
2091 <p>Any user who does not log in for the period specified in 'Default
2092 user purge time' will be deleted the next time a purge is run. This
2093 setting may be modified on a per-user basis.</p>
2094 <p>'Default room purge time' behaves the same way, and may also be
2095 modified on a per-room basis.</p>
2096 <p>'System default message expire policy' defines the way in which old
2097 messages are expired (purged) off the system. You can specify any of:</p>
2099 <li>Purge by age (specify in days) </li>
2100 <li>Purge by message count in the room (specify number of messages) </li>
2101 <li>Do not purge at all </li>
2103 <p>Again, this setting may be overridden on a per-floor basis, and the
2104 floor setting may be overridden on a per-room basis. You'll also notice
2105 that you can set a <i>different</i> default for mailbox rooms if you
2107 to. This can allow you, for example, to set a policy under which old
2108 messages scroll out of public rooms, but private mail stays online
2110 until deleted by the mailbox owners.<br>
2112 <p>"How often to run network jobs" refers to the sharing of content on
2114 Citadel network. If your system is on a Citadel network, this
2116 item dictates how often the Citadel server will contact other Citadel
2117 servers to send and receive messages. In reality, this will happen more
2118 frequently than you specify, because other Citadel servers will be
2119 contacting yours at regular intervals as well.<br>
2121 <p>"Hour to run purges" determines when expired and/or deleted objects
2122 are purged from the database. These purge operations are
2123 typically run overnight and automatically, sometime during whatever
2124 hour you specify. If your site is much busier at night than
2125 during the day, you may choose to have the auto-purger run during the
2127 <p>"Enable full text search index," if enabled, instructs the server to
2128 build and maintain a searchable index of all messages on the
2129 system. This is a time and resource intensive process -- it could
2130 take days to build the index if you enable it on a large
2131 database. It is also fairly memory intensive; we do not recommend
2132 that you enable the index unless your host system has at least 512 MB
2133 of memory. Once enabled, however, it will be updated
2135 and will not have any noticeable impact on the interactive response
2136 time of your system. The full text index is currently only
2137 searchable when using IMAP clients; other search facilities will be
2138 made available in the near future.</p>
2139 <p>The "Perform journaling..." options allow you to configure
2140 your Citadel server to send an extra copy of every message, along with
2141 recipient information if applicable, to the email address of your choice.
2142 The journaling destination address may be an account on the local Citadel
2143 server, an account on another Citadel server on your network, or an Internet
2144 email address. These options, used in conjunction with an archiving service,
2145 allow you to build an archive of all messages which flow through your Citadel
2146 system. This is typically used for regulatory compliance in industries which
2147 require such things. Please refer to the <a href="journaling.html">journaling
2148 guide</a> for more details on this subject.</p>
2149 <p><span style="font-family: monospace;">Save this configuration? No</span><br>
2151 <p>When you're done, enter 'Yes' to confirm the changes, or 'No' to
2152 discard the changes.</p>
2154 <hr size="2" width="100%">
2155 <h2 align="center"><a name="Configuring_Citadel_for_Internet_e-mail"></a>Configuring
2156 Citadel for Internet e-mail</h2>
2157 <div align="justify">
2158 <h3><a name="Introduction"></a>Introduction</h3>
2159 As you know by now, Citadel is a completely self-contained,
2160 full-featured Internet e-mail system. When you run Citadel you do
2161 not need any other mail software on your host system. This
2162 eliminates the need for tedious mucking about with sendmail, qmail,
2163 postfix, Cyrus, the UW IMAP
2164 server, or any of countless other needlessly complex programs that lead
2165 some people to the false assumption that Unix systems are difficult to
2168 Some of the many features supported by Citadel are:<br>
2170 <li>Built-in SMTP and ESMTP service, for delivering and receiving
2171 e-mail on the Internet</li>
2172 <li>Built-in POP3 service, for remote fetching of messages</li>
2173 <li>Built-in IMAP service, for access to mail using any standard mail
2175 <li>Web mail (implemented using the "WebCit" middleware, which is
2176 installed separately)</li>
2177 <li>Support for mailing lists, in both "individual message" and
2178 "digest" formats</li>
2179 <li>Multiple/virtual domain support</li>
2180 <li>Any user may have multiple Internet e-mail addresses, in multiple
2182 <li>Global address book (Users with addresses in a domain may be
2183 spread out across many servers on a Citadel network)</li>
2184 <li>Easy-to-configure integration with <a
2185 href="http://www.spamassassin.org/">SpamAssassin</a> can block spam <i>before</i>
2186 it enters the mail system</li>
2187 <li>Easy-to-configure integration with most Realtime Blackhole
2188 Lists (RBL) provide further defense against spammers</li>
2190 This section of the documentation will demonstrate how to configure
2193 <h3><a name="Basic_site_configuration"></a>Basic site configuration</h3>
2194 <p>Basic configuration of your Citadel system for Internet e-mail
2196 the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>I</b>nternet</tt>
2198 <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>
2199 <p>This is a "clean" setup. For a simple, standalone e-mail system you
2200 simply have to enter the <tt><b>A</b>dd</tt> command:</p>
2201 <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>
2202 <p><b>localhost:</b> Basically what you're doing here is telling
2204 what any aliases for your machine are. If your machine were <tt>schmeep.splorph.com</tt>
2205 and you also had a DNS entry set up for <tt>blah.com</tt>, you might
2206 want to enter '1' and enter <tt>blah.com</tt> as your alias, so that
2208 sent to that address won't bounce.</p>
2209 <p><i>Important tip:</i> if your system is known by one name and <i>only</i>
2210 one domain, you might not even need to do this at all. You will recall
2211 that you entered your system's fully qualified domain name earlier when
2212 you went through the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
2213 command. The domain name you entered there is automatically considered
2214 by Citadel to be a 'localhost' entry in your Internet mail
2215 configuration. It does not hurt to enter it in both locations, though.</p>
2216 <p><b>gateway domain:</b> this is a simple way of mapping various
2217 Citadel hosts in an Internet domain. For example, if you enter <tt>bar.com</tt>
2218 as a gateway domain, then mail to users at <tt>foo.bar.com</tt> will
2219 be forwarded to the host called <tt>foo</tt> on a Citadel network,
2221 at <tt>kunst.bar.com</tt> will be delivered to the Citadel server
2223 <tt>kunst</tt>, etc. This feature has limited usefulness; if you are
2225 a network of Citadel servers, it is more likely that you will use the
2227 feature, explained below.</p>
2228 <p><b>smart-host:</b> Normally, Citadel sends outbound Internet e-mail
2229 directly to its destination. This may not be appropriate for some
2230 sites; you may require (due to local convention, security policy, or
2231 whatever) that all outbound mail be sent to an SMTP relay or forwarder.
2233 functionality, simply enter the domain name or IP address of your relay
2234 as a 'smart-host' entry.</p>
2235 <p>If your relay server is running on a port other
2236 than the standard SMTP port 25, you can also specify the port number
2237 using "host:port" syntax; i.e. <tt>relay99.myisp.com:2525</tt></p>
2238 <p>Furthermore, if your relay server requires authentication, you can
2239 specify it using username:password@host or username:password@host:port
2240 syntax; i.e. <tt>jsmith:pass123@relay99.myisp.com:25</tt></p>
2241 <p><b>directory:</b> a domain for which you are participating in
2242 directory services across any number of Citadel nodes. For example, if
2243 users who have addresses in the domain <tt>citadel.org</tt> are spread
2244 out across multiple Citadel servers on your network, then enter <tt>citadel.org</tt>
2245 as a 'directory' entry. <i>For this to work, all Citadel servers
2246 participating in directory service <b>must</b> carry and share the <tt>Global
2247 Address Book></tt> room.</i></p>
2248 <p><b>spamassassin:</b> if you are running a <a
2249 href="http://www.spamassassin.org">SpamAssassin</a> service anywhere
2251 <b>local</b> network, enter its name or IP address as a 'spamassassin'
2252 entry. This may be (and, in fact, will usually be) <tt>127.0.0.1</tt>
2254 that the service is running on the same host computer as the Citadel
2256 <p>Please install SpamAssassin as per its own documentation. You will
2257 want to run SpamAssassin in client/server mode, where a <tt>spamd</tt>
2258 daemon is always running on your computer. Citadel does not utilize the
2259 <tt>spamc</tt> client; instead, it implements SpamAssassin's protocol
2261 <p>Connecting to a SpamAssassin service across a wide area network is
2262 strongly discouraged. In order to determine whether an incoming e-mail
2263 is spam, Citadel must feed the <i>entire message</i> to the
2264 SpamAssassin service. Doing this over a wide area network would consume
2266 which would affect performance.</p>
2267 <p>Citadel invokes the SpamAssassin service when incoming messages are
2268 arriving via SMTP. Before a message is accepted, it is submitted to
2269 SpamAssassin. If SpamAssassin determines that the message is spam, the
2271 service <i>rejects the message,</i> causing a delivery failure on the
2273 host. This is superior to software which files away spam in a separate
2274 folder, because delivery failures will cause some spammers to assume
2276 address is invalid and remove it from their mailing lists.</p>
2277 <p><b>RBL:</b> Realtime Blackhole Lists (RBL's) provide defense against
2278 spammers based on their source IP address. There are many such lists
2279 available on the Internet, some of which may be utilized free of
2280 charge. Since they are DNS based, the lists do not require storage on
2281 your server -- they are queried during the SMTP conversation.</p>
2282 <p>Citadel can utilize any RBL that uses the <tt>z.y.x.w.nameoflist.org</tt>
2283 syntax, where <tt>w.x.y.z</tt> is the source IP address which is
2284 attempting to deliver mail to your server. For example, <a
2285 href="http://www.spamcop.net">SpamCop</a> would use the query <tt>2.0.0.127.bl.spamcop.net</tt>
2286 to determine whether the host at <tt>127.0.0.2</tt> is a known spammer
2287 or open relay. In this case, you simply select option '6' to add an RBL
2288 entry, and provide it with the domain suffix of <tt>bl.spamcop.net</tt>
2290 and extra dot will be automatically prepended for each query).</p>
2291 <p>Now select <tt><b>S</b>ave</tt> and you are just about ready for
2292 Internet e-mail.</p>
2293 <h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the
2294 Internet mail protocols</h3>
2295 <p>As previously mentioned, Citadel contains its own SMTP, POP3, and
2296 IMAP services. Enabling them is simple.</p>
2297 <p>Check for the existance of a current MTA (sendmail, qmail, etc.) by
2298 connecting to port 25 on your host. If you see something similar to the
2300 you're running an MTA already and you'll need to shut it down:</p>
2301 <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>
2302 <p>In the above example, we see that the host already has Sendmail
2303 listening on port 25. Before Citadel can use port 25, Sendmail must be
2304 shut off. Please consult the documentation for your operating system
2305 for instructions on how to do this. (On a Red Hat Linux system, for
2306 example, you can run the <tt>ntsysv</tt> utility, un-checking <tt>sendmail</tt>
2308 the next reboot; then, run <tt>service sendmail stop</tt> to shut off
2310 currently running service.)</p>
2311 <p>If you get a 'connection refused' message when you telnet to port 25
2312 there's nothing running and you should be able to continue. You might
2313 also want to turn off POP (try the above test substituting 110 for 25)
2314 and IMAP (port 143) and use Citadel's POP and IMAP services.</p>
2315 <p>Citadel will look for an existing pop/smtp server on startup. If
2317 don't exist (and you've configured them properly) then Citadel should
2319 them at startup. You can check your logs to be sure, or you can start
2321 server from a shell and watch it load. It might look something like
2323 <font size="-2"> </font>
2324 <pre><font size="-2">smw @ pixel % ./citserver<br><br>Multithreaded message server for Citadel<br>Copyright (C) 1987-2006 by the Citadel development team.<br>Citadel is open source, covered by the GNU General Public License, and<br>you are welcome to change it and/or distribute copies of it under certain<br>conditions. There is absolutely no warranty for this software. Please<br>read the 'COPYING.txt' file for details.<br><br>Loading citadel.config<br>Opening databases<br>This is GDBM version 1.8.0, as of May 19, 1999.<br>Checking floor reference counts<br>Creating base rooms (if necessary)<br>Registered a new service (TCP port 504)<br>Registered a new service (TCP port 0)<br>Initializing loadable modules<br>Registered server command CHAT (Begin real-time chat)<br>Registered server command PEXP (Poll for instant messages)<br>Registered server command GEXP (Get instant messages)<br>Registered server command SEXP (Send an instant message)<br>Registered server command DEXP (Disable instant messages)<br>Registered a new session function (type 0)<br>Registered a new x-msg function (priority 0)<br>Loaded module: $Id$<br>Registered a new session function (type 1)<br>Registered a new message function (type 201)<br>Registered a new message function (type 202)<br>Registered server command REGI (Enter registration info)<br>Registered server command GREG (Get registration info)<br>Registered a new user function (type 100)<br>Loaded module: $Id$<br>Server-hosted upgrade level is 5.62<br>Loaded module: $Id$<br>Registered server command EXPI (Expire old system objects)<br>Registered server command FSCK (Check message ref counts)<br>Loaded module: $Id$<br><b>citserver: Can't bind: Address already in use<br>ERROR: could not bind to TCP port 25.</b><br>Registered a new service (TCP port 0)<br>Registered a new session function (type 50)<br>Loaded module: $Id$<br><b>citserver: Can't bind: Address already in use<br>ERROR: could not bind to TCP port 110.</b><br>Registered a new session function (type 0)<br>Loaded module: $Id$<br>Registered a new message function (type 202)Loaded module: $Id$<br>Registered server command RWHO (Display who is online)<br>Registered server command HCHG (Masquerade hostname)<br>Registered server command RCHG (Masquerade roomname)<br>Registered server command UCHG (Masquerade username)<br>Registered server command STEL (Enter/exit stealth mode)<br>Loaded module: $Id$<br>Changing uid to 513<br>Starting housekeeper thread<br></font></pre>
2325 <p>The lines emphasized in boldface in the above log output tell you
2326 that Citadel "can't bind" to various ports. The error 'address already
2327 in use' generally means that something else is already running on the
2328 requested port. Make SURE you've followed the above steps to remove
2329 sendmail/pop and start your Citadel server again.</p>
2330 <h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
2331 <p>Occationally it is not practical to remove a non-Citadel MTA on your
2332 host system. For example, you might have multiple groups of users, some
2334 which are using Citadel and some of which are using a legacy Unix mail
2335 spool. This type of configuration is discouraged, but two tools are
2338 <p>The tool is called <tt>citmail</tt> and it is, quite simply, a
2339 local MDA (Mail Delivery Agent) which you can configure into your MTA
2340 for final delivery of incoming messages to Citadel users. A full
2341 discussion of the finer points of complex Sendmail configurations is
2342 beyond the scope of this document; however, you might want to visit <a
2343 href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some
2344 useful HOWTO documents are provided.<br>
2346 <p>The other tool is an <a href="http://www.faqs.org/rfcs/rfc2033.html">RFC2033</a>
2347 compliant LMTP service running on a local socket. If you're
2348 running a mailer that speaks LMTP (such as <a
2349 href="http://www.postfix.org/">Postfix</a>), you can simply point your
2350 mailer at the socket called <span style="font-family: monospace;">citadel.socket</span>
2351 in your Citadel directory. For example, in Postfix you might put
2352 the following line into <span style="font-family: monospace;">main.cf</span>
2353 in order to tell it to use Citadel to deliver mail to local recipients:<br>
2355 <pre>local_transport = lmtp:unix:/usr/local/citadel/lmtp.socket<br></pre>
2356 <p>Postfix also has something called a "fallback transport" which can
2357 be used to implement Citadel as a "secondary" mail system on your
2358 server, while keeping the existing Unix mailboxes intact.
2359 However, it is beyond the scope of this document to detail the finer
2360 points of the configuration of Postfix or any other mailer, so refer to
2361 the documentation to those programs and keep in mind that Citadel has
2362 LMTP support.<span style="font-family: monospace;"></span></p>
2363 <p>There are actually <i>two</i> LMTP sockets. One is called
2364 <tt>lmtp.socket</tt> and the other is called <tt>lmtp-unfiltered.socket</tt>
2365 (both are found in your Citadel directory). The difference should be
2366 obvious: messages submitted via <tt>lmtp.socket</tt> are subject to
2368 spam filtering you may have configured (such as SpamAssassin), while
2370 submitted via <tt>lmtp-unfiltered.socket</tt> will bypass the filters.
2372 would use the filtered socket when receiving mail from an external MTA
2374 as Postfix, but you might want to use the unfiltered socket with
2376 such as fetchmail.</p>
2378 <p>For outbound mail, you
2379 can either allow Citadel to perform
2381 (this won't affect your other mail system because outbound mail doesn't
2383 up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which will
2385 Citadel to forward all of its outbound mail to your other mail system.</p>
2386 <h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet
2388 <p>Citadel has built in mailing list service (known in Internet
2389 vernacular as "listserv") functionality. You can turn any room
2390 into a mailing list. Users can then choose how they participate
2391 -- by logging on to your Citadel server directly, or by having the
2392 room's contents mailed to
2393 them somewhere else. Configuring this is easy.</p>
2394 <p>Citadel supports two modes of mailing list delivery: </p>
2396 <li>"List mode" -- each individual message is delivered as a single
2397 e-mail to each list mode recipient. The "From:" header will
2398 display the address of the message's original author.</li>
2399 <li>"Digest mode" -- groups of one or more messages are delivered
2400 to digest mode recipients. The number of messages in the group
2401 depends on how many new messages arrived since the last batch was
2402 delivered. The "From:" header will display the address of the
2403 room itself, which allows replies to be posted back to the room.</li>
2405 A room may have any combination of list mode and digest mode
2407 <p>As alluded to above, every room on your Citadel system has an
2408 Internet e-mail address of its own. Messages sent to that address
2410 posted in the room (and sent back out to mailing list recipients, as
2412 as to any other Citadels you share the room with). The address
2414 is <tt>room_</tt> plus the name of the room, with any spaces replaced
2416 underscores, followed by <tt>@</tt> and your hostname. For example, if
2418 system is known as <tt>phlargmalb.orc.org</tt> on the Internet, and
2420 a room called <tt>Bubblegum Collectors</tt>, you can post to that room
2422 anywhere on the Internet simply by sending an e-mail to <tt>room_bubblegum_collectors@phlargmalb.orc.org</tt>.
2423 When the message arrives, it's automatically posted in that room.</p>
2424 <p>To manually edit the list of "list mode" recipients, simply enter
2425 the <tt><b>.A</b>ide
2426 mailing <b>L</b>ist management</tt> command. Your text editor will
2428 up and you will be able to create or edit a list of recipients, one per
2429 line. Lines beginning with a hash (<tt>#</tt>) are comments.</p>
2430 <p>To manually edit the list of "digest mode" recipients, enter the <tt><b>.A</b>ide
2431 mailing list <b>D</b>igest recipients</tt> command. As with the
2432 previous command, the text editor will open up and you can edit the
2433 list of digest mode recipients, one per line.</p>
2434 <p>Citadel also has a facility which allows users to subscribe or
2435 unsubscribe to mailing lists using a web browser. In order to do this,
2436 WebCit must also be running on your server in addition to Citadel.
2437 WebCit is obtained and installed separately from the rest of the
2439 <p>In order to prevent "just anyone" from subscribing to any room on
2440 your system, there is a setting in the <tt><b>.A</b>ide <b>E</b>dit
2441 room</tt> command:</p>
2442 <pre>CitaNews} . Aide Edit this room<br>
2443 Room name [CitaNews]:<br>
2445 <i>(lots of other stuff omitted for brevity...)</i><br>
2447 Self-service list subscribe/unsubscribe [No]: Yes<br></pre>
2448 <p>When you answer "Yes" to self-service list subscribe/unsubscribe,
2450 enabling that feature. Now, all you have to do is tell the world about
2452 web page they need to visit. It looks like this:</p>
2453 <center><tt>http://foobar.baz.org:2000/listsub</tt></center>
2454 <p>In this example, the server is called <tt>foobar.baz.org</tt> and
2455 WebCit is running on port 2000. Edit appropriately.</p>
2456 <p>Citadel offers a subscribe/unsubscribe facility that is more
2457 intuitive than other listservs. With most systems, sending commands to
2458 the listserv requires that you e-mail it commands in a special format.
2459 It's easy to get it wrong. Citadel simply uses your web browser. You
2460 select the list you want to subscribe or unsubscribe (hint: it's the
2461 list of rooms you've enabled self-service for), select whether you want
2462 list mode or digest mode, and enter your e-mail address. For security
2463 purposes, a confirmation message is sent to the address you enter. But
2464 you don't have to reply to the message in a weird format, either: the
2465 confirmation contains another URL which
2466 you simply click on (or paste into your browser if you can't click on
2468 in your e-mail software) and the confirmation is automatically
2470 <hr size="2" width="100%">
2472 <h2><a name="Building_or_joining_a_Citadel_network"></a>Building or
2473 joining a Citadel network</h2>
2475 <h3><a name="Overview__"></a>Overview</h3>
2476 <p>If you are running Citadel as a BBS or other forum type of
2477 application, one way to 'keep the conversation going' is to share rooms
2478 with other Citadel systems. In a shared room, a message posted to the
2479 room is automatically
2480 propagated to every system on the network. It's kind of like a UseNet
2481 newsgroup, but without the spam.</p>
2482 <p>If you are using Citadel as the e-mail and groupware platform for a
2483 large organization, you can use its networking features to build a
2484 large network of Citadel servers which share content (think of rooms as
2485 public folders), redistribute e-mail throughout the organization, and
2486 integrate the global address book. It might make sense, for
2487 example, in a large corporation to give each department or location its
2488 own Citadel server. Thanks
2489 to Citadel's global address book features, you could still have all of
2490 the users share a single e-mail domain.</p>
2491 <p>Obviously, the first thing you have to do is find another Citadel to
2492 share rooms with, and make arrangements with them. The following
2493 Citadels are a good place to start:</p>
2495 <li>UNCENSORED! - <a href="http://uncensored.citadel.org">uncensored.citadel.org</a>
2497 <li>The Dog Pound II - <a href="http://dogpound2.citadel.org">dogpound2.citadel.org</a>
2500 <p>You don't have to be a part of the citadel.org domain to participate
2501 in the public Citadel network, but the DNS service is provided free of
2502 charge by the Citadel community if you wish to do this.</p>
2503 <h3><a name="Conventions_and_etiquette_when"></a>Conventions and
2504 etiquette when connecting to the public Citadel network</h3>
2505 <p>Before we get into the technical nitty gritty, there are two points
2506 of etiquette to keep in mind. The first thing to keep in mind is that
2507 the operator of any particular Citadel may not be willing to share some
2508 of his/her rooms. Some sites are proud to offer exclusive content in
2509 certain areas. Chances are, if a room is already being shared on the
2510 network, it's available for anyone to share; if not, it can't hurt to
2511 ask -- but take care not to demand it of them. Ask if you may share the
2512 room instead of telling them that you wish to share the room. When
2513 looking at a <tt><b>K</b></tt>nown rooms list, network rooms are the
2514 ones ending in parentheses instead of angle brackets. For example, <tt>Gateway)</tt>
2515 would be a network room, <tt>Lobby></tt> would not.</p>
2516 <p>The other point of etiquette to remember is that you should be
2518 the arrangements in advance, and then set it up. It is extremely rude
2520 simply begin networking with another Citadel, or unilaterally start
2522 a new room, without first obtaining permission from its operator.
2524 ask first. Most Citadel operators are more than happy to network with
2525 you. Also, if later on you decide to take your system down, please take
2527 to notify the operators of any other Citadels you network with, so they
2529 unconfigure their end.</p>
2530 <h3><a name="Getting_ready_to_join_the_network"></a>Getting ready to
2531 join the network</h3>
2532 <p>Ok, first things first. On a Citadel room sharing network, the first
2533 thing you need to know is your own system's node name. Presumably you
2535 this up during installation, but if you want to change it you can do so
2537 the <tt><b>.A</b>ide <b>S</b>ysconfig <b>G</b>eneral</tt> command:</p>
2538 <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>
2539 <p>The "node name" is important, it's how the network identifies
2540 messages coming from your system. The "human readable node name" is
2541 simply a label; it shows up in messages coming from your system. "Fully
2542 qualified domain name" is your DNS name; it's used for routing messages
2543 on the Internet. In the above example, the node name is "uncnsrd".</p>
2544 <h3><a name="Defining_neighbor_nodes"></a>Defining neighbor nodes</h3>
2545 <p>The next thing you need to do is configure your neighbor node(s).
2546 You need to do this for each node you network with. Let's say you
2548 to talk to a Citadel system called "frobozz". Use the <tt><b>.A</b>ide
2549 <b>S</b>ysconfig <b>N</b>etwork</tt> command:</p>
2550 <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>
2551 <p>As you can see in the above example, you have to enter the Citadel
2552 node name, the DNS name or IP address of the server, and the port
2553 number the Citadel service is running on. The "shared secret" is a
2554 password to allow the two Citadel nodes to connect to each other to
2555 exchange network data. The password must be <i>identical</i> on both
2556 ends of the connection -- when the operator of the other Citadel node
2557 sets up the connection with
2558 your system, he/she must use the same password.</p>
2559 <h3><a name="Sharing_rooms"></a>Sharing rooms</h3>
2560 <p>Now you're ready to share rooms. You have to do this for each room
2561 you want to share, and you have to do it from BOTH ENDS -- again, when
2563 share a room with another Citadel, they must share it with you as well.
2564 Let's say you have a room called "Quiche Recipes>" and you want to
2566 it with the node you set up above. First, edit the room and flag it as
2569 <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>
2570 <p>Notice how the prompt changed? It was > before, but it's ) now.
2571 That means it's a network room. Now you can tell Citadel that you want
2573 share the room with frobozz. Enter this command:</p>
2574 <pre>Quiche Recipes) . Aide Network room sharing<br></pre>
2575 <p>Your text editor will pop up (you <i>did</i> configure Citadel to
2577 your favorite text editor, right?) with a screen that looks like this:</p>
2578 <pre># Configuration for room: Quiche Recipes<br># Nodes with which we share this room<br># Specify one per line.<br></pre>
2579 <p>All you have to do is enter the name of the other Citadel node (i.e.
2580 "frobozz" in our example) on a line by itself. As usual, lines starting
2581 with a "#" are comments. Just go to the end of the file, type "frobozz"
2582 (without the quotes), save the file... and you're done!</p>
2583 <p>At this point, you just sit back and enjoy. Your Citadel and the
2584 other one will begin polling each other at regular intervals (once per
2585 hour by default) and sharing messages.</p>
2586 <h3><a name="Sending_mail"></a>Sending mail</h3>
2587 <p>You can send mail to any user on any node of your Citadel network.
2588 It may take a little while for your system to learn the entire node
2589 list, though, as this is done by watching incoming messages on the
2590 network and learning which nodes are out there.</p>
2591 <p>To send a private message, just enter <tt>user @ host</tt> as the
2593 <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>
2594 <h3><a name="Changing_the_polling_interval"></a>Changing the polling
2596 <p>As previously mentioned, Citadel will poll other Citadel nodes for
2597 messages once per hour. If this is not an acceptable interval, you can
2598 change it using the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
2599 command. Enter this command and look for the option:</p>
2600 <pre>How often to run network jobs (in seconds) [3600]:<br></pre>
2601 <p>Change it to whatever you like. For example, 15 minutes is 900
2602 seconds. So if you changed the default value to 900, network polling
2603 would occur every 15 minutes.</p>
2605 <h2 align="center"><a name="Database_maintenance"></a>Database
2607 <h3><a name="Introduction_"></a>Introduction</h3>
2608 The data store used by Citadel is reliable and self-maintaining.
2609 It requires very little maintenance. This is primarily due
2610 to its use of the <a href="http://www.sleepycat.com">Berkeley DB</a>
2611 record manager. It is robust, high-performance, and transactional.<br>
2613 A few small data files are kept in your main Citadel directory, but the
2614 databases are in the <tt>data/</tt> subdirectory. The files with
2615 names that begin with "cdb" are the databases themselves; the files
2616 with names that begin with "log" are the logs (sometimes referred to as
2617 "journals"). Log files will continue to appear as you use your
2618 system; each will grow to approximately 10 megabytes in size before a
2619 new one is started. There is a system configuration setting
2620 (found in <span style="font-family: monospace;"><span
2621 style="font-weight: bold;">.A</span>ide <span
2622 style="font-weight: bold;">S</span>ystem-configuration <span
2623 style="font-weight: bold;">G</span>eneral</span> in the text mode
2624 client, or in <span style="font-family: monospace;">Administration
2625 --> Edit site-wide configuration --> Tuning</span> in the WebCit
2626 client) which specifies "Automatically delete committed database
2627 logs." If you have this option enabled, Citadel will
2628 automatically delete any log files whose contents have been fully
2629 committed to the database files.<br>
2631 For more insight into how the database and log files work, you may wish
2633 href="http://www.sleepycat.com/docs/ref/transapp/archival.html">Berkeley
2634 DB documentation</a> on this subject.<br>
2636 <h3><a name="Backing_up_your_Citadel_database"></a>Backing up your
2637 Citadel database</h3>
2638 <span style="font-weight: bold;">Please read this section carefully.</span><br>
2640 There are two backup strategies you can use, depending on your site's
2641 availability requirements and disk space availability.<br>
2642 <h5>Strategy #1: Standard backup</h5>
2643 The standard (or "offline") backup is used when your Citadel server is
2644 configured to automatically delete committed database logs. The
2645 backup procedure is as follows:<br>
2647 <li>Shut down the Citadel server.</li>
2648 <li>Back up all files (database files, log files, etc.) to tape or
2649 some other backup media.</li>
2650 <li>Start the Citadel server.</li>
2652 <span style="font-style: italic;">Advantage:</span> very little disk
2653 space is consumed by the logs.<br>
2654 <span style="font-style: italic;">Disadvantage:</span> Citadel is not
2655 available during backups.<br>
2657 <h5>Strategy #2: "Hot" backup</h5>
2658 The "hot backup" procedure is used when your Citadel server is
2659 configured <span style="font-weight: bold;">not</span> to
2660 automatically delete committed database logs. The backup
2661 procedure is as follows:<br>
2663 <li>Back up all files. Make sure the database files (<span
2664 style="font-family: monospace;">cdb.*</span>) are backed up <span
2665 style="font-style: italic;">before</span> the log files (<span
2666 style="font-family: monospace;">log.*</span>). This will usually
2667 be the case, because the database files tend to appear first in both
2668 alphabetical and on-disk ordering of the <span
2669 style="font-family: monospace;">data/</span> directory.</li>
2670 <li>After verifying that your backup completed successfully, delete
2671 the committed log files with a command like this:</li>
2673 <span style="font-family: monospace;">/usr/local/citadel/sendcommand
2676 <span style="font-style: italic;">Advantage:</span> Citadel continues
2677 to run normally during backups.<span style="font-style: italic;"><br>
2678 Disadvantage:</span> Much disk space is consumed by the log files,
2679 particularly if the full text indexer is turned on.<br>
2682 It is up to you to decide which backup strategy to use. <span
2683 style="font-weight: bold;">Warning: if you configure Citadel to
2684 automatically delete committed database logs, and do not shut the
2685 Citadel service down during backups, there is no guarantee that your
2686 backups will be usable!</span><br>
2688 <h3><a name="Database_repair"></a>Database repair</h3>
2689 Although Citadel's data store is quite reliable, database corruption
2690 can occur in rare instances. External factors such as an
2692 system crash or an unexpected loss of power might leave the database in
2693 an unknown state. A utility is provided which may be able to
2695 your database if this occurs. If you find that your Citadel
2697 is not running, and reading the logs shows that it is crashing because
2699 an inability to validate a database, follow these steps:<br>
2701 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2702 "respawn" to "off." Type <tt>init q</tt> to make this setting
2704 <li><b>Make a backup of your data.</b> Either write it out to
2705 tape or copy it to another directory, or a tarball.<br>
2707 <li><tt>cd</tt> to your Citadel directory and type <tt>./database_cleanup.sh</tt></li>
2708 <li>Let the cleanup script run. <b>Do not interrupt this
2709 process for any reason.</b><br>
2711 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2712 "off" to "respawn". Type <tt>init q</tt> to activate your
2715 If this procedure does not work, you must restore from your most recent
2718 <h3><a name="ImportingExporting_your_Citadel"></a>Importing/Exporting
2719 your Citadel database<br>
2721 <p>Citadel contains an importer/exporter module, affectionately
2722 known as the "Art Vandelay" module (a not-so-obscure Seinfeld
2724 allows you to export the entire contents of your Citadel databases to a
2725 flat file, which may then be imported on another system. (This
2727 is also known as "dump and load" to database gurus.)</p>
2728 <p>Why would you want to do this? Here are some scenarios: </p>
2730 <li>You are moving a Citadel installation to another computer, which
2731 uses a different CPU. Since Citadel stores data in an
2732 architecture-dependent format, the data files wouldn't work on the new
2733 computer as-is. </li>
2734 <li>Your computer crashed, lost power, etc. and you suspect that your
2735 databases have become corrupted. </li>
2736 <li>You want to switch to a different back-end data store. (For
2737 example, from GDBM to Berkeley DB) </li>
2739 <p>So ... how do we work this magic? Follow these steps <i>exactly</i>
2740 as documented and you should be able to do it all with very little
2743 <li>This should be obvious, but it's still worth mentioning: <b>Make
2744 sure you have a backup of everything before you start this! </b>
2745 You're performing a major operation here. Don't risk it. </li>
2746 <li>First, get all the users logged off from your system. Disconnect
2747 it from the network if possible. You don't want anyone logging in while
2748 you're doing this. </li>
2749 <li>Log on as root, or some other user that has read/write access to
2750 all relevant files. </li>
2751 <li>Go to the directory that Citadel is installed in. For example,
2752 issue a command like <tt>cd /usr/local/citadel</tt> </li>
2753 <li>Export the databases with the following command:<br>
2755 <tt>./sendcommand "ARTV export" >exported.dat</tt><br>
2757 This command may run for a while. On a very large system it could take
2758 an hour or more. Please be patient! </li>
2759 <li>When the export completes, check to make sure that <tt>exported.dat</tt>
2760 exists and has some data in it. (Type "ls -l exported.dat") </li>
2761 <li>Shut down the Citadel server. If you have a line in <tt>/etc/inittab</tt>
2762 that reads like this:<br>
2764 <tt>c1:2345:respawn:/usr/local/citadel/citserver
2765 -h/usr/local/citadel</tt> <br>
2766 ...then you should change the <tt>respawn</tt> to <tt>off</tt> and
2767 then type <tt>/sbin/init q</tt> to make the changes take effect. </li>
2768 <li>Now it's time to delete your current binary databases. Type:<br>
2770 <tt>rm -f citadel.config citadel.control data/*</tt> </li>
2771 <li>If you're moving Citadel to another computer, you should move the
2772 <i>entire</i> directory over at this time. <tt>exported.dat</tt>
2773 only contains the information that was in the binary databases.
2774 Information which was stored in portable formats doesn't need to be
2775 exported/imported, so
2776 you must bring it all over in its current form. </li>
2777 <li>Now get Citadel running on the new computer (or whatever). Run <tt>setup</tt>
2778 and turn the service back on (from <tt>/etc/inittab</tt>) but DO NOT
2780 <li>As root, run the import command:<br>
2782 <tt>./sendcommand "ARTV import" <exported.dat</tt><br>
2784 This will import your databases. Again, it may run for a long time. </li>
2785 <li>Restart the Citadel server. You can do this any way you like.
2786 From the command line, you can do it with a command like:<br>
2788 <tt>./sendcommand "DOWN"</tt> <br>
2790 <li>Now you're finished. Log in and test everything. You may delete
2791 exported.dat at this time, or you might want to save it somewhere as a
2792 sort of pseudo-backup. </li>
2796 <h2><a name="crypto"></a>Cryptography support (TLS/SSL)</h2>
2798 <h3><a name="crypto_intro"></a>Overview</h3>
2799 <p>Citadel provides built-in support for encryption using Transport
2800 Layer Security (TLS) for ESMTP, IMAP, POP3, and the Citadel client
2802 A simple cryptographic configuration is installed automatically when
2804 bring the system online. The remainder of this section describes how
2806 configuration is built, and what you can do to make changes to it.</p>
2807 <p>Encryption files are kept in the <tt>keys/</tt> directory. The
2809 files used by Citadel are:</p>
2811 <li><tt>citadel.key</tt> - Contains your system's RSA private key.
2813 generates a new key automatically if one is not found. </li>
2814 <li><tt>citadel.csr</tt> - Contains a Certificate Signing Request
2816 for your system. Citadel generates a new CSR automatically, using your
2817 private key, if one is not found. </li>
2818 <li><tt>citadel.cer</tt> - Contains the public certificate for your
2819 system. The public key in the certificate <b>must</b> correspond with
2821 private key in <tt>citadel.key</tt>, otherwise encryption will not
2822 function properly. Citadel will generate a self-signed certificate,
2824 using your private key, if a certificate is not found. </li>
2826 <h3><a name="real_cert"></a>Generating and installing a Trusted
2828 <p>If you wish to interact with 3rd party clients
2829 that have hard coded lists of acceptable Certificate Authorities, and
2831 do not want annoying dialog boxes popping up for the user on the first
2833 all) connections, then you will have to have your key signed by a valid
2834 Certificate Authority.</p>
2835 <p>It is beyond the scope of this document to provide a complete
2837 on SSL certificates. Here are the general rules to follow:</p>
2839 <li>Generally, the Certificate Signing Requeste which is
2841 generated by Citadel will not contain enough information for any
2843 Authority to sign it. Generate a new CSR with the following commands:<br>
2845 <tt>cd keys</tt><br>
2846 <tt>openssl req -new -key citadel.key -out citadel.csr</tt><br>
2848 Answer all questions (your geographic location, organization name,
2850 and then send the new <tt>citadel.csr</tt> to your Certificate
2852 when you order the certificate. </li>
2853 <li>When the certificate is received, simply save it as <tt>citadel.cer</tt>
2854 and restart the Citadel server. </li>
2855 <li>If your certificate authority delivers a 'chained' certificate
2857 with intermediate certificate authorities), simply append the
2859 certificate after your server's own certificate in the <tt>citadel.cer</tt>
2863 <hr style="width: 100%; height: 2px;">
2864 <div style="text-align: center;">
2865 <h2><a name="LDAP_Directory_Support"></a>LDAP (Directory) Support</h2>
2866 <div style="text-align: justify;">
2867 <h3><a name="Introduction_ldap"></a>Introduction</h3>
2868 LDAP (Lightweight Directory Access Protocol) has become the open
2869 standard protocol for directory access. There are many client
2870 programs which are capable of making use of an LDAP directory
2871 service. Therefore it may be beneficial for some sites to have a
2872 directory available which is populated with Citadel user information.<br>
2874 Citadel does not contain its own LDAP service, because that would
2875 eliminate its ability to coexist with any existing directory you may
2876 already have in place at your organization. Instead, we provide
2877 the LDAP Connector for Citadel, which allows the Citadel service to
2878 populate an external LDAP directory. If you do not already have
2879 an LDAP directory in place, you can use the OpenLDAP server, which is
2880 probably already present in your operating system, or at least can be
2881 loaded from the installation CD's. The supplied configuration
2882 file <tt>citadel-slapd.conf</tt> can be used as a starting
2883 point to get your LDAP server running.<br>
2885 <h3><a name="Preparing_your_LDAP_server_for_Citadel"></a>Preparing your
2886 LDAP server for Citadel connections</h3>
2887 It is difficult to find a commonly accepted LDAP scheme. It seems, most
2888 real life LDAP installations go for the domain oriented apporach
2889 and lay out the structure after an existing domain/subdomain structure.
2890 <p> The most widely accepted and standardized object for storing
2891 personal data clearly is "inetOrgPerson". Citadel therefore extends this
2892 standard schema with an object class called "citadelInetOrgPerson".</p>
2893 <p>If you are using OpenLDAP as your directory server, you should
2894 choose options similar to the following:</p>
2896 include /etc/openldap/schema/core.schema
2897 include /etc/openldap/schema/cosine.schema
2898 include /etc/openldap/schema/inetorgperson.schema
2899 include /etc/openldap/schema/rfc2739.schema
2900 include /etc/openldap/schema/citadel.schema
2905 suffix "dc=example,dc=com"
2906 rootdn "cn=manager,dc=example,dc=com"
2908 directory /var/openldap-data
2912 <p>Notes on this configuration:
2914 <li>Obviously, you can make your suffix and rootdn whatever you wish,
2915 but in most cases you'd simply follow a DC path that looks similar to
2916 your DNS domain.</li>
2917 <li>In earlier versions of OpenLDAP, you could use the
2918 option <span style="font-family: monospace;">schemacheck off</span> to
2919 make life easier by relaxing the strict schema checking. This option
2920 has been removed from OpenLDAP, so now you <strong>must</strong> install
2921 the supplied schema extensions. <tt>rfc2739.schema</tt> and
2922 <tt>citadel.schema</tt> are included with the Citadel distribution.</li>
2923 <li>Your <span style="font-family: monospace;">rootdn</span> and <span
2924 style="font-family: monospace;">rootpw</span> can be whatever you
2925 want. Usually the rootdn is <span style="font-family: monospace;">cn=manager,</span>
2926 followed by your usual suffix. Please don't use <span
2927 style="font-family: monospace;">secret</span> as your password, as in
2928 this example. Select a new password for your site.</li>
2931 Your LDAP service <span style="font-weight: bold;">must</span> be up
2932 and running before you attempt to connect Citadel to it.<br>
2934 <h3><a name="Configuring_the_LDAP_Connector_for"></a>Configuring the
2935 LDAP Connector for Citadel</h3>
2936 Once you've located or installed your LDAP server, connecting Citadel
2937 to it is easily completed with the <span style="font-weight: bold;"><span
2938 style="font-family: monospace;">.A</span></span><span
2939 style="font-family: monospace;">ide <span style="font-weight: bold;">S</span>ystem-configuration
2940 <span style="font-weight: bold;">G</span>eneral command:<br>
2942 <pre>Lobby> . Aide System configuration General<br><br><span
2943 style="font-style: italic;">(lots of other stuff omitted for brevity...)</span><br><br>Connect this Citadel to an LDAP directory [Yes]: <span
2944 style="font-weight: bold;">Yes</span><br>Host name of LDAP server []: <span
2945 style="font-weight: bold;">127.0.0.1</span><br>Port number of LDAP service [389]: <span
2946 style="font-weight: bold;">389</span><br>Base DN []: <span
2947 style="font-weight: bold;">dc=servername,dc=domain,dc=org</span><br>Bind DN []: <span
2948 style="font-weight: bold;">cn=manager,dc=servername,dc=domain,dc=org</span><br>Password for bind DN []: <span
2949 style="font-weight: bold;">secret</span><br style="font-weight: bold;"><br><span
2950 style="font-style: italic;">(more questions omitted...)</span><br><br>Save this configuration? <span
2951 style="font-weight: bold;">Yes</span><br></pre>
2952 Once you've done this, restart your Citadel service with the <span
2953 style="font-weight: bold;"><span style="font-family: monospace;">.A</span></span><span
2954 style="font-family: monospace;">ide <span style="font-weight: bold;">T</span>erminate-server
2955 <span style="font-weight: bold;">N</span>ow</span> command. When
2956 Citadel restarts, it will connect to your LDAP directory. Note
2957 that we gave Citadel the same Base DN, Bind DN, and password that was
2958 in our LDAP server configuration example. Obviously, everything
2959 needs to be identical on both sides or the connection will be
2960 refused. 127.0.0.1 is the loopback address, and 389 is the
2961 standard port number for LDAP, so this would be the proper host and
2962 port combination for an LDAP service running on your local
2963 server. It could just as easily be on another server, for example
2964 an organization-wide directory server.<br>
2966 You can also configure the LDAP Connector for Citadel from a WebCit
2967 session. Log on as an Aide and click on Advanced Options -->
2968 Edit Site-Wide Configuration --> Directory, and you will be
2969 presented with the same set of questions.<br>
2971 So, what kind of information will be entered into LDAP? As a
2972 rule, anything that gets saved to your Global Address Book room will
2973 also be saved to LDAP. Citadel will set up OU's (Organizational
2974 Units) for each node on your Citadel network, so if you are running
2975 multiple Citadel servers in an organization, you will automatically
2976 have a hierarchial view built for you. Below the OU's will be an
2977 entry for each user who has a vCard registered on the system.
2978 Citadel automatically translates vCard information to LDAP.<br>
2980 If you already have a Global Address Book full of existing information,
2981 you can execute an <span style="font-family: monospace;">IGAB</span>
2982 (Initialize Global Address Book) server command to rebuild it. In
2983 addition to performing its usual function of rebuilding the internal
2984 Internet e-mail address mapping table, Citadel will also repopulate
2985 LDAP with all existing vCards. You should be aware, however, that
2986 existing LDAP entries will not be cleared from your directory
2987 server. If your directory contains only Citadel data, you can
2988 safely delete your database and start over, because it will be
2989 repopulated. Otherwise, Citadel will merely update any existing
2990 records with fresh information.<br>
2992 The LDAP Connector for Citadel is a recent development, so expect more
2993 functionality in this space in the near future.<br>
2999 <h2><a name="utilities"></a>Utilities</h2>
3001 <h3><a name="overview"></a>Overview</h3>
3002 <p>The following utilities will be discussed: </p>
3004 <li><b>aidepost</b> - Post standard input to the Aide> room </li>
3005 <li><b>whobbs</b> - Who is on the system </li>
3006 <li><b>msgform</b> - Format a binary message to the screen (stdin or
3008 <li><b>userlist</b> - Print the userlist </li>
3009 <li><b>sendcommand</b> - Send a server command </li>
3011 <p>It is up to you to decide which utilities should be made accessible
3012 only to system administrators. It is important that you set the file
3013 permissions correctly. All utilities should have access to the Citadel
3015 will attempt to address each program individually.</p>
3016 <h3><a name="aidepost"></a>aidepost</h3>
3017 <p>The nature of this program is rather simple. Standard input (stdin)
3018 is converted into a message, filed in the main message store, and
3019 posted in the Aide> room. This is useful for keeping transcripts of
3020 system activity that has to do with Citadel operations. You might even
3021 elect to send all of
3022 your system logs there, too.</p>
3023 <p><tt>aidepost</tt> also accepts the usage <tt>aidepost -rTargetRoom</tt>,
3024 where TargetRoom is the name of a room to which you'd like the message
3026 <h3><a name="whobbs"></a>whobbs</h3>
3027 <p>This program is similar to the <tt>who</tt> command. It lists all
3028 of the users who are currently connected to your Citadel server, either
3030 across a network. Unless you're running a standalone system, <tt>who</tt>
3031 and <tt>whobbs</tt> will probably not have a one-to-one
3032 correspondence. Remember
3033 that you will see sessions for SMTP, POP, and IMAP users, as well as
3035 running a Citadel client.</p>
3036 <p>One thing to keep in mind is that the <tt>whobbs</tt> utility
3037 actually opens a connection to the server. If the server is maxed out, <tt>whobbs</tt>
3038 will still be able to provide a listing, because it doesn't need to log
3039 in to execute the <tt>RWHO</tt> command. Note that whobbs does not
3040 list its own session.</p>
3041 <p>The <tt>whobbs</tt> utility is smart enough to know when it is
3042 being invoked by a web server as a CGI program. In this situation, it
3043 will output its listing
3044 as a nicely formatted web page instead of plain text. This makes it
3046 to just put a link to the whobbs binary in your cgi-bin directory,
3048 a quick and easy way for web surfers to see who is online.</p>
3049 <p>Running the <tt><b>W</b>ho is online</tt> command from the Citadel
3050 client does <b>not</b> call this utility. It has this functionality
3054 <h3><a name="msgform"></a>msgform</h3>
3055 <p>The <tt>msgform</tt> utility reads its standard input (stdin)
3057 Citadel messages stored in the internal format used on disk and over
3059 network, and sends them in a human-readable format to standard output
3060 (stdout). There is no longer much use for this program, but it is
3063 <h3><a name="userlist"></a>userlist</h3>
3064 <p>This is a program to print the userlist. There are two flags that
3066 set when running this program. When called without any arguments, <tt>userlist</tt>
3067 will display all users (except those who have chosen to be unlisted),
3068 their user numbers, times called, messages posted, screen width, and
3069 date of their most recent call.</p>
3070 <p><tt>userlist</tt> is simply the same user listing code that is in
3072 client, made into a standalone utility for convenience.<br>
3074 <h3><a name="sendcommand"></a>sendcommand</h3>
3075 <p><tt>sendcommand</tt> will interpret its arguments (except for <tt>-hDIRNAME</tt>)
3076 as a server command, which is sent to the server. Commands which
3077 require textual input will read it from stdin. Commands which generate
3078 textual output will be sent to stdout.</p>
3079 <p>This utility is intended to be used to enable Citadel server
3081 be executed from shell scripts.</p>
3082 <p><b>NOTE:</b> be sure that this utility is not world-executable. It
3083 connects to the server in privileged mode, and therefore could present
3084 a security hole if not properly restricted.</p>
projects / citadel.git / blob