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