1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <title>Citadel/UX Documentation</title>
6 <meta http-equiv="content-type"
7 content="text/html; charset=ISO-8859-1">
14 <h2>a messaging and collaboration platform for BBS and groupware applications</h2>
15 Copyright ©1987-2003 by the Citadel development team:<br>
18 <table cellpadding="2" cellspacing="2" border="0" align="center">
21 <td valign="top">Steven M. Bellovin<br>
23 <td valign="top"><i>author of public domain 'parsedate' function<br>
27 <td valign="top">Nathan Bryant<br>
29 <td valign="top"><i>build system, security, database access,
34 <td valign="top">Art Cancro<br>
36 <td valign="top"><i>overall system design and lead developer<br>
40 <td valign="top">Brian Costello<br>
42 <td valign="top"><i>cosmetics, additional commands<br>
46 <td valign="top">Michael Hampton<br>
48 <td valign="top"><i>client software development<br>
52 <td valign="top">Andru Luvisi<br>
54 <td valign="top"><i>troubleshooting and development assistance<br>
58 <td valign="top">Daniel Malament<br>
60 <td valign="top"><i>string compare function for IMAP server<br>
64 <td valign="top">Stu Mark<br>
66 <td valign="top"><i>additional client features, IGnet protocol
71 <td valign="top">Ben Mehlman<br>
73 <td valign="top"><i>additional client features<br>
77 <td valign="top">Ari Samson<br>
79 <td valign="top"><i>assistance with project management<br>
83 <td valign="top">John Walker<br>
85 <td valign="top"><i>author of public domain base64 encoder/decoder<br>
89 <td valign="top">Steve Williams<br>
91 <td valign="top"><i>documentation<br>
95 <td valign="top">Ethan Young<br>
97 <td valign="top"><i>IGnet protocol design<br>
106 <div align="justify">The entire package is open source; you can redistribute
107 and/or modify it under the terms of the GNU General Public License as
108 published by the Free Software Foundation; either version 2 of the License,
109 or (at your option) any later version.<br>
111 This program is distributed in the hope that it will be useful, but
112 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
113 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
114 for more details. </div>
116 <div align="justify"><br>
117 For more information, visit either of these locations on the web:<br>
120 <li>The Citadel home page: <a href="http://www.citadel.org">http://www.citadel.org</a></li>
121 <li>UNCENSORED! BBS, the home of Citadel: <a
122 href="http://uncensored.citadel.org">http://uncensored.citadel.org</a></li>
126 <hr width="100%" size="2">
127 <h2 align="center">Table of Contents</h2>
130 <li><a href="#GPL">License</a></li>
131 <li><a href="#Installation">Installation</a></li>
134 <li><a href="#Everything_in_its_place...">Everything in its place...</a></li>
135 <li><a href="#The_BBS_Login">The BBS Login</a></li>
136 <li><a href="#Bypassing_the_login:_prompt">Bypassing the login: prompt</a></li>
137 <li><a href="#Compiling_the_programs">Compiling the programs</a></li>
138 <li><a href="#Upgrading">Upgrading</a></li>
139 <li><a href="#The_citadel.rc_file">The citadel.rc file</a></li>
140 <li><a href="#Using_an_external_editor_for_message">Using an external
141 editor for message composition</a></li>
142 <li><a href="#Printing_messages">Printing messages</a></li>
143 <li><a href="#URL_viewing">URL viewing</a></li>
144 <li><a href="#Setup_and_login">Setup and login</a></li>
145 <li><a href="#Configuring_your_host_system_to_start">Configuring your
146 host system to start the service</a></li>
147 <li><a href="#Logging_in_for_the_first_time">Logging in for the first
149 <li><a href="#Welcoming_new_users">Welcoming new users</a></li>
150 <li><a href="#Space_for_adding_your_own_client">Space for adding your
151 own client features (doors)</a></li>
152 <li><a href="#Troubleshooting_and_getting_help">Troubleshooting and
157 <li><a href="#sysop">System Administration</a></li>
160 <li><a href="#Overview_">Overview</a></li>
161 <li><a href="#Aide_commands">Aide commands</a></li>
162 <li><a href="#Editing_rooms">Editing rooms</a></li>
163 <li><a href="#File_directories">File directories</a></li>
164 <li><a href="#Creating_and_editing_user_accounts">Creating and editing
165 user accounts</a></li>
166 <li><a href="#Deleting_and_moving_messages">Deleting and moving messages</a></li>
167 <li><a href="#Customizing_the_help_files">Customizing the help files</a></li>
168 <li><a href="#Site_configuration">Site configuration</a><br>
178 <hr width="100%" size="2"><br>
180 <h2 align="center"><a name="GPL"></a>GNU General Public License<br>
184 <p> Version 2, June 1991 </p>
186 <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>
188 <h3 align="justify">Preamble</h3>
190 <div align="justify"> </div>
192 <p align="justify"> The licenses for most software are designed to take
193 away your freedom to share and change it. By contrast, the GNU General
194 Public License is intended to guarantee your freedom to share and change
195 free software--to make sure the software is free for all its users. This
196 General Public License applies to most of the Free Software Foundation's
197 software and to any other program whose authors commit to using it. (Some
198 other Free Software Foundation software is covered by the GNU Library General
199 Public License instead.) You can apply it to your programs, too. </p>
201 <div align="justify"> </div>
203 <p align="justify"> When we speak of free software, we are referring to
204 freedom, not price. Our General Public Licenses are designed to make sure
205 that you have the freedom to distribute copies of free software (and charge
206 for this service if you wish), that you receive source code or can get
207 it if you want it, that you can change the software or use pieces of it
208 in new free programs; and that you know you can do these things. </p>
210 <div align="justify"> </div>
212 <p align="justify"> To protect your rights, we need to make restrictions
213 that forbid anyone to deny you these rights or to ask you to surrender
214 the rights. These restrictions translate to certain responsibilities for
215 you if you distribute copies of the software, or if you modify it. </p>
217 <div align="justify"> </div>
219 <p align="justify"> For example, if you distribute copies of such a program,
220 whether gratis or for a fee, you must give the recipients all the rights
221 that you have. You must make sure that they, too, receive or can get the
222 source code. And you must show them these terms so they know their rights.
225 <div align="justify"> </div>
227 <p align="justify"> We protect your rights with two steps: (1) copyright
228 the software, and (2) offer you this license which gives you legal permission
229 to copy, distribute and/or modify the software. </p>
231 <div align="justify"> </div>
233 <p align="justify"> Also, for each author's protection and ours, we want
234 to make certain that everyone understands that there is no warranty for
235 this free software. If the software is modified by someone else and passed
236 on, we want its recipients to know that what they have is not the original,
237 so that any problems introduced by others will not reflect on the original
238 authors' reputations. </p>
240 <div align="justify"> </div>
242 <p align="justify"> Finally, any free program is threatened constantly by
243 software patents. We wish to avoid the danger that redistributors of a free
244 program will individually obtain patent licenses, in effect making the program
245 proprietary. To prevent this, we have made it clear that any patent must
246 be licensed for everyone's free use or not licensed at all. </p>
248 <div align="justify"> </div>
250 <p align="justify"> The precise terms and conditions for copying, distribution
251 and modification follow. </p>
253 <div align="justify"> </div>
255 <h3>TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</h3>
257 <div align="justify"> </div>
259 <p align="justify"> <strong>0.</strong> This License applies to any program
260 or other work which contains a notice placed by the copyright holder saying
261 it may be distributed under the terms of this General Public License.
262 The "Program", below, refers to any such program or work, and a "work based
263 on the Program" means either the Program or any derivative work under copyright
264 law: that is to say, a work containing the Program or a portion of it,
265 either verbatim or with modifications and/or translated into another language.
266 (Hereinafter, translation is included without limitation in the term "modification".)
267 Each licensee is addressed as "you". </p>
269 <p align="justify"> Activities other than copying, distribution and modification
270 are not covered by this License; they are outside its scope. The act of
271 running the Program is not restricted, and the output from the Program
272 is covered only if its contents constitute a work based on the Program
273 (independent of having been made by running the Program). Whether that
274 is true depends on what the Program does. </p>
276 <p align="justify"> <strong>1.</strong> You may copy and distribute verbatim
277 copies of the Program's source code as you receive it, in any medium, provided
278 that you conspicuously and appropriately publish on each copy an appropriate
279 copyright notice and disclaimer of warranty; keep intact all the notices
280 that refer to this License and to the absence of any warranty; and give
281 any other recipients of the Program a copy of this License along with the
284 <p align="justify"> You may charge a fee for the physical act of transferring
285 a copy, and you may at your option offer warranty protection in exchange
288 <p align="justify"> <strong>2.</strong> You may modify your copy or copies
289 of the Program or any portion of it, thus forming a work based on the Program,
290 and copy and distribute such modifications or work under the terms of
291 Section 1 above, provided that you also meet all of these conditions: </p>
293 <p align="justify"> </p>
295 <div align="justify">
297 <li><strong>a)</strong> You must cause the modified files to
298 carry prominent notices stating that you changed the files and the
302 <li><strong>b)</strong> You must cause any work that you distribute
303 or publish, that in whole or in part contains or is derived from the
304 Program or any part thereof, to be licensed as a whole at no charge
305 to all third parties under the terms of this License.
309 <li><strong>c)</strong> If the modified program normally reads
310 commands interactively when run, you must cause it, when started
311 running for such interactive use in the most ordinary way, to print
312 or display an announcement including an appropriate copyright notice
313 and a notice that there is no warranty (or else, saying that you provide
314 a warranty) and that users may redistribute the program under
315 these conditions, and telling the user how to view a copy of this
316 License. (Exception: if the Program itself is interactive but does
317 not normally print such an announcement, your work based on the Program
318 is not required to print an announcement.) </li>
321 These requirements apply to the modified work as a whole. If identifiable
322 sections of that work are not derived from the Program, and can be reasonably
323 considered independent and separate works in themselves, then this License,
324 and its terms, do not apply to those sections when you distribute them
325 as separate works. But when you distribute the same sections as part of
326 a whole which is a work based on the Program, the distribution of the whole
327 must be on the terms of this License, whose permissions for other licensees
328 extend to the entire whole, and thus to each and every part regardless of
331 <p align="justify"> Thus, it is not the intent of this section to claim rights
332 or contest your rights to work written entirely by you; rather, the intent
333 is to exercise the right to control the distribution of derivative or collective
334 works based on the Program. </p>
336 <p align="justify"> In addition, mere aggregation of another work not based
337 on the Program with the Program (or with a work based on the Program) on
338 a volume of a storage or distribution medium does not bring the other work
339 under the scope of this License. </p>
341 <p align="justify"> <strong>3.</strong> You may copy and distribute the
342 Program (or a work based on it, under Section 2) in object code or executable
343 form under the terms of Sections 1 and 2 above provided that you also do
344 one of the following: <!-- we use this doubled UL to get the sub-sections indented, -->
345 <!-- while making the bullets as unobvious as possible. --> </p>
347 <div align="justify">
349 <li><strong>a)</strong> Accompany it with the complete corresponding
350 machine-readable source code, which must be distributed under the
351 terms of Sections 1 and 2 above on a medium customarily used for software
355 <li><strong>b)</strong> Accompany it with a written offer,
356 valid for at least three years, to give any third party, for a charge
357 no more than your cost of physically performing source distribution,
358 a complete machine-readable copy of the corresponding source code,
359 to be distributed under the terms of Sections 1 and 2 above on a medium
360 customarily used for software interchange; or,
364 <li><strong>c)</strong> Accompany it with the information
365 you received as to the offer to distribute corresponding source code.
366 (This alternative is allowed only for noncommercial distribution and
367 only if you received the program in object code or executable form
368 with such an offer, in accord with Subsection b above.) </li>
371 The source code for a work means the preferred form of the work
372 for making modifications to it. For an executable work, complete source
373 code means all the source code for all modules it contains, plus any associated
374 interface definition files, plus the scripts used to control compilation
375 and installation of the executable. However, as a special exception,
376 the source code distributed need not include anything that is normally
377 distributed (in either source or binary form) with the major components
378 (compiler, kernel, and so on) of the operating system on which the executable
379 runs, unless that component itself accompanies the executable. </div>
381 <p align="justify"> If distribution of executable or object code is made
382 by offering access to copy from a designated place, then offering equivalent
383 access to copy the source code from the same place counts as distribution
384 of the source code, even though third parties are not compelled to copy
385 the source along with the object code. </p>
387 <p align="justify"> <strong>4.</strong> You may not copy, modify, sublicense,
388 or distribute the Program except as expressly provided under this License.
389 Any attempt otherwise to copy, modify, sublicense or distribute the Program
390 is void, and will automatically terminate your rights under this License.
391 However, parties who have received copies, or rights, from you under
392 this License will not have their licenses terminated so long as such parties
393 remain in full compliance. </p>
395 <p align="justify"> <strong>5.</strong> You are not required to accept
396 this License, since you have not signed it. However, nothing else grants
397 you permission to modify or distribute the Program or its derivative works.
398 These actions are prohibited by law if you do not accept this License.
399 Therefore, by modifying or distributing the Program (or any work based on
400 the Program), you indicate your acceptance of this License to do so, and
401 all its terms and conditions for copying, distributing or modifying the
402 Program or works based on it. </p>
404 <p align="justify"> <strong>6.</strong> Each time you redistribute the Program
405 (or any work based on the Program), the recipient automatically receives a
406 license from the original licensor to copy, distribute or modify the Program
407 subject to these terms and conditions. You may not impose any further
408 restrictions on the recipients' exercise of the rights granted herein. You
409 are not responsible for enforcing compliance by third parties to this License.
412 <p align="justify"> <strong>7.</strong> If, as a consequence of a court
413 judgment or allegation of patent infringement or for any other reason (not
414 limited to patent issues), conditions are imposed on you (whether by court
415 order, agreement or otherwise) that contradict the conditions of this
416 License, they do not excuse you from the conditions of this License.
417 If you cannot distribute so as to satisfy simultaneously your obligations
418 under this License and any other pertinent obligations, then as a consequence
419 you may not distribute the Program at all. For example, if a patent license
420 would not permit royalty-free redistribution of the Program by all those
421 who receive copies directly or indirectly through you, then the only way
422 you could satisfy both it and this License would be to refrain entirely from
423 distribution of the Program. </p>
425 <p align="justify"> If any portion of this section is held invalid or unenforceable
426 under any particular circumstance, the balance of the section is intended
427 to apply and the section as a whole is intended to apply in other circumstances.
430 <p align="justify"> It is not the purpose of this section to induce you to
431 infringe any patents or other property right claims or to contest validity
432 of any such claims; this section has the sole purpose of protecting the
433 integrity of the free software distribution system, which is implemented
434 by public license practices. Many people have made generous contributions
435 to the wide range of software distributed through that system in reliance
436 on consistent application of that system; it is up to the author/donor to
437 decide if he or she is willing to distribute software through any other system
438 and a licensee cannot impose that choice. </p>
440 <p align="justify"> This section is intended to make thoroughly clear what
441 is believed to be a consequence of the rest of this License. </p>
443 <p align="justify"> <strong>8.</strong> If the distribution and/or use of
444 the Program is restricted in certain countries either by patents or by copyrighted
445 interfaces, the original copyright holder who places the Program under this
446 License may add an explicit geographical distribution limitation excluding
447 those countries, so that distribution is permitted only in or among countries
448 not thus excluded. In such case, this License incorporates the limitation
449 as if written in the body of this License. </p>
451 <p align="justify"> <strong>9.</strong> The Free Software Foundation may
452 publish revised and/or new versions of the General Public License from
453 time to time. Such new versions will be similar in spirit to the present
454 version, but may differ in detail to address new problems or concerns.
457 <p align="justify"> Each version is given a distinguishing version number.
458 If the Program specifies a version number of this License which applies
459 to it and "any later version", you have the option of following the terms
460 and conditions either of that version or of any later version published
461 by the Free Software Foundation. If the Program does not specify a version
462 number of this License, you may choose any version ever published by the
463 Free Software Foundation. </p>
465 <p align="justify"> <strong>10.</strong> If you wish to incorporate parts
466 of the Program into other free programs whose distribution conditions are
467 different, write to the author to ask for permission. For software which
468 is copyrighted by the Free Software Foundation, write to the Free Software
469 Foundation; we sometimes make exceptions for this. Our decision will
470 be guided by the two goals of preserving the free status of all derivatives
471 of our free software and of promoting the sharing and reuse of software generally.
474 <p align="justify"><strong>NO WARRANTY</strong></p>
476 <div align="justify"> </div>
478 <p align="justify"> <strong>11.</strong> BECAUSE THE PROGRAM IS LICENSED
479 FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED
480 BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
481 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
482 OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
483 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
484 THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH
485 YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
486 SERVICING, REPAIR OR CORRECTION. </p>
488 <p align="justify"> <strong>12.</strong> IN NO EVENT UNLESS REQUIRED BY
489 APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY
490 OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED
491 ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL
492 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM
493 (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE
494 OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
495 TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
496 HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. </p>
498 <p align="justify"> </p>
500 <h3>END OF TERMS AND CONDITIONS</h3>
503 <hr width="100%" size="2"><br>
506 <h2><a name="Installation"></a>Installation</h2>
509 <div align="justify">
512 <p>Citadel/UX is an advanced, multiuser, client/server, room-based BBS program.
513 It is designed to handle the needs of both small dialup systems and large-scale
514 Internet-connected systems. It was originally developed on an Altos system
515 running Xenix, and has been installed and tested on various Unix and Unix-like
516 platforms. The author's current development environment (and BBS) is an
517 ordinary Linux system. The current distribution includes: </p>
520 <li>The Citadel/UX server (this is the back end that does all processing)
522 <li>A text-based client program designed with the traditional Citadel
523 "look and feel" (room prompts, dot commands, and the like) </li>
524 <li>Setup programs </li>
525 <li>A set of utilities for system administration and maintenance </li>
526 <li>Documentation </li>
530 <p>Some knowledge of the Unix system is necessary to install and manage the
531 system. It is mandatory that the sysop have "root" access to the operating
532 system. The following are required to install Citadel/UX: </p>
535 <li>A Unix operating system (Linux, BSD, Solaris, Tru64, HP/UX) </li>
536 <li>C compiler (such as gcc or egcs) and "make" </li>
537 <li>POSIX threads (the "pthreads" library) </li>
539 <li><a href="http://www.sleepycat.com">Berkeley DB</a> v4.1 or newer
540 (GDBM also works, but its use is officially depracated. If you are building
541 a new system, do <i>not</i> use GDBM. If you have an existing system which
542 uses GDBM, you should migrate it to Berkeley DB as soon as possible.) </li>
543 <li>Enough disk space to hold all of the programs and data </li>
547 <p>If you are running Citadel/UX on a Linux system, it is STRONGLY recommended
548 that you run it on a recent distribution (such as <a
549 href="http://www.redhat.com">Red Hat</a> 7.3 or newer). A new-ish distribution
550 will have most or all of the prerequisite tools and libraries already integrated
553 <h3>Now available:</h3>
556 <li>"WebCit", a gateway program to allow full access to Citadel via
557 the World Wide Web. Interactive access through any Web browser. </li>
558 <li>Access to Citadel via <i>any</i> standards-compliant e-mail program,
559 thanks to Citadel's built-in SMTP, POP, and IMAP services. You can
560 use Netscape/Mozilla, Evolution, Eudora, Pine, or even Microsoft VirusSpreader
561 (better known as "Outlook") with Citadel. </li>
565 <h3>Coming soon:</h3>
568 <li>Newer and better GUI-based clients. </li>
572 <h3><a name="Everything_in_its_place..."></a>Everything in its place...</h3>
574 <p>Hopefully you've unpacked the distribution archive into its own directory.
575 This is the directory in which all Citadel files are located and in which
576 all activity will take place. Several subdirectories have already been
577 created during the unpacking process, and others may be created by the software
578 if needed. Make sure you have Berkeley DB installed on your system, and
579 that you have all the development libraries and headers in place so that
580 you can compile against them. If you don't, you can get the latest Berkeley
581 DB at <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
582 If your operating system uses a separate library to support POSIX threads
583 (pthreads), make sure that library is installed as well. This is almost
584 never the case with Linux, but some commercial Unix flavors might need it.</p>
586 <h3><a name="The_BBS_Login"></a></h3>
588 <h3>The BBS Login</h3>
590 <p>As with many Unix programs, Citadel wants to run under its own user ID.
591 Unlike other programs, however, this user ID will do double-duty as a public
592 login for your system if you are running a BBS. This account is typically
593 called "bbs" or "citadel" or something to that effect. You will tell Citadel
594 what the user-id of that account is, and when someone logs in under that
595 account, Citadel will prompt for a user name.</p>
597 <p>The Citadel user should have a unique uid. The home directory should be
598 the one your Citadel installation resides in (in this example we will use
599 /usr/local/citadel) and the shell should be either "citadel" in that directory,
600 or a script that will start up citadel (you may wish to set up an external
601 text editor; see below). Example:</p>
603 <pre>bbs::100:1:BBS Login:/usr/local/citadel:/usr/local/citadel/citadel<br></pre>
605 <p>When you run setup later, you will be required to tell it what the Citadel
606 user's numeric user ID is, so it knows what user to run as. If you create
607 an account called <tt>bbs</tt>, <tt>guest</tt>, or <tt>citadel</tt>, the
608 setup program will automatically pick up the user ID by default.</p>
610 <p>For all other users in /etc/passwd, Citadel will automatically set up
611 an account using the full name (or 'gecos' in Unixspeak) of the user. It'll
612 also ignore any password you supply, because it uses the user's password
613 on the host system. This allows a 'single sign on' type of environment.
614 Note that this does have to be enabled at compile time -- it's the configure
615 option called <tt>--enable-autologin</tt>. Keep in mind that these users
616 can use *either* their Citadel login name or their login name on the host
617 computer, and their password on the host computer.</p>
619 <h3><a name="Bypassing_the_login:_prompt"></a></h3>
621 <h3>Bypassing the <tt>login:</tt> prompt</h3>
623 <p>If you normally log in to your host system using some method other than
624 telnet (such as ssh), you might want the telnet service to go straight to
625 the Citadel BBS, instead of displaying the <tt>login:</tt> prompt first.
626 You can do this by having telnetd start citadel directly instead of <tt>/bin/login</tt>.
627 This is actually very simple to implement; all you need to do is make a simple
628 change to your <tt>inetd</tt> or <tt>xinetd</tt> configuration. Here are
629 some configuration examples.</p>
631 <p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
632 replacing any existing telnet configuration line already there):</p>
634 <pre>telnet stream tcp nowait root /usr/sbin/tcpd in.telnetd -L /usr/local/citadel/citadel<br></pre>
636 <p>An example for <tt>xinetd</tt> (if you have a file called <tt>/etc/xinetd.d/telnet</tt>
637 then simply replace that file with this one):</p>
639 <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>
641 <p>Please make sure you know what you're doing before you install this! If
642 you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
643 then change the directory name accordingly. If you know of any other local
644 peculiarities which need to be observed, edit the above configuration accordingly
645 as well. And, of course, if you're working remotely, make sure you can
646 successfully log in using SSH before you start changing your telnet configuration,
647 otherwise you could lock yourself out of your system (ask any networking
648 specialist about the dangers of "working inline" -- then pull up a chair
649 and get a fresh cup of coffee, because you're going to hear some war stories).</p>
651 <h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
653 <p>You can easily compile the Citadel system with the following commands:</p>
655 <pre>./configure<br>make<br>make install<br></pre>
657 <p>The 'configure' script will generate a Makefile from the Makefile.in,
658 and it will also write the file "sysdep.h" to your Citadel directory. Please
659 do not edit sysdep.h or Makefile.in yourself. The configure script will
660 figure out your system dependencies and set everything correctly.</p>
662 <p>Mac OS X 10.1 and later are now supported. (Sorry, 10.0 cannot be supported,
663 now or in the future.) You need to install the Developer Tools CD, which
664 you can purchase or download for free from <a
665 href="http://developer.apple.com">http://developer.apple.com</a>. Then run
666 configure like this:</p>
668 <pre>env CC=/usr/bin/cc ./configure (options - see below)<br></pre>
670 <p>By default, the Citadel system will install in <tt>/usr/local/citadel</tt>.
671 If you wish to place it in a different directory, you can instead do:</p>
673 <pre>./configure --prefix=/export/home/citadel (or whatever)<br></pre>
675 <p>If you've got Berkeley DB installed in a non-standard location, you can
676 help the configure script find it by doing something like this:</p>
678 <pre>./configure --with-db=/usr/local/BerkeleyDB-4.1<br></pre>
680 <p>The configure script prefers Berkeley DB if it is available, but will fall
681 back to GDBM if it has to.</p>
683 <p>File permissions are always a bother to work with. You don't want Citadel
684 to crash because someone couldn't access a file, but you also don't want
685 shell users peeking into the binaries to do things like reading others'
686 mail, finding private rooms, etc. The Citadel server needs to be started
687 as root in order to bind to privileged ports, but as soon as its initialization
688 is finished, it changes its user ID to your BBS user ID in order to avoid
691 <h3><a name="Upgrading"></a></h3>
695 <p>Any existing Citadel installation which is at version 5.50 or newer may
696 be upgraded in place without the need to discard your existing data files.</p>
698 <p>Upgrading to a new version uses the same build procedure as compiling
699 the program for a fresh install, except that you want to do <tt>make install-exec</tt>
700 instead of <tt>make install</tt>. This will overwrite the programs but not
701 your data. <b>Be sure to shut down citserver during this process!</b> If
702 Citadel is running while you upgrade, you may face data corruption issues.<br>
705 <p>After doing <tt>make install-exec</tt>, you should run <tt>setup</tt>
706 again to bring your data files up to date. Please see the setup section
707 below for more information on this.</p>
709 <h3><a name="The_citadel.rc_file"></a>The <tt>citadel.rc</tt> file</h3>
711 <p>The text-based client included with Citadel is suitable for BBS applications.
712 Much of its command set and other behavior is configurable through a Run
713 Control (RC) file. The standard client looks for this file in the following
717 <li><tt>$HOME/.citadelrc</tt></li>
718 <li><tt>/usr/local/lib/citadel.rc</tt></li>
719 <li><i>your-Citadel-directory</i><tt>/citadel.rc</tt></li>
722 The next couple of sections deal with client-side configuration.
723 <h3><a name="Using_an_external_editor_for_message"></a>Using an external editor
724 for message composition</h3>
726 <p>Citadel/UX has a built-in message editor. However, you can also use your
727 favorite text editor to write messages. To do this you simply put a line
728 in your citadel.rc file like this:</p>
730 <pre>editor=/usr/bin/vi<br></pre>
732 <p>The above example would make Citadel call the vi editor when using the
733 <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make it the default
734 editor for the <tt><b>E</b>nter</tt> command by editing the <tt>citadel.rc</tt>
735 file. <b>But be warned:</b> external editors on public systems can be a
736 security hole, because they usually provide users with the ability to drop
737 into a shell on the host system, or save files using names other than the
738 name of the temporary file they are editing. If you intend to use an external
739 editor on a public BBS, make sure you use one that has been hardened for
740 such a purpose -- one which has had the 'shell' and 'save as' commands disabled,
741 as well as any other functions which a destructive user could use to gain
742 unauthorized access to your host system.</p>
744 <h3><a name="Printing_messages"></a>Printing messages</h3>
746 <p>Citadel/UX can send messages to a printer, or just about anywhere else
747 in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt> specifies
748 what command you use to print. Text is sent to the standard input (stdin)
749 of the print command.</p>
751 <p>So if you did this:</p>
753 <pre>printcmd="nl|pr|lpr -Plocal"<br></pre>
755 <p>...that would add line numbers, then paginate, then print on the printer
756 named "local". There's tons of stuff you can do with this feature. For example,
757 you could use a command like <tt>cat <<$HOME/archive</tt> to save copies
758 of important messages in a textfile. Again, this is probably something
759 you don't want to configure for a public BBS host -- most system administrators
760 don't want remote users sending arbitrary things to local printers.</p>
762 <h3><a name="URL_viewing"></a>URL viewing</h3>
764 <p>This is one more feature which is appropriate for local users. While reading
765 a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
766 command, and it will perform some pre-defined action (usually, this is to
767 open up the URL in a web browser). For example:</p>
769 <pre>urlcmd=netscape -remote "openURL(%s)"<br></pre>
771 <p>In the above example, it would open up the URL in an open <a
772 href="http://www.netscape.com/download">Netscape</a> window.</p>
774 <h3><a name="Setup_and_login"></a></h3>
776 <h3>Setup and login</h3>
778 <p>Before logging in for the first time, you must run the setup program.
779 To begin this procedure, enter the following commands:</p>
781 <pre>cd /usr/local/citadel<br>./setup<br></pre>
783 <p>The setup program will guide you through a simple configuration procedure.
784 It will ask you what directory to place your data files in -- the default
785 is the current directory, which is usually the sensible thing to select.
786 If you want to run more than one instance of Citadel on the same host, however,
787 you can specify a different directory here -- just remember to specify the
788 directory name again when you start up the server later on.</p>
790 <p><tt>setup</tt> will then shut down the Citadel service if it is found to
793 <p>You will then be prompted for the name of the system administrator. This
794 is not merely a cosmetic option -- when you log in to your system a little
795 while from now, you'll log in with this name, and it will automatically assign
796 your account the highest access level.</p>
798 <p>Next, you will be prompted for the User ID of the Citadel account on your
799 host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
800 or <tt>citadel</tt>, that account's UID will be the default. If you are
801 upgrading or reconfiguring an existing system, the existing value will be
804 <p>Then you will be prompted for a server port number. This is the TCP port
805 which Citadel clients use to connect to your Citadel server. In almost all
806 cases, you want to use the default -- port 504, which is the official port
807 number assigned by the IANA for Citadel implementations.</p>
809 <p>The Citadel service will then be started, and you will see the following
812 <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 find
815 out if you need to do anything else:</p>
817 <h3><a name="Configuring_your_host_system_to_start"></a>Configuring your host
818 system to start the service</h3>
820 <p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
821 and <tt>/etc/inittab</tt> in order to configure your host system to automatically
822 start the Citadel service. <tt>setup</tt> will automatically perform these
823 steps if it can, and if you allow it to -- just answer 'Yes' when prompted,
824 and everything will be taken care of for you. If you answer 'No' -- or if
825 your system is a little bit odd (for example, BSD systems don't have <tt>/etc/inittab</tt>)
826 -- read this section and do what you need to in order to get things configured.</p>
828 <p>Before you can use Citadel, you must define the "citadel" service to your
829 system. This is accomplished by adding a line to your /etc/services file
830 that looks something like this:</p>
832 <pre>citadel 504/tcp # Citadel/UX Server<br></pre>
834 <p>504 is the port number officially designated by the IANA for use by Citadel.
835 There should not be any need to use a different port number, unless you are
836 running multiple Citadels on the same computer and therefore need a different
837 port for each one.</p>
839 <p>The next step is to arrange for the server to start. The <tt>citserver</tt>
840 program is the main Citadel server. Before we cover the recommended method
841 of starting the server, let's examine its usage options:</p>
843 <pre>citserver [-hHomeDir] [-xDebugLevel] [-tTraceFile] [-d] [-f]<br></pre>
845 <p>The options are as follows:</p>
847 <p><tt>-hHomeDir</tt> - the directory your BBS data files live in. This should,
848 of course, be a directory that you've run the <tt>setup</tt> program against
849 to set up some data files. If a directory is not specified, the directory
850 name which was specified in the <tt>Makefile</tt> will be used.</p>
852 <p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed. The
853 available debugging levels are: </p>
856 <li>1 - Internal errors (failed thread creation, malloc problems, etc.)
858 <li>2 - Network errors (broken sockets, failed socket creation)
860 <li>3 - Begin and end of sessions, startup/shutdown of server </li>
861 <li>5 - Server commands being sent from clients </li>
862 <li>7 - Entry and exit of various functions </li>
863 <li>8 - Entry and exit of critical sections </li>
864 <li>9 - Various debugging checkpoints (insanely verbose) </li>
868 <p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace output.
869 Normally it is sent to stdout.</p>
871 <p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch would
872 be necessary if you were starting the Citadel server, for example, from an
873 rc.local script (which is not recommended, because this won't allow the server
874 to automatically restart when it is shut down).</p>
876 <p><tt>-f</tt> - Defragment all the databases upon startup. This isn't normally
877 necessary due to the nature of the data stored in Citadel, but the option
878 is provided in case you need it. (Note that this only applies to GDBM installations;
879 if you are using Berkeley DB it has no effect.)</p>
881 <p>The preferred method of starting the Citadel server is to place an entry
882 in your /etc/inittab file. This will conveniently bring the server up when
883 your system is up, and terminate it gracefully when your system is shutting
884 down. The exact syntax for your system may vary, but here's an entry that
885 could be used on a Linux system:</p>
887 <pre>cit:2345:respawn:/usr/local/citadel/citserver -h/usr/local/citadel -t/dev/tty9 -x3<br></pre>
889 <p>In this example, we've chosen debugging level 3, and have the trace stuff
890 output to one of the virtual consoles. It's important to remember to turn
891 off any getty that is set up on that virtual console, if you do this. After
892 making this change, the command <tt>init q</tt> works on most systems to tell
893 init to re-read the file. If in doubt, just reboot the computer.</p>
895 <h3><a name="Logging_in_for_the_first_time"></a>Logging in for the first time</h3>
897 <p>At this point, your system is ready to run. Run the <tt>citadel</tt> program
898 from the shell and log in as a new user. NOTE: the first user account to
899 be created will automatically be set to access level 6 (Aide). This overcomes
900 some obvious logistical problems - normally, Aide access is given by another
901 Aide, but since there aren't any on your system yet, this isn't possible.</p>
903 <h3><a name="Welcoming_new_users"></a>Welcoming new users</h3>
905 <p>Sometimes you might decide that you want a welcome message (or several
906 different messages) automatically mailed to new users upon their first login.
907 Now there is a way to do this. If you create a room called <tt>New User Greetings</tt>,
908 and it is a <i>private</i> room (invitation-only probably makes the most
909 sense), any messages you enter into that room will automatically be delivered
910 to all new users upon registration.</p>
912 <p>You can put anything you want there: a welcome message, system policies,
913 special information, etc. You can also put as many messages there as you
914 want to (although it really doesn't make sense to clutter new users' mailboxes
915 with lots of junk).</p>
917 <p>Don't worry about wasting disk space, either. Citadel has a single-instance
918 message store, so all the new users are actually looking at the same copy
919 of the message on disk.</p>
921 <h3><a name="Space_for_adding_your_own_client"></a>Space for adding your own
922 client features (doors)</h3>
924 <p><b>Please take note!</b> This function really represents the "old" way
925 of doing things, and it doesn't fit in well with the client/server paradigm.
926 Please consider it "deprecated" because it may be removed someday.</p>
928 <p>The "doorway" feature is just a generic way to add features to the system.
929 I called it "Doorway" to make it resemble the doors on non-Unix boards, but
930 as we all know, us Unix types don't have to write special code to access the
931 modem. :-) Anyway, when a user hits the <tt><b>*</b></tt> (doorway) command,
934 <pre>USERNAME=(username); export USERNAME<br>./subsystem (user-number) (screen-width) (access level)<br></pre>
936 <p>...so you can put whatever you want in there. I suggest putting in a menu
937 program to allow the users to pick one of a number of programs, etc. Do
938 be aware that door programs will only be available when the client and server
939 programs are running on the <i>same</i> computer, and when the user is running
940 the text-mode client. Because of these restrictions, Door programs are being
941 utilized less and less every day.</p>
943 <h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and getting
946 <p>That's just about all the information you need to install the system.
947 But if you get stuck, you can visit UNCENSORED! BBS and report a problem or
948 ask for help. But if you intend to report a problem getting the Citadel server
949 to run, <i>please</i> double-check the following things first: </p>
952 <li>Did you do <tt>./configure && make && make install</tt>
954 <li>Did you run setup? </li>
955 <li>Did you start the server? </li>
959 <p>To report a problem, you can log on to UNCENSORED! or any other BBS on
960 the Citadel network which carries the <tt>Citadel/UX></tt> room. Please
961 DO NOT e-mail the developers directly. Post a request for help on the BBS,
962 with all of the following information: </p>
965 <li>The exact nature of your difficulty </li>
966 <li>A transcript of the error message(s) if possible </li>
967 <li>The version of Citadel you are running </li>
968 <li>The version of Berkeley DB present on your system </li>
969 <li>Which operating system you are running, and what version </li>
970 <li>If you are running a Linux system, we need to know which distribution,
971 and the version of the kernel, libc, and pthreads you are using (it would
972 help to post the output of a <tt>ldd ./citserver</tt> command). </li>
978 <hr width="100%" size="2">
979 <h2><a name="sysop"></a>System Administration</h2>
982 <div align="justify">
983 <h3><a name="Overview_"></a>Overview</h3>
985 <p>Citadel/UX, when installed properly, will do most of its maintenance by
986 itself. It is intended to be run unattended for extended periods of time,
987 and most installations do just that without any software failures.</p>
989 <p>The system has seven access levels. Most users are at the bottom and have
990 no special privileges. Aides are selected people who have special access within
991 the Citadel program. Room Aides only have this access in a certain room.
992 Preferred users can be selected by Aides for access to preferred only rooms.
993 A sysop is anyone who has access to the various sysop utilities - these
994 are in their own executable files, which should have their permissions set
995 to allow only sysops to run them. You should either create a sysops group
996 in /etc/group, or use some other existing group for this purpose.</p>
998 <p>Aides have access to EVERY room on the system, public and private (all
999 types). They also have access to commands starting with <tt>.<b>A</b>ide</tt>
1000 in addition to being able to delete and move messages. The system room,
1001 <tt>Aide></tt>, is accessible only by those users designated as Aides.</p>
1003 <h3><a name="Aide_commands"></a>Aide commands</h3>
1005 <p>Aides have the following commands available to them that are not available
1006 to normal users. They are:</p>
1011 <td width="30%"><tt> .<b>A</b>ide <b>K</b>ill this room </tt></td>
1012 <td> Deletes the current room from the system. </td>
1015 <td width="30%"><tt> .<b>A</b>ide <b>E</b>dit this room </tt></td>
1016 <td> Allows editing of the properties of the current room. This is
1017 explained in greater detail below. </td>
1020 <td width="30%"><tt> .<b>A</b>ide <b>W</b>ho knows room </tt></td>
1021 <td> For private rooms with access controls, or mailbox rooms, this
1022 command displays a list of users who have access to the current room. </td>
1025 <td width="30%"><tt> .<b>A</b>ide edit <b>U</b>ser </tt></td>
1026 <td> Allows editing of the properties of any user account on the system.
1030 <td width="30%"><tt> .<b>A</b>ide <b>V</b>alidate new users </tt></td>
1031 <td> For public access systems, this command reviews all new user
1032 registrations and allows you to set each new user's access level (or simply
1033 delete the accounts). </td>
1036 <td width="30%"><tt> .<b>A</b>ide enter <b>I</b>nfo file </tt></td>
1037 <td> Each room may contain a short textual description of its purpose,
1038 which is displayed to users upon entering the room for the first time (or
1039 in the room banner, for users of the Web client). This command allows you
1040 to enter or edit that description. </td>
1043 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite user </tt></td>
1044 <td> Access control command to grant any specific user access to a
1048 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick out user
1050 <td> Access control command to revoke any specifc user's access to
1051 the current room. This works regardless of whether the room is public or
1055 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>D</b>elete </tt></td>
1056 <td> If the current room has an associated file directory, this command
1057 may be used to delete files from it. </td>
1060 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end over net
1062 <td> If the current room has an associated file directory, this command
1063 may be used to transmit a copy of any file in that directory to another node
1064 on a Citadel network. </td>
1067 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>M</b>ove </tt></td>
1068 <td> If the current room has an associated file directory, this command
1069 may be used to move any file in that directory to another room. The target
1070 room must also have an associated file directory. </td>
1073 <td width="30%"><tt> .<b>A</b>ide <b>M</b>essage edit </tt></td>
1074 <td> This command allows editing of any of the various system banners
1075 and messages which are displayed to users. Type the name of the banner or
1076 message you wish to edit. </td>
1079 <td width="30%"><tt> .<b>A</b>ide <b>P</b>ost </tt></td>
1080 <td> This is the functional equivalent of the <tt><b>E</b>nter message</tt>
1081 command available to all users, except that it allows you to post using any
1085 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>G</b>eneral
1087 <td> This command allows configuration of a large number of global
1088 settings for your Citadel system. These settings will be explained in greater
1092 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>I</b>nternet
1094 <td> This command allows configuration of settings which affect how
1095 your Citadel system sends and receives messages on the Internet. </td>
1098 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration check
1099 <b>M</b>essage base </tt></td>
1100 <td> Perform a consistency check on your message store. This is a
1101 very time-consuming operation which should not be performed unless you have
1102 reason to believe there is trouble with your database. </td>
1105 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>N</b>etwork
1107 <td> Configure networking (e-mail, room sharing, etc.) with other
1108 Citadel nodes. </td>
1111 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration network
1112 <b>F</b>ilter list </tt></td>
1113 <td> If you are on a large public or semi-public network of Citadel
1114 nodes and you find content from certain systems or individuals objectionable,
1115 you can use this command to define a rule set to automatically reject those
1116 messages when they arrive on your system. </td>
1119 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>N</b>ow
1121 <td> Immediately shut down the Citadel service, disconnecting any
1122 users who are logged in. Please keep in mind that it will start right back
1123 up again if you are running the service from <tt>/etc/inittab</tt>, so in
1124 practice this command will probably not get much use. </td>
1127 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>S</b>cheduled
1129 <td> Shut down the Citadel service the next time there are zero users
1130 connected. This allows you to automatically wait until all users are logged
1134 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients </tt></td>
1135 <td> Any room may be made into a mailing list. Enter this command
1136 to open an editor window containing the list of Internet e-mail addresses
1137 to which every message posted in the room will be sent. </td>
1140 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest recipients
1142 <td> Similar to the regular mailing list command, except the messages
1143 will be sent out in 'digest' form -- recipients will see messages from the
1144 address of the room itself rather than the address of the author of each message,
1145 and a digest may contain more than one message. Each room may have any combination
1146 of List and Digest recipients. </td>
1149 <td width="30%"><tt> .<b>A</b>ide <b>N</b>etwork room sharing </tt></td>
1150 <td> Configures the sharing of the current room's contents with other
1151 Citadel nodes. Messages posted in this room on any Citadel system will automatically
1152 be replicated to other Citadel systems carrying the room. </td>
1158 <h3><a name="Editing_rooms"></a>Editing rooms</h3>
1160 <p>This command allows any aide to change the parameters of a room. Go to
1161 the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit room</tt>
1162 command. A series of prompts will be displayed. The existing parameters
1163 will be displayed in brackets; simply press return if you want to leave any
1164 or all of them unchanged.</p>
1166 <pre> <br>Room name [IG's Fun Room]:<br></pre>
1168 <p>...the name of the room.</p>
1170 <pre>Private room [Yes]? <br></pre>
1172 <p>...enter Yes if you wish to restrict access to the room, or no if the room
1173 is to be accessible by all users. Note that Citadel doesn't bother users
1174 about access to rooms every time they need to access the room. Once a user
1175 gains access to a private room, it then behaves like a public room to them.
1176 The following four questions will only be asked if you selected Private...</p>
1178 <pre>Accessible by guessing room name [No]?<br></pre>
1180 <p>...if you enter Yes, the room will not show up in users' <tt><b>K</b>nown
1181 rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing the
1182 room's full name), they will gain access to the room.</p>
1184 <pre>Accessible by entering a password [No]?<br>Room password [mypasswd]: <br></pre>
1186 <p>...this adds an additional layer of security to the room, prompting users
1187 for a password before they can gain access to the room.</p>
1189 <p>If you did not select guessname or passworded, then the only way users
1190 can access the room is if an Aide explicitly invites them to the room using
1191 the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt> command.</p>
1193 <pre>Cause current users to forget room [No] ? No<br></pre>
1195 <p>Enter Yes if you wish to kick out anyone who currently has access to the
1198 <pre>Preferred users only [No]? No<br></pre>
1200 <p>Enter Yes if you wish to restrict the room to only users who have level
1201 5 (Preferred User) status (and Aides too, of course). You should make the
1202 room public if you intend to do this, otherwise the two restrictions will
1205 <pre>Read-only room [No]? No<br></pre>
1207 <p>If you set a room to Read-Only, then normal users will not be allowed to
1208 post messages in it. Messages may only be posted by Aides, and by utility
1209 programs such as the networker and the "aidepost" utility. This is useful
1210 in situations where a room is used exclusively for important announcements,
1211 or if you've set up a room to receive an Internet mailing list and posting
1212 wouldn't make sense. Other uses will, of course, become apparent as the
1215 <p>Now for a few other attributes...</p>
1217 <pre>Directory room [Yes]? Yes<br></pre>
1219 <p>...enter Yes if you wish to associate a directory with this room. This
1220 can be used as a small file repository for files relevant to the topic of
1221 the room. If you enter Yes, you will also be prompted with the following four
1224 <pre>Directory name [mydirname]: <br></pre>
1226 <p>...the name of the subdirectory to put this room's files in. The name
1227 of the directory created will be <tt><i><your BBS directory></i>/files/<i><room
1228 dir name></i></tt>.</p>
1230 <pre>Uploading allowed [Yes]? Yes<br></pre>
1232 <p>...enter Yes if users are allowed to upload to this room.</p>
1234 <pre>Downloading allowed [Yes]? Yes<br></pre>
1236 <p>...enter Yes if users are allowed to download from this room.</p>
1238 <pre>Visible directory [Yes]? Yes<br></pre>
1240 <p>...enter Yes if users can read the directory of this room.</p>
1242 <pre>Network shared room [No]? No<br></pre>
1244 <p>...you can share a room over a network without setting this flag, and
1245 vice versa, but what this flag does is twofold: </p>
1248 <li>It prevents people with no network access from entering messages here
1250 <li>Messages are displayed with the name of their originating system in
1255 <pre>Permanent room [No]? No<br></pre>
1257 <p>Citadel contains an 'auto purger' which is capable of removing rooms which
1258 have not been posted in for a pre-defined period of time (by default this
1259 is set to two weeks). If you wish to keep this from happening to a particular
1260 room, you can set this option. (Keep in mind that <tt>Lobby></tt>, <tt>Aide></tt>,
1261 any private mailbox rooms, any network shared rooms, and any rooms with
1262 a file directory are automatically permanent.)</p>
1264 <pre>Anonymous messages [No]? No<br>Ask users whether to make messages anonymous [No]? No<br></pre>
1266 <p>...you can have rooms in which all messages are automatically anonymous,
1267 and you can have rooms in which users are prompted whether to make a message
1268 anonymous when they enter it. The real identity of the author of each message
1269 is still revealed to the Room Aide for this room, as well as any system-wide
1272 <pre>Room aide [Joe Responsible]: <br></pre>
1274 <p>...on larger systems, it helps to designate a person to be responsible
1275 for a room. Room Aides have access to a restricted set of Aide commands,
1276 ONLY when they are in the room in which they have this privilege. They can
1277 edit the room, delete the room, delete and move messages, and invite or kick
1278 out users (if it is a private room), but they cannot perform aide commands
1279 that are not room-related (such as changing users access levels).</p>
1281 <pre>Listing order [64]: <br></pre>
1283 <p>This is just a simple way to try to control the order rooms are listed
1284 in when users call up a <tt><b>K</b>nown Rooms</tt> listing. Rooms with a
1285 lower listing order are displayed prior to rooms with a higher listing order.
1286 It has no other effect. For users who list rooms in floor order, the display
1287 will sort first by floor, then by listing order.</p>
1289 <pre>Message expire policy (? for list) [0]:<br></pre>
1291 <p>This provides you with the opportunity to select how long each message
1292 will remain in a room before automatically being deleted. Press <tt><b>?</b></tt>
1293 for a list of options. You can choose to keep messages around forever (or
1294 until they are manually deleted), until they become a certain number of
1295 days old, or until a certain number of additional messages are posted in
1296 the room, at which time the oldest ones will scroll out.</p>
1298 <p>You will notice that you can also fall back to the default expire policy
1299 for the floor upon which the room resides. This is the default setting.
1300 You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit floor</tt>
1301 command. The default setting for the floor default, in turn, is the system
1302 default setting, which can be changed using the <tt><b>.A</b>ide <b>S</b>ystem
1303 configuration <b>G</b>eneral</tt> command.</p>
1305 <pre>Save changes (y/n)? Yes<br></pre>
1307 <p>...this gives you an opportunity to back out, if you feel you really messed
1308 things up while editing.</p>
1310 <h3><a name="File_directories"></a>File directories</h3>
1312 <p>If you have created any directory rooms, you can attach file descriptions
1313 to the filenames through a special file called <tt>filedir</tt>. Each line
1314 contains the name of a file in the directory, followed by a space and then
1315 a description of the file, such as:</p>
1317 <pre>myfile.txt This is a description of my file.<br>phluff A phile phull of phluff!<br></pre>
1319 <p>...this would create file descriptions for the files <tt>myfile.txt</tt>
1320 and <tt>phluff</tt> which would be displayed along with the directory.
1321 It should also be noted that when users upload files to your system, they
1322 will be prompted for file descriptions, which will be added to the <tt>filedir</tt>
1323 file. If one does not exist, it will be created.</p>
1325 <h3><a name="Creating_and_editing_user_accounts"></a>Creating and editing
1328 <p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1329 command to create and/or edit user accounts. There are several parameters
1330 which can be set here.</p>
1332 <p>To create a user:</p>
1334 <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>
1336 <p>At this point, the new user account has been created, and the command will
1337 continue as if you were editing an existing account. Therefore the remainder
1338 of this procedure is the same for creating and editing:</p>
1340 <pre>Lobby> . Aide edit User <br>User name: person of significance<br>User #70 - Person of Significance PW: <br> <br><br>, <br> <br> <br><br>Current access level: 4 (Network User)<br></pre>
1342 <p>The blank lines are the user's 'registration' information -- personal
1343 information such as full name, address, telephone number, etc. This information
1344 will comprise the user's vCard in both their user profile and in the Global
1347 <pre>Change password [No]: No<br></pre>
1349 <p>...answer Yes to set or change the password for this account.</p>
1351 <pre>Access level [4]: <br></pre>
1353 <p>...this allows you to set or change the access level for this account.
1354 The access levels available are as follows: </p>
1357 <li>0 - Deleted. (This immediately deletes the account.) </li>
1358 <li>1 - New, unvalidated user </li>
1359 <li>2 - Problem user (severely restricts account - use for probationary
1361 <li>3 - User with no network privileges. Same access as a normal user
1362 except cannot post messages in rooms shared on a network. </li>
1363 <li>4 - Normal user </li>
1364 <li>5 - Preferred user (access is granted to privileged rooms) </li>
1365 <li>6 - Aide (administrative access to the whole system) </li>
1369 <pre>Permission to send/receive Internet mail [ No]? No<br></pre>
1371 <p>If your system is configured to only allow Internet mail privileges to
1372 certain users, this is where you can grant or revoke that privilege.</p>
1374 <pre>Ask user to register again [Yes]: Yes<br></pre>
1376 <p>If you answer Yes to this question, the user will be presented with a
1377 'registration' screen or set of prompts, the next time they log in using
1378 a Citadel client. This will prompt them for their full name, address, telephone
1381 <pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1383 <p>These statistics are available for informational purposes only, so there
1384 is normally no need to change them.</p>
1386 <pre>Set last call to now [No]: No<br>Purge time (in days, 0 for system default [0]: <br></pre>
1388 <p>Citadel contains an auto-purger which is capable of automatically deleting
1389 accounts which have not been accessed in a predefined period of time. If
1390 you choose to perform this operation, you can 'touch' the account of a wayward
1391 user by setting their 'last call' time to 'now'. You can also adjust, on
1392 a per-user basis, the amount of time which must pass before their account
1393 is purged by the system. This time is set in days. You can also specify
1394 0 days to indicate that you wish to use the system default setting.</p>
1396 <h3><a name="Deleting_and_moving_messages"></a>Deleting and moving messages</h3>
1398 <p>Aides and Room Aides have the ability to delete and move messages. After
1399 each message, the normal prompt appears:</p>
1401 <pre>(8) <B>ack <A>gain <Q>uote <R>eply <N>ext <S>top m<Y> next <?>help -><br></pre>
1403 <p>Entering <tt><b>D</b>elete</tt> will delete the message. A <tt>(y/n)</tt>
1404 prompt will appear to confirm that you really want to delete the message.
1405 Entering <tt><b>M</b>ove</tt> will prompt for a room to which the message
1406 should be moved.</p>
1408 <h3><a name="Customizing_the_help_files"></a>Customizing the help files</h3>
1410 <p>The subdirectory called <tt>help</tt> contains your system's help files.
1411 There's nothing hard-coded into the system that dictates what files should
1412 be there. Whenever a user types the command <tt><b>.H</b>elp</tt> followed
1413 by the name of a help file, it displays the contents of that help file.</p>
1415 <p>The help files that come with the system, of course, are enough to guide
1416 a user through its operation. But you can add, change, or remove help files
1417 to suit whatever is appropriate for your system.</p>
1419 <p>There are several strings that you can put in help files that will be automatically
1420 substituted with other strings. They are:</p>
1422 <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 BBS software you're running<br> ^bbsdir = The directory on the host system in which you have<br> installed the Citadel system.<br></pre>
1424 <p>So, for example, you could create a help file which looked like:</p>
1426 <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></pre>
1428 <h3><a name="Site_configuration"></a>Site configuration</h3>
1430 <p>Once your Citadel server is up and running, the first thing you'll want
1431 to do is customize and tune it. This can be done from the text-based client
1432 with the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1433 command, or from WebCit (if you have it installed) by clicking 'Advanced
1434 Options' followed by 'Edit site-wide configuration.' Either method will
1435 offer the same configuration options. This document shows the text mode client
1438 <p>The first set of options deal with the identification of your system.</p>
1440 <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
1441 !="" more="" text="" on="" the="" next="" screen="">]: <br></jinkies></pre>
1443 <p>'Node name' refers to the short, unqualified node name by which your system
1444 is known on a Citadel network. Generally it will be the same as the unqualified
1445 host name of your computer; this is, in fact, the default setting.</p>
1447 <p>Then enter the fully-qualified domain name (FQDN) of your system. If you
1448 are not on the Internet, you can simply set it to the same as your unqualified
1449 host name. Otherwise you should set this value to the host name by which
1450 your system is most commonly known.</p>
1452 <p>The field called 'Human-readable node name' (also known as the 'node title'
1453 or 'organization name' in other software) is used solely for display purposes.
1454 Set it to the actual name of your system as you want it to appear in banners,
1457 <p>If you have a modem or bank of modems answering data calls for your system,
1458 enter it in the field marked 'Modem dialup number.' Otherwise you may leave
1461 <p>'Geographic location of this system' is another display field. Enter a
1462 city and state, or city and country. </p>
1464 <p>'Name of system administrator' is important! Any user who logs on with
1465 the name you enter here will automatically be granted Aide privileges. This
1466 is one of two ways for the system administrator to grant himself/herself Aide
1467 access to the system when initially setting it up. (The other is simply to
1468 have the first account created on a new installation.)</p>
1470 <p>The next set of options are your system's security settings. Before delving
1471 into the actual options, we should review the various access levels available
1472 on the system. Citadel has seven access levels:</p>
1475 <li>0 (Deleted). A user whose access level is set to 0 will automatically
1476 be deleted by the system. </li>
1477 <li>1 (New User). Users at this level may only read messages. Entering
1478 messages is prohibited, except in the <tt>Mail></tt> room, where a message
1479 to 'sysop' may be entered. </li>
1480 <li>2 (Problem User). Also known as 'Twit.' </li>
1481 <li>3 (Local User). May enter messages, except in rooms shared on a
1482 Citadel network. </li>
1483 <li>4 (Network User). May enter messages in every accessible room. </li>
1484 <li>5 (Preferred User). Use of this level is up to the whim of the system
1485 administrator. </li>
1486 <li>6 (Aide). Access is granted to the administrative functions of the
1487 system. (This access level may also be granted to a user only for a specific
1488 room, please see 'Room Aide' for more information.) </li>
1492 <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>
1494 <p>'Registration' refers to the process of a user entering various personal
1495 contact information (real name, address, telephone number, etc.) into the
1496 system. When enabled, this information is stored as a vCard object on the
1497 system in two places: the user's <tt>My Citadel Config></tt> room, and
1498 in the <tt>Global Address Book></tt> room. (Note: the latter should be
1499 made private on publicly-accessible systems, for obvious reasons.)</p>
1501 <p>If you answer Yes to 'Require registration for new users' then each new
1502 user, upon creating a new account, will immediately be entered into the
1503 registration process. On the other hand, if you answer Yes to 'Disable self-service
1504 user account creation' then new users will not be able to log in at all --
1505 all accounts must be created by an Aide.</p>
1507 <p>'Initial access level for new users' should be set to 1 (New User) if you
1508 would like to review each new user's registration info before granting
1509 them higher access. This would be done periodically with the <tt><b>.A</b>ide
1510 <b>V</b>alidate new users</tt> command. If you do not require registration,
1511 you should set the initial access level to 4 (Network User).</p>
1513 <p>Given the above options, it then becomes clear that there are generally
1514 two ways you can set up your Citadel system, depending on its purpose:</p>
1517 <li><b>A public access BBS or message board</b> - since you do not know
1518 who might want to log in, self-service account creation needs to stay enabled.
1519 If you want to be strict about users identifying themselves, then you should
1520 also require users to register (just remember to post a privacy policy if
1521 you're going to collect personal information) -- then set the initial access
1522 level to 1 (New User), so new users cannot post messages until after you've
1523 validated them. For a more lax environment, you can remove the registration
1524 requirement and grant new accounts level 4 (Normal User) access on the first
1526 <li><b>A private email/groupware system for your organization</b> - in
1527 this case, disable self-service account creation; you don't want strangers
1528 welcoming themselves to your system. You'll probably also want to disable
1529 registration, because you or some other site administrator will be entering
1530 users' contact info when you create their accounts. Since this is also how
1531 you assign their Internet e-mail addresses, it's probably a good idea to do
1532 it yourself instead of expecting them to do it. </li>
1536 <p>'Access level required to create rooms' is up to you. You might wish to
1537 restrict the creation of new rooms only to Aides, or you might wish to allow
1538 anyone to create a room. The latter is one of the Citadel culture's most
1539 long-standing traditions; the former may be appropriate if users are abusing
1542 <p>You have the ability to 'Automatically give room aide privs to a user who
1543 creates a private room.' If you answer Yes, then any user who creates a
1544 guess-name, passworded, or invitation-only room will automatically become
1545 the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1546 command set while in that room. If you would rather grant this permission
1547 manually, answer No.</p>
1549 <p>Another tradition in the Citadel culture is to refrain from deleting
1550 problem users, but instead to 'twit' them (reduce their access level to 2
1551 [Problem User]). You can then 'Automatically move problem user messages
1552 to twit room' (answer Yes, then specify 'Name of twit room' and remember
1553 to create that room). If you employ this logic, any user with level 2 (Problem
1554 User) access will continue to have access to the same set of rooms, but all
1555 messages posted will automatically be routed to the Trashcan (or whatever
1556 you call your twit room).</p>
1558 <p>If you have Internet mail configured, you have the option of restricting
1559 its use on a user-by-user basis. If you wish to do this, answer Yes to 'Restrict
1560 Internet mail to only those with that privilege.' Obviously this makes no
1561 sense for an internal e-mail system, but for a public BBS it might be appropriate.</p>
1563 <p>Normally, Aides have access to every room, public or private, except for
1564 user mailboxes. They are also forbidden from <tt><b>Z</b>ap</tt>ping rooms,
1565 because the review of content is considered one of their roles. If you wish
1566 to change these policies, the next two options allow you to. You may 'Allow
1567 Aides to Zap (forget) rooms', in which case they may use the <tt><b>Z</b>ap</tt>
1568 command just like any other user. Furthermore, if you 'Allow system Aides
1569 access to user mailboxes', then they may <tt><b>.G</b>oto</tt> any private
1570 mailbox belonging to any user, using a special room name format.</p>
1572 <p>If your local security and/or privacy policy dictates that you keep a
1573 log of all pages (instant messages) that go through the system, then answer
1574 Yes to 'Log all pages'. If you answer Yes, you will be prompted for the
1575 name of a room to which all pages will be logged. If you answer No, then
1576 only the sender and recipient of each individual message will receive a copy.</p>
1578 <p>The next set of options deals with the tuning of your system. It is usually
1579 safe to leave these untouched.</p>
1581 <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>
1583 <p>The 'Server connection idle timeout' is for the connection between client
1584 and server software. It is <b>not</b> an idle timer for the user interface.
1585 900 seconds (15 minutes) is the default and a sane setting.</p>
1587 <p>'Maximum concurrent sessions' is the highest number of user sessions you
1588 wish to allow on your system at any given time. Citadel can scale to hundreds
1589 of concurrent users, but if you have limited hardware or (more likely) limited
1590 bandwidth, you might wish to set a maximum. You can also set it to zero for
1593 <p>'Maximum message length' is just that. This could be a good way to prevent
1594 enormous multimedia files from finding their way into your message base.
1595 This maximum is enforced in all protocols and is also advertised by the ESMTP
1598 <p>The minimum and maximum number of worker threads can be tuned to your
1599 liking. Citadel will attempt to keep one worker thread running per session,
1600 within these constraints. You should be aware that due to the use of the
1601 worker thread model, Citadel can handle a large number of concurrent sessions
1602 with a much smaller thread pool. If you don't know the programming theory
1603 behind multithreaded servers, you should leave these parameters alone.</p>
1605 <p>The next set of options affect how Citadel behaves on a network.</p>
1607 <pre>How often to run network jobs (in seconds) [3600]: <br>SMTP server port (-1 to disable) [25]: <br>POP3 server port (-1 to disable) [110]:<br>IMAP server port (-1 to disable) [143]:<br></pre>
1609 <p>'How often to run network jobs' refers to the sharing of content on a
1610 Citadel network. If your system is on a Citadel network, this configuration
1611 item dictates how often the Citadel server will contact other Citadel servers
1612 to send and receive messages. In reality, this will happen more frequently
1613 than you specify, because other Citadel servers will be contacting yours at
1614 regular intervals as well.</p>
1616 <p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP services.
1617 For a system being used primarily for Internet e-mail, these are essential,
1618 so you'll want to specify the standard port numbers: 25, 110, and 143. If
1619 Citadel is running alongside some other mail system, though, then you might
1620 want to choose other, unused port numbers, or enter -1 for any protocol to
1621 disable it entirely.</p>
1623 <p>The final set of options configures system-wide defaults for the auto-purger:</p>
1625 <pre>Default user purge time (days) [120]: <br>Default room purge time (days) [30]: <br>System default message expire policy (? for list) [2]: <br>Keep how many messages online? [150]:<br></pre>
1627 <p>Any user who does not log in for the period specified in 'Default user
1628 purge time' will be deleted the next time a purge is run. This setting
1629 may be modified on a per-user basis.</p>
1631 <p>'Default room purge time' behaves the same way, and may also be modified
1632 on a per-room basis.</p>
1634 <p>'System default message expire policy' defines the way in which old messages
1635 are expired (purged) off the system. You can specify any of:</p>
1638 <li>Purge by age (specify in days) </li>
1639 <li>Purge by message count in the room (specify number of messages) </li>
1640 <li>Do not purge at all </li>
1644 <p>Again, this setting may be overridden on a per-floor basis, and the floor
1645 setting may be overridden on a per-room basis.</p>
1647 <pre>Save this configuration? No<br></pre>
1649 <p>When you're done, enter 'Yes' to confirm the changes, or 'No' to discard
projects / citadel.git / blob