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>a messaging and collaboration platform for BBS and groupware
13 Copyright ©1987-2005 by the Citadel development team:<br>
15 <table cellpadding="2" cellspacing="2" border="0" align="center">
18 <td valign="top">Clint Adams<br>
20 <td valign="top"><i>portability enhancements<br>
24 <td valign="top">Steven M. Bellovin<br>
26 <td valign="top"><i>author of public domain 'parsedate' function<br>
30 <td valign="top">Nathan Bryant<br>
32 <td valign="top"><i>build system, security, database access, and
37 <td valign="top">Art Cancro<br>
39 <td valign="top"><i>overall system design and lead
44 <td valign="top">Brian Costello<br>
46 <td valign="top"><i>cosmetics, additional commands<br>
50 <td valign="top">Nick Georbit<br>
52 <td valign="top"><i>additional client features<br>
56 <td valign="top">David Given<br>
58 <td valign="top"><i>IMAP and build patches<br>
62 <td valign="top">Michael Hampton<br>
64 <td valign="top"><i>client software development<br>
68 <td style="vertical-align: top;">Urs Jannsen<br>
70 <td style="vertical-align: top;"><span style="font-style: italic;">text
71 search algorithm</span><br>
75 <td valign="top">Andru Luvisi<br>
77 <td valign="top"><i>troubleshooting and development assistance<br>
81 <td valign="top">Daniel Malament<br>
83 <td valign="top"><i>string compare function for IMAP server<br>
87 <td valign="top">Stu Mark<br>
89 <td valign="top"><i>additional client features, IGnet protocol
94 <td valign="top">Ben Mehlman<br>
96 <td valign="top"><i>additional client features<br>
100 <td valign="top">Ari Samson<br>
102 <td valign="top"><i>assistance with project management<br>
106 <td valign="top">John Walker<br>
108 <td valign="top"><i>author of public domain base64
113 <td valign="top">Steve Williams<br>
115 <td valign="top"><i>documentation<br>
119 <td valign="top">Ethan Young<br>
121 <td valign="top"><i>IGnet protocol design<br>
128 <div align="justify">The entire package is open source; you can
129 redistribute and/or modify it under the terms of the GNU General Public
130 License as published by the Free Software Foundation; either version 2
131 of the License, or (at your option) any later version.<br>
133 This program is distributed in the hope that it will be useful, but
134 WITHOUT ANY WARRANTY; without even the implied warranty of
135 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
136 General Public License for more details. </div>
137 <div align="justify"><br>
138 For more information, visit either of these locations on
141 <li>The Citadel home page: <a href="http://www.citadel.org">http://www.citadel.org</a></li>
142 <li>UNCENSORED! BBS, the home of Citadel: <a
143 href="http://uncensored.citadel.org">http://uncensored.citadel.org</a></li>
145 <hr width="100%" size="2">
146 <h2 align="center">Table of Contents</h2>
148 <li><a href="#GPL">License</a></li>
149 <li><a href="#Installation">Installation</a></li>
151 <li><a href="#Everything_in_its_place...">Everything in its
153 <li><a href="#ctdl_login_acct">Creating a system account for Citadel</a></li>
154 <li><a href="#bypassing_login">Bypassing the login:
156 <li><a href="#Compiling_the_programs">Compiling the programs</a></li>
157 <li><a href="#Upgrading">Upgrading</a></li>
158 <li><a href="#rc_file">The citadel.rc file</a></li>
159 <li><a href="#Using_an_external_editor_for_message">Using an
160 external editor for message composition</a></li>
161 <li><a href="#Printing_messages">Printing messages</a></li>
162 <li><a href="#URL_viewing">URL viewing</a></li>
163 <li><a href="#Setup_and_login">Setup and login</a></li>
164 <li><a href="#Configuring_your_host_system_to_start">Configuring
165 your host system to start the service</a></li>
166 <li><a href="#first_time_login">Logging in for
167 the first time</a></li>
168 <li><a href="#Welcoming_new_users">Welcoming new users</a></li>
169 <li><a href="#adding_doors">Space for adding
170 your own client features (doors)</a></li>
171 <li><a href="#Troubleshooting_and_getting_help">Troubleshooting and
175 <li><a href="#sysop">System Administration</a></li>
177 <li><a href="#Overview_">Overview</a></li>
178 <li><a href="#Aide_commands">Aide commands</a></li>
179 <li><a href="#Editing_rooms">Editing rooms</a></li>
180 <li><a href="#File_directories">File directories</a></li>
181 <li><a href="#Creating_and_editing_user_accounts">Creating and
182 editing user accounts</a></li>
183 <li><a href="#Deleting_and_moving_messages">Deleting and moving
185 <li><a href="#Customizing_the_help_files">Customizing the help files</a></li>
186 <li><a href="#Site_configuration">Site configuration</a><br>
189 <li> <a href="#Configuring_Citadel_for_Internet_e-mail">Configuring
190 Citadel for Internet e-mail</a></li>
192 <li><a href="#Introduction">Introduction</a></li>
193 <li><a href="#Basic_site_configuration">Basic site configuration</a></li>
194 <li><a href="#Enabling_the_Internet_mail_protocols">Enabling the
195 Internet mail protocols</a></li>
196 <li><a href="#Hosting_an_Internet_mailing_list">Hosting an Internet
199 <li><a href="#citmail">Using Citadel in conjunction with another MTA</a></li>
201 <li><a href="#Building_or_joining_a_Citadel_network">Building or
202 joining a Citadel network</a></li>
204 <li><a href="#Overview__">Overview</a></li>
205 <li><a href="#Conventions_and_etiquette_when">Conventions and
206 etiquette when connecting to the public Citadel network</a></li>
207 <li><a href="#Getting_ready_to_join_the_network">Getting ready
208 to join the network</a></li>
209 <li><a href="#Defining_neighbor_nodes">Defining neighbor nodes</a></li>
210 <li><a href="#Sharing_rooms">Sharing rooms</a></li>
211 <li><a href="#Sending_mail">Sending mail</a></li>
212 <li><a href="#Changing_the_polling_interval">Changing the polling
215 <li><a href="#Database_maintenance">Database maintenance</a></li>
217 <li><a href="#Introduction_">Introduction</a></li>
218 <li><a href="#Database_repair">Database repair</a></li>
219 <li><a href="#ImportingExporting_your_Citadel">Importing/Exporting
220 your Citadel database</a><br>
223 <li><a href="#crypto">Cryptography support (TLS/SSL)</a></li>
225 <li><a href="#crypto_intro">Overview</a></li>
226 <li><a href="#real_cert">Generating and installing a Trusted
229 <li><a href="#LDAP_Directory_Support">LDAP directory support</a></li>
231 <li><a href="#Introduction_ldap">Introduction</a></li>
232 <li><a href="#Preparing_your_LDAP_server_for_Citadel">Preparing
233 your LDAP server for Citadel connections</a><br>
235 <li><a href="#Configuring_the_LDAP_Connector_for">Configuring the
236 LDAP Connector for Citadel</a><br>
239 <li><a href="#utilities">Included utilities</a></li>
241 <li><a href="#overview">Overview</a></li>
242 <li><a href="#aidepost">aidepost</a></li>
243 <li><a href="#whobbs">whobbs</a></li>
244 <li><a href="#msgform">msgform</a></li>
245 <li><a href="#userlist">userlist</a></li>
246 <li><a href="#sendcommand">sendcommand</a></li>
250 <hr width="100%" size="2"><br>
251 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
254 <p> Version 2, June 1991 </p>
255 <pre>Copyright (C) 1989, 1991 Free Software Foundation, Inc. <br>59 Temple Place - Suite 330, Boston, MA 02111-1307, USA<br><br>Everyone is permitted to copy and distribute verbatim copies<br>of this license document, but changing it is not allowed.<br></pre>
256 <h3 align="justify">Preamble</h3>
257 <div align="justify"> </div>
258 <p align="justify"> The licenses for most software are designed to take
259 away your freedom to share and change it. By contrast, the GNU General
260 Public License is intended to guarantee your freedom to share and
261 change free software--to make sure the software is free for all its
262 users. This General Public License applies to most of the Free Software
263 Foundation's software and to any other program whose authors commit to
264 using it. (Some other Free Software Foundation software is covered by
265 the GNU Library General Public License instead.) You can apply it to
266 your programs, too. </p>
267 <div align="justify"> </div>
268 <p align="justify"> When we speak of free software, we are referring to
269 freedom, not price. Our General Public Licenses are designed to make
270 sure that you have the freedom to distribute copies of free software
271 (and charge for this service if you wish), that you receive source code
272 or can get it if you want it, that you can change the software or use
273 pieces of it in new free programs; and that you know you can do these
275 <div align="justify"> </div>
276 <p align="justify"> To protect your rights, we need to make
277 restrictions that forbid anyone to deny you these rights or to ask you
278 to surrender the rights. These restrictions translate to certain
279 responsibilities for you if you distribute copies of the software, or
280 if you modify it. </p>
281 <div align="justify"> </div>
282 <p align="justify"> For example, if you distribute copies of such a
283 program, whether gratis or for a fee, you must give the recipients all
284 the rights that you have. You must make sure that they, too, receive or
285 can get the source code. And you must show them these terms so they
286 know their rights. </p>
287 <div align="justify"> </div>
288 <p align="justify"> We protect your rights with two steps: (1)
289 copyright the software, and (2) offer you this license which gives you
290 legal permission to copy, distribute and/or modify the software. </p>
291 <div align="justify"> </div>
292 <p align="justify"> Also, for each author's protection and ours, we
293 want to make certain that everyone understands that there is no
294 warranty for this free software. If the software is modified by someone
295 else and passed on, we want its recipients to know that what they have
297 the original, so that any problems introduced by others will not
299 on the original authors' reputations. </p>
300 <div align="justify"> </div>
301 <p align="justify"> Finally, any free program is threatened constantly
303 software patents. We wish to avoid the danger that redistributors of a
305 program will individually obtain patent licenses, in effect making the
307 proprietary. To prevent this, we have made it clear that any patent
309 be licensed for everyone's free use or not licensed at all. </p>
310 <div align="justify"> </div>
311 <p align="justify"> The precise terms and conditions for copying,
312 distribution and modification follow. </p>
313 <div align="justify"> </div>
314 <h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
315 <div align="justify"> </div>
316 <p align="justify"> <strong>0.</strong> This License applies to any
317 program or other work which contains a notice placed by the copyright
318 holder saying it may be distributed under the terms of this General
319 Public License. The "Program", below, refers to any such program or
320 work, and a "work based on the Program" means either the Program or any
321 derivative work under copyright law: that is to say, a work containing
322 the Program or a portion of it, either verbatim or with modifications
323 and/or translated into another language. (Hereinafter, translation is
324 included without limitation in the term "modification".) Each licensee
325 is addressed as "you". </p>
326 <p align="justify"> Activities other than copying, distribution and
327 modification are not covered by this License; they are outside its
328 scope. The act of running the Program is not restricted, and the output
329 from the Program is covered only if its contents constitute a work
330 based on the Program (independent of having been made by running the
331 Program). Whether that is true depends on what the Program does. </p>
332 <p align="justify"> <strong>1.</strong> You may copy and distribute
333 verbatim copies of the Program's source code as you receive it, in any
334 medium, provided that you conspicuously and appropriately publish on
335 each copy an appropriate copyright notice and disclaimer of warranty;
336 keep intact all the notices that refer to this License and to the
337 absence of any warranty; and give any other recipients of the Program a
338 copy of this License along with the Program. </p>
339 <p align="justify"> You may charge a fee for the physical act of
340 transferring a copy, and you may at your option offer warranty
341 protection in exchange for a fee. </p>
342 <p align="justify"> <strong>2.</strong> You may modify your copy or
343 copies of the Program or any portion of it, thus forming a work based
344 on the Program, and copy and distribute such modifications or work
345 under the terms of Section 1 above, provided that you also meet all of
346 these conditions: </p>
347 <p align="justify"> </p>
348 <div align="justify">
350 <li><strong>a)</strong> You must cause the modified files to carry
351 prominent notices stating that you changed the files
352 and the date of any change.
355 <li><strong>b)</strong> You must cause any work that you distribute
356 or publish, that in whole or in part contains
357 or is derived from the Program or any part thereof, to be licensed
358 as a whole at no charge to all third parties under the terms of this
362 <li><strong>c)</strong> If the modified program normally reads
363 commands interactively when run, you must cause it, when started
364 running for such interactive use in the most ordinary way, to print or
365 display an announcement including an appropriate copyright notice and a
366 notice that there is no warranty (or else, saying that you provide a
367 warranty) and that users may redistribute the program under these
368 conditions, and telling the user how to view a copy of this License.
369 (Exception: if the Program itself is interactive but does not normally
370 print such an announcement, your work based on the Program is not
371 required to print an announcement.) </li>
373 These requirements apply to the modified work as a whole. If
374 identifiable sections of that work are not derived from the Program,
375 and can be reasonably considered independent and separate works in
376 themselves, then this License, and its terms, do not apply to those
377 sections when you distribute them as separate works. But when you
378 distribute the same sections as part of a whole which is a work based
379 on the Program, the distribution of the whole must be on the terms of
380 this License, whose permissions for other licensees extend to the
382 whole, and thus to each and every part regardless of who wrote it. </div>
383 <p align="justify"> Thus, it is not the intent of this section to claim
385 or contest your rights to work written entirely by you; rather, the
387 is to exercise the right to control the distribution of derivative or
389 works based on the Program. </p>
390 <p align="justify"> In addition, mere aggregation of another work not
391 based on the Program with the Program (or with a work based on the
392 Program) on a volume of a storage or distribution medium does not bring
393 the other work under the scope of this License. </p>
394 <p align="justify"> <strong>3.</strong> You may copy and distribute
395 the Program (or a work based on it, under Section 2) in object code or
396 executable form under the terms of Sections 1 and 2 above provided that
397 you also do one of the following:<!-- we use this doubled UL to get the sub-sections indented, --><!-- while making the bullets as unobvious as possible. -->
399 <div align="justify">
401 <li><strong>a)</strong> Accompany it with the complete corresponding
402 machine-readable source code, which must be distributed under the terms
403 of Sections 1 and 2 above on a medium customarily used for software
407 <li><strong>b)</strong> Accompany it with a written offer, valid for
408 at least three years, to give any third party, for a charge no more
409 than your cost of physically performing source distribution, a complete
410 machine-readable copy of the corresponding source code, to be
411 distributed under the terms of Sections 1 and 2 above on a medium
412 customarily used for software interchange; or,
415 <li><strong>c)</strong> Accompany it with the information you
416 received as to the offer to distribute corresponding source code. (This
417 alternative is allowed only for noncommercial distribution and only if
418 you received the program in object code or executable form with such an
419 offer, in accord with Subsection b above.) </li>
421 The source code for a work means the preferred form of the work for
422 making modifications to it. For an executable work, complete source
423 code means all the source code for all modules it contains, plus any
424 associated interface definition files, plus the scripts used to control
425 compilation and installation of the executable. However, as a special
426 exception, the source code distributed need not include anything that
427 is normally distributed (in either source or binary form) with the
428 major components (compiler, kernel, and so on) of the operating system
429 on which the executable runs, unless that component itself accompanies
430 the executable. </div>
431 <p align="justify"> If distribution of executable or object code is
432 made by offering access to copy from a designated place, then offering
433 equivalent access to copy the source code from the same place counts as
434 distribution of the source code, even though third parties are not
436 copy the source along with the object code. </p>
437 <p align="justify"> <strong>4.</strong> You may not copy, modify,
438 sublicense, or distribute the Program except as expressly provided
439 under this License. Any attempt otherwise to copy, modify, sublicense
440 or distribute the Program is void, and will automatically terminate
441 your rights under this License. However, parties who have received
442 copies, or rights, from
443 you under this License will not have their licenses terminated so long
444 as such parties remain in full compliance. </p>
445 <p align="justify"> <strong>5.</strong> You are not required to accept
446 this License, since you have not signed it. However, nothing else
447 grants you permission to modify or distribute the Program or its
448 derivative works. These actions are prohibited by law if you do not
449 accept this License. Therefore, by modifying or distributing the
450 Program (or any work based on the Program), you indicate your
451 acceptance of this License to do so, and all its terms and conditions
452 for copying, distributing or modifying the Program or works based on
454 <p align="justify"> <strong>6.</strong> Each time you redistribute the
456 (or any work based on the Program), the recipient automatically
458 license from the original licensor to copy, distribute or modify the
459 Program subject to these terms and conditions. You may not impose any
460 further restrictions on the recipients' exercise of the rights granted
461 herein. You are not responsible for enforcing compliance by third
462 parties to this License. </p>
463 <p align="justify"> <strong>7.</strong> If, as a consequence of a
464 court judgment or allegation of patent infringement or for any other
465 reason (not limited to patent issues), conditions are imposed on you
466 (whether by court order, agreement or otherwise) that contradict the
467 conditions of this License, they do not excuse you from the conditions
468 of this License. If you cannot distribute so as to satisfy
469 simultaneously your obligations under this License and any other
470 pertinent obligations, then as a consequence you may not distribute the
471 Program at all. For example, if a patent license would not permit
472 royalty-free redistribution of the Program by all those who receive
473 copies directly or indirectly through you, then the only way you could
474 satisfy both it and this License would be to refrain entirely from
475 distribution of the Program. </p>
476 <p align="justify"> If any portion of this section is held invalid or
477 unenforceable under any particular circumstance, the balance of the
478 section is intended to apply and the section as a whole is intended to
479 apply in other circumstances. </p>
480 <p align="justify"> It is not the purpose of this section to induce you
482 infringe any patents or other property right claims or to contest
483 validity of any such claims; this section has the sole purpose of
484 protecting the integrity of the free software distribution system,
485 which is implemented by public license practices. Many people have made
486 generous contributions to the wide range of software distributed
487 through that system in reliance on consistent application of that
488 system; it is up to the author/donor to decide if he or she is willing
489 to distribute software through any other system and a licensee cannot
490 impose that choice. </p>
491 <p align="justify"> This section is intended to make thoroughly clear
492 what is believed to be a consequence of the rest of this License. </p>
493 <p align="justify"> <strong>8.</strong> If the distribution and/or use
495 the Program is restricted in certain countries either by patents or by
497 interfaces, the original copyright holder who places the Program under
499 License may add an explicit geographical distribution limitation
501 those countries, so that distribution is permitted only in or among
503 not thus excluded. In such case, this License incorporates the
505 as if written in the body of this License. </p>
506 <p align="justify"> <strong>9.</strong> The Free Software Foundation
507 may publish revised and/or new versions of the General Public License
508 from time to time. Such new versions will be similar in spirit to the
509 present version, but may differ in detail to address new problems or
511 <p align="justify"> Each version is given a distinguishing version
512 number. If the Program specifies a version number of this License which
513 applies to it and "any later version", you have the option of following
514 the terms and conditions either of that version or of any later version
515 published by the Free Software Foundation. If the Program does not
516 specify a version number of this License, you may choose any version
518 the Free Software Foundation. </p>
519 <p align="justify"> <strong>10.</strong> If you wish to incorporate
520 parts of the Program into other free programs whose distribution
521 conditions are different, write to the author to ask for permission.
522 For software which is copyrighted by the Free Software Foundation,
523 write to the Free Software Foundation; we sometimes make exceptions for
524 this. Our decision will be guided by the two goals of preserving the
526 derivatives of our free software and of promoting the sharing and reuse
527 of software generally. </p>
528 <p align="justify"><strong>NO WARRANTY</strong></p>
529 <div align="justify"> </div>
530 <p align="justify"> <strong>11.</strong> BECAUSE THE PROGRAM IS
531 LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE
532 EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN
533 WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
534 "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
535 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
536 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK
537 AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
538 THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
539 SERVICING, REPAIR OR CORRECTION. </p>
540 <p align="justify"> <strong>12.</strong> IN NO EVENT UNLESS REQUIRED
541 BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
542 ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS
543 PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
545 INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY
546 TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
547 BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
548 OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN
549 IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
552 <p align="justify"> </p>
553 <h3>END OF TERMS AND CONDITIONS</h3>
555 <hr width="100%" size="2"><br>
557 <h2><a name="Installation"></a>Installation</h2>
559 <div align="justify">
561 <p>Citadel is an advanced, multiuser, client/server messaging system
562 suitable for BBS, e-mail, and groupware applications. It is designed to
563 handle the needs of both small dialup systems and large-scale
564 Internet-connected systems. It was originally developed on an Altos
565 system running Xenix, and has been installed and tested on various Unix
566 and Unix-like platforms. The current development environment (and
567 public BBS) is an ordinary Linux system. The current distribution
570 <li>The Citadel server (this is the back end that does all
572 <li>A text-based client program designed with the traditional Citadel
573 "look and feel" (room prompts, dot commands, and the like) </li>
574 <li>Setup programs </li>
575 <li>A set of utilities for system administration and maintenance </li>
576 <li>Documentation </li>
578 <p>Some knowledge of the Unix system is necessary to install and manage
579 the system. It is mandatory that the sysop have "root" access to the
580 operating system. The following are required to install Citadel: </p>
582 <li>A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX) </li>
583 <li>C compiler (<a href="http://gcc.gnu.org/">GCC</a> with <a
584 href="http://www.gnu.org/software/make/make.html">gmake</a> is the
585 recommended build environment) </li>
586 <li>POSIX threads (already present on most systems) </li>
588 <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1 or newer</li>
589 <li><a href="http://softwarestudio.org/libical/">libical</a> v0.24 or
590 newer (if you want the calendar service to work)<br>
592 <li>Enough disk space to hold all of the programs and data </li>
594 <p>If you are running Citadel on a Linux system, it is STRONGLY
595 recommended that you run it on a recent distribution (such as <a
596 href="http://www.redhat.com">Red Hat</a> 7.3 or newer). A new-ish
597 distribution will have most or all of the prerequisite tools and
598 libraries already integrated for you.</p>
599 <h3>Now available:</h3>
601 <li>"WebCit", a gateway program to allow full access to Citadel via
602 the World Wide Web. Interactive access through any Web browser. </li>
603 <li>Access to Citadel via <i>any</i> standards-compliant e-mail
604 program, thanks to Citadel's built-in SMTP, POP, and IMAP services.
605 You can use Mozilla, Netscape, Evolution, Eudora, Pine, Outlook, etc.
608 <h3>Coming soon:</h3>
610 <li>Newer and better GUI-based clients.</li>
612 <h3><a name="Everything_in_its_place..."></a>Everything in its place...</h3>
613 <p>Hopefully you've unpacked the distribution archive into its own
614 directory. This is the directory in which all Citadel files are located
616 which all activity will take place. Several subdirectories have already
617 been created during the unpacking process, and others may be created
618 by the software if needed. Make sure you have Berkeley DB installed on
619 your system, and that you have all the development libraries and
621 in place so that you can compile against them. If you don't, you can
622 get the latest Berkeley DB at <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
623 If your operating system uses a separate library to support POSIX
624 threads (pthreads), make sure that library is installed as well. This
625 is almost never the case with Linux, but some commercial Unix flavors
629 <h3><a name="ctdl_login_acct"></a>Creating a system account for Citadel</h3>
630 <p>As with many Unix programs, Citadel wants to run under its own user
631 ID. Unlike other programs, however, this user ID will do double-duty as
632 a public login for your system if you are running a BBS. This account
633 is typically called "bbs" or "citadel" or something to that effect. You
634 will tell Citadel what the user-id of that account is, and when someone
635 logs in under that account, Citadel will prompt for a user name.</p>
636 <p>The Citadel user should have a unique uid. The home directory should
637 be the one your Citadel installation resides in (in this example we
638 will use <tt>/usr/local/citadel</tt>) and the shell should be either
640 that directory, or a script that will start up the citadel client.
642 <pre>bbs::100:1:Citadel Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
643 <p>When you run setup later, you will be required to tell it the
644 username or user ID of the account you created is, so it knows what
645 user to run as. If you create an account called <tt>bbs</tt>, <tt>guest</tt>,
646 or <tt>citadel</tt>, the setup program will automatically pick up the
647 user ID by default.</p>
648 <p>For all other users in /etc/passwd (or in some other name service
649 such as NIS), Citadel will automatically set up
650 an account using the full name (or 'gecos' in Unixspeak) of the user.
651 It'll also ignore any password you supply, because it uses the user's
653 on the host system. This allows a 'single sign on' type of environment.
654 Note that this does have to be enabled at compile time -- it's the
656 option called <tt>--enable-autologin</tt>. Keep in mind that these
658 can use *either* their Citadel login name or their login name on the
660 computer, and their password on the host computer.<br>
663 <h3><a name="bypassing_login"></a>Bypassing the <tt>login:</tt>
665 <p>If you normally log in to your host system using some method other
666 than telnet (such as ssh), you might want the telnet service to go
667 straight into Citadel, instead of displaying the <tt>login:</tt>
669 can do this by having telnetd start citadel directly instead of
670 <tt>/bin/login</tt>. The <tt>setup</tt> program will offer to
672 this automatically for you if it sees a configuration it understands.
673 If you would prefer to configure it manually, all you need to do is
675 simple change to your <tt>inetd</tt> or <tt>xinetd</tt>
676 configuration. Here are some configuration examples.</p>
677 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
678 replacing any existing telnet configuration line already there):</p>
679 <pre>telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel<br></pre>
680 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
681 then simply replace that file with this one):</p>
682 <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>
683 <p>Please make sure you know what you're doing before you install this!
685 you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
686 then change the directory name accordingly. If you know of any other
687 local peculiarities which need to be observed, edit the above
689 accordingly as well. And, of course, if you're working remotely, make
690 sure you can successfully log in using SSH <b>before</b> you start
692 changes to telnet, because if you accidentally break telnet and don't
694 SSH running, you'll have effectively locked yourself out of your system
695 until you can get physical access to the console.<br>
698 <h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
699 <p>You can easily compile the Citadel system with the following
701 <pre>./configure<br>make<br>make install<br></pre>
702 <p>The 'configure' script will generate a Makefile from the
704 and it will also write the file "sysdep.h" to your Citadel directory.
705 Please do not edit sysdep.h or Makefile.in yourself. The configure
707 figure out your system dependencies and set everything correctly.</p>
708 <p>Mac OS X 10.1 and later are now supported. (Sorry, 10.0 cannot be
709 supported, now or in the future.) You need to install the Developer
710 Tools CD, which you can purchase or download for free from <a
711 href="http://developer.apple.com">http://developer.apple.com</a>. Then
712 run configure like this:</p>
713 <pre>env CC=/usr/bin/cc ./configure (options - see below)<br></pre>
714 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
715 If you wish to place it in a different directory, you can instead do:</p>
716 <pre>./configure --prefix=/export/home/citadel (or whatever)<br></pre>
717 <p>If you've got Berkeley DB installed in a non-standard location, you
718 can help the configure script find it by doing something like this:</p>
719 <pre>./configure --with-db=/usr/local/BerkeleyDB-4.1<br></pre>
720 <p>Keep in mind that if you're using Berkeley DB from a non-standard
722 you'll have to make sure that location is available at runtime.</p>
723 <p>File permissions are always a bother to work with. You don't want
724 Citadel to crash because someone couldn't access a file, but you also
725 don't want shell users peeking into the binaries to do things like
726 reading others' mail, finding private rooms, etc. The Citadel server
727 needs to be started as root in order to bind to privileged ports, but
728 as soon as its initialization is finished, it changes its user ID to
729 your Citadel user in order to avoid security holes.</p>
730 <h3><a name="Upgrading"></a>Upgrading</h3>
731 <p>Any existing Citadel installation which is at version 5.50 or newer
732 may be upgraded in place without the need to discard your existing data
734 <p>Upgrading to a new version uses the same build procedure as
736 the program for a fresh install, except that you want to do <tt>make
737 upgrade</tt> instead of <tt>make install</tt>. This will
738 overwrite the programs but not your data. <b>Be sure to shut down
739 citserver during this process!</b> If Citadel is running while you
740 upgrade, you may face data corruption issues.<br>
742 <p>After doing <tt>make upgrade</tt>, you should run <tt>setup</tt>
743 again to bring your data files up to date. Please see the setup section
744 below for more information on this.</p>
745 <h3><a name="rc_file"></a>The <tt>citadel.rc</tt> file</h3>
746 <p>The text-based client included with Citadel is suitable for BBS
747 applications. Much of its command set and other behavior is
748 configurable through a Run Control (RC) file. The standard client looks
749 for this file in the following locations: </p>
751 <li><tt>$HOME/.citadelrc</tt></li>
752 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
753 <li><tt>/etc/citadel.rc</tt></li>
754 <li><i>current-directory</i><tt>/citadel.rc</tt></li>
756 The next couple of sections deal with client-side configuration.
757 <h3><a name="Using_an_external_editor_for_message"></a>Using an
759 for message composition</h3>
760 <p>Citadel has a built-in message editor. However, you can also use
761 your favorite text editor to write messages. To do this you simply put
762 a line in your citadel.rc file like this:</p>
763 <pre>editor=/usr/bin/vi<br></pre>
764 <p>The above example would make Citadel call the vi editor when using
765 the <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make
766 it the default editor for the <tt><b>E</b>nter</tt> command by editing
767 the <tt>citadel.rc</tt> file. <b>But be warned:</b> external editors
768 on public systems can
769 be a security hole, because they usually provide users with the ability
770 to drop into a shell on the host system, or save files using names
772 than the name of the temporary file they are editing. If you intend to
773 use an external editor on a public BBS, make sure you use one that has
775 hardened for such a purpose -- one which has had the 'shell' and 'save
777 commands disabled, as well as any other functions which a destructive
778 user could use to gain unauthorized access to your host system.</p>
779 <h3><a name="Printing_messages"></a>Printing messages</h3>
780 <p>Citadel can send messages to a printer, or just about anywhere
781 else in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt>
782 specifies what command you use to print. Text is sent to the standard
783 input (stdin) of the print command.</p>
784 <p>So if you did this:</p>
785 <pre>printcmd="nl|pr|lpr -Plocal"<br></pre>
786 <p>...that would add line numbers, then paginate, then print on the
787 printer named "local". There's tons of stuff you can do with this
788 feature. For example, you could use a command like <tt>cat
789 <<$HOME/archive</tt> to save copies of important messages in a
790 textfile. Again, this is probably something you don't want to configure
791 for a public BBS host -- most system administrators don't want remote
792 users sending arbitrary things to local printers.</p>
793 <h3><a name="URL_viewing"></a>URL viewing</h3>
794 <p>This is one more feature which is appropriate for local users. While
796 a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
797 command, and it will perform some pre-defined action (usually, this is
798 to open up the URL in a web browser). For example:</p>
799 <pre>urlcmd=netscape -remote "openURL(%s)"<br></pre>
800 <p>In the above example, it would open up the URL in an open <a
801 href="http://www.netscape.com/download">Netscape</a> window.<br>
804 <h3><a name="Setup_and_login"></a>Setup and login</h3>
805 <p>Before logging in for the first time, you must run the setup
806 program. To begin this procedure, enter the following commands:</p>
807 <pre>cd /usr/local/citadel<br>./setup<br></pre>
808 <p>The setup program will guide you through a simple configuration
809 procedure. It will ask you what directory to place your data files in
810 -- the default is the current directory, which is usually the sensible
811 thing to select. If you want to run more than one instance of Citadel
812 on the same host, however, you can specify a different directory here
813 -- just remember to specify the directory name again when you start up
814 the server later on.</p>
815 <p><tt>setup</tt> will then shut down the Citadel service if it is
818 <p>You will then be prompted for the name of the system administrator.
819 This is not merely a cosmetic option -- when you log in to your system
820 a little while from now, you'll log in with this name, and it will
821 automatically assign your account the highest access level.</p>
822 <p>Next, you will be prompted for the User ID of the Citadel account on
823 your host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
824 or <tt>citadel</tt>, that account's UID will be the default. If you
825 are upgrading or reconfiguring an existing system, the existing value
826 will be preserved.</p>
827 <p>Then you will be prompted for a server port number. This is the TCP
828 port which Citadel clients use to connect to your Citadel server. In
829 almost all cases, you want to use the default -- port 504, which is the
830 official port number assigned by the IANA for Citadel implementations.</p>
831 <p>The Citadel service will then be started, and you will see the
832 following message:</p>
833 <pre>Setup is finished. You may now log in.<br></pre>
834 <p>Setup is now complete, on most systems, anyway. Please see below to
835 find out if you need to do anything else:</p>
836 <h3><a name="Configuring_your_host_system_to_start"></a>Configuring
838 system to start the service</h3>
839 <p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
840 and <tt>/etc/inittab</tt> in order to configure your host system to
841 automatically start the Citadel service. <tt>setup</tt> will
842 automatically perform these steps if it can, and if you allow it to --
843 just answer 'Yes' when prompted, and everything will be taken care of
844 for you. If you answer 'No' -- or if your system is a little bit odd
845 (for example, BSD systems don't have <tt>/etc/inittab</tt>) -- read
846 this section and do what you need to in order to get things configured.</p>
847 <p>Before you can use Citadel, you must define the "citadel" service to
848 your system. This is accomplished by adding a line to your
849 /etc/services file that looks something like this:</p>
850 <pre>citadel 504/tcp # Citadel Server<br></pre>
851 <p>504 is the port number officially designated by the IANA for use by
852 Citadel. There should not be any need to use a different port number,
853 unless you are running multiple Citadels on the same computer and
855 a different port for each one.</p>
856 <p>The next step is to arrange for the server to start. The <tt>citserver</tt>
857 program is the main Citadel server. Before we cover the recommended
858 method of starting the server, let's examine its usage options:</p>
859 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-lLogFacility] [-d] [-f]<br></pre>
860 <p>The options are as follows:</p>
861 <p><tt>-hHomeDir</tt> - the directory your Citadel data files live in.
862 This should, of course, be a directory that you've run the <tt>setup</tt>
863 program against to set up some data files. If a directory is not
864 specified, the directory
865 name which was specified in the <tt>Makefile</tt> will be used.</p>
866 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed.
867 When -x is used, it will suppress messages sent to syslog (see below).
869 other words, syslog will never see certain messages if -x is used.
871 you should configure logging through syslog, but -x may still be useful
873 some circumstances. The available debugging levels are: </p>
875 <li>0 - Emergency condition; Citadel will exit immediately </li>
876 <li>1 - Severe errors; Citadel may be unable to continue without
878 <li>2 - Critical errors; Citadel will continue with degraded
880 <li>3 - Error conditions; Citadel will recover and continue normally </li>
881 <li>4 - Warning messages; Citadel will continue normally </li>
882 <li>5 - Normal operational messages </li>
883 <li>6 - Informational messages, progress reports, etc. </li>
884 <li>7 - Debugging messages; extremely verbose </li>
886 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace
887 output. Normally it is sent to stdout.</p>
888 <p><tt>-lLogFacility</tt> - Tell the server to send its debug/trace
890 to the <tt>syslog</tt> service on the host system <i>instead of</i>
892 trace file. <tt>LogFacility</tt> must be one of: <tt><i>kern, user,
894 daemon, auth, syslog, lpr, news, uucp, local0, local1, local2, local3,
895 local4, local5, local6, local7</i></tt>. Please note that use of the
896 <tt>-l</tt> option will cancel any use of the <tt>-t</tt> option; that
898 if you specify a trace file <i>and</i> a syslog facility, log output
900 only go to the syslog facility.
902 <p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch
903 would be necessary if you were starting the Citadel server, for
904 example, from an rc.local script (which is not recommended, because
905 this won't allow the server to automatically restart when it is shut
907 <p><tt>-f</tt> - Defragment all the databases upon startup. This
908 currently has no effect, as it is a vestige from the old data store.</p>
909 <p>The preferred method of starting the Citadel server is to place an
910 entry in your /etc/inittab file. This will conveniently bring the
911 server up when your system is up, and terminate it gracefully when your
912 system is shutting down. The exact syntax for your system may vary, but
913 here's an entry that could be used on a Linux system:</p>
914 <pre>cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x6<br></pre>
915 <p>In this example, we've chosen debugging level 6, and have the trace
916 stuff output to one of the virtual consoles. It's important to remember
917 to turn off any getty that is set up on that virtual console, if you do
918 this. After making this change, the command <tt>init q</tt> works on
919 most systems to tell init to re-read the file. If in doubt, just reboot
923 <h3><a name="first_time_login"></a>Logging in for the
925 <p>At this point, your system is ready to run. Run the <tt>citadel</tt>
926 program from the shell and log in as a new user. NOTE: the first user
927 account to be created will automatically be set to access level 6
928 (Aide). This overcomes some obvious logistical problems - normally,
929 Aide access is given by another Aide, but since there aren't any on
930 your system yet, this isn't possible.<br>
933 <h3><a name="Welcoming_new_users"></a>Welcoming new users</h3>
934 <p>Sometimes you might decide that you want a welcome message (or
935 several different messages) automatically mailed to new users upon
936 their first login. Now there is a way to do this. If you create a room
937 called <tt>New User Greetings</tt>, and it is a <i>private</i> room
938 (invitation-only probably makes the most sense), any messages you enter
939 into that room will automatically be delivered to all new users upon
941 <p>You can put anything you want there: a welcome message, system
942 policies, special information, etc. You can also put as many messages
943 there as you want to (although it really doesn't make sense to clutter
944 new users' mailboxes with lots of junk).</p>
945 <p>Don't worry about wasting disk space, either. Citadel has a
946 single-instance message store, so all the new users are actually
947 looking at the same copy of the message on disk.<br>
950 <h3><a name="adding_doors"></a>Space for adding
952 client features (doors)</h3>
953 <p><b>Please take note!</b> This function really represents the "old"
954 way of doing things, and it doesn't fit in well with the client/server
955 paradigm. Please consider it "deprecated" because it may be removed
957 <p>The "doorway" feature is just a generic way to add features to the
958 system. It is called "Doorway" to make it resemble the doors on
959 non-Unix boards, but as we all know, us Unix types don't have to write
960 special code to access the modem. :-) Anyway, when a user hits the <tt><b>*</b></tt>
961 (doorway) command, Citadel does...</p>
962 <pre>USERNAME=(username); export USERNAME<br>./subsystem (user-number) (screen-width) (access level)<br></pre>
963 <p>...so you can put whatever you want in there. I suggest putting in a
965 program to allow the users to pick one of a number of programs, etc. Do
966 be aware that door programs will only be available when the client and
968 programs are running on the <i>same</i> computer, and when the user is
970 the text-mode client. Because of these restrictions, Door programs are
972 utilized less and less every day.<br>
975 <h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and
977 <p>That's just about all the information you need to install the
978 system. But if you get stuck, you can visit <a
979 href="http://uncensored.citadel.org">UNCENSORED! BBS</a> and report a
980 problem or ask for help. But if you intend to report a problem getting
981 the Citadel server to run, <i>please</i> double-check the following
984 <li>Did you do <tt>./configure && make && make
985 install</tt> ?? </li>
986 <li>Did you run setup? </li>
987 <li>Did you start the server? </li>
989 <p>To report a problem, you can log on to <a
990 href="http://uncensored.citadel.org">UNCENSORED!</a> or any other BBS
991 on the Citadel network which carries the <tt>Citadel></tt> room.
992 Please DO NOT e-mail the developers directly. Post a request for help
993 on the BBS, with all of the following information: </p>
995 <li>The exact nature of your difficulty </li>
996 <li>A transcript of the error message(s) if possible </li>
997 <li>The version of Citadel you are running </li>
998 <li>The version of Berkeley DB present on your system </li>
999 <li>Which operating system you are running, and what version </li>
1000 <li>If you are running a Linux system, we need to know which
1001 distribution, and the version of the kernel, libc, and pthreads you
1002 are using (it would help to post the output of a <tt>ldd ./citserver</tt>
1006 <div align="center">
1007 <hr width="100%" size="2">
1008 <h2><a name="sysop"></a>System Administration</h2>
1010 <div align="justify">
1011 <h3><a name="Overview_"></a>Overview</h3>
1012 <p>Citadel, when installed properly, will do most of its maintenance
1013 by itself. It is intended to be run unattended for extended periods of
1014 time, and most installations do just that without any software failures.</p>
1015 <p>The system has seven access levels. Most users are at the bottom and
1017 no special privileges. Aides are selected people who have special
1019 the Citadel program. Room Aides only have this access in a certain
1020 room. Preferred users can be selected by Aides for access to preferred
1021 only rooms. A sysop is anyone who has access to the various sysop
1023 are in their own executable files, which should have their permissions
1025 to allow only sysops to run them. You should either create a sysops
1027 in /etc/group, or use some other existing group for this purpose.</p>
1028 <p>Aides have access to EVERY room on the system, public and private
1029 (all types). They also have access to commands starting with <tt>.<b>A</b>ide</tt>
1030 in addition to being able to delete and move messages. The system room,
1031 <tt>Aide></tt>, is accessible only by those users designated as
1033 <h3><a name="Aide_commands"></a>Aide commands</h3>
1034 <p>Aides have the following commands available to them that are not
1035 available to normal users. They are:</p>
1039 <td width="30%"><tt> .<b>A</b>ide <b>K</b>ill this room </tt></td>
1040 <td> Deletes the current room from the system. </td>
1043 <td width="30%"><tt> .<b>A</b>ide <b>E</b>dit this room </tt></td>
1044 <td> Allows editing of the properties of the current room. This
1045 is explained in greater detail below. </td>
1048 <td width="30%"><tt> .<b>A</b>ide <b>W</b>ho knows room </tt></td>
1049 <td> For private rooms with access controls, or mailbox rooms,
1050 this command displays a list of users who have access to the current
1054 <td width="30%"><tt> .<b>A</b>ide edit <b>U</b>ser </tt></td>
1055 <td> Allows editing of the properties of any user account
1056 on the system. </td>
1059 <td width="30%"><tt> .<b>A</b>ide <b>V</b>alidate new users </tt></td>
1060 <td> For public access systems, this command reviews all new user
1061 registrations and allows you to set each new user's access level (or
1062 simply delete the accounts). </td>
1065 <td width="30%"><tt> .<b>A</b>ide enter <b>I</b>nfo file </tt></td>
1066 <td> Each room may contain a short textual description of
1067 its purpose, which is displayed to users upon entering the room for the
1068 first time (or in the room banner, for users of the Web client). This
1069 command allows you to enter or edit that description. </td>
1072 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite
1074 <td> Access control command to grant any specific user access to
1075 a private room. </td>
1078 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick
1080 <td> Access control command to revoke any specifc user's access
1081 to the current room. This works regardless of whether the room is
1082 public or private. </td>
1085 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>D</b>elete </tt></td>
1086 <td> If the current room has an associated file directory, this
1087 command may be used to delete files from it. </td>
1090 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end
1092 <td> If the current room has an associated file directory, this
1093 command may be used to transmit a copy of any file in that directory to
1094 another node on a Citadel network. </td>
1097 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>M</b>ove </tt></td>
1098 <td> If the current room has an associated file directory, this
1099 command may be used to move any file in that directory to another room.
1100 The target room must also have an associated file directory. </td>
1103 <td width="30%"><tt> .<b>A</b>ide <b>M</b>essage edit </tt></td>
1104 <td> This command allows editing of any of the various system
1105 banners and messages which are displayed to users. Type the name of
1106 the banner or message you wish to edit. </td>
1109 <td width="30%"><tt> .<b>A</b>ide <b>P</b>ost </tt></td>
1110 <td> This is the functional equivalent of the <tt><b>E</b>nter
1111 message</tt> command available to all users, except that it allows you
1112 to post using any user name. </td>
1115 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>G</b>eneral
1117 <td> This command allows configuration of a large number of
1118 global settings for your Citadel system. These settings will be
1119 explained in greater detail below. </td>
1122 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>I</b>nternet
1124 <td> This command allows configuration of settings which affect
1125 how your Citadel system sends and receives messages on the Internet. </td>
1128 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1129 check <b>M</b>essage base </tt></td>
1130 <td> Perform a consistency check on your message store. This is a
1131 very time-consuming operation which should not be performed unless you
1132 have reason to believe there is trouble with your database. </td>
1135 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>N</b>etwork
1137 <td> Configure networking (e-mail, room sharing, etc.) with other
1138 Citadel nodes. </td>
1141 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1142 network <b>F</b>ilter list </tt></td>
1143 <td> If you are on a large public or semi-public network of
1144 Citadel nodes and you find content from certain systems or individuals
1145 objectionable, you can use this command to define a rule set to
1146 automatically reject those messages when they arrive on your system. </td>
1149 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>N</b>ow
1151 <td> Immediately shut down the Citadel service, disconnecting any
1152 users who are logged in. Please keep in mind that it will start
1153 right back up again if you are running the service from <tt>/etc/inittab</tt>,
1154 so in practice this command will probably not get much use. </td>
1157 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>S</b>cheduled
1159 <td> Shut down the Citadel service the next time there are zero
1160 users connected. This allows you to automatically wait until all users
1161 are logged out. </td>
1164 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients
1166 <td> Any room may be made into a mailing list. Enter this command
1167 to open an editor window containing the list of Internet e-mail
1168 addresses to which every message posted in the room will be sent. </td>
1171 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest
1172 recipients </tt></td>
1173 <td> Similar to the regular mailing list command, except the
1174 messages will be sent out in 'digest' form -- recipients will see
1175 messages from the address of the room itself rather than the address of
1176 the author of each message, and a digest may contain more than one
1177 message. Each room may have any combination of List and Digest
1181 <td width="30%"><tt> .<b>A</b>ide <b>N</b>etwork room sharing </tt></td>
1182 <td> Configures the sharing of the current room's contents with
1183 other Citadel nodes. Messages posted in this room on any Citadel system
1184 will automatically be replicated to other Citadel systems carrying the
1191 <h3><a name="Editing_rooms"></a>Editing rooms</h3>
1192 <p>This command allows any aide to change the parameters of a room. Go
1193 to the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit
1194 room</tt> command. A series of prompts will be displayed. The existing
1195 parameters will be displayed in brackets; simply press return if you
1197 to leave any or all of them unchanged.</p>
1198 <pre> <br>Room name [IG's Fun Room]:<br></pre>
1199 <p>...the name of the room.</p>
1200 <pre>Private room [Yes]? <br></pre>
1201 <p>...enter Yes if you wish to restrict access to the room, or no if
1203 is to be accessible by all users. Note that Citadel doesn't bother
1205 about access to rooms every time they need to access the room. Once a
1207 gains access to a private room, it then behaves like a public room to
1209 The following four questions will only be asked if you selected
1211 <pre>Accessible by guessing room name [No]?<br></pre>
1212 <p>...if you enter Yes, the room will not show up in users' <tt><b>K</b>nown
1213 rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing
1214 the room's full name), they will gain access to the room.</p>
1215 <pre>Accessible by entering a password [No]?<br>Room password [mypasswd]: <br></pre>
1216 <p>...this adds an additional layer of security to the room, prompting
1217 users for a password before they can gain access to the room.</p>
1218 <p>If you did not select guessname or passworded, then the only way
1219 users can access the room is if an Aide explicitly invites them to the
1220 room using the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt>
1222 <pre>Cause current users to forget room [No] ? No<br></pre>
1223 <p>Enter Yes if you wish to kick out anyone who currently has access to
1225 <pre>Preferred users only [No]? No<br></pre>
1226 <p>Enter Yes if you wish to restrict the room to only users who have
1227 level 5 (Preferred User) status (and Aides too, of course). You should
1228 make the room public if you intend to do this, otherwise the two
1229 restrictions will be COMBINED.</p>
1230 <pre>Read-only room [No]? No<br></pre>
1231 <p>If you set a room to Read-Only, then normal users will not be
1233 post messages in it. Messages may only be posted by Aides, and by
1234 utility programs such as the networker and the "aidepost" utility. This
1236 useful in situations where a room is used exclusively for important
1237 announcements, or if you've set up a room to receive an Internet
1239 list and posting wouldn't make sense. Other uses will, of course,
1241 apparent as the need arises.</p>
1242 <p>Now for a few other attributes...</p>
1243 <pre>Directory room [Yes]? Yes<br></pre>
1244 <p>...enter Yes if you wish to associate a directory with this room.
1245 This can be used as a small file repository for files relevant to the
1246 topic of the room. If you enter Yes, you will also be prompted with the
1247 following four questions:</p>
1248 <pre>Directory name [mydirname]: <br></pre>
1249 <p>...the name of the subdirectory to put this room's files in. The
1250 name of the directory created will be <tt><i><your Citadel
1251 directory></i>/files/<i><room dir name></i></tt>.</p>
1252 <pre>Uploading allowed [Yes]? Yes<br></pre>
1253 <p>...enter Yes if users are allowed to upload to this room.</p>
1254 <pre>Downloading allowed [Yes]? Yes<br></pre>
1255 <p>...enter Yes if users are allowed to download from this room.</p>
1256 <pre>Visible directory [Yes]? Yes<br></pre>
1257 <p>...enter Yes if users can read the directory of this room.</p>
1258 <pre>Network shared room [No]? No<br></pre>
1259 <p>...you can share a room over a network without setting this flag,
1261 vice versa, but what this flag does is twofold: </p>
1263 <li>It prevents people with no network access from entering messages
1265 <li>Messages are displayed with the name of their originating
1266 system in the header. </li>
1268 <pre>Permanent room [No]? No<br></pre>
1269 <p>Citadel contains an 'auto purger' which is capable of removing rooms
1270 which have not been posted in for a pre-defined period of time (by
1272 this is set to two weeks). If you wish to keep this from happening to
1273 a particular room, you can set this option. (Keep in mind that <tt>Lobby></tt>,
1274 <tt>Aide></tt>, any private mailbox rooms, any network shared rooms,
1275 and any rooms with a file directory are automatically permanent.)</p>
1276 <pre>Anonymous messages [No]? No<br>Ask users whether to make messages anonymous [No]? No<br></pre>
1277 <p>...you can have rooms in which all messages are automatically
1278 anonymous, and you can have rooms in which users are prompted whether
1280 message anonymous when they enter it. The real identity of the author
1281 of each message is still revealed to the Room Aide for this room, as
1283 as any system-wide Aides.</p>
1284 <pre>Room aide [Joe Responsible]: <br></pre>
1285 <p>...on larger systems, it helps to designate a person to be
1286 responsible for a room. Room Aides have access to a restricted set of
1287 Aide commands, ONLY when they are in the room in which they have this
1288 privilege. They can edit the room, delete the room, delete and move
1289 messages, and invite or kick out users (if it is a private room), but
1290 they cannot perform aide commands that are not room-related (such as
1291 changing users access levels).</p>
1292 <pre>Listing order [64]: <br></pre>
1293 <p>This is just a simple way to try to control the order rooms are
1294 listed in when users call up a <tt><b>K</b>nown Rooms</tt> listing.
1295 Rooms with a lower listing order are displayed prior to rooms with a
1296 higher listing order. It has no other effect. For users who list rooms
1297 in floor order, the display will sort first by floor, then by listing
1299 <pre>Message expire policy (? for list) [0]:<br></pre>
1300 <p>This provides you with the opportunity to select how long each
1301 message will remain in a room before automatically being deleted. Press
1302 <tt><b>?</b></tt> for a list of options. You can choose to keep
1303 messages around forever (or until they are manually deleted), until
1304 they become a certain number of days old, or until a certain number of
1305 additional messages are posted in the room, at which time the oldest
1306 ones will scroll out.</p>
1307 <p>You will notice that you can also fall back to the default expire
1308 policy for the floor upon which the room resides. This is the default
1309 setting. You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit
1310 floor</tt> command. The default setting for the floor default, in turn,
1311 is the system default setting, which can be changed using the <tt><b>.A</b>ide
1312 <b>S</b>ystem configuration <b>G</b>eneral</tt> command.</p>
1313 <pre>Save changes (y/n)? Yes<br></pre>
1314 <p>...this gives you an opportunity to back out, if you feel you really
1315 messed things up while editing.<br>
1318 <h3><a name="File_directories"></a>File directories</h3>
1319 <p>If you have created any directory rooms, you can attach file
1320 descriptions to the filenames through a special file called <tt>filedir</tt>.
1321 Each line contains the name of a file in the directory, followed by a
1322 space and then a description of the file, such as:</p>
1323 <pre>myfile.txt This is a description of my file.<br>phluff A phile phull of phluff!<br></pre>
1324 <p>...this would create file descriptions for the files <tt>myfile.txt</tt>
1325 and <tt>phluff</tt> which would be displayed along with the directory.
1326 It should also be noted that when users upload files to your system,
1327 they will be prompted for file descriptions, which will be added to the
1328 <tt>filedir</tt> file. If one does not exist, it will be created.<br>
1331 <h3><a name="Creating_and_editing_user_accounts"></a>Creating and
1332 editing user accounts</h3>
1333 <p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1334 command to create and/or edit user accounts. There are several
1335 parameters which can be set here.</p>
1336 <p>To create a user:</p>
1337 <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>
1338 <p>At this point, the new user account has been created, and the
1340 continue as if you were editing an existing account. Therefore the
1342 of this procedure is the same for creating and editing:</p>
1343 <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>
1344 <p>The blank lines are the user's 'registration' information --
1346 information such as full name, address, telephone number, etc. This
1348 will comprise the user's vCard in both their user profile and in the
1351 <pre>Change password [No]: No<br></pre>
1352 <p>...answer Yes to set or change the password for this account.</p>
1353 <pre>Access level [4]: <br></pre>
1354 <p>...this allows you to set or change the access level for this
1355 account. The access levels available are as follows: </p>
1357 <li>0 - Deleted. (This immediately deletes the account.) </li>
1358 <li>1 - New, unvalidated user </li>
1359 <li>2 - Problem user (severely restricts account - use for
1360 probationary access) </li>
1361 <li>3 - User with no network privileges. Same access as a normal user
1362 except cannot post messages in rooms shared on a network. </li>
1363 <li>4 - Normal user </li>
1364 <li>5 - Preferred user (access is granted to privileged rooms) </li>
1365 <li>6 - Aide (administrative access to the whole system) </li>
1367 <pre>Permission to send/receive Internet mail [ No]? No<br></pre>
1368 <p>If your system is configured to only allow Internet mail privileges
1369 to certain users, this is where you can grant or revoke that privilege.</p>
1370 <pre>Ask user to register again [Yes]: Yes<br></pre>
1371 <p>If you answer Yes to this question, the user will be presented with
1373 'registration' screen or set of prompts, the next time they log in
1375 a Citadel client. This will prompt them for their full name, address,
1378 <pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1379 <p>These statistics are available for informational purposes only, so
1380 there is normally no need to change them.</p>
1381 <pre>Set last call to now [No]: No<br>Purge time (in days, 0 for system default [0]: <br></pre>
1382 <p>Citadel contains an auto-purger which is capable of automatically
1383 deleting accounts which have not been accessed in a predefined period
1384 of time. If you choose to perform this operation, you can 'touch' the
1386 of a wayward user by setting their 'last call' time to 'now'. You can
1387 also adjust, on a per-user basis, the amount of time which must pass
1389 their account is purged by the system. This time is set in days. You
1390 can also specify 0 days to indicate that you wish to use the system
1395 <h3><a name="Deleting_and_moving_messages"></a>Deleting and moving
1397 <p>Aides and Room Aides have the ability to delete and move messages.
1398 After each message, the normal prompt appears:</p>
1399 <pre>(8) <B>ack <A>gain <Q>uote <R>eply <N>ext <S>top m<Y> next <?>help -><br></pre>
1400 <p>Entering <tt><b>D</b>elete</tt> will delete the message. A <tt>(y/n)</tt>
1401 prompt will appear to confirm that you really want to delete the
1402 message. Entering <tt><b>M</b>ove</tt> will prompt for a room to which
1403 the message should be moved.<br>
1406 <h3><a name="Customizing_the_help_files"></a>Customizing the help files</h3>
1407 <p>The subdirectory called <tt>help</tt> contains your system's help
1408 files. There's nothing hard-coded into the system that dictates what
1410 should be there. Whenever a user types the command <tt><b>.H</b>elp</tt>
1411 followed by the name of a help file, it displays the contents of that
1413 <p>The help files that come with the system, of course, are enough to
1414 guide a user through its operation. But you can add, change, or remove
1415 help files to suit whatever is appropriate for your system.</p>
1416 <p>There are several strings that you can put in help files that will
1418 substituted with other strings. They are:</p>
1419 <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>
1420 <p>So, for example, you could create a help file which looked like:</p>
1421 <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>
1422 <h3><a name="Site_configuration"></a>Site configuration</h3>
1423 <p>Once your Citadel server is up and running, the first thing you'll
1424 want to do is customize and tune it. This can be done from the
1425 text-based client with the <tt><b>.A</b>ide <b>S</b>ystem
1426 configuration <b>G</b>eneral</tt> command, or from WebCit (if you have
1427 it installed) by clicking 'Advanced Options' followed by 'Edit
1428 site-wide configuration.' Either method will offer the same
1429 configuration options. This document shows the text mode client being
1431 <p>The first set of options deal with the identification of your system.</p>
1432 <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
1433 !="" more="" text="" on="" the="" next="" screen="">]: <br></jinkies></pre>
1434 <p>'Node name' refers to the short, unqualified node name by which your
1435 system is known on a Citadel network. Generally it will be the same as
1436 the unqualified host name of your computer; this is, in fact, the
1437 default setting.</p>
1438 <p>Then enter the fully-qualified domain name (FQDN) of your system. If
1440 are not on the Internet, you can simply set it to the same as your
1441 unqualified host name. Otherwise you should set this value to the host
1442 name by which your system is most commonly known.</p>
1443 <p>The field called 'Human-readable node name' (also known as the 'node
1444 title' or 'organization name' in other software) is used solely for
1445 display purposes. Set it to the actual name of your system as you want
1447 banners, messages, etc.</p>
1448 <p>If you have a modem or bank of modems answering data calls for your
1449 system, enter it in the field marked 'Modem dialup number.' Otherwise
1450 you may leave it blank.</p>
1451 <p>'Geographic location of this system' is another display field. Enter
1452 a city and state, or city and country. </p>
1453 <p>'Name of system administrator' is important! Any user who logs on
1454 with the name you enter here will automatically be granted Aide
1455 privileges. This is one of two ways for the system administrator to
1456 grant himself/herself Aide access to the system when initially setting
1457 it up. (The other is simply to have the first account created on a new
1459 <p>The next set of options are your system's security settings. Before
1460 delving into the actual options, we should review the various access
1461 levels available on the system. Citadel has seven access levels:</p>
1463 <li>0 (Deleted). A user whose access level is set to 0 will
1464 automatically be deleted by the system. </li>
1465 <li>1 (New User). Users at this level may only read messages.
1466 Entering messages is prohibited, except in the <tt>Mail></tt> room,
1467 where a message to 'sysop' may be entered. </li>
1468 <li>2 (Problem User). Also known as 'Twit.' </li>
1469 <li>3 (Local User). May enter messages, except in rooms shared on a
1470 Citadel network. </li>
1471 <li>4 (Network User). May enter messages in every accessible
1473 <li>5 (Preferred User). Use of this level is up to the whim of the
1474 system administrator. </li>
1475 <li>6 (Aide). Access is granted to the administrative functions of
1476 the system. (This access level may also be granted to a user only for a
1477 specific room, please see 'Room Aide' for more information.) </li>
1479 <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>
1480 <p>'Registration' refers to the process of a user entering various
1481 personal contact information (real name, address, telephone number,
1482 etc.) into the system. When enabled, this information is stored as a
1483 vCard object on the system in two places: the user's <tt>My Citadel
1485 room, and in the <tt>Global Address Book></tt> room. (Note: the
1487 should be made private on publicly-accessible systems, for obvious
1489 <p>If you answer Yes to 'Require registration for new users' then each
1490 new user, upon creating a new account, will immediately be entered into
1491 the registration process. On the other hand, if you answer Yes to
1492 'Disable self-service user account creation' then new users will not be
1494 log in at all -- all accounts must be created by an Aide.</p>
1495 <p>'Initial access level for new users' should be set to 1 (New User)
1496 if you would like to review each new user's registration info before
1497 granting them higher access. This would be done periodically with the <tt><b>.A</b>ide
1498 <b>V</b>alidate new users</tt> command. If you do not require
1499 registration, you should set the initial access level to 4 (Network
1501 <p>Given the above options, it then becomes clear that there are
1502 generally two ways you can set up your Citadel system, depending on its
1505 <li><b>A public access BBS or message board</b> - since you do
1506 not know who might want to log in, self-service account creation needs
1508 stay enabled. If you want to be strict about users identifying
1510 then you should also require users to register (just remember to post a
1511 privacy policy if you're going to collect personal information) -- then
1513 the initial access level to 1 (New User), so new users cannot post
1515 until after you've validated them. For a more lax environment, you can
1516 remove the registration requirement and grant new accounts level 4
1518 User) access on the first visit. </li>
1519 <li><b>A private email/groupware system for your organization</b> -
1520 in this case, disable self-service account creation; you don't want
1521 strangers welcoming themselves to your system. You'll probably also
1523 to disable registration, because you or some other site administrator
1524 will be entering users' contact info when you create their accounts.
1525 Since this is also how you assign their Internet e-mail addresses, it's
1526 probably a good idea to do it yourself instead of expecting them to do
1529 <p>'Access level required to create rooms' is up to you. You might wish
1531 restrict the creation of new rooms only to Aides, or you might wish to
1533 anyone to create a room. The latter is one of the Citadel culture's
1535 long-standing traditions; the former may be appropriate if users are
1538 <p>You have the ability to 'Automatically give room aide privs to a
1539 user who creates a private room.' If you answer Yes, then any user who
1541 guess-name, passworded, or invitation-only room will automatically
1542 become the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1543 command set while in that room. If you would rather grant this
1544 permission manually, answer No.</p>
1545 <p>Another tradition in the Citadel culture is to refrain from deleting
1546 problem users, but instead to 'twit' them (reduce their access level to
1548 [Problem User]). You can then 'Automatically move problem user messages
1549 to twit room' (answer Yes, then specify 'Name of twit room' and
1551 to create that room). If you employ this logic, any user with level 2
1553 User) access will continue to have access to the same set of rooms, but
1555 messages posted will automatically be routed to the Trashcan (or
1557 you call your twit room).</p>
1558 <p>If you have Internet mail configured, you have the option of
1559 restricting its use on a user-by-user basis. If you wish to do this,
1560 answer Yes to 'Restrict Internet mail to only those with that
1561 privilege.' Obviously this makes no sense for an internal e-mail
1562 system, but for a public BBS it
1563 might be appropriate.</p>
1564 <p>Normally, Aides have access to every room, public or private.
1565 They are also forbidden from <tt><b>Z</b>ap</tt>ping
1566 rooms, because the review of content is considered one of their roles.
1567 If you wish to change these policies, the next two options allow you
1568 to. You may 'Allow Aides to Zap (forget) rooms', in which case they may
1569 use the <tt><b>Z</b>ap</tt> command just like any other user.
1570 Aides may also <tt><b>.G</b>oto</tt> any private mailbox belonging to any
1571 user, using a special room name format.</p>
1572 <p>If your local security and/or privacy policy dictates that you keep
1574 log of all pages (instant messages) that go through the system, then
1576 Yes to 'Log all pages'. If you answer Yes, you will be prompted for the
1577 name of a room to which all pages will be logged. If you answer No,
1579 only the sender and recipient of each individual message will receive a
1581 <p>The next set of options deals with the tuning of your system. It is
1582 usually safe to leave these untouched.</p>
1583 <pre>Server connection idle timeout (in seconds) [900]: <br>Maximum concurrent sessions [20]: <br>Maximum message length [2147483647]: <br>Minimum number of worker threads [5]: <br>Maximum number of worker threads [256]: <br></pre>
1584 <p>The 'Server connection idle timeout' is for the connection between
1585 client and server software. It is <b>not</b> an idle timer for the
1586 user interface. 900 seconds (15 minutes) is the default and a sane
1588 <p>'Maximum concurrent sessions' is the highest number of user sessions
1589 you wish to allow on your system at any given time. Citadel can scale
1590 to hundreds of concurrent users, but if you have limited hardware or
1591 (more likely) limited bandwidth, you might wish to set a maximum. You
1592 can also set it to zero for no limit.</p>
1593 <p>'Maximum message length' is just that. This could be a good way to
1594 prevent enormous multimedia files from finding their way into your
1595 message base. This maximum is enforced in all protocols and is also
1596 advertised by the ESMTP service.</p>
1597 <p>The minimum and maximum number of worker threads can be tuned to
1599 liking. Citadel will attempt to keep one worker thread running per
1601 within these constraints. You should be aware that due to the use of
1603 worker thread model, Citadel can handle a large number of concurrent
1605 with a much smaller thread pool. If you don't know the programming
1607 behind multithreaded servers, you should leave these parameters alone.</p>
1608 <p>The next set of options affect how Citadel behaves on a network.</p>
1609 <pre>How often to run network jobs (in seconds) [3600]: <br><br>POP3 server port (-1 to disable) [110]:<br><br>IMAP server port (-1 to disable) [143]:<br><br>SMTP MTA server port (-1 to disable) [25]: <br><br>SMTP MSA server port (-1 to disable) [587]: <br><br>Correct forged From: lines during authenticated SMTP [Yes]:<br><br></pre>
1610 <p>"How often to run network jobs" refers to the sharing of content on
1612 Citadel network. If your system is on a Citadel network, this
1614 item dictates how often the Citadel server will contact other Citadel
1615 servers to send and receive messages. In reality, this will happen more
1616 frequently than you specify, because other Citadel servers will be
1617 contacting yours at regular intervals as well.</p>
1618 <p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP
1619 services. For a system being used primarily for Internet e-mail, these
1620 are essential, so you'll want to specify the standard port numbers: 25,
1621 110, and 143. If Citadel is running alongside some other mail system,
1622 though, then you might want to choose other, unused port numbers, or
1623 enter -1 for any protocol
1624 to disable it entirely.</p>
1625 <p>You'll also notice that you can specify two port numbers for SMTP: one
1626 for MTA (Mail Transport Agent) and one for MSA (Mail Submission Agent). The
1627 traditional ports to use for these purposes are 25 and 587. If you are
1628 running an external MTA, such as Postfix (which submits mail to Citadel using
1629 LMTP) or Sendmail (which submits mail to Citadel using the 'citmail'
1630 delivery agent), that external MTA will be running on port 25, and you should
1631 specify "-1" for the Citadel MTA port to disable it. The MSA port (again,
1632 usually 587) would be the port used by end-user mail client programs such as
1633 Aethera, Thunderbird, Eudora, or Outlook, to submit mail into the system.
1634 All connections to the MSA port <b>must</b> use Authenticated SMTP.</p>
1635 <p>The question about correcting forged From: lines affects how Citadel
1636 behaves with authenticated SMTP clients. Citadel does not ever allow
1637 third-party SMTP relaying from unauthenticated clients -- any incoming
1639 addressed to a user on the system or somewhere in a Citadel network. To
1640 use Citadel with SMTP client software such as Netscape, Outlook,
1642 whatever, users must log in with a username and password. In order to
1644 message forgeries, Citadel discards the <tt>From:</tt> line in any
1646 entered by an authenticated user, and replaces it with a <tt>From:</tt>
1648 containing the user's genuine name and e-mail address. Technically,
1650 violates RFC822, because headers are never supposed to be altered, but
1652 sense dictates that this is a good idea. Nevertheless, if you want to
1654 this behavior, answer 'No' at the prompt (the default is 'Yes') and the
1656 will never be altered.</p>
1657 <p>The final set of options configures system-wide defaults for the
1659 <pre>Default user purge time (days) [120]: <br><br>Default room purge time (days) [30]: <br><br>System default message expire policy (? for list) [2]: <br><br>Keep how many messages online? [150]:<br><br>Mailbox default message expire policy (? for list) [1]: <br><br></pre>
1660 <p>Any user who does not log in for the period specified in 'Default
1661 user purge time' will be deleted the next time a purge is run. This
1662 setting may be modified on a per-user basis.</p>
1663 <p>'Default room purge time' behaves the same way, and may also be
1664 modified on a per-room basis.</p>
1665 <p>'System default message expire policy' defines the way in which old
1666 messages are expired (purged) off the system. You can specify any of:</p>
1668 <li>Purge by age (specify in days) </li>
1669 <li>Purge by message count in the room (specify number of messages) </li>
1670 <li>Do not purge at all </li>
1672 <p>Again, this setting may be overridden on a per-floor basis, and the
1673 floor setting may be overridden on a per-room basis. You'll also notice
1674 that you can set a <i>different</i> default for mailbox rooms if you
1676 to. This can allow you, for example, to set a policy under which old
1677 messages scroll out of public rooms, but private mail stays online
1679 until deleted by the mailbox owners.</p>
1680 <pre>Save this configuration? No<br></pre>
1681 <p>When you're done, enter 'Yes' to confirm the changes, or 'No' to
1682 discard the changes.</p>
1684 <hr width="100%" size="2">
1685 <h2 align="center"><a name="Configuring_Citadel_for_Internet_e-mail"></a>Configuring
1686 Citadel for Internet e-mail</h2>
1687 <div align="justify">
1688 <h3><a name="Introduction"></a>Introduction</h3>
1689 As you know by now, Citadel is a completely self-contained,
1690 full-featured Internet e-mail system. When you run Citadel you do
1691 not need any other mail software on your host system. This
1692 eliminates the need for tedious mucking about with sendmail, qmail,
1693 postfix, Cyrus, the UW IMAP
1694 server, or any of countless other needlessly complex programs that lead
1695 some people to the false assumption that Unix systems are difficult to
1698 Some of the many features supported by Citadel are:<br>
1700 <li>Built-in SMTP and ESMTP service, for delivering and receiving
1701 e-mail on the Internet</li>
1702 <li>Built-in POP3 service, for remote fetching of messages</li>
1703 <li>Built-in IMAP service, for access to mail using any standard mail
1705 <li>Web mail (implemented using the "WebCit" middleware, which is
1706 installed separately)</li>
1707 <li>Support for mailing lists, in both "individual message" and
1708 "digest" formats</li>
1709 <li>Multiple/virtual domain support</li>
1710 <li>Any user may have multiple Internet e-mail addresses, in multiple
1712 <li>Global address book (Users with addresses in a domain may be
1713 spread out across many servers on a Citadel network)</li>
1714 <li>Easy-to-configure integration with <a
1715 href="http://www.spamassassin.org/">SpamAssassin</a> can block spam <i>before</i>
1716 it enters the mail system</li>
1717 <li>Easy-to-configure integration with most Realtime Blackhole
1718 Lists (RBL) provide further defense against spammers</li>
1720 This section of the documentation will demonstrate how to configure
1723 <h3><a name="Basic_site_configuration"></a>Basic site configuration</h3>
1724 <p>Basic configuration of your Citadel system for Internet e-mail
1726 the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>I</b>nternet</tt>
1728 <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>
1729 <p>This is a "clean" setup. For a simple, standalone e-mail system you
1730 simply have to enter the <tt><b>A</b>dd</tt> command:</p>
1731 <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>
1732 <p><b>localhost:</b> Basically what you're doing here is telling
1734 what any aliases for your machine are. If your machine were <tt>schmeep.splorph.com</tt>
1735 and you also had a DNS entry set up for <tt>blah.com</tt>, you might
1736 want to enter '1' and enter <tt>blah.com</tt> as your alias, so that
1738 sent to that address won't bounce.</p>
1739 <p><i>Important tip:</i> if your system is known by one name and <i>only</i>
1740 one domain, you might not even need to do this at all. You will recall
1741 that you entered your system's fully qualified domain name earlier when
1742 you went through the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1743 command. The domain name you entered there is automatically considered
1744 by Citadel to be a 'localhost' entry in your Internet mail
1745 configuration. It does not hurt to enter it in both locations, though.</p>
1746 <p><b>gateway domain:</b> this is a simple way of mapping various
1747 Citadel hosts in an Internet domain. For example, if you enter <tt>bar.com</tt>
1748 as a gateway domain, then mail to users at <tt>foo.bar.com</tt> will
1749 be forwarded to the host called <tt>foo</tt> on a Citadel network,
1751 at <tt>kunst.bar.com</tt> will be delivered to the Citadel server
1753 <tt>kunst</tt>, etc. This feature has limited usefulness; if you are
1755 a network of Citadel servers, it is more likely that you will use the
1757 feature, explained below.</p>
1758 <p><b>smart-host:</b> Normally, Citadel sends outbound Internet e-mail
1759 directly to its destination. This may not be appropriate for some
1760 sites; you may require (due to local convention, security policy, or
1761 whatever) that all outbound mail be sent to an SMTP relay or forwarder.
1763 functionality, simply enter the domain name or IP address of your relay
1764 as a 'smart-host' entry.</p>
1765 <p><b>directory:</b> a domain for which you are participating in
1766 directory services across any number of Citadel nodes. For example, if
1767 users who have addresses in the domain <tt>citadel.org</tt> are spread
1768 out across multiple Citadel servers on your network, then enter <tt>citadel.org</tt>
1769 as a 'directory' entry. <i>For this to work, all Citadel servers
1770 participating in directory service <b>must</b> carry and share the <tt>Global
1771 Address Book></tt> room.</i></p>
1772 <p><b>spamassassin:</b> if you are running a <a
1773 href="http://www.spamassassin.org">SpamAssassin</a> service anywhere
1775 <b>local</b> network, enter its name or IP address as a 'spamassassin'
1776 entry. This may be (and, in fact, will usually be) <tt>127.0.0.1</tt>
1778 that the service is running on the same host computer as the Citadel
1780 <p>Please install SpamAssassin as per its own documentation. You will
1781 want to run SpamAssassin in client/server mode, where a <tt>spamd</tt>
1782 daemon is always running on your computer. Citadel does not utilize the
1783 <tt>spamc</tt> client; instead, it implements SpamAssassin's protocol
1785 <p>Connecting to a SpamAssassin service across a wide area network is
1786 strongly discouraged. In order to determine whether an incoming e-mail
1787 is spam, Citadel must feed the <i>entire message</i> to the
1788 SpamAssassin service. Doing this over a wide area network would consume
1790 which would affect performance.</p>
1791 <p>Citadel invokes the SpamAssassin service when incoming messages are
1792 arriving via SMTP. Before a message is accepted, it is submitted to
1793 SpamAssassin. If SpamAssassin determines that the message is spam, the
1795 service <i>rejects the message,</i> causing a delivery failure on the
1797 host. This is superior to software which files away spam in a separate
1798 folder, because delivery failures will cause some spammers to assume
1800 address is invalid and remove it from their mailing lists.</p>
1801 <p><b>RBL:</b> Realtime Blackhole Lists (RBL's) provide defense against
1802 spammers based on their source IP address. There are many such lists
1803 available on the Internet, some of which may be utilized free of
1804 charge. Since they are DNS based, the lists do not require storage on
1805 your server -- they are queried during the SMTP conversation.</p>
1806 <p>Citadel can utilize any RBL that uses the <tt>z.y.x.w.nameoflist.org</tt>
1807 syntax, where <tt>w.x.y.z</tt> is the source IP address which is
1808 attempting to deliver mail to your server. For example, <a
1809 href="http://www.spamcop.net">SpamCop</a> would use the query <tt>2.0.0.127.bl.spamcop.net</tt>
1810 to determine whether the host at <tt>127.0.0.2</tt> is a known spammer
1811 or open relay. In this case, you simply select option '6' to add an RBL
1812 entry, and provide it with the domain suffix of <tt>bl.spamcop.net</tt>
1814 and extra dot will be automatically prepended for each query).</p>
1815 <p>Now select <tt><b>S</b>ave</tt> and you are just about ready for
1816 Internet e-mail.</p>
1817 <h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the
1818 Internet mail protocols</h3>
1819 <p>As previously mentioned, Citadel contains its own SMTP, POP3, and
1820 IMAP services. Enabling them is simple.</p>
1821 <p>Check for the existance of a current MTA (sendmail, qmail, etc.) by
1822 connecting to port 25 on your host. If you see something similar to the
1824 you're running an MTA already and you'll need to shut it down:</p>
1825 <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>
1826 <p>In the above example, we see that the host already has Sendmail
1827 listening on port 25. Before Citadel can use port 25, Sendmail must be
1828 shut off. Please consult the documentation for your operating system
1829 for instructions on how to do this. (On a Red Hat Linux system, for
1830 example, you can run the <tt>ntsysv</tt> utility, un-checking <tt>sendmail</tt>
1832 the next reboot; then, run <tt>service sendmail stop</tt> to shut off
1834 currently running service.)</p>
1835 <p>If you get a 'connection refused' message when you telnet to port 25
1836 there's nothing running and you should be able to continue. You might
1837 also want to turn off POP (try the above test substituting 110 for 25)
1838 and IMAP (port 143) and use Citadel's POP and IMAP services.</p>
1839 <p>Citadel will look for an existing pop/smtp server on startup. If
1841 don't exist (and you've configured them properly) then Citadel should
1843 them at startup. You can check your logs to be sure, or you can start
1845 server from a shell and watch it load. It might look something like
1847 <font size="-2"> </font>
1848 <pre><font size="-2">smw @ pixel % ./citserver<br><br>Multithreaded message server for Citadel<br>Copyright (C) 1987-2003 by the Citadel development team.<br>Citadel is open source, covered by the GNU General Public License, and<br>you are welcome to change it and/or distribute copies of it under certain<br>conditions. There is absolutely no warranty for this software. Please<br>read the 'COPYING.txt' file for details.<br><br>Loading citadel.config<br>Opening databases<br>This is GDBM version 1.8.0, as of May 19, 1999.<br>Checking floor reference counts<br>Creating base rooms (if necessary)<br>Registered a new service (TCP port 504)<br>Registered a new service (TCP port 0)<br>Initializing loadable modules<br>Registered server command CHAT (Begin real-time chat)<br>Registered server command PEXP (Poll for instant messages)<br>Registered server command GEXP (Get instant messages)<br>Registered server command SEXP (Send an instant message)<br>Registered server command DEXP (Disable instant messages)<br>Registered a new session function (type 0)<br>Registered a new x-msg function (priority 0)<br>Loaded module: $Id$<br>Registered a new session function (type 1)<br>Registered a new message function (type 201)<br>Registered a new message function (type 202)<br>Registered server command REGI (Enter registration info)<br>Registered server command GREG (Get registration info)<br>Registered a new user function (type 100)<br>Loaded module: $Id$<br>Server-hosted upgrade level is 5.62<br>Loaded module: $Id$<br>Registered server command EXPI (Expire old system objects)<br>Registered server command FSCK (Check message ref counts)<br>Loaded module: $Id$<br><b>citserver: Can't bind: Address already in use<br>ERROR: could not bind to TCP port 25.</b><br>Registered a new service (TCP port 0)<br>Registered a new session function (type 50)<br>Loaded module: $Id$<br><b>citserver: Can't bind: Address already in use<br>ERROR: could not bind to TCP port 110.</b><br>Registered a new session function (type 0)<br>Loaded module: $Id$<br>Registered a new message function (type 202)Loaded module: $Id$<br>Registered server command RWHO (Display who is online)<br>Registered server command HCHG (Masquerade hostname)<br>Registered server command RCHG (Masquerade roomname)<br>Registered server command UCHG (Masquerade username)<br>Registered server command STEL (Enter/exit stealth mode)<br>Loaded module: $Id$<br>Changing uid to 513<br>Starting housekeeper thread<br></font></pre>
1849 <p>The lines emphasized in boldface in the above log output tell you
1850 that Citadel "can't bind" to various ports. The error 'address already
1851 in use' generally means that something else is already running on the
1852 requested port. Make SURE you've followed the above steps to remove
1853 sendmail/pop and start your Citadel server again.</p>
1854 <h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
1855 <p>Occationally it is not practical to remove a non-Citadel MTA on your
1856 host system. For example, you might have multiple groups of users, some
1858 which are using Citadel and some of which are using a legacy Unix mail
1859 spool. This type of configuration is discouraged, but two tools are
1862 <p>The tool is called <tt>citmail</tt> and it is, quite simply, a
1863 local MDA (Mail Delivery Agent) which you can configure into your MTA
1864 for final delivery of incoming messages to Citadel users. A full
1865 discussion of the finer points of complex Sendmail configurations is
1866 beyond the scope of this document; however, you might want to visit <a
1867 href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some
1868 useful HOWTO documents are provided.<br>
1870 <p>The other tool is an <a href="http://www.faqs.org/rfcs/rfc2033.html">RFC2033</a>
1871 compliant LMTP service running on a local socket. If you're
1872 running a mailer that speaks LMTP (such as <a
1873 href="http://www.postfix.org/">Postfix</a>), you can simply point your
1874 mailer at the socket called <span style="font-family: monospace;">citadel.socket</span>
1875 in your Citadel directory. For example, in Postfix you might put
1876 the following line into <span style="font-family: monospace;">main.cf</span>
1877 in order to tell it to use Citadel to deliver mail to local recipients:<br>
1879 <pre>local_transport = lmtp:unix:/usr/local/citadel/lmtp.socket<br></pre>
1880 <p>Postfix also has something called a "fallback transport" which can
1881 be used to implement Citadel as a "secondary" mail system on your
1882 server, while keeping the existing Unix mailboxes intact.
1883 However, it is beyond the scope of this document to detail the finer
1884 points of the configuration of Postfix or any other mailer, so refer to
1885 the documentation to those programs and keep in mind that Citadel has
1886 LMTP support.<span style="font-family: monospace;"><br>
1888 <p>For outbound mail, you
1889 can either allow Citadel to perform
1891 (this won't affect your other mail system because outbound mail doesn't
1893 up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which will
1895 Citadel to forward all of its outbound mail to your other mail system.</p>
1896 <h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet
1898 <p>Citadel has built in mailing list service (known in the 'net
1899 vernacular as "listserv") functionality. You can turn any room
1900 into a mailing list. Users can then choose how they participate
1901 -- by logging on to your Citadel server directly, or by having the
1902 room's contents mailed to
1903 them somewhere else. Configuring this is easy.</p>
1904 <p>Citadel supports two modes of mailing list delivery: </p>
1906 <li>"List mode" -- each individual message is delivered as a single
1907 e-mail to each list mode recipient. The "From:" header will
1908 display the address of the message's original author.</li>
1909 <li>"Digest mode" -- groups of one or more messages are delivered
1910 to digest mode recipients. The number of messages in the group
1911 depends on how many new messages arrived since the last batch was
1912 delivered. The "From:" header will display the address of the
1913 room itself, which allows replies to be posted back to the room.</li>
1915 A room may have any combination of list mode and digest mode
1917 <p>As alluded to above, every room on your Citadel system has an
1918 Internet e-mail address of its own. Messages sent to that address
1920 posted in the room (and sent back out to mailing list recipients, as
1922 as to any other Citadels you share the room with). The address
1924 is <tt>room_</tt> plus the name of the room, with any spaces replaced
1926 underscores, followed by <tt>@</tt> and your hostname. For example, if
1928 system is known as <tt>phlargmalb.orc.org</tt> on the Internet, and
1930 a room called <tt>Bubblegum Collectors</tt>, you can post to that room
1932 anywhere on the Internet simply by sending an e-mail to <tt>room_bubblegum_collectors@phlargmalb.orc.org</tt>.
1933 When the message arrives, it's automatically posted in that room.</p>
1934 <p>To manually edit the list of "list mode" recipients, simply enter
1935 the <tt><b>.A</b>ide
1936 mailing <b>L</b>ist management</tt> command. Your text editor will
1938 up and you will be able to create or edit a list of recipients, one per
1939 line. Lines beginning with a hash (<tt>#</tt>) are comments.</p>
1940 <p>To manually edit the list of "digest mode" recipients, enter the <tt><b>.A</b>ide
1941 mailing list <b>D</b>igest recipients</tt> command. As with the
1942 previous command, the text editor will open up and you can edit the
1943 list of digest mode recipients, one per line.</p>
1944 <p>Citadel also has a facility which allows users to subscribe or
1945 unsubscribe to mailing lists using a web browser. In order to do this,
1946 WebCit must also be running on your server in addition to Citadel.
1947 WebCit is obtained and installed separately from the rest of the
1949 <p>In order to prevent "just anyone" from subscribing to any room on
1950 your system, there is a setting in the <tt><b>.A</b>ide <b>E</b>dit
1951 room</tt> command:</p>
1952 <pre>CitaNews} . Aide Edit this room<br>
1953 Room name [CitaNews]:<br>
1955 <i>(lots of other stuff omitted for brevity...)</i><br>
1957 Self-service list subscribe/unsubscribe [No]: Yes<br></pre>
1958 <p>When you answer "Yes" to self-service list subscribe/unsubscribe,
1960 enabling that feature. Now, all you have to do is tell the world about
1962 web page they need to visit. It looks like this:</p>
1963 <center><tt>http://foobar.baz.org:2000/listsub</tt></center>
1964 <p>In this example, the server is called <tt>foobar.baz.org</tt> and
1965 WebCit is running on port 2000. Edit appropriately.</p>
1966 <p>Citadel offers a subscribe/unsubscribe facility that is more
1967 intuitive than other listservs. With most systems, sending commands to
1968 the listserv requires that you e-mail it commands in a special format.
1969 It's easy to get it wrong. Citadel simply uses your web browser. You
1970 select the list you want to subscribe or unsubscribe (hint: it's the
1971 list of rooms you've enabled self-service for), select whether you want
1972 list mode or digest mode, and enter your e-mail address. For security
1973 purposes, a confirmation message is sent to the address you enter. But
1974 you don't have to reply to the message in a weird format, either: the
1975 confirmation contains another URL which
1976 you simply click on (or paste into your browser if you can't click on
1978 in your e-mail software) and the confirmation is automatically
1980 <hr width="100%" size="2">
1982 <h2><a name="Building_or_joining_a_Citadel_network"></a>Building or
1983 joining a Citadel network</h2>
1985 <h3><a name="Overview__"></a>Overview</h3>
1986 <p>If you are running Citadel as a BBS or other forum type of
1987 application, one way to 'keep the conversation going' is to share rooms
1988 with other Citadel systems. In a shared room, a message posted to the
1989 room is automatically
1990 propagated to every system on the network. It's kind of like a UseNet
1992 but without the spam.</p>
1993 <p>If you are using Citadel as the e-mail and groupware platform for a
1994 large organization, you can use its networking features to build a
1995 large network of Citadel servers which share content (think of rooms as
1996 public folders), redistribute e-mail throughout the organization, and
1997 integrate the global address book. It might make sense, for
1998 example, in a large corporation to give each department or location its
1999 own Citadel server. Thanks
2000 to Citadel's global address book features, you could still have all of
2002 users share a single e-mail domain.</p>
2003 <p>Obviously, the first thing you have to do is find another Citadel to
2004 share rooms with, and make arrangements with them. The following
2005 Citadels are a good place to start:</p>
2007 <li>UNCENSORED! - <a href="http://uncensored.citadel.org">uncensored.citadel.org</a>
2009 <li>The Dog Pound II - <a href="http://dogpound2.citadel.org">dogpound2.citadel.org</a>
2011 <li>PixelBBS - <a href="http://pixel.citadel.org">pixel.citadel.org</a>
2014 <p>You don't have to be a part of the citadel.org domain to participate
2015 in the public Citadel network, but the DNS service is provided free of
2016 charge by the Citadel community if you wish to do this.</p>
2017 <h3><a name="Conventions_and_etiquette_when"></a>Conventions and
2018 etiquette when connecting to the public Citadel network</h3>
2019 <p>Before we get into the technical nitty gritty, there are two points
2020 of etiquette to keep in mind. The first thing to keep in mind is that
2021 the operator of any particular Citadel may not be willing to share some
2022 of his/her rooms. Some sites are proud to offer exclusive content in
2023 certain areas. Chances are, if a room is already being shared on the
2024 network, it's available for anyone to share; if not, it can't hurt to
2025 ask -- but take care not to demand it of them. Ask if you may share the
2026 room instead of telling them that you wish to share the room. When
2027 looking at a <tt><b>K</b></tt>nown rooms list, network rooms are the
2028 ones ending in parentheses instead of angle brackets. For example, <tt>Gateway)</tt>
2029 would be a network room, <tt>Lobby></tt> would not.</p>
2030 <p>The other point of etiquette to remember is that you should be
2032 the arrangements in advance, and then set it up. It is extremely rude
2034 simply begin networking with another Citadel, or unilaterally start
2036 a new room, without first obtaining permission from its operator.
2038 ask first. Most Citadel operators are more than happy to network with
2039 you. Also, if later on you decide to take your system down, please take
2041 to notify the operators of any other Citadels you network with, so they
2043 unconfigure their end.</p>
2044 <h3><a name="Getting_ready_to_join_the_network"></a>Getting ready to
2045 join the network</h3>
2046 <p>Ok, first things first. On a Citadel room sharing network, the first
2047 thing you need to know is your own system's node name. Presumably you
2049 this up during installation, but if you want to change it you can do so
2051 the <tt><b>.A</b>ide <b>S</b>ysconfig <b>G</b>eneral</tt> command:</p>
2052 <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>
2053 <p>The "node name" is important, it's how the network identifies
2054 messages coming from your system. The "human readable node name" is
2055 simply a label; it shows up in messages coming from your system. "Fully
2056 qualified domain name" is your DNS name; it's used for routing messages
2057 on the Internet. In the above example, the node name is "uncnsrd".</p>
2058 <h3><a name="Defining_neighbor_nodes"></a>Defining neighbor nodes</h3>
2059 <p>The next thing you need to do is configure your neighbor node(s).
2060 You need to do this for each node you network with. Let's say you
2062 to talk to a Citadel system called "frobozz". Use the <tt><b>.A</b>ide
2063 <b>S</b>ysconfig <b>N</b>etwork</tt> command:</p>
2064 <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>
2065 <p>As you can see in the above example, you have to enter the Citadel
2066 node name, the DNS name or IP address of the server, and the port
2067 number the Citadel service is running on. The "shared secret" is a
2068 password to allow the two Citadel nodes to connect to each other to
2069 exchange network data. The password must be <i>identical</i> on both
2070 ends of the connection -- when the operator of the other Citadel node
2071 sets up the connection with
2072 your system, he/she must use the same password.</p>
2073 <h3><a name="Sharing_rooms"></a>Sharing rooms</h3>
2074 <p>Now you're ready to share rooms. You have to do this for each room
2075 you want to share, and you have to do it from BOTH ENDS -- again, when
2077 share a room with another Citadel, they must share it with you as well.
2078 Let's say you have a room called "Quiche Recipes>" and you want to
2080 it with the node you set up above. First, edit the room and flag it as
2083 <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>
2084 <p>Notice how the prompt changed? It was > before, but it's ) now.
2085 That means it's a network room. Now you can tell Citadel that you want
2087 share the room with frobozz. Enter this command:</p>
2088 <pre>Quiche Recipes) . Aide Network room sharing<br></pre>
2089 <p>Your text editor will pop up (you <i>did</i> configure Citadel to
2091 your favorite text editor, right?) with a screen that looks like this:</p>
2092 <pre># Configuration for room: Quiche Recipes<br># Nodes with which we share this room<br># Specify one per line.<br></pre>
2093 <p>All you have to do is enter the name of the other Citadel node (i.e.
2094 "frobozz" in our example) on a line by itself. As usual, lines starting
2096 "#" are comments. Just go to the end of the file, type "frobozz"
2098 the quotes), save the file... and you're done!</p>
2099 <p>At this point, you just sit back and enjoy. Your Citadel and the
2100 other one will begin polling each other at regular intervals (once per
2102 by default) and sharing messages.</p>
2103 <h3><a name="Sending_mail"></a>Sending mail</h3>
2104 <p>You can send mail to any user on any node of your Citadel network.
2105 It may take a little while for your system to learn the entire node
2106 list, though, as this is done by watching incoming messages on the
2107 network and learning which nodes are out there.</p>
2108 <p>To send a private message, just enter <tt>user @ host</tt> as the
2110 <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>
2111 <h3><a name="Changing_the_polling_interval"></a>Changing the polling
2113 <p>As previously mentioned, Citadel will poll other Citadel nodes for
2114 messages once per hour. If this is not an acceptable interval, you can
2115 change it using the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
2116 command. Enter this command and look for the option:</p>
2117 <pre>How often to run network jobs (in seconds) [3600]:<br></pre>
2118 <p>Change it to whatever you like. For example, 15 minutes is 900
2119 seconds. So if you changed the default value to 900, network polling
2120 would occur every 15 minutes.</p>
2122 <h2 align="center"><a name="Database_maintenance"></a>Database
2124 <h3><a name="Introduction_"></a>Introduction</h3>
2125 The data store used by Citadel is reliable and self-maintaining.
2126 It requires very little maintenance. This is primarily due
2127 to its use of the <a href="http://www.sleepycat.com">Berkeley DB</a>
2128 record manager. It is robust, high-performance, and transactional.<br>
2130 A few small data files are kept in your main Citadel directory, but the
2131 databases are in the <tt>data/</tt> subdirectory. The files with
2132 names that begin with "cdb" are the databases themselves; the files
2133 with names that begin with "log" are the journals. Journal files
2134 will come and go as you use your system; when the database engine has
2135 determined that a particular log file is no longer needed, the file
2136 will automatically be deleted. Nevertheless, you should always
2137 ensure that there is ample disk space for the files to grow.<br>
2139 There is no need to shut down Citadel during backups. The data
2140 store may be backed up "hot." The makers of Berkeley DB suggest
2141 that you should back up the data files <i>first</i> and the log files <i>second</i>.
2142 This is the only method that will guarantee that a database which
2143 is being changed while you back it up will still be usable when you
2145 from the tape later.<br>
2147 <h3><a name="Database_repair"></a>Database repair</h3>
2148 Although Citadel's data store is quite reliable, database corruption
2149 can occur in rare instances. External factors such as an
2151 system crash or an unexpected loss of power might leave the database in
2152 an unknown state. A utility is provided which may be able to
2154 your database if this occurs. If you find that your Citadel
2156 is not running, and reading the logs shows that it is crashing because
2158 an inability to validate a database, follow these steps:<br>
2160 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2161 "respawn" to "off." Type <tt>init q</tt> to make this setting
2163 <li><b>Make a backup of your data.</b> Either write it out to
2164 tape or copy it to another directory, or a tarball.<br>
2166 <li><tt>cd</tt> to your Citadel directory and type <tt>./database_cleanup.sh</tt></li>
2167 <li>Let the cleanup script run. <b>Do not interrupt this
2168 process for any reason.</b><br>
2170 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2171 "off" to "respawn". Type <tt>init q</tt> to activate your
2174 If this procedure does not work, you must restore from your most recent
2177 <h3><a name="ImportingExporting_your_Citadel"></a>Importing/Exporting
2178 your Citadel database<br>
2180 <p>Citadel contains an importer/exporter module, affectionately
2181 known as the "Art Vandelay" module (a not-so-obscure Seinfeld
2183 allows you to export the entire contents of your Citadel databases to a
2184 flat file, which may then be imported on another system. (This
2186 is also known as "dump and load" to database gurus.)</p>
2187 <p>Why would you want to do this? Here are some scenarios: </p>
2189 <li>You are moving a Citadel installation to another computer, which
2190 uses a different CPU. Since Citadel stores data in an
2191 architecture-dependent format, the data files wouldn't work on the new
2192 computer as-is. </li>
2193 <li>Your computer crashed, lost power, etc. and you suspect that your
2194 databases have become corrupted. </li>
2195 <li>You want to switch to a different back-end data store. (For
2196 example, from GDBM to Berkeley DB) </li>
2198 <p>So ... how do we work this magic? Follow these steps <i>exactly</i>
2199 as documented and you should be able to do it all with very little
2202 <li>This should be obvious, but it's still worth mentioning: <b>Make
2203 sure you have a backup of everything before you start this! </b>
2204 You're performing a major operation here. Don't risk it. </li>
2205 <li>First, get all the users logged off from your system. Disconnect
2206 it from the network if possible. You don't want anyone logging in while
2207 you're doing this. </li>
2208 <li>Log on as root, or some other user that has read/write access to
2209 all relevant files. </li>
2210 <li>Go to the directory that Citadel is installed in. For example,
2211 issue a command like <tt>cd /usr/local/citadel</tt> </li>
2212 <li>Export the databases with the following command:<br>
2214 <tt>./sendcommand "ARTV export" >exported.dat</tt><br>
2216 This command may run for a while. On a very large system it could take
2217 an hour or more. Please be patient! </li>
2218 <li>When the export completes, check to make sure that <tt>exported.dat</tt>
2219 exists and has some data in it. (Type "ls -l exported.dat") </li>
2220 <li>Shut down the Citadel server. If you have a line in <tt>/etc/inittab</tt>
2221 that reads like this:<br>
2223 <tt>c1:2345:respawn:/usr/local/citadel/citserver
2224 -h/usr/local/citadel</tt> <br>
2225 ...then you should change the <tt>respawn</tt> to <tt>off</tt> and
2226 then type <tt>/sbin/init q</tt> to make the changes take effect. </li>
2227 <li>Now it's time to delete your current binary databases. Type:<br>
2229 <tt>rm -f citadel.config citadel.control data/*</tt> </li>
2230 <li>If you're moving Citadel to another computer, you should move the
2231 <i>entire</i> directory over at this time. <tt>exported.dat</tt>
2232 only contains the information that was in the binary databases.
2233 Information which was stored in portable formats doesn't need to be
2234 exported/imported, so
2235 you must bring it all over in its current form. </li>
2236 <li>Now get Citadel running on the new computer (or whatever). Run <tt>setup</tt>
2237 and turn the service back on (from <tt>/etc/inittab</tt>) but DO NOT
2239 <li>As root, run the import command:<br>
2241 <tt>./sendcommand "ARTV import" <exported.dat</tt><br>
2243 This will import your databases. Again, it may run for a long time. </li>
2244 <li>Restart the Citadel server. You can do this any way you like.
2245 From the command line, you can do it with a command like:<br>
2247 <tt>./sendcommand "DOWN"</tt> <br>
2249 <li>Now you're finished. Log in and test everything. You may delete
2250 exported.dat at this time, or you might want to save it somewhere as a
2251 sort of pseudo-backup. </li>
2255 <h2><a name="crypto"></a>Cryptography support (TLS/SSL)</h2>
2257 <h3><a name="crypto_intro"></a>Overview</h3>
2258 <p>Citadel provides built-in support for encryption using Transport
2259 Layer Security (TLS) for ESMTP, IMAP, POP3, and the Citadel client
2261 A simple cryptographic configuration is installed automatically when
2263 bring the system online. The remainder of this section describes how
2265 configuration is built, and what you can do to make changes to it.</p>
2266 <p>Encryption files are kept in the <tt>keys/</tt> directory. The
2268 files used by Citadel are:</p>
2270 <li><tt>citadel.key</tt> - Contains your system's RSA private key.
2272 generates a new key automatically if one is not found. </li>
2273 <li><tt>citadel.csr</tt> - Contains a Certificate Signing Request
2275 for your system. Citadel generates a new CSR automatically, using your
2276 private key, if one is not found. </li>
2277 <li><tt>citadel.cer</tt> - Contains the public certificate for your
2278 system. The public key in the certificate <b>must</b> correspond with
2280 private key in <tt>citadel.key</tt>, otherwise encryption will not
2281 function properly. Citadel will generate a self-signed certificate,
2283 using your private key, if a certificate is not found. </li>
2285 <h3><a name="real_cert"></a>Generating and installing a Trusted
2287 <p>If you wish to interact with 3rd party clients
2288 that have hard coded lists of acceptable Certificate Authorities, and
2290 do not want annoying dialog boxes popping up for the user on the first
2292 all) connections, then you will have to have your key signed by a valid
2293 Certificate Authority.</p>
2294 <p>It is beyond the scope of this document to provide a complete
2296 on SSL certificates. Here are the general rules to follow:</p>
2298 <li>Generally, the Certificate Signing Requeste which is
2300 generated by Citadel will not contain enough information for any
2302 Authority to sign it. Generate a new CSR with the following commands:<br>
2304 <tt>cd keys</tt><br>
2305 <tt>openssl req -new -key citadel.key -out citadel.csr</tt><br>
2307 Answer all questions (your geographic location, organization name,
2309 and then send the new <tt>citadel.csr</tt> to your Certificate
2311 when you order the certificate. </li>
2312 <li>When the certificate is received, simply save it as <tt>citadel.cer</tt>
2313 and restart the Citadel server. </li>
2316 <hr style="width: 100%; height: 2px;">
2317 <div style="text-align: center;">
2318 <h2><a name="LDAP_Directory_Support"></a>LDAP (Directory) Support</h2>
2319 <div style="text-align: justify;">
2320 <h3><a name="Introduction_ldap"></a>Introduction</h3>
2321 LDAP (Lightweight Directory Access Protocol) has become the open
2322 standard protocol for directory access. There are many client
2323 programs which are capable of making use of an LDAP directory
2324 service. Therefore it may be beneficial for some sites to have a
2325 directory available which is populated with Citadel user information.<br>
2327 Citadel does not contain its own LDAP service, because that would
2328 eliminate its ability to coexist with any existing directory you may
2329 already have in place at your organization. Instead, we provide
2330 the LDAP Connector for Citadel, which allows the Citadel service to
2331 populate an external LDAP directory. If you do not already have
2332 an LDAP directory in place, you can use the OpenLDAP server, which is
2333 probably already present in your operating system, or at least can be
2334 loaded from the installation CD's. The supplied configuration
2335 file <tt>citadel-slapd.conf</tt> can be used as a starting
2336 point to get your LDAP server running.<br>
2338 <h3><a name="Preparing_your_LDAP_server_for_Citadel"></a>Preparing your
2339 LDAP server for Citadel connections</h3>
2340 It is difficult to find a commonly accepted LDAP scheme. It seems, most
2341 real life LDAP installations go for the domain oriented apporach
2342 and lay out the structure after an existing domain/subdomain structure.
2343 <p> The most widely accepted and standardized object for storing
2345 clearly is "inetOrgPerson". Citadel therefore attempts to follow
2346 this type of schema.<br>
2348 <p>If you are using OpenLDAP as your directory server, you should
2349 choose options similar to the following:<br>
2351 <pre>database ldbm<br>schemacheck off<br>allow bind_v2<br>suffix "dc=servername,dc=domain,dc=org"<br>rootdn "cn=manager,dc=servername,dc=domain,dc=org"<br>rootpw secret<br></pre>
2353 <li>Obviously, you can make your suffix and rootdn whatever you wish,
2354 but in most cases you'd simply follow a DC path that looks similar to
2355 your DNS domain.</li>
2356 <li>If you don't want LDBM, feel free to choose any backend available
2357 on your system.</li>
2358 <li><span style="font-family: monospace;">bind_v2</span> is <span
2359 style="font-style: italic;">required</span> because Citadel will make
2360 v2 protocol connections.</li>
2361 <li><span style="font-family: monospace;">schemacheck off</span> is <span
2362 style="font-style: italic;">recommended</span> because Citadel uses
2363 fields that do not necessarily exist in your system's default
2364 schema. If you don't like that idea, your other option is to
2365 reference the included <span style="font-family: monospace;">citadel-openldap.schema</span>
2366 in your configuration.</li>
2367 <li>Your <span style="font-family: monospace;">rootdn</span> and <span
2368 style="font-family: monospace;">rootpw</span> can be whatever you
2369 want. Usually the rootdn is <span style="font-family: monospace;">cn=manager,</span>
2370 followed by your usual suffix. Please don't use <span
2371 style="font-family: monospace;">secret</span> as your password, as in
2372 this example. Select a new password for your site.</li>
2375 Your LDAP service <span style="font-weight: bold;">must</span> be up
2376 and running before you attempt to connect Citadel to it.<br>
2378 <h3><a name="Configuring_the_LDAP_Connector_for"></a>Configuring the
2379 LDAP Connector for Citadel</h3>
2380 Once you've located or installed your LDAP server, connecting Citadel
2381 to it is easily completed with the <span style="font-weight: bold;"><span
2382 style="font-family: monospace;">.A</span></span><span
2383 style="font-family: monospace;">ide <span style="font-weight: bold;">S</span>ystem-configuration
2384 <span style="font-weight: bold;">G</span>eneral command:<br>
2386 <pre>Lobby> . Aide System configuration General<br><br><span
2387 style="font-style: italic;">(lots of other stuff omitted for brevity...)</span><br><br>Connect this Citadel to an LDAP directory [Yes]: <span
2388 style="font-weight: bold;">Yes</span><br>Host name of LDAP server []: <span
2389 style="font-weight: bold;">127.0.0.1</span><br>Port number of LDAP service [389]: <span
2390 style="font-weight: bold;">389</span><br>Base DN []: <span
2391 style="font-weight: bold;">dc=servername,dc=domain,dc=org</span><br>Bind DN []: <span
2392 style="font-weight: bold;">cn=manager,dc=servername,dc=domain,dc=org</span><br>Password for bind DN []: <span
2393 style="font-weight: bold;">secret</span><br style="font-weight: bold;"><br><span
2394 style="font-style: italic;">(more questions omitted...)</span><br><br>Save this configuration? <span
2395 style="font-weight: bold;">Yes</span><br></pre>
2396 Once you've done this, restart your Citadel service with the <span
2397 style="font-weight: bold;"><span style="font-family: monospace;">.A</span></span><span
2398 style="font-family: monospace;">ide <span style="font-weight: bold;">T</span>erminate-server
2399 <span style="font-weight: bold;">N</span>ow</span> command. When
2400 Citadel restarts, it will connect to your LDAP directory. Note
2401 that we gave Citadel the same Base DN, Bind DN, and password that was
2402 in our LDAP server configuration example. Obviously, everything
2403 needs to be identical on both sides or the connection will be
2404 refused. 127.0.0.1 is the loopback address, and 389 is the
2405 standard port number for LDAP, so this would be the proper host and
2406 port combination for an LDAP service running on your local
2407 server. It could just as easily be on another server, for example
2408 an organization-wide directory server.<br>
2410 You can also configure the LDAP Connector for Citadel from a WebCit
2411 session. Log on as an Aide and click on Advanced Options -->
2412 Edit Site-Wide Configuration --> Directory, and you will be
2413 presented with the same set of questions.<br>
2415 So, what kind of information will be entered into LDAP? As a
2416 rule, anything that gets saved to your Global Address Book room will
2417 also be saved to LDAP. Citadel will set up OU's (Organizational
2418 Units) for each node on your Citadel network, so if you are running
2419 multiple Citadel servers in an organization, you will automatically
2420 have a hierarchial view built for you. Below the OU's will be an
2421 entry for each user who has a vCard registered on the system.
2422 Citadel automatically translates vCard information to LDAP.<br>
2424 If you already have a Global Address Book full of existing information,
2425 you can execute an <span style="font-family: monospace;">IGAB</span>
2426 (Initialize Global Address Book) server command to rebuild it. In
2427 addition to performing its usual function of rebuilding the internal
2428 Internet e-mail address mapping table, Citadel will also repopulate
2429 LDAP with all existing vCards. You should be aware, however, that
2430 existing LDAP entries will not be cleared from your directory
2431 server. If your directory contains only Citadel data, you can
2432 safely delete your database and start over, because it will be
2433 repopulated. Otherwise, Citadel will merely update any existing
2434 records with fresh information.<br>
2436 The LDAP Connector for Citadel is a recent development, so expect more
2437 functionality in this space in the near future.<br>
2443 <h2><a name="utilities"></a>Utilities</h2>
2445 <h3><a name="overview"></a>Overview</h3>
2446 <p>The following utilities will be discussed: </p>
2448 <li><b>aidepost</b> - Post standard input to the Aide> room </li>
2449 <li><b>whobbs</b> - Who is on the system </li>
2450 <li><b>msgform</b> - Format a binary message to the screen (stdin or
2452 <li><b>userlist</b> - Print the userlist </li>
2453 <li><b>sendcommand</b> - Send a server command </li>
2455 <p>It is up to you to decide which utilities should be made accessible
2456 only to system administrators. It is important that you set the file
2457 permissions correctly. All utilities should have access to the Citadel
2459 will attempt to address each program individually.</p>
2460 <h3><a name="aidepost"></a>aidepost</h3>
2461 <p>The nature of this program is rather simple. Standard input (stdin)
2462 is converted into a message, filed in the main message store, and
2463 posted in the Aide> room. This is useful for keeping transcripts of
2464 system activity that has to do with Citadel operations. You might even
2465 elect to send all of
2466 your system logs there, too.</p>
2467 <p><tt>aidepost</tt> also accepts the usage <tt>aidepost -rTargetRoom</tt>,
2468 where TargetRoom is the name of a room to which you'd like the message
2470 <h3><a name="whobbs"></a>whobbs</h3>
2471 <p>This program is similar to the <tt>who</tt> command. It lists all
2472 of the users who are currently connected to your Citadel server, either
2474 across a network. Unless you're running a standalone system, <tt>who</tt>
2475 and <tt>whobbs</tt> will probably not have a one-to-one
2476 correspondence. Remember
2477 that you will see sessions for SMTP, POP, and IMAP users, as well as
2479 running a Citadel client.</p>
2480 <p>One thing to keep in mind is that the <tt>whobbs</tt> utility
2481 actually opens a connection to the server. If the server is maxed out, <tt>whobbs</tt>
2482 will still be able to provide a listing, because it doesn't need to log
2483 in to execute the <tt>RWHO</tt> command. Note that whobbs does not
2484 list its own session.</p>
2485 <p>The <tt>whobbs</tt> utility is smart enough to know when it is
2486 being invoked by a web server as a CGI program. In this situation, it
2487 will output its listing
2488 as a nicely formatted web page instead of plain text. This makes it
2490 to just put a link to the whobbs binary in your cgi-bin directory,
2492 a quick and easy way for web surfers to see who is online.</p>
2493 <p>Running the <tt><b>W</b>ho is online</tt> command from the Citadel
2494 client does <b>not</b> call this utility. It has this functionality
2498 <h3><a name="msgform"></a>msgform</h3>
2499 <p>The <tt>msgform</tt> utility reads its standard input (stdin)
2501 Citadel messages stored in the internal format used on disk and over
2503 network, and sends them in a human-readable format to standard output
2504 (stdout). There is no longer much use for this program, but it is
2507 <h3><a name="userlist"></a>userlist</h3>
2508 <p>This is a program to print the userlist. There are two flags that
2510 set when running this program. When called without any arguments, <tt>userlist</tt>
2511 will display all users (except those who have chosen to be unlisted),
2512 their user numbers, times called, messages posted, screen width, and
2513 date of their most recent call.</p>
2514 <p><tt>userlist</tt> is simply the same user listing code that is in
2516 client, made into a standalone utility for convenience.<br>
2518 <h3><a name="sendcommand"></a>sendcommand</h3>
2519 <p><tt>sendcommand</tt> will interpret its arguments (except for <tt>-hDIRNAME</tt>)
2520 as a server command, which is sent to the server. Commands which
2521 require textual input will read it from stdin. Commands which generate
2522 textual output will be sent to stdout.</p>
2523 <p>This utility is intended to be used to enable Citadel server
2525 be executed from shell scripts. Review the script called <tt>weekly</tt>
2526 which ships with the Citadel distribution for an example of how this
2529 <p><b>NOTE:</b> be sure that this utility is not world-executable. It
2530 connects to the server in privileged mode, and therefore could present
2532 if not properly restricted.</p>
projects / citadel.git / blob