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