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-2003 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="#The_BBS_Login">Creating a system account for Citadel</a></li>
148 <li><a href="#Bypassing_the_login:_prompt">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="#The_citadel.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="#Logging_in_for_the_first_time">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="#Space_for_adding_your_own_client">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="#utilities">Included utilities</a></li>
219 <li><a href="#overview">Overview</a></li>
220 <li><a href="#aidepost">aidepost</a></li>
221 <li><a href="#whobbs">whobbs</a></li>
222 <li><a href="#stats">stats</a></li>
223 <li><a href="#msgform">msgform</a></li>
224 <li><a href="#userlist">userlist</a></li>
225 <li><a href="#readlog">readlog</a></li>
226 <li><a href="#sendcommand">sendcommand</a></li>
230 <hr width="100%" size="2"><br>
231 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
234 <p> Version 2, June 1991 </p>
235 <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>
236 <h3 align="justify">Preamble</h3>
237 <div align="justify"> </div>
238 <p align="justify"> The licenses for most software are designed to take
239 away your freedom to share and change it. By contrast, the GNU General
240 Public License is intended to guarantee your freedom to share and
241 change free software--to make sure the software is free for all its
242 users. This General Public License applies to most of the Free Software
243 Foundation's software and to any other program whose authors commit to
244 using it. (Some other Free Software Foundation software is covered by
245 the GNU Library General Public License instead.) You can apply it to
246 your programs, too. </p>
247 <div align="justify"> </div>
248 <p align="justify"> When we speak of free software, we are referring to
249 freedom, not price. Our General Public Licenses are designed to make
250 sure that you have the freedom to distribute copies of free software
251 (and charge for this service if you wish), that you receive source code
252 or can get it if you want it, that you can change the software or use
253 pieces of it in new free programs; and that you know you can do these
255 <div align="justify"> </div>
256 <p align="justify"> To protect your rights, we need to make
257 restrictions that forbid anyone to deny you these rights or to ask you
258 to surrender the rights. These restrictions translate to certain
259 responsibilities for you if you distribute copies of the software, or
260 if you modify it. </p>
261 <div align="justify"> </div>
262 <p align="justify"> For example, if you distribute copies of such a
263 program, whether gratis or for a fee, you must give the recipients all
264 the rights that you have. You must make sure that they, too, receive or
265 can get the source code. And you must show them these terms so they
266 know their rights. </p>
267 <div align="justify"> </div>
268 <p align="justify"> We protect your rights with two steps: (1)
269 copyright the software, and (2) offer you this license which gives you
270 legal permission to copy, distribute and/or modify the software. </p>
271 <div align="justify"> </div>
272 <p align="justify"> Also, for each author's protection and ours, we
273 want to make certain that everyone understands that there is no
274 warranty for this free software. If the software is modified by someone
275 else and passed on, we want its recipients to know that what they have
277 the original, so that any problems introduced by others will not
279 on the original authors' reputations. </p>
280 <div align="justify"> </div>
281 <p align="justify"> Finally, any free program is threatened constantly
283 software patents. We wish to avoid the danger that redistributors of a
285 program will individually obtain patent licenses, in effect making the
287 proprietary. To prevent this, we have made it clear that any patent
289 be licensed for everyone's free use or not licensed at all. </p>
290 <div align="justify"> </div>
291 <p align="justify"> The precise terms and conditions for copying,
292 distribution and modification follow. </p>
293 <div align="justify"> </div>
294 <h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
295 <div align="justify"> </div>
296 <p align="justify"> <strong>0.</strong> This License applies to any
297 program or other work which contains a notice placed by the copyright
298 holder saying it may be distributed under the terms of this General
299 Public License. The "Program", below, refers to any such program or
300 work, and a "work based on the Program" means either the Program or any
301 derivative work under copyright law: that is to say, a work containing
302 the Program or a portion of it, either verbatim or with modifications
303 and/or translated into another language. (Hereinafter, translation is
304 included without limitation in the term "modification".) Each licensee
305 is addressed as "you". </p>
306 <p align="justify"> Activities other than copying, distribution and
307 modification are not covered by this License; they are outside its
308 scope. The act of running the Program is not restricted, and the output
309 from the Program is covered only if its contents constitute a work
310 based on the Program (independent of having been made by running the
311 Program). Whether that is true depends on what the Program does. </p>
312 <p align="justify"> <strong>1.</strong> You may copy and distribute
313 verbatim copies of the Program's source code as you receive it, in any
314 medium, provided that you conspicuously and appropriately publish on
315 each copy an appropriate copyright notice and disclaimer of warranty;
316 keep intact all the notices that refer to this License and to the
317 absence of any warranty; and give any other recipients of the Program a
318 copy of this License along with the Program. </p>
319 <p align="justify"> You may charge a fee for the physical act of
320 transferring a copy, and you may at your option offer warranty
321 protection in exchange for a fee. </p>
322 <p align="justify"> <strong>2.</strong> You may modify your copy or
323 copies of the Program or any portion of it, thus forming a work based
324 on the Program, and copy and distribute such modifications or work
325 under the terms of Section 1 above, provided that you also meet all of
326 these conditions: </p>
327 <p align="justify"> </p>
328 <div align="justify">
330 <li><strong>a)</strong> You must cause the modified files to carry
331 prominent notices stating that you changed the files
332 and the date of any change.
335 <li><strong>b)</strong> You must cause any work that you distribute
336 or publish, that in whole or in part contains
337 or is derived from the Program or any part thereof, to be licensed
338 as a whole at no charge to all third parties under the terms of this
342 <li><strong>c)</strong> If the modified program normally reads
343 commands interactively when run, you must cause it, when started
344 running for such interactive use in the most ordinary way, to print or
345 display an announcement including an appropriate copyright notice and a
346 notice that there is no warranty (or else, saying that you provide a
347 warranty) and that users may redistribute the program under these
348 conditions, and telling the user how to view a copy of this License.
349 (Exception: if the Program itself is interactive but does not normally
350 print such an announcement, your work based on the Program is not
351 required to print an announcement.) </li>
353 These requirements apply to the modified work as a whole. If
354 identifiable sections of that work are not derived from the Program,
355 and can be reasonably considered independent and separate works in
356 themselves, then this License, and its terms, do not apply to those
357 sections when you distribute them as separate works. But when you
358 distribute the same sections as part of a whole which is a work based
359 on the Program, the distribution of the whole must be on the terms of
360 this License, whose permissions for other licensees extend to the
362 whole, and thus to each and every part regardless of who wrote it. </div>
363 <p align="justify"> Thus, it is not the intent of this section to claim
365 or contest your rights to work written entirely by you; rather, the
367 is to exercise the right to control the distribution of derivative or
369 works based on the Program. </p>
370 <p align="justify"> In addition, mere aggregation of another work not
371 based on the Program with the Program (or with a work based on the
372 Program) on a volume of a storage or distribution medium does not bring
373 the other work under the scope of this License. </p>
374 <p align="justify"> <strong>3.</strong> You may copy and distribute
375 the Program (or a work based on it, under Section 2) in object code or
376 executable form under the terms of Sections 1 and 2 above provided that
377 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. -->
379 <div align="justify">
381 <li><strong>a)</strong> Accompany it with the complete corresponding
382 machine-readable source code, which must be distributed under the terms
383 of Sections 1 and 2 above on a medium customarily used for software
387 <li><strong>b)</strong> Accompany it with a written offer, valid for
388 at least three years, to give any third party, for a charge no more
389 than your cost of physically performing source distribution, a complete
390 machine-readable copy of the corresponding source code, to be
391 distributed under the terms of Sections 1 and 2 above on a medium
392 customarily used for software interchange; or,
395 <li><strong>c)</strong> Accompany it with the information you
396 received as to the offer to distribute corresponding source code. (This
397 alternative is allowed only for noncommercial distribution and only if
398 you received the program in object code or executable form with such an
399 offer, in accord with Subsection b above.) </li>
401 The source code for a work means the preferred form of the work for
402 making modifications to it. For an executable work, complete source
403 code means all the source code for all modules it contains, plus any
404 associated interface definition files, plus the scripts used to control
405 compilation and installation of the executable. However, as a special
406 exception, the source code distributed need not include anything that
407 is normally distributed (in either source or binary form) with the
408 major components (compiler, kernel, and so on) of the operating system
409 on which the executable runs, unless that component itself accompanies
410 the executable. </div>
411 <p align="justify"> If distribution of executable or object code is
412 made by offering access to copy from a designated place, then offering
413 equivalent access to copy the source code from the same place counts as
414 distribution of the source code, even though third parties are not
416 copy the source along with the object code. </p>
417 <p align="justify"> <strong>4.</strong> You may not copy, modify,
418 sublicense, or distribute the Program except as expressly provided
419 under this License. Any attempt otherwise to copy, modify, sublicense
420 or distribute the Program is void, and will automatically terminate
421 your rights under this License. However, parties who have received
422 copies, or rights, from
423 you under this License will not have their licenses terminated so long
424 as such parties remain in full compliance. </p>
425 <p align="justify"> <strong>5.</strong> You are not required to accept
426 this License, since you have not signed it. However, nothing else
427 grants you permission to modify or distribute the Program or its
428 derivative works. These actions are prohibited by law if you do not
429 accept this License. Therefore, by modifying or distributing the
430 Program (or any work based on the Program), you indicate your
431 acceptance of this License to do so, and all its terms and conditions
432 for copying, distributing or modifying the Program or works based on
434 <p align="justify"> <strong>6.</strong> Each time you redistribute the
436 (or any work based on the Program), the recipient automatically
438 license from the original licensor to copy, distribute or modify the
439 Program subject to these terms and conditions. You may not impose any
440 further restrictions on the recipients' exercise of the rights granted
441 herein. You are not responsible for enforcing compliance by third
442 parties to this License. </p>
443 <p align="justify"> <strong>7.</strong> If, as a consequence of a
444 court judgment or allegation of patent infringement or for any other
445 reason (not limited to patent issues), conditions are imposed on you
446 (whether by court order, agreement or otherwise) that contradict the
447 conditions of this License, they do not excuse you from the conditions
448 of this License. If you cannot distribute so as to satisfy
449 simultaneously your obligations under this License and any other
450 pertinent obligations, then as a consequence you may not distribute the
451 Program at all. For example, if a patent license would not permit
452 royalty-free redistribution of the Program by all those who receive
453 copies directly or indirectly through you, then the only way you could
454 satisfy both it and this License would be to refrain entirely from
455 distribution of the Program. </p>
456 <p align="justify"> If any portion of this section is held invalid or
457 unenforceable under any particular circumstance, the balance of the
458 section is intended to apply and the section as a whole is intended to
459 apply in other circumstances. </p>
460 <p align="justify"> It is not the purpose of this section to induce you
462 infringe any patents or other property right claims or to contest
463 validity of any such claims; this section has the sole purpose of
464 protecting the integrity of the free software distribution system,
465 which is implemented by public license practices. Many people have made
466 generous contributions to the wide range of software distributed
467 through that system in reliance on consistent application of that
468 system; it is up to the author/donor to decide if he or she is willing
469 to distribute software through any other system and a licensee cannot
470 impose that choice. </p>
471 <p align="justify"> This section is intended to make thoroughly clear
472 what is believed to be a consequence of the rest of this License. </p>
473 <p align="justify"> <strong>8.</strong> If the distribution and/or use
475 the Program is restricted in certain countries either by patents or by
477 interfaces, the original copyright holder who places the Program under
479 License may add an explicit geographical distribution limitation
481 those countries, so that distribution is permitted only in or among
483 not thus excluded. In such case, this License incorporates the
485 as if written in the body of this License. </p>
486 <p align="justify"> <strong>9.</strong> The Free Software Foundation
487 may publish revised and/or new versions of the General Public License
488 from time to time. Such new versions will be similar in spirit to the
489 present version, but may differ in detail to address new problems or
491 <p align="justify"> Each version is given a distinguishing version
492 number. If the Program specifies a version number of this License which
493 applies to it and "any later version", you have the option of following
494 the terms and conditions either of that version or of any later version
495 published by the Free Software Foundation. If the Program does not
496 specify a version number of this License, you may choose any version
498 the Free Software Foundation. </p>
499 <p align="justify"> <strong>10.</strong> If you wish to incorporate
500 parts of the Program into other free programs whose distribution
501 conditions are different, write to the author to ask for permission.
502 For software which is copyrighted by the Free Software Foundation,
503 write to the Free Software Foundation; we sometimes make exceptions for
504 this. Our decision will be guided by the two goals of preserving the
506 derivatives of our free software and of promoting the sharing and reuse
507 of software generally. </p>
508 <p align="justify"><strong>NO WARRANTY</strong></p>
509 <div align="justify"> </div>
510 <p align="justify"> <strong>11.</strong> BECAUSE THE PROGRAM IS
511 LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE
512 EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN
513 WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
514 "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
515 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
516 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK
517 AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
518 THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
519 SERVICING, REPAIR OR CORRECTION. </p>
520 <p align="justify"> <strong>12.</strong> IN NO EVENT UNLESS REQUIRED
521 BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
522 ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS
523 PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
525 INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY
526 TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
527 BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
528 OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN
529 IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
532 <p align="justify"> </p>
533 <h3>END OF TERMS AND CONDITIONS</h3>
535 <hr width="100%" size="2"><br>
537 <h2><a name="Installation"></a>Installation</h2>
539 <div align="justify">
541 <p>Citadel/UX is an advanced, multiuser, client/server messaging system
542 suitable for BBS, e-mail, and groupware applications. It is designed to
543 handle the needs of both small dialup systems and large-scale
544 Internet-connected systems. It was originally developed on an Altos
545 system running Xenix, and has been installed and tested on various Unix
546 and Unix-like platforms. The current development environment (and
547 public BBS) is an ordinary Linux system. The current distribution
550 <li>The Citadel/UX server (this is the back end that does all
552 <li>A text-based client program designed with the traditional Citadel
553 "look and feel" (room prompts, dot commands, and the like) </li>
554 <li>Setup programs </li>
555 <li>A set of utilities for system administration and maintenance </li>
556 <li>Documentation </li>
558 <p>Some knowledge of the Unix system is necessary to install and manage
559 the system. It is mandatory that the sysop have "root" access to the
560 operating system. The following are required to install Citadel/UX: </p>
562 <li>A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX) </li>
563 <li>C compiler (<a href="http://gcc.gnu.org/">GCC</a> with <a
564 href="http://www.gnu.org/software/make/make.html">gmake</a> is the
565 recommended build environment) </li>
566 <li>POSIX threads (already present on most systems) </li>
568 <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1 or newer</li>
569 <li><a href="http://softwarestudio.org/libical/">libical</a> v0.24 or
570 newer (if you want the calendar service to work)<br>
572 <li>Enough disk space to hold all of the programs and data </li>
574 <p>If you are running Citadel/UX on a Linux system, it is STRONGLY
575 recommended that you run it on a recent distribution (such as <a
576 href="http://www.redhat.com">Red Hat</a> 7.3 or newer). A new-ish
577 distribution will have most or all of the prerequisite tools and
578 libraries already integrated for you.</p>
579 <h3>Now available:</h3>
581 <li>"WebCit", a gateway program to allow full access to Citadel via
582 the World Wide Web. Interactive access through any Web browser. </li>
583 <li>Access to Citadel via <i>any</i> standards-compliant e-mail
584 program, thanks to Citadel's built-in SMTP, POP, and IMAP services.
585 You can use Netscape/Mozilla, Evolution, Eudora, Pine, or even
587 VirusSpreader (better known as "Outlook") with Citadel. </li>
589 <h3>Coming soon:</h3>
591 <li>Newer and better GUI-based clients.</li>
593 <h3><a name="Everything_in_its_place..."></a>Everything in its place...</h3>
594 <p>Hopefully you've unpacked the distribution archive into its own
595 directory. This is the directory in which all Citadel files are located
597 which all activity will take place. Several subdirectories have already
598 been created during the unpacking process, and others may be created
599 by the software if needed. Make sure you have Berkeley DB installed on
600 your system, and that you have all the development libraries and
602 in place so that you can compile against them. If you don't, you can
603 get the latest Berkeley DB at <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
604 If your operating system uses a separate library to support POSIX
605 threads (pthreads), make sure that library is installed as well. This
606 is almost never the case with Linux, but some commercial Unix flavors
610 <h3><a name="The_BBS_Login"></a>Creating a system account for Citadel</h3>
611 <p>As with many Unix programs, Citadel wants to run under its own user
612 ID. Unlike other programs, however, this user ID will do double-duty as
613 a public login for your system if you are running a BBS. This account
614 is typically called "bbs" or "citadel" or something to that effect. You
615 will tell Citadel what the user-id of that account is, and when someone
616 logs in under that account, Citadel will prompt for a user name.</p>
617 <p>The Citadel user should have a unique uid. The home directory should
618 be the one your Citadel installation resides in (in this example we
619 will use <tt>/usr/local/citadel</tt>) and the shell should be either
621 that directory, or a script that will start up the citadel client.
623 <pre>bbs::100:1:Citadel Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
624 <p>When you run setup later, you will be required to tell it the
625 username or user ID of the account you created is, so it knows what
626 user to run as. If you create an account called <tt>bbs</tt>, <tt>guest</tt>,
627 or <tt>citadel</tt>, the setup program will automatically pick up the
628 user ID by default.</p>
629 <p>For all other users in /etc/passwd, Citadel will automatically set
631 an account using the full name (or 'gecos' in Unixspeak) of the user.
632 It'll also ignore any password you supply, because it uses the user's
634 on the host system. This allows a 'single sign on' type of environment.
635 Note that this does have to be enabled at compile time -- it's the
637 option called <tt>--enable-autologin</tt>. Keep in mind that these
639 can use *either* their Citadel login name or their login name on the
641 computer, and their password on the host computer.<br>
644 <h3><a name="Bypassing_the_login:_prompt"></a>Bypassing the <tt>login:</tt>
646 <p>If you normally log in to your host system using some method other
647 than telnet (such as ssh), you might want the telnet service to go
648 straight into Citadel, instead of displaying the <tt>login:</tt>
650 can do this by having telnetd start citadel directly instead of <tt>/bin/login</tt>.
651 This is actually very simple to implement; all you need to do is make a
652 simple change to your <tt>inetd</tt> or <tt>xinetd</tt>
653 configuration. Here are some configuration examples.</p>
654 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
655 replacing any existing telnet configuration line already there):</p>
656 <pre>telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel<br></pre>
657 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
658 then simply replace that file with this one):</p>
659 <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>
660 <p>Please make sure you know what you're doing before you install this!
662 you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
663 then change the directory name accordingly. If you know of any other
664 local peculiarities which need to be observed, edit the above
666 accordingly as well. And, of course, if you're working remotely, make
667 sure you can successfully log in using SSH <b>before</b> you start
669 your telnet configuration, otherwise you could lock yourself out of
671 system (ask any networking specialist about the dangers of "working
673 -- then pull up a chair and get a fresh cup of coffee, because you're
675 to hear some war stories).<br>
678 <h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
679 <p>You can easily compile the Citadel system with the following
681 <pre>./configure<br>make<br>make install<br></pre>
682 <p>The 'configure' script will generate a Makefile from the
684 and it will also write the file "sysdep.h" to your Citadel directory.
685 Please do not edit sysdep.h or Makefile.in yourself. The configure
687 figure out your system dependencies and set everything correctly.</p>
688 <p>Mac OS X 10.1 and later are now supported. (Sorry, 10.0 cannot be
689 supported, now or in the future.) You need to install the Developer
690 Tools CD, which you can purchase or download for free from <a
691 href="http://developer.apple.com">http://developer.apple.com</a>. Then
692 run configure like this:</p>
693 <pre>env CC=/usr/bin/cc ./configure (options - see below)<br></pre>
694 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
695 If you wish to place it in a different directory, you can instead do:</p>
696 <pre>./configure --prefix=/export/home/citadel (or whatever)<br></pre>
697 <p>If you've got Berkeley DB installed in a non-standard location, you
698 can help the configure script find it by doing something like this:</p>
699 <pre>./configure --with-db=/usr/local/BerkeleyDB-4.1<br></pre>
700 <p>Keep in mind that if you're using Berkeley DB from a non-standard
702 you'll have to make sure that location is available at runtime.</p>
703 <p>File permissions are always a bother to work with. You don't want
704 Citadel to crash because someone couldn't access a file, but you also
705 don't want shell users peeking into the binaries to do things like
706 reading others' mail, finding private rooms, etc. The Citadel server
707 needs to be started as root in order to bind to privileged ports, but
708 as soon as its initialization is finished, it changes its user ID to
709 your Citadel user in order to avoid security holes.</p>
710 <h3><a name="Upgrading"></a>Upgrading</h3>
711 <p>Any existing Citadel installation which is at version 5.50 or newer
712 may be upgraded in place without the need to discard your existing data
714 <p>Upgrading to a new version uses the same build procedure as
716 the program for a fresh install, except that you want to do <tt>make
717 install-exec</tt> instead of <tt>make install</tt>. This will
718 overwrite the programs but not your data. <b>Be sure to shut down
719 citserver during this process!</b> If Citadel is running while you
720 upgrade, you may face data corruption issues.<br>
722 <p>After doing <tt>make install-exec</tt>, you should run <tt>setup</tt>
723 again to bring your data files up to date. Please see the setup section
724 below for more information on this.</p>
725 <h3><a name="The_citadel.rc_file"></a>The <tt>citadel.rc</tt> file</h3>
726 <p>The text-based client included with Citadel is suitable for BBS
727 applications. Much of its command set and other behavior is
728 configurable through a Run Control (RC) file. The standard client looks
729 for this file in the following locations: </p>
731 <li><tt>$HOME/.citadelrc</tt></li>
732 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
733 <li><tt>/etc/citadel.rc</tt></li>
734 <li><i>current-directory</i><tt>/citadel.rc</tt></li>
736 The next couple of sections deal with client-side configuration.
737 <h3><a name="Using_an_external_editor_for_message"></a>Using an
739 for message composition</h3>
740 <p>Citadel/UX has a built-in message editor. However, you can also use
741 your favorite text editor to write messages. To do this you simply put
742 a line in your citadel.rc file like this:</p>
743 <pre>editor=/usr/bin/vi<br></pre>
744 <p>The above example would make Citadel call the vi editor when using
745 the <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make
746 it the default editor for the <tt><b>E</b>nter</tt> command by editing
747 the <tt>citadel.rc</tt> file. <b>But be warned:</b> external editors
748 on public systems can
749 be a security hole, because they usually provide users with the ability
750 to drop into a shell on the host system, or save files using names
752 than the name of the temporary file they are editing. If you intend to
753 use an external editor on a public BBS, make sure you use one that has
755 hardened for such a purpose -- one which has had the 'shell' and 'save
757 commands disabled, as well as any other functions which a destructive
758 user could use to gain unauthorized access to your host system.</p>
759 <h3><a name="Printing_messages"></a>Printing messages</h3>
760 <p>Citadel/UX can send messages to a printer, or just about anywhere
761 else in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt>
762 specifies what command you use to print. Text is sent to the standard
763 input (stdin) of the print command.</p>
764 <p>So if you did this:</p>
765 <pre>printcmd="nl|pr|lpr -Plocal"<br></pre>
766 <p>...that would add line numbers, then paginate, then print on the
767 printer named "local". There's tons of stuff you can do with this
768 feature. For example, you could use a command like <tt>cat
769 <<$HOME/archive</tt> to save copies of important messages in a
770 textfile. Again, this is probably something you don't want to configure
771 for a public BBS host -- most system administrators don't want remote
772 users sending arbitrary things to local printers.</p>
773 <h3><a name="URL_viewing"></a>URL viewing</h3>
774 <p>This is one more feature which is appropriate for local users. While
776 a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
777 command, and it will perform some pre-defined action (usually, this is
778 to open up the URL in a web browser). For example:</p>
779 <pre>urlcmd=netscape -remote "openURL(%s)"<br></pre>
780 <p>In the above example, it would open up the URL in an open <a
781 href="http://www.netscape.com/download">Netscape</a> window.<br>
784 <h3><a name="Setup_and_login"></a>Setup and login</h3>
785 <p>Before logging in for the first time, you must run the setup
786 program. To begin this procedure, enter the following commands:</p>
787 <pre>cd /usr/local/citadel<br>./setup<br></pre>
788 <p>The setup program will guide you through a simple configuration
789 procedure. It will ask you what directory to place your data files in
790 -- the default is the current directory, which is usually the sensible
791 thing to select. If you want to run more than one instance of Citadel
792 on the same host, however, you can specify a different directory here
793 -- just remember to specify the directory name again when you start up
794 the server later on.</p>
795 <p><tt>setup</tt> will then shut down the Citadel service if it is
798 <p>You will then be prompted for the name of the system administrator.
799 This is not merely a cosmetic option -- when you log in to your system
800 a little while from now, you'll log in with this name, and it will
801 automatically assign your account the highest access level.</p>
802 <p>Next, you will be prompted for the User ID of the Citadel account on
803 your host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
804 or <tt>citadel</tt>, that account's UID will be the default. If you
805 are upgrading or reconfiguring an existing system, the existing value
806 will be preserved.</p>
807 <p>Then you will be prompted for a server port number. This is the TCP
808 port which Citadel clients use to connect to your Citadel server. In
809 almost all cases, you want to use the default -- port 504, which is the
810 official port number assigned by the IANA for Citadel implementations.</p>
811 <p>The Citadel service will then be started, and you will see the
812 following message:</p>
813 <pre>Setup is finished. You may now log in.<br></pre>
814 <p>Setup is now complete, on most systems, anyway. Please see below to
815 find out if you need to do anything else:</p>
816 <h3><a name="Configuring_your_host_system_to_start"></a>Configuring
818 system to start the service</h3>
819 <p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
820 and <tt>/etc/inittab</tt> in order to configure your host system to
821 automatically start the Citadel service. <tt>setup</tt> will
822 automatically perform these steps if it can, and if you allow it to --
823 just answer 'Yes' when prompted, and everything will be taken care of
824 for you. If you answer 'No' -- or if your system is a little bit odd
825 (for example, BSD systems don't have <tt>/etc/inittab</tt>) -- read
826 this section and do what you need to in order to get things configured.</p>
827 <p>Before you can use Citadel, you must define the "citadel" service to
828 your system. This is accomplished by adding a line to your
829 /etc/services file that looks something like this:</p>
830 <pre>citadel 504/tcp # Citadel/UX Server<br></pre>
831 <p>504 is the port number officially designated by the IANA for use by
832 Citadel. There should not be any need to use a different port number,
833 unless you are running multiple Citadels on the same computer and
835 a different port for each one.</p>
836 <p>The next step is to arrange for the server to start. The <tt>citserver</tt>
837 program is the main Citadel server. Before we cover the recommended
838 method of starting the server, let's examine its usage options:</p>
839 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-d] [-f]<br></pre>
840 <p>The options are as follows:</p>
841 <p><tt>-hHomeDir</tt> - the directory your Citadel data files live in.
842 This should, of course, be a directory that you've run the <tt>setup</tt>
843 program against to set up some data files. If a directory is not
844 specified, the directory
845 name which was specified in the <tt>Makefile</tt> will be used.</p>
846 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed.
848 available debugging levels are: </p>
850 <li>1 - Internal errors (failed thread creation, malloc problems,
852 <li>2 - Network errors (broken sockets, failed socket creation) </li>
853 <li>3 - Begin and end of sessions, startup/shutdown of server </li>
854 <li>5 - Server commands being sent from clients </li>
855 <li>7 - Entry and exit of various functions </li>
856 <li>9 - Various debugging checkpoints (insanely verbose) </li>
858 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace
859 output. Normally it is sent to stdout.</p>
860 <p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch
861 would be necessary if you were starting the Citadel server, for
862 example, from an rc.local script (which is not recommended, because
863 this won't allow the server to automatically restart when it is shut
865 <p><tt>-f</tt> - Defragment all the databases upon startup. This
866 currently has no effect, as it is a vestige from the old data store.</p>
867 <p>The preferred method of starting the Citadel server is to place an
868 entry in your /etc/inittab file. This will conveniently bring the
869 server up when your system is up, and terminate it gracefully when your
870 system is shutting down. The exact syntax for your system may vary, but
871 here's an entry that could be used on a Linux system:</p>
872 <pre>cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x3<br></pre>
873 <p>In this example, we've chosen debugging level 3, and have the trace
874 stuff output to one of the virtual consoles. It's important to remember
875 to turn off any getty that is set up on that virtual console, if you do
876 this. After making this change, the command <tt>init q</tt> works on
877 most systems to tell init to re-read the file. If in doubt, just reboot
881 <h3><a name="Logging_in_for_the_first_time"></a>Logging in for the
883 <p>At this point, your system is ready to run. Run the <tt>citadel</tt>
884 program from the shell and log in as a new user. NOTE: the first user
885 account to be created will automatically be set to access level 6
886 (Aide). This overcomes some obvious logistical problems - normally,
887 Aide access is given by another Aide, but since there aren't any on
888 your system yet, this isn't possible.<br>
891 <h3><a name="Welcoming_new_users"></a>Welcoming new users</h3>
892 <p>Sometimes you might decide that you want a welcome message (or
893 several different messages) automatically mailed to new users upon
894 their first login. Now there is a way to do this. If you create a room
895 called <tt>New User Greetings</tt>, and it is a <i>private</i> room
896 (invitation-only probably makes the most sense), any messages you enter
897 into that room will automatically be delivered to all new users upon
899 <p>You can put anything you want there: a welcome message, system
900 policies, special information, etc. You can also put as many messages
901 there as you want to (although it really doesn't make sense to clutter
902 new users' mailboxes with lots of junk).</p>
903 <p>Don't worry about wasting disk space, either. Citadel has a
904 single-instance message store, so all the new users are actually
905 looking at the same copy of the message on disk.<br>
908 <h3><a name="Space_for_adding_your_own_client"></a>Space for adding
910 client features (doors)</h3>
911 <p><b>Please take note!</b> This function really represents the "old"
912 way of doing things, and it doesn't fit in well with the client/server
913 paradigm. Please consider it "deprecated" because it may be removed
915 <p>The "doorway" feature is just a generic way to add features to the
916 system. It is called "Doorway" to make it resemble the doors on
917 non-Unix boards, but as we all know, us Unix types don't have to write
918 special code to access the modem. :-) Anyway, when a user hits the <tt><b>*</b></tt>
919 (doorway) command, Citadel does...</p>
920 <pre>USERNAME=(username); export USERNAME<br>./subsystem (user-number) (screen-width) (access level)<br></pre>
921 <p>...so you can put whatever you want in there. I suggest putting in a
923 program to allow the users to pick one of a number of programs, etc. Do
924 be aware that door programs will only be available when the client and
926 programs are running on the <i>same</i> computer, and when the user is
928 the text-mode client. Because of these restrictions, Door programs are
930 utilized less and less every day.<br>
933 <h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and
935 <p>That's just about all the information you need to install the
936 system. But if you get stuck, you can visit <a
937 href="http://uncensored.citadel.org">UNCENSORED! BBS</a> and report a
938 problem or ask for help. But if you intend to report a problem getting
939 the Citadel server to run, <i>please</i> double-check the following
942 <li>Did you do <tt>./configure && make && make
943 install</tt> ?? </li>
944 <li>Did you run setup? </li>
945 <li>Did you start the server? </li>
947 <p>To report a problem, you can log on to <a
948 href="http://uncensored.citadel.org">UNCENSORED!</a> or any other BBS
949 on the Citadel network which carries the <tt>Citadel/UX></tt> room.
950 Please DO NOT e-mail the developers directly. Post a request for help
951 on the BBS, with all of the following information: </p>
953 <li>The exact nature of your difficulty </li>
954 <li>A transcript of the error message(s) if possible </li>
955 <li>The version of Citadel you are running </li>
956 <li>The version of Berkeley DB present on your system </li>
957 <li>Which operating system you are running, and what version </li>
958 <li>If you are running a Linux system, we need to know which
959 distribution, and the version of the kernel, libc, and pthreads you
960 are using (it would help to post the output of a <tt>ldd ./citserver</tt>
965 <hr width="100%" size="2">
966 <h2><a name="sysop"></a>System Administration</h2>
968 <div align="justify">
969 <h3><a name="Overview_"></a>Overview</h3>
970 <p>Citadel/UX, when installed properly, will do most of its maintenance
971 by itself. It is intended to be run unattended for extended periods of
972 time, and most installations do just that without any software failures.</p>
973 <p>The system has seven access levels. Most users are at the bottom and
975 no special privileges. Aides are selected people who have special
977 the Citadel program. Room Aides only have this access in a certain
978 room. Preferred users can be selected by Aides for access to preferred
979 only rooms. A sysop is anyone who has access to the various sysop
981 are in their own executable files, which should have their permissions
983 to allow only sysops to run them. You should either create a sysops
985 in /etc/group, or use some other existing group for this purpose.</p>
986 <p>Aides have access to EVERY room on the system, public and private
987 (all types). They also have access to commands starting with <tt>.<b>A</b>ide</tt>
988 in addition to being able to delete and move messages. The system room,
989 <tt>Aide></tt>, is accessible only by those users designated as
991 <h3><a name="Aide_commands"></a>Aide commands</h3>
992 <p>Aides have the following commands available to them that are not
993 available to normal users. They are:</p>
997 <td width="30%"><tt> .<b>A</b>ide <b>K</b>ill this room </tt></td>
998 <td> Deletes the current room from the system. </td>
1001 <td width="30%"><tt> .<b>A</b>ide <b>E</b>dit this room </tt></td>
1002 <td> Allows editing of the properties of the current room. This
1003 is explained in greater detail below. </td>
1006 <td width="30%"><tt> .<b>A</b>ide <b>W</b>ho knows room </tt></td>
1007 <td> For private rooms with access controls, or mailbox rooms,
1008 this command displays a list of users who have access to the current
1012 <td width="30%"><tt> .<b>A</b>ide edit <b>U</b>ser </tt></td>
1013 <td> Allows editing of the properties of any user account
1014 on the system. </td>
1017 <td width="30%"><tt> .<b>A</b>ide <b>V</b>alidate new users </tt></td>
1018 <td> For public access systems, this command reviews all new user
1019 registrations and allows you to set each new user's access level (or
1020 simply delete the accounts). </td>
1023 <td width="30%"><tt> .<b>A</b>ide enter <b>I</b>nfo file </tt></td>
1024 <td> Each room may contain a short textual description of
1025 its purpose, which is displayed to users upon entering the room for the
1026 first time (or in the room banner, for users of the Web client). This
1027 command allows you to enter or edit that description. </td>
1030 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite
1032 <td> Access control command to grant any specific user access to
1033 a private room. </td>
1036 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick
1038 <td> Access control command to revoke any specifc user's access
1039 to the current room. This works regardless of whether the room is
1040 public or private. </td>
1043 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>D</b>elete </tt></td>
1044 <td> If the current room has an associated file directory, this
1045 command may be used to delete files from it. </td>
1048 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end
1050 <td> If the current room has an associated file directory, this
1051 command may be used to transmit a copy of any file in that directory to
1052 another node on a Citadel network. </td>
1055 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>M</b>ove </tt></td>
1056 <td> If the current room has an associated file directory, this
1057 command may be used to move any file in that directory to another room.
1058 The target room must also have an associated file directory. </td>
1061 <td width="30%"><tt> .<b>A</b>ide <b>M</b>essage edit </tt></td>
1062 <td> This command allows editing of any of the various system
1063 banners and messages which are displayed to users. Type the name of
1064 the banner or message you wish to edit. </td>
1067 <td width="30%"><tt> .<b>A</b>ide <b>P</b>ost </tt></td>
1068 <td> This is the functional equivalent of the <tt><b>E</b>nter
1069 message</tt> command available to all users, except that it allows you
1070 to post using any user name. </td>
1073 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>G</b>eneral
1075 <td> This command allows configuration of a large number of
1076 global settings for your Citadel system. These settings will be
1077 explained in greater detail below. </td>
1080 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>I</b>nternet
1082 <td> This command allows configuration of settings which affect
1083 how your Citadel system sends and receives messages on the Internet. </td>
1086 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1087 check <b>M</b>essage base </tt></td>
1088 <td> Perform a consistency check on your message store. This is a
1089 very time-consuming operation which should not be performed unless you
1090 have reason to believe there is trouble with your database. </td>
1093 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>N</b>etwork
1095 <td> Configure networking (e-mail, room sharing, etc.) with other
1096 Citadel nodes. </td>
1099 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1100 network <b>F</b>ilter list </tt></td>
1101 <td> If you are on a large public or semi-public network of
1102 Citadel nodes and you find content from certain systems or individuals
1103 objectionable, you can use this command to define a rule set to
1104 automatically reject those messages when they arrive on your system. </td>
1107 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>N</b>ow
1109 <td> Immediately shut down the Citadel service, disconnecting any
1110 users who are logged in. Please keep in mind that it will start
1111 right back up again if you are running the service from <tt>/etc/inittab</tt>,
1112 so in practice this command will probably not get much use. </td>
1115 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>S</b>cheduled
1117 <td> Shut down the Citadel service the next time there are zero
1118 users connected. This allows you to automatically wait until all users
1119 are logged out. </td>
1122 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients
1124 <td> Any room may be made into a mailing list. Enter this command
1125 to open an editor window containing the list of Internet e-mail
1126 addresses to which every message posted in the room will be sent. </td>
1129 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest
1130 recipients </tt></td>
1131 <td> Similar to the regular mailing list command, except the
1132 messages will be sent out in 'digest' form -- recipients will see
1133 messages from the address of the room itself rather than the address of
1134 the author of each message, and a digest may contain more than one
1135 message. Each room may have any combination of List and Digest
1139 <td width="30%"><tt> .<b>A</b>ide <b>N</b>etwork room sharing </tt></td>
1140 <td> Configures the sharing of the current room's contents with
1141 other Citadel nodes. Messages posted in this room on any Citadel system
1142 will automatically be replicated to other Citadel systems carrying the
1149 <h3><a name="Editing_rooms"></a>Editing rooms</h3>
1150 <p>This command allows any aide to change the parameters of a room. Go
1151 to the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit
1152 room</tt> command. A series of prompts will be displayed. The existing
1153 parameters will be displayed in brackets; simply press return if you
1155 to leave any or all of them unchanged.</p>
1156 <pre> <br>Room name [IG's Fun Room]:<br></pre>
1157 <p>...the name of the room.</p>
1158 <pre>Private room [Yes]? <br></pre>
1159 <p>...enter Yes if you wish to restrict access to the room, or no if
1161 is to be accessible by all users. Note that Citadel doesn't bother
1163 about access to rooms every time they need to access the room. Once a
1165 gains access to a private room, it then behaves like a public room to
1167 The following four questions will only be asked if you selected
1169 <pre>Accessible by guessing room name [No]?<br></pre>
1170 <p>...if you enter Yes, the room will not show up in users' <tt><b>K</b>nown
1171 rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing
1172 the room's full name), they will gain access to the room.</p>
1173 <pre>Accessible by entering a password [No]?<br>Room password [mypasswd]: <br></pre>
1174 <p>...this adds an additional layer of security to the room, prompting
1175 users for a password before they can gain access to the room.</p>
1176 <p>If you did not select guessname or passworded, then the only way
1177 users can access the room is if an Aide explicitly invites them to the
1178 room using the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt>
1180 <pre>Cause current users to forget room [No] ? No<br></pre>
1181 <p>Enter Yes if you wish to kick out anyone who currently has access to
1183 <pre>Preferred users only [No]? No<br></pre>
1184 <p>Enter Yes if you wish to restrict the room to only users who have
1185 level 5 (Preferred User) status (and Aides too, of course). You should
1186 make the room public if you intend to do this, otherwise the two
1187 restrictions will be COMBINED.</p>
1188 <pre>Read-only room [No]? No<br></pre>
1189 <p>If you set a room to Read-Only, then normal users will not be
1191 post messages in it. Messages may only be posted by Aides, and by
1192 utility programs such as the networker and the "aidepost" utility. This
1194 useful in situations where a room is used exclusively for important
1195 announcements, or if you've set up a room to receive an Internet
1197 list and posting wouldn't make sense. Other uses will, of course,
1199 apparent as the need arises.</p>
1200 <p>Now for a few other attributes...</p>
1201 <pre>Directory room [Yes]? Yes<br></pre>
1202 <p>...enter Yes if you wish to associate a directory with this room.
1203 This can be used as a small file repository for files relevant to the
1204 topic of the room. If you enter Yes, you will also be prompted with the
1205 following four questions:</p>
1206 <pre>Directory name [mydirname]: <br></pre>
1207 <p>...the name of the subdirectory to put this room's files in. The
1208 name of the directory created will be <tt><i><your Citadel
1209 directory></i>/files/<i><room dir name></i></tt>.</p>
1210 <pre>Uploading allowed [Yes]? Yes<br></pre>
1211 <p>...enter Yes if users are allowed to upload to this room.</p>
1212 <pre>Downloading allowed [Yes]? Yes<br></pre>
1213 <p>...enter Yes if users are allowed to download from this room.</p>
1214 <pre>Visible directory [Yes]? Yes<br></pre>
1215 <p>...enter Yes if users can read the directory of this room.</p>
1216 <pre>Network shared room [No]? No<br></pre>
1217 <p>...you can share a room over a network without setting this flag,
1219 vice versa, but what this flag does is twofold: </p>
1221 <li>It prevents people with no network access from entering messages
1223 <li>Messages are displayed with the name of their originating
1224 system in the header. </li>
1226 <pre>Permanent room [No]? No<br></pre>
1227 <p>Citadel contains an 'auto purger' which is capable of removing rooms
1228 which have not been posted in for a pre-defined period of time (by
1230 this is set to two weeks). If you wish to keep this from happening to
1231 a particular room, you can set this option. (Keep in mind that <tt>Lobby></tt>,
1232 <tt>Aide></tt>, any private mailbox rooms, any network shared rooms,
1233 and any rooms with a file directory are automatically permanent.)</p>
1234 <pre>Anonymous messages [No]? No<br>Ask users whether to make messages anonymous [No]? No<br></pre>
1235 <p>...you can have rooms in which all messages are automatically
1236 anonymous, and you can have rooms in which users are prompted whether
1238 message anonymous when they enter it. The real identity of the author
1239 of each message is still revealed to the Room Aide for this room, as
1241 as any system-wide Aides.</p>
1242 <pre>Room aide [Joe Responsible]: <br></pre>
1243 <p>...on larger systems, it helps to designate a person to be
1244 responsible for a room. Room Aides have access to a restricted set of
1245 Aide commands, ONLY when they are in the room in which they have this
1246 privilege. They can edit the room, delete the room, delete and move
1247 messages, and invite or kick out users (if it is a private room), but
1248 they cannot perform aide commands that are not room-related (such as
1249 changing users access levels).</p>
1250 <pre>Listing order [64]: <br></pre>
1251 <p>This is just a simple way to try to control the order rooms are
1252 listed in when users call up a <tt><b>K</b>nown Rooms</tt> listing.
1253 Rooms with a lower listing order are displayed prior to rooms with a
1254 higher listing order. It has no other effect. For users who list rooms
1255 in floor order, the display will sort first by floor, then by listing
1257 <pre>Message expire policy (? for list) [0]:<br></pre>
1258 <p>This provides you with the opportunity to select how long each
1259 message will remain in a room before automatically being deleted. Press
1260 <tt><b>?</b></tt> for a list of options. You can choose to keep
1261 messages around forever (or until they are manually deleted), until
1262 they become a certain number of days old, or until a certain number of
1263 additional messages are posted in the room, at which time the oldest
1264 ones will scroll out.</p>
1265 <p>You will notice that you can also fall back to the default expire
1266 policy for the floor upon which the room resides. This is the default
1267 setting. You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit
1268 floor</tt> command. The default setting for the floor default, in turn,
1269 is the system default setting, which can be changed using the <tt><b>.A</b>ide
1270 <b>S</b>ystem configuration <b>G</b>eneral</tt> command.</p>
1271 <pre>Save changes (y/n)? Yes<br></pre>
1272 <p>...this gives you an opportunity to back out, if you feel you really
1273 messed things up while editing.<br>
1276 <h3><a name="File_directories"></a>File directories</h3>
1277 <p>If you have created any directory rooms, you can attach file
1278 descriptions to the filenames through a special file called <tt>filedir</tt>.
1279 Each line contains the name of a file in the directory, followed by a
1280 space and then a description of the file, such as:</p>
1281 <pre>myfile.txt This is a description of my file.<br>phluff A phile phull of phluff!<br></pre>
1282 <p>...this would create file descriptions for the files <tt>myfile.txt</tt>
1283 and <tt>phluff</tt> which would be displayed along with the directory.
1284 It should also be noted that when users upload files to your system,
1285 they will be prompted for file descriptions, which will be added to the
1286 <tt>filedir</tt> file. If one does not exist, it will be created.<br>
1289 <h3><a name="Creating_and_editing_user_accounts"></a>Creating and
1290 editing user accounts</h3>
1291 <p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1292 command to create and/or edit user accounts. There are several
1293 parameters which can be set here.</p>
1294 <p>To create a user:</p>
1295 <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>
1296 <p>At this point, the new user account has been created, and the
1298 continue as if you were editing an existing account. Therefore the
1300 of this procedure is the same for creating and editing:</p>
1301 <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>
1302 <p>The blank lines are the user's 'registration' information --
1304 information such as full name, address, telephone number, etc. This
1306 will comprise the user's vCard in both their user profile and in the
1309 <pre>Change password [No]: No<br></pre>
1310 <p>...answer Yes to set or change the password for this account.</p>
1311 <pre>Access level [4]: <br></pre>
1312 <p>...this allows you to set or change the access level for this
1313 account. The access levels available are as follows: </p>
1315 <li>0 - Deleted. (This immediately deletes the account.) </li>
1316 <li>1 - New, unvalidated user </li>
1317 <li>2 - Problem user (severely restricts account - use for
1318 probationary access) </li>
1319 <li>3 - User with no network privileges. Same access as a normal user
1320 except cannot post messages in rooms shared on a network. </li>
1321 <li>4 - Normal user </li>
1322 <li>5 - Preferred user (access is granted to privileged rooms) </li>
1323 <li>6 - Aide (administrative access to the whole system) </li>
1325 <pre>Permission to send/receive Internet mail [ No]? No<br></pre>
1326 <p>If your system is configured to only allow Internet mail privileges
1327 to certain users, this is where you can grant or revoke that privilege.</p>
1328 <pre>Ask user to register again [Yes]: Yes<br></pre>
1329 <p>If you answer Yes to this question, the user will be presented with
1331 'registration' screen or set of prompts, the next time they log in
1333 a Citadel client. This will prompt them for their full name, address,
1336 <pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1337 <p>These statistics are available for informational purposes only, so
1338 there is normally no need to change them.</p>
1339 <pre>Set last call to now [No]: No<br>Purge time (in days, 0 for system default [0]: <br></pre>
1340 <p>Citadel contains an auto-purger which is capable of automatically
1341 deleting accounts which have not been accessed in a predefined period
1342 of time. If you choose to perform this operation, you can 'touch' the
1344 of a wayward user by setting their 'last call' time to 'now'. You can
1345 also adjust, on a per-user basis, the amount of time which must pass
1347 their account is purged by the system. This time is set in days. You
1348 can also specify 0 days to indicate that you wish to use the system
1353 <h3><a name="Deleting_and_moving_messages"></a>Deleting and moving
1355 <p>Aides and Room Aides have the ability to delete and move messages.
1356 After each message, the normal prompt appears:</p>
1357 <pre>(8) <B>ack <A>gain <Q>uote <R>eply <N>ext <S>top m<Y> next <?>help -><br></pre>
1358 <p>Entering <tt><b>D</b>elete</tt> will delete the message. A <tt>(y/n)</tt>
1359 prompt will appear to confirm that you really want to delete the
1360 message. Entering <tt><b>M</b>ove</tt> will prompt for a room to which
1361 the message should be moved.<br>
1364 <h3><a name="Customizing_the_help_files"></a>Customizing the help files</h3>
1365 <p>The subdirectory called <tt>help</tt> contains your system's help
1366 files. There's nothing hard-coded into the system that dictates what
1368 should be there. Whenever a user types the command <tt><b>.H</b>elp</tt>
1369 followed by the name of a help file, it displays the contents of that
1371 <p>The help files that come with the system, of course, are enough to
1372 guide a user through its operation. But you can add, change, or remove
1373 help files to suit whatever is appropriate for your system.</p>
1374 <p>There are several strings that you can put in help files that will
1376 substituted with other strings. They are:</p>
1377 <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>
1378 <p>So, for example, you could create a help file which looked like:</p>
1379 <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>
1380 <h3><a name="Site_configuration"></a>Site configuration</h3>
1381 <p>Once your Citadel server is up and running, the first thing you'll
1382 want to do is customize and tune it. This can be done from the
1383 text-based client with the <tt><b>.A</b>ide <b>S</b>ystem
1384 configuration <b>G</b>eneral</tt> command, or from WebCit (if you have
1385 it installed) by clicking 'Advanced Options' followed by 'Edit
1386 site-wide configuration.' Either method will offer the same
1387 configuration options. This document shows the text mode client being
1389 <p>The first set of options deal with the identification of your system.</p>
1390 <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
1391 !="" more="" text="" on="" the="" next="" screen="">]: <br></jinkies></pre>
1392 <p>'Node name' refers to the short, unqualified node name by which your
1393 system is known on a Citadel network. Generally it will be the same as
1394 the unqualified host name of your computer; this is, in fact, the
1395 default setting.</p>
1396 <p>Then enter the fully-qualified domain name (FQDN) of your system. If
1398 are not on the Internet, you can simply set it to the same as your
1399 unqualified host name. Otherwise you should set this value to the host
1400 name by which your system is most commonly known.</p>
1401 <p>The field called 'Human-readable node name' (also known as the 'node
1402 title' or 'organization name' in other software) is used solely for
1403 display purposes. Set it to the actual name of your system as you want
1405 banners, messages, etc.</p>
1406 <p>If you have a modem or bank of modems answering data calls for your
1407 system, enter it in the field marked 'Modem dialup number.' Otherwise
1408 you may leave it blank.</p>
1409 <p>'Geographic location of this system' is another display field. Enter
1410 a city and state, or city and country. </p>
1411 <p>'Name of system administrator' is important! Any user who logs on
1412 with the name you enter here will automatically be granted Aide
1413 privileges. This is one of two ways for the system administrator to
1414 grant himself/herself Aide access to the system when initially setting
1415 it up. (The other is simply to have the first account created on a new
1417 <p>The next set of options are your system's security settings. Before
1418 delving into the actual options, we should review the various access
1419 levels available on the system. Citadel has seven access levels:</p>
1421 <li>0 (Deleted). A user whose access level is set to 0 will
1422 automatically be deleted by the system. </li>
1423 <li>1 (New User). Users at this level may only read messages.
1424 Entering messages is prohibited, except in the <tt>Mail></tt> room,
1425 where a message to 'sysop' may be entered. </li>
1426 <li>2 (Problem User). Also known as 'Twit.' </li>
1427 <li>3 (Local User). May enter messages, except in rooms shared on a
1428 Citadel network. </li>
1429 <li>4 (Network User). May enter messages in every accessible
1431 <li>5 (Preferred User). Use of this level is up to the whim of the
1432 system administrator. </li>
1433 <li>6 (Aide). Access is granted to the administrative functions of
1434 the system. (This access level may also be granted to a user only for a
1435 specific room, please see 'Room Aide' for more information.) </li>
1437 <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>Allow system Aides access to user mailboxes [Yes]: Yes<br>Log all pages [No]: No<br></pre>
1438 <p>'Registration' refers to the process of a user entering various
1439 personal contact information (real name, address, telephone number,
1440 etc.) into the system. When enabled, this information is stored as a
1441 vCard object on the system in two places: the user's <tt>My Citadel
1443 room, and in the <tt>Global Address Book></tt> room. (Note: the
1445 should be made private on publicly-accessible systems, for obvious
1447 <p>If you answer Yes to 'Require registration for new users' then each
1448 new user, upon creating a new account, will immediately be entered into
1449 the registration process. On the other hand, if you answer Yes to
1450 'Disable self-service user account creation' then new users will not be
1452 log in at all -- all accounts must be created by an Aide.</p>
1453 <p>'Initial access level for new users' should be set to 1 (New User)
1454 if you would like to review each new user's registration info before
1455 granting them higher access. This would be done periodically with the <tt><b>.A</b>ide
1456 <b>V</b>alidate new users</tt> command. If you do not require
1457 registration, you should set the initial access level to 4 (Network
1459 <p>Given the above options, it then becomes clear that there are
1460 generally two ways you can set up your Citadel system, depending on its
1463 <li><b>A public access BBS or message board</b> - since you do
1464 not know who might want to log in, self-service account creation needs
1466 stay enabled. If you want to be strict about users identifying
1468 then you should also require users to register (just remember to post a
1469 privacy policy if you're going to collect personal information) -- then
1471 the initial access level to 1 (New User), so new users cannot post
1473 until after you've validated them. For a more lax environment, you can
1474 remove the registration requirement and grant new accounts level 4
1476 User) access on the first visit. </li>
1477 <li><b>A private email/groupware system for your organization</b> -
1478 in this case, disable self-service account creation; you don't want
1479 strangers welcoming themselves to your system. You'll probably also
1481 to disable registration, because you or some other site administrator
1482 will be entering users' contact info when you create their accounts.
1483 Since this is also how you assign their Internet e-mail addresses, it's
1484 probably a good idea to do it yourself instead of expecting them to do
1487 <p>'Access level required to create rooms' is up to you. You might wish
1489 restrict the creation of new rooms only to Aides, or you might wish to
1491 anyone to create a room. The latter is one of the Citadel culture's
1493 long-standing traditions; the former may be appropriate if users are
1496 <p>You have the ability to 'Automatically give room aide privs to a
1497 user who creates a private room.' If you answer Yes, then any user who
1499 guess-name, passworded, or invitation-only room will automatically
1500 become the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1501 command set while in that room. If you would rather grant this
1502 permission manually, answer No.</p>
1503 <p>Another tradition in the Citadel culture is to refrain from deleting
1504 problem users, but instead to 'twit' them (reduce their access level to
1506 [Problem User]). You can then 'Automatically move problem user messages
1507 to twit room' (answer Yes, then specify 'Name of twit room' and
1509 to create that room). If you employ this logic, any user with level 2
1511 User) access will continue to have access to the same set of rooms, but
1513 messages posted will automatically be routed to the Trashcan (or
1515 you call your twit room).</p>
1516 <p>If you have Internet mail configured, you have the option of
1517 restricting its use on a user-by-user basis. If you wish to do this,
1518 answer Yes to 'Restrict Internet mail to only those with that
1519 privilege.' Obviously this makes no sense for an internal e-mail
1520 system, but for a public BBS it
1521 might be appropriate.</p>
1522 <p>Normally, Aides have access to every room, public or private, except
1523 for user mailboxes. They are also forbidden from <tt><b>Z</b>ap</tt>ping
1524 rooms, because the review of content is considered one of their roles.
1525 If you wish to change these policies, the next two options allow you
1526 to. You may 'Allow Aides to Zap (forget) rooms', in which case they may
1527 use the <tt><b>Z</b>ap</tt> command just like any other user.
1528 Furthermore, if you 'Allow system Aides access to user mailboxes', then
1529 they may <tt><b>.G</b>oto</tt> any private mailbox belonging to any
1530 user, using a special room name format.</p>
1531 <p>If your local security and/or privacy policy dictates that you keep
1533 log of all pages (instant messages) that go through the system, then
1535 Yes to 'Log all pages'. If you answer Yes, you will be prompted for the
1536 name of a room to which all pages will be logged. If you answer No,
1538 only the sender and recipient of each individual message will receive a
1540 <p>The next set of options deals with the tuning of your system. It is
1541 usually safe to leave these untouched.</p>
1542 <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>
1543 <p>The 'Server connection idle timeout' is for the connection between
1544 client and server software. It is <b>not</b> an idle timer for the
1545 user interface. 900 seconds (15 minutes) is the default and a sane
1547 <p>'Maximum concurrent sessions' is the highest number of user sessions
1548 you wish to allow on your system at any given time. Citadel can scale
1549 to hundreds of concurrent users, but if you have limited hardware or
1550 (more likely) limited bandwidth, you might wish to set a maximum. You
1551 can also set it to zero for no limit.</p>
1552 <p>'Maximum message length' is just that. This could be a good way to
1553 prevent enormous multimedia files from finding their way into your
1554 message base. This maximum is enforced in all protocols and is also
1555 advertised by the ESMTP service.</p>
1556 <p>The minimum and maximum number of worker threads can be tuned to
1558 liking. Citadel will attempt to keep one worker thread running per
1560 within these constraints. You should be aware that due to the use of
1562 worker thread model, Citadel can handle a large number of concurrent
1564 with a much smaller thread pool. If you don't know the programming
1566 behind multithreaded servers, you should leave these parameters alone.</p>
1567 <p>The next set of options affect how Citadel behaves on a network.</p>
1568 <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>
1569 <p>"How often to run network jobs" refers to the sharing of content on
1571 Citadel network. If your system is on a Citadel network, this
1573 item dictates how often the Citadel server will contact other Citadel
1574 servers to send and receive messages. In reality, this will happen more
1575 frequently than you specify, because other Citadel servers will be
1576 contacting yours at regular intervals as well.</p>
1577 <p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP
1578 services. For a system being used primarily for Internet e-mail, these
1579 are essential, so you'll want to specify the standard port numbers: 25,
1580 110, and 143. If Citadel is running alongside some other mail system,
1581 though, then you might want to choose other, unused port numbers, or
1582 enter -1 for any protocol
1583 to disable it entirely.</p>
1584 <p>The question about correcting forged From: lines affects how Citadel
1585 behaves with authenticated SMTP clients. Citadel does not ever allow
1586 third-party SMTP relaying from unauthenticated clients -- any incoming
1588 addressed to a user on the system or somewhere in a Citadel network. To
1589 use Citadel with SMTP client software such as Netscape, Outlook,
1591 whatever, users must log in with a username and password. In order to
1593 message forgeries, Citadel discards the <tt>From:</tt> line in any
1595 entered by an authenticated user, and replaces it with a <tt>From:</tt>
1597 containing the user's genuine name and e-mail address. Technically,
1599 violates RFC822, because headers are never supposed to be altered, but
1601 sense dictates that this is a good idea. Nevertheless, if you want to
1603 this behavior, answer 'No' at the prompt (the default is 'Yes') and the
1605 will never be altered.</p>
1606 <p>The final set of options configures system-wide defaults for the
1608 <pre>Default user purge time (days) [120]: <br>
1609 Default room purge time (days) [30]: <br>
1610 System default message expire policy (? for list) [2]: <br>
1611 Keep how many messages online? [150]:<br>
1612 Mailbox default message expire policy (? for list) [1]: <br>
1614 <p>Any user who does not log in for the period specified in 'Default
1615 user purge time' will be deleted the next time a purge is run. This
1616 setting may be modified on a per-user basis.</p>
1617 <p>'Default room purge time' behaves the same way, and may also be
1618 modified on a per-room basis.</p>
1619 <p>'System default message expire policy' defines the way in which old
1620 messages are expired (purged) off the system. You can specify any of:</p>
1622 <li>Purge by age (specify in days) </li>
1623 <li>Purge by message count in the room (specify number of messages) </li>
1624 <li>Do not purge at all </li>
1626 <p>Again, this setting may be overridden on a per-floor basis, and the
1627 floor setting may be overridden on a per-room basis. You'll also notice
1628 that you can set a <i>different</i> default for mailbox rooms if you want
1629 to. This can allow you, for example, to set a policy under which old
1630 messages scroll out of public rooms, but private mail stays online indefinitely
1631 until deleted by the mailbox owners.</p>
1632 <pre>Save this configuration? No<br></pre>
1633 <p>When you're done, enter 'Yes' to confirm the changes, or 'No' to
1634 discard the changes.</p>
1636 <hr width="100%" size="2">
1637 <h2 align="center"><a name="Configuring_Citadel_for_Internet_e-mail"></a>Configuring
1638 Citadel for Internet e-mail</h2>
1639 <div align="justify">
1640 <h3><a name="Introduction"></a>Introduction</h3>
1641 As you know by now, Citadel is a completely self-contained,
1642 full-featured Internet e-mail system. When you run Citadel you do
1643 not need any other mail software on your host system. This
1644 eliminates the need for tedious mucking about with sendmail, qmail,
1645 postfix, Cyrus, the UW IMAP
1646 server, or any of countless other needlessly complex programs that lead
1647 some people to the false assumption that Unix systems are difficult to
1650 Some of the many features supported by Citadel are:<br>
1652 <li>Built-in SMTP and ESMTP service, for delivering and receiving
1653 e-mail on the Internet</li>
1654 <li>Built-in POP3 service, for remote fetching of messages</li>
1655 <li>Built-in IMAP service, for access to mail using any standard mail
1657 <li>Web mail (implemented using the "WebCit" middleware, which is
1658 installed separately)</li>
1659 <li>Support for mailing lists, in both "individual message" and
1660 "digest" formats</li>
1661 <li>Multiple/virtual domain support</li>
1662 <li>Any user may have multiple Internet e-mail addresses, in multiple
1664 <li>Global address book (Users with addresses in a domain may be
1665 spread out across many servers on a Citadel network)</li>
1666 <li>Easy-to-configure integration with <a
1667 href="http://www.spamassassin.org/">SpamAssassin</a> can block spam <i>before</i>
1668 it enters the mail system</li>
1669 <li>Easy-to-configuration integration with most Realtime Blackhole
1670 Lists (RBL) provide further defense against spammers</li>
1672 This section of the documentation will demonstrate how to configure
1675 <h3><a name="Basic_site_configuration"></a>Basic site configuration</h3>
1676 <p>Basic configuration of your Citadel system for Internet e-mail
1678 the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>I</b>nternet</tt>
1680 <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>
1681 <p>This is a "clean" setup. For a simple, standalone e-mail system you
1682 simply have to enter the <tt><b>A</b>dd</tt> command:</p>
1683 <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>
1684 <p><b>localhost:</b> Basically what you're doing here is telling
1686 what any aliases for your machine are. If your machine were <tt>schmeep.splorph.com</tt>
1687 and you also had a DNS entry set up for <tt>blah.com</tt>, you might
1688 want to enter '1' and enter <tt>blah.com</tt> as your alias, so that
1690 sent to that address won't bounce.</p>
1691 <p><i>Important tip:</i> if your system is known by one name and <i>only</i>
1692 one domain, you might not even need to do this at all. You will recall
1693 that you entered your system's fully qualified domain name earlier when
1694 you went through the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1695 command. The domain name you entered there is automatically considered
1696 by Citadel to be a 'localhost' entry in your Internet mail
1697 configuration. It does not hurt to enter it in both locations, though.</p>
1698 <p><b>gateway domain:</b> this is a simple way of mapping various
1699 Citadel hosts in an Internet domain. For example, if you enter <tt>bar.com</tt>
1700 as a gateway domain, then mail to users at <tt>foo.bar.com</tt> will
1701 be forwarded to the host called <tt>foo</tt> on a Citadel network,
1703 at <tt>kunst.bar.com</tt> will be delivered to the Citadel server
1705 <tt>kunst</tt>, etc. This feature has limited usefulness; if you are
1707 a network of Citadel servers, it is more likely that you will use the
1709 feature, explained below.</p>
1710 <p><b>smart-host:</b> Normally, Citadel sends outbound Internet e-mail
1711 directly to its destination. This may not be appropriate for some
1712 sites; you may require (due to local convention, security policy, or
1713 whatever) that all outbound mail be sent to an SMTP relay or forwarder.
1715 functionality, simply enter the domain name or IP address of your relay
1716 as a 'smart-host' entry.</p>
1717 <p><b>directory:</b> a domain for which you are participating in
1718 directory services across any number of Citadel nodes. For example, if
1719 users who have addresses in the domain <tt>citadel.org</tt> are spread
1720 out across multiple Citadel servers on your network, then enter <tt>citadel.org</tt>
1721 as a 'directory' entry. <i>For this to work, all Citadel servers
1722 participating in directory service <b>must</b> carry and share the <tt>Global
1723 Address Book></tt> room.</i></p>
1724 <p><b>spamassassin:</b> if you are running a <a
1725 href="http://www.spamassassin.org">SpamAssassin</a> service anywhere
1727 <b>local</b> network, enter its name or IP address as a 'spamassassin'
1728 entry. This may be (and, in fact, will usually be) <tt>127.0.0.1</tt>
1730 that the service is running on the same host computer as the Citadel
1732 <p>Please install SpamAssassin as per its own documentation. You will
1733 want to run SpamAssassin in client/server mode, where a <tt>spamd</tt>
1734 daemon is always running on your computer. Citadel does not utilize the
1735 <tt>spamc</tt> client; instead, it implements SpamAssassin's protocol
1737 <p>Connecting to a SpamAssassin service across a wide area network is
1738 strongly discouraged. In order to determine whether an incoming e-mail
1739 is spam, Citadel must feed the <i>entire message</i> to the
1740 SpamAssassin service. Doing this over a wide area network would consume
1742 which would affect performance.</p>
1743 <p>Citadel invokes the SpamAssassin service when incoming messages are
1744 arriving via SMTP. Before a message is accepted, it is submitted to
1745 SpamAssassin. If SpamAssassin determines that the message is spam, the
1747 service <i>rejects the message,</i> causing a delivery failure on the
1749 host. This is superior to software which files away spam in a separate
1750 folder, because delivery failures will cause some spammers to assume
1752 address is invalid and remove it from their mailing lists.</p>
1753 <p><b>RBL:</b> Realtime Blackhole Lists (RBL's) provide defense against
1754 spammers based on their source IP address. There are many such lists
1755 available on the Internet, some of which may be utilized free of
1756 charge. Since they are DNS based, the lists do not require storage on
1757 your server -- they are queried during the SMTP conversation.</p>
1758 <p>Citadel can utilize any RBL that uses the <tt>z.y.x.w.nameoflist.org</tt>
1759 syntax, where <tt>w.x.y.z</tt> is the source IP address which is
1760 attempting to deliver mail to your server. For example, <a
1761 href="http://www.spamcop.net">SpamCop</a> would use the query <tt>2.0.0.127.bl.spamcop.net</tt>
1762 to determine whether the host at <tt>127.0.0.2</tt> is a known spammer
1763 or open relay. In this case, you simply select option '6' to add an RBL
1764 entry, and provide it with the domain suffix of <tt>bl.spamcop.net</tt>
1766 and extra dot will be automatically prepended for each query).</p>
1767 <p>Now select <tt><b>S</b>ave</tt> and you are just about ready for
1768 Internet e-mail.</p>
1769 <h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the
1770 Internet mail protocols</h3>
1771 <p>As previously mentioned, Citadel contains its own SMTP, POP3, and
1772 IMAP services. Enabling them is simple.</p>
1773 <p>Check for the existance of a current MTA (sendmail, qmail, etc.) by
1774 connecting to port 25 on your host. If you see something similar to the
1776 you're running an MTA already and you'll need to shut it down:</p>
1777 <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>
1778 <p>In the above example, we see that the host already has Sendmail
1779 listening on port 25. Before Citadel can use port 25, Sendmail must be
1780 shut off. Please consult the documentation for your operating system
1781 for instructions on how to do this. (On a Red Hat Linux system, for
1782 example, you can run the <tt>ntsysv</tt> utility, un-checking <tt>sendmail</tt>
1784 the next reboot; then, run <tt>service sendmail stop</tt> to shut off
1786 currently running service.)</p>
1787 <p>If you get a 'connection refused' message when you telnet to port 25
1788 there's nothing running and you should be able to continue. You might
1789 also want to turn off POP (try the above test substituting 110 for 25)
1790 and IMAP (port 143) and use Citadel's POP and IMAP services.</p>
1791 <p>Citadel will look for an existing pop/smtp server on startup. If
1793 don't exist (and you've configured them properly) then Citadel should
1795 them at startup. You can check your logs to be sure, or you can start
1797 server from a shell and watch it load. It might look something like
1799 <font size="-2"> </font>
1800 <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 express messages)<br>Registered server command GEXP (Get express messages)<br>Registered server command SEXP (Send an express message)<br>Registered server command DEXP (Disable express 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>
1801 <p>The lines emphasized in boldface in the above log output tell you
1802 that Citadel "can't bind" to various ports. The error 'address already
1803 in use' generally means that something else is already running on the
1804 requested port. Make SURE you've followed the above steps to remove
1805 sendmail/pop and start your Citadel server again.</p>
1806 <h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
1807 <p>Occationally it is not practical to remove a non-Citadel MTA on your
1808 host system. For example, you might have multiple groups of users, some
1810 which are using Citadel and some of which are using a legacy Unix mail
1811 spool. This type of configuration is discouraged, but two tools are
1814 <p>The tool is called <tt>citmail</tt> and it is, quite simply, a
1815 local MDA (Mail Delivery Agent) which you can configure into your MTA
1816 for final delivery of incoming messages to Citadel users. A full
1817 discussion of the finer points of complex Sendmail configurations is
1818 beyond the scope of this document; however, you might want to visit <a
1819 href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some
1820 useful HOWTO documents are provided.<br>
1822 <p>The other tool is an <a href="http://www.faqs.org/rfcs/rfc2033.html">RFC2033</a>
1823 compliant LMTP service running on a local socket. If you're
1824 running a mailer that speaks LMTP (such as <a
1825 href="http://www.postfix.org/">Postfix</a>), you can simply point your
1826 mailer at the socket called <span style="font-family: monospace;">citadel.socket</span>
1827 in your Citadel directory. For example, in Postfix you might put
1828 the following line into <span style="font-family: monospace;">main.cf</span>
1829 in order to tell it to use Citadel to deliver mail to local recipients:<br>
1831 <pre>local_transport = lmtp:unix:/usr/local/citadel/lmtp.socket<br></pre>
1832 <p>Postfix also has something called a "fallback transport" which can
1833 be used to implement Citadel as a "secondary" mail system on your
1834 server, while keeping the existing Unix mailboxes intact.
1835 However, it is beyond the scope of this document to detail the finer
1836 points of the configuration of Postfix or any other mailer, so refer to
1837 the documentation to those programs and keep in mind that Citadel has
1838 LMTP support.<span style="font-family: monospace;"><br>
1840 <p><span style="font-family: monospace;"></span>For outbound mail, you
1841 can either allow Citadel to perform
1843 (this won't affect your other mail system because outbound mail doesn't
1845 up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which will
1847 Citadel to forward all of its outbound mail to your other mail system.</p>
1848 <h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet
1850 <p>Citadel has built in mailing list service (known in the 'net
1851 vernacular as "listserv") functionality. You can turn any room
1852 into a mailing list. Users can then choose how they participate
1853 -- by logging on to your Citadel server directly, or by having the
1854 room's contents mailed to
1855 them somewhere else. Configuring this is easy.</p>
1856 <p>Citadel supports two modes of mailing list delivery: </p>
1858 <li>"List mode" -- each individual message is delivered as a single
1859 e-mail to each list mode recipient. The "From:" header will
1860 display the address of the message's original author.</li>
1861 <li>"Digest mode" -- groups of one or more messages are delivered
1862 to digest mode recipients. The number of messages in the group
1863 depends on how many new messages arrived since the last batch was
1864 delivered. The "From:" header will display the address of the
1865 room itself, which allows replies to be posted back to the room.</li>
1867 A room may have any combination of list mode and digest mode
1869 <p>As alluded to above, every room on your Citadel system has an
1870 Internet e-mail address of its own. Messages sent to that address
1872 posted in the room (and sent back out to mailing list recipients, as
1874 as to any other Citadels you share the room with). The address
1876 is <tt>room_</tt> plus the name of the room, with any spaces replaced
1878 underscores, followed by <tt>@</tt> and your hostname. For example, if
1880 system is known as <tt>phlargmalb.orc.org</tt> on the Internet, and
1882 a room called <tt>Bubblegum Collectors</tt>, you can post to that room
1884 anywhere on the Internet simply by sending an e-mail to <tt>room_bubblegum_collectors@phlargmalb.orc.org</tt>.
1885 When the message arrives, it's automatically posted in that room.</p>
1886 <p>To manually edit the list of "list mode" recipients, simply enter
1887 the <tt><b>.A</b>ide
1888 mailing <b>L</b>ist management</tt> command. Your text editor will
1890 up and you will be able to create or edit a list of recipients, one per
1891 line. Lines beginning with a hash (<tt>#</tt>) are comments.</p>
1892 <p>To manually edit the list of "digest mode" recipients, enter the <tt><b>.A</b>ide
1893 mailing list <b>D</b>igest recipients</tt> command. As with the
1894 previous command, the text editor will open up and you can edit the
1895 list of digest mode recipients, one per line.</p>
1896 <p>Citadel also has a facility which allows users to subscribe or
1897 unsubscribe to mailing lists using a web browser. In order to do this,
1898 WebCit must also be running on your server in addition to Citadel.
1899 WebCit is obtained and installed separately from the rest of the
1901 <p>In order to prevent "just anyone" from subscribing to any room on
1902 your system, there is a setting in the <tt><b>.A</b>ide <b>E</b>dit
1903 room</tt> command:</p>
1904 <pre>CitaNews} . Aide Edit this room<br>Room name [CitaNews]:<br><br><i>(lots of other stuff omitted for brevity...)</i><br><br>Self-service list subscribe/unsubscribe [No]: Yes<br></pre>
1905 <p>When you answer "Yes" to self-service list subscribe/unsubscribe,
1907 enabling that feature. Now, all you have to do is tell the world about
1909 web page they need to visit. It looks like this:</p>
1910 <center><tt>http://foobar.baz.org:2000/listsub</tt></center>
1911 <p>In this example, the server is called <tt>foobar.baz.org</tt> and
1912 WebCit is running on port 2000. Edit appropriately.</p>
1913 <p>Citadel offers a subscribe/unsubscribe facility that is more
1914 intuitive than other listservs. With most systems, sending commands to
1915 the listserv requires that you e-mail it commands in a special format.
1916 It's easy to get it wrong. Citadel simply uses your web browser. You
1917 select the list you want to subscribe or unsubscribe (hint: it's the
1918 list of rooms you've enabled self-service for), select whether you want
1919 list mode or digest mode, and enter your e-mail address. For security
1920 purposes, a confirmation message is sent to the address you enter. But
1921 you don't have to reply to the message in a weird format, either: the
1922 confirmation contains another URL which
1923 you simply click on (or paste into your browser if you can't click on
1925 in your e-mail software) and the confirmation is automatically
1927 <hr width="100%" size="2">
1929 <h2><a name="Building_or_joining_a_Citadel_network"></a>Building or
1930 joining a Citadel network</h2>
1932 <h3><a name="Overview__"></a>Overview</h3>
1933 <p>If you are running Citadel as a BBS or other forum type of
1934 application, one way to 'keep the conversation going' is to share rooms
1935 with other Citadel systems. In a shared room, a message posted to the
1936 room is automatically
1937 propagated to every system on the network. It's kind of like a UseNet
1939 but without the spam.</p>
1940 <p>If you are using Citadel as the e-mail and groupware platform for a
1941 large organization, you can use its networking features to build a
1942 large network of Citadel servers which share content (think of rooms as
1943 public folders), redistribute e-mail throughout the organization, and
1944 integrate the global address book. It might make sense, for
1945 example, in a large corporation to give each department or location its
1946 own Citadel server. Thanks
1947 to Citadel's global address book features, you could still have all of
1949 users share a single e-mail domain.</p>
1950 <p>Obviously, the first thing you have to do is find another Citadel to
1951 share rooms with, and make arrangements with them. The following
1952 Citadels are a good place to start:</p>
1954 <li>UNCENSORED! - <a href="http://uncensored.citadel.org">uncensored.citadel.org</a>
1956 <li>The Dog Pound II - <a href="http://dogpound2.citadel.org">dogpound2.citadel.org</a>
1958 <li>PixelBBS - <a href="http://pixel.citadel.org">pixel.citadel.org</a>
1961 <p>You don't have to be a part of the citadel.org domain to participate
1962 in the public Citadel network, but the DNS service is provided free of
1963 charge by the Citadel community if you wish to do this.</p>
1964 <h3><a name="Conventions_and_etiquette_when"></a>Conventions and
1965 etiquette when connecting to the public Citadel network</h3>
1966 <p>Before we get into the technical nitty gritty, there are two points
1967 of etiquette to keep in mind. The first thing to keep in mind is that
1968 the operator of any particular Citadel may not be willing to share some
1969 of his/her rooms. Some sites are proud to offer exclusive content in
1970 certain areas. Chances are, if a room is already being shared on the
1971 network, it's available for anyone to share; if not, it can't hurt to
1972 ask -- but take care not to demand it of them. Ask if you may share the
1973 room instead of telling them that you wish to share the room. When
1974 looking at a <tt><b>K</b></tt>nown rooms list, network rooms are the
1975 ones ending in parentheses instead of angle brackets. For example, <tt>Gateway)</tt>
1976 would be a network room, <tt>Lobby></tt> would not.</p>
1977 <p>The other point of etiquette to remember is that you should be
1979 the arrangements in advance, and then set it up. It is extremely rude
1981 simply begin networking with another Citadel, or unilaterally start
1983 a new room, without first obtaining permission from its operator.
1985 ask first. Most Citadel operators are more than happy to network with
1986 you. Also, if later on you decide to take your system down, please take
1988 to notify the operators of any other Citadels you network with, so they
1990 unconfigure their end.</p>
1991 <h3><a name="Getting_ready_to_join_the_network"></a>Getting ready to
1992 join the network</h3>
1993 <p>Ok, first things first. On a Citadel room sharing network, the first
1994 thing you need to know is your own system's node name. Presumably you
1996 this up during installation, but if you want to change it you can do so
1998 the <tt><b>.A</b>ide <b>S</b>ysconfig <b>G</b>eneral</tt> command:</p>
1999 <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>
2000 <p>The "node name" is important, it's how the network identifies
2001 messages coming from your system. The "human readable node name" is
2002 simply a label; it shows up in messages coming from your system. "Fully
2003 qualified domain name" is your DNS name; it's used for routing messages
2004 on the Internet. In the above example, the node name is "uncnsrd".</p>
2005 <h3><a name="Defining_neighbor_nodes"></a>Defining neighbor nodes</h3>
2006 <p>The next thing you need to do is configure your neighbor node(s).
2007 You need to do this for each node you network with. Let's say you
2009 to talk to a Citadel system called "frobozz". Use the <tt><b>.A</b>ide
2010 <b>S</b>ysconfig <b>N</b>etwork</tt> command:</p>
2011 <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>
2012 <p>As you can see in the above example, you have to enter the Citadel
2013 node name, the DNS name or IP address of the server, and the port
2014 number the Citadel service is running on. The "shared secret" is a
2015 password to allow the two Citadel nodes to connect to each other to
2016 exchange network data. The password must be <i>identical</i> on both
2017 ends of the connection -- when the operator of the other Citadel node
2018 sets up the connection with
2019 your system, he/she must use the same password.</p>
2020 <h3><a name="Sharing_rooms"></a>Sharing rooms</h3>
2021 <p>Now you're ready to share rooms. You have to do this for each room
2022 you want to share, and you have to do it from BOTH ENDS -- again, when
2024 share a room with another Citadel, they must share it with you as well.
2025 Let's say you have a room called "Quiche Recipes>" and you want to
2027 it with the node you set up above. First, edit the room and flag it as
2030 <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>
2031 <p>Notice how the prompt changed? It was > before, but it's ) now.
2032 That means it's a network room. Now you can tell Citadel that you want
2034 share the room with frobozz. Enter this command:</p>
2035 <pre>Quiche Recipes) . Aide Network room sharing<br></pre>
2036 <p>Your text editor will pop up (you <i>did</i> configure Citadel to
2038 your favorite text editor, right?) with a screen that looks like this:</p>
2039 <pre># Configuration for room: Quiche Recipes<br># Nodes with which we share this room<br># Specify one per line.<br></pre>
2040 <p>All you have to do is enter the name of the other Citadel node (i.e.
2041 "frobozz" in our example) on a line by itself. As usual, lines starting
2043 "#" are comments. Just go to the end of the file, type "frobozz"
2045 the quotes), save the file... and you're done!</p>
2046 <p>At this point, you just sit back and enjoy. Your Citadel and the
2047 other one will begin polling each other at regular intervals (once per
2049 by default) and sharing messages.</p>
2050 <h3><a name="Sending_mail"></a>Sending mail</h3>
2051 <p>You can send mail to any user on any node of your Citadel network.
2052 It may take a little while for your system to learn the entire node
2053 list, though, as this is done by watching incoming messages on the
2054 network and learning which nodes are out there.</p>
2055 <p>To send a private message, just enter <tt>user @ host</tt> as the
2057 <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>
2058 <h3><a name="Changing_the_polling_interval"></a>Changing the polling
2060 <p>As previously mentioned, Citadel will poll other Citadel nodes for
2061 messages once per hour. If this is not an acceptable interval, you can
2062 change it using the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
2063 command. Enter this command and look for the option:</p>
2064 <pre>How often to run network jobs (in seconds) [3600]:<br></pre>
2065 <p>Change it to whatever you like. For example, 15 minutes is 900
2066 seconds. So if you changed the default value to 900, network polling
2067 would occur every 15 minutes.</p>
2069 <h2 align="center"><a name="Database_maintenance"></a>Database
2071 <h3><a name="Introduction_"></a>Introduction</h3>
2072 The data store used by Citadel is reliable and self-maintaining.
2073 It requires very little maintenance. This is primarily due
2074 to its use of the <a href="http://www.sleepycat.com">Berkeley DB</a>
2075 record manager. It is robust, high-performance, and transactional.<br>
2077 A few small data files are kept in your main Citadel directory, but the
2078 databases are in the <tt>data/</tt> subdirectory. The files with
2079 names that begin with "cdb" are the databases themselves; the files
2080 with names that begin with "log" are the journals. Journal files
2081 will come and go as you use your system; when the database engine has
2082 determined that a particular log file is no longer needed, the file
2083 will automatically be deleted. Nevertheless, you should always
2084 ensure that there is ample disk space for the files to grow.<br>
2086 There is no need to shut down Citadel during backups. The data
2087 store may be backed up "hot." The makers of Berkeley DB suggest
2088 that you should back up the data files <i>first</i> and the log files <i>second</i>.
2089 This is the only method that will guarantee that a database which
2090 is being changed while you back it up will still be usable when you
2092 from the tape later.<br>
2094 <h3><a name="Database_repair"></a>Database repair</h3>
2095 Although Citadel's data store is quite reliable, database corruption
2096 can occur in rare instances. External factors such as an
2098 system crash or an unexpected loss of power might leave the database in
2099 an unknown state. A utility is provided which may be able to
2101 your database if this occurs. If you find that your Citadel
2103 is not running, and reading the logs shows that it is crashing because
2105 an inability to validate a database, follow these steps:<br>
2107 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2108 "respawn" to "off." Type <tt>init q</tt> to make this setting
2110 <li><b>Make a backup of your data.</b> Either write it out to
2111 tape or copy it to another directory, or a tarball.<br>
2113 <li><tt>cd</tt> to your Citadel directory and type <tt>./database_cleanup.sh</tt></li>
2114 <li>Let the cleanup script run. <b>Do not interrupt this
2115 process for any reason.</b><br>
2117 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2118 "off" to "respawn". Type <tt>init q</tt> to activate your
2121 If this procedure does not work, you must restore from your most recent
2124 <h3><a name="ImportingExporting_your_Citadel"></a>Importing/Exporting
2125 your Citadel database<br>
2127 <p>Citadel/UX contains an importer/exporter module, affectionately
2128 known as the "Art Vandelay" module (a not-so-obscure Seinfeld
2130 allows you to export the entire contents of your Citadel databases to a
2131 flat file, which may then be imported on another system. (This
2133 is also known as "dump and load" to database gurus.)</p>
2134 <p>Why would you want to do this? Here are some scenarios: </p>
2136 <li>You are moving a Citadel installation to another computer, which
2137 uses a different CPU. Since Citadel stores data in an
2138 architecture-dependent format, the data files wouldn't work on the new
2139 computer as-is. </li>
2140 <li>Your computer crashed, lost power, etc. and you suspect that your
2141 databases have become corrupted. </li>
2142 <li>You want to switch to a different back-end data store. (For
2143 example, from GDBM to Berkeley DB) </li>
2145 <p>So ... how do we work this magic? Follow these steps <i>exactly</i>
2146 as documented and you should be able to do it all with very little
2149 <li>This should be obvious, but it's still worth mentioning: <b>Make
2150 sure you have a backup of everything before you start this! </b>
2151 You're performing a major operation here. Don't risk it. </li>
2152 <li>First, get all the users logged off from your system. Disconnect
2153 it from the network if possible. You don't want anyone logging in while
2154 you're doing this. </li>
2155 <li>Log on as root, or some other user that has read/write access to
2156 all relevant files. </li>
2157 <li>Go to the directory that Citadel is installed in. For example,
2158 issue a command like <tt>cd /usr/local/citadel</tt> </li>
2159 <li>Export the databases with the following command:<br>
2161 <tt>./sendcommand "ARTV export" >exported.dat</tt><br>
2163 This command may run for a while. On a very large system it could take
2164 an hour or more. Please be patient! </li>
2165 <li>When the export completes, check to make sure that <tt>exported.dat</tt>
2166 exists and has some data in it. (Type "ls -l exported.dat") </li>
2167 <li>Shut down the Citadel server. If you have a line in <tt>/etc/inittab</tt>
2168 that reads like this:<br>
2170 <tt>c1:2345:respawn:/usr/local/citadel/citserver
2171 -h/usr/local/citadel</tt> <br>
2172 ...then you should change the <tt>respawn</tt> to <tt>off</tt> and
2173 then type <tt>/sbin/init q</tt> to make the changes take effect. </li>
2174 <li>Now it's time to delete your current binary databases. Type:<br>
2176 <tt>rm -f citadel.config citadel.control data/*</tt> </li>
2177 <li>If you're moving Citadel to another computer, you should move the
2178 <i>entire</i> directory over at this time. <tt>exported.dat</tt>
2179 only contains the information that was in the binary databases.
2180 Information which was stored in portable formats doesn't need to be
2181 exported/imported, so
2182 you must bring it all over in its current form. </li>
2183 <li>Now get Citadel running on the new computer (or whatever). Run <tt>setup</tt>
2184 and turn the service back on (from <tt>/etc/inittab</tt>) but DO NOT
2186 <li>As root, run the import command:<br>
2188 <tt>./sendcommand "ARTV import" <exported.dat</tt><br>
2190 This will import your databases. Again, it may run for a long time. </li>
2191 <li>Restart the Citadel server. You can do this any way you like.
2192 From the command line, you can do it with a command like:<br>
2194 <tt>./sendcommand "DOWN"</tt> <br>
2196 <li>Now you're finished. Log in and test everything. You may delete
2197 exported.dat at this time, or you might want to save it somewhere as a
2198 sort of pseudo-backup. </li>
2202 <h2><a name="utilities"></a>Utilities</h2>
2204 <h3><a name="overview"></a>Overview</h3>
2205 <p>The following utilities will be discussed: </p>
2207 <li><b>aidepost</b> - Post standard input to the Aide> room </li>
2208 <li><b>whobbs</b> - Who is on the system </li>
2209 <li><b>msgform</b> - Format a binary message to the screen (stdin or
2211 <li><b>userlist</b> - Print the userlist </li>
2212 <li><b>sendcommand</b> - Send a server command </li>
2214 <p>It is up to you to decide which utilities should be made accessible
2215 only to system administrators. It is important that you set the file
2216 permissions correctly. All utilities should have access to the Citadel
2218 will attempt to address each program individually.</p>
2219 <h3><a name="aidepost"></a>aidepost</h3>
2220 <p>The nature of this program is rather simple. Standard input (stdin)
2221 is converted into a message, filed in the main message store, and
2222 posted in the Aide> room. This is useful for keeping transcripts of
2223 system activity that has to do with Citadel operations. You might even
2224 elect to send all of
2225 your system logs there, too.</p>
2226 <p><tt>aidepost</tt> also accepts the usage <tt>aidepost -rTargetRoom</tt>,
2227 where TargetRoom is the name of a room to which you'd like the message
2229 <h3><a name="whobbs"></a>whobbs</h3>
2230 <p>This program is similar to the <tt>who</tt> command. It lists all
2231 of the users who are currently connected to your Citadel server, either
2233 across a network. Unless you're running a standalone system, <tt>who</tt>
2234 and <tt>whobbs</tt> will probably not have a one-to-one
2235 correspondence. Remember
2236 that you will see sessions for SMTP, POP, and IMAP users, as well as
2238 running a Citadel client.</p>
2239 <p>One thing to keep in mind is that the <tt>whobbs</tt> utility
2240 actually opens a connection to the server. If the server is maxed out, <tt>whobbs</tt>
2241 will still be able to provide a listing, because it doesn't need to log
2242 in to execute the <tt>RWHO</tt> command. Note that whobbs does not
2243 list its own session.</p>
2244 <p>The <tt>whobbs</tt> utility is smart enough to know when it is
2245 being invoked by a web server as a CGI program. In this situation, it
2246 will output its listing
2247 as a nicely formatted web page instead of plain text. This makes it
2249 to just put a link to the whobbs binary in your cgi-bin directory,
2251 a quick and easy way for web surfers to see who is online.</p>
2252 <p>Running the <tt><b>W</b>ho is online</tt> command from the Citadel
2253 client does <b>not</b> call this utility. It has this functionality
2257 <h3><a name="msgform"></a>msgform</h3>
2258 <p>The <tt>msgform</tt> utility reads its standard input (stdin)
2260 Citadel messages stored in the internal format used on disk and over
2262 network, and sends them in a human-readable format to standard output
2263 (stdout). There is no longer much use for this program, but it is
2266 <h3><a name="userlist"></a>userlist</h3>
2267 <p>This is a program to print the userlist. There are two flags that
2269 set when running this program. When called without any arguments, <tt>userlist</tt>
2270 will display all users (except those who have chosen to be unlisted),
2271 their user numbers, times called, messages posted, screen width, and
2272 date of their most recent call.</p>
2273 <p><tt>userlist</tt> is simply the same user listing code that is in
2275 client, made into a standalone utility for convenience.<br>
2277 <h3><a name="sendcommand"></a>sendcommand</h3>
2278 <p><tt>sendcommand</tt> will interpret its arguments (except for <tt>-hDIRNAME</tt>)
2279 as a server command, which is sent to the server. Commands which
2280 require textual input will read it from stdin. Commands which generate
2281 textual output will be sent to stdout.</p>
2282 <p>This utility is intended to be used to enable Citadel server
2284 be executed from shell scripts. Review the script called <tt>weekly</tt>
2285 which ships with the Citadel distribution for an example of how this
2288 <p><b>NOTE:</b> be sure that this utility is not world-executable. It
2289 connects to the server in privileged mode, and therefore could present
2291 if not properly restricted.</p>
projects / citadel.git / blob