· 8 years ago · May 12, 2018, 10:32 PM
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4 <title>Citadel/UX Documentation</title>
5 <meta http-equiv="content-type"
6 content="text/html; charset=ISO-8859-1">
7</head>
8<body>
9<div align="center">
10<h1>Citadel/UX</h1>
11<h2>a messaging and collaboration platform for BBS and groupware
12applications</h2>
13Copyright ©1987-2003 by the Citadel development team:<br>
14<br>
15<table cellpadding="2" cellspacing="2" border="0" align="center">
16 <tbody>
17 <tr>
18 <td valign="top">Clint Adams<br>
19 </td>
20 <td valign="top"><i>portability enhancements<br>
21 </i></td>
22 </tr>
23 <tr>
24 <td valign="top">Steven M. Bellovin<br>
25 </td>
26 <td valign="top"><i>author of public domain 'parsedate' function<br>
27 </i></td>
28 </tr>
29 <tr>
30 <td valign="top">Nathan Bryant<br>
31 </td>
32 <td valign="top"><i>build system, security, database access, and
33others<br>
34 </i></td>
35 </tr>
36 <tr>
37 <td valign="top">Art Cancro<br>
38 </td>
39 <td valign="top"><i>overall system design and lead
40developer<br>
41 </i></td>
42 </tr>
43 <tr>
44 <td valign="top">Brian Costello<br>
45 </td>
46 <td valign="top"><i>cosmetics, additional commands<br>
47 </i></td>
48 </tr>
49 <tr>
50 <td valign="top">Nick Georbit<br>
51 </td>
52 <td valign="top"><i>additional client features<br>
53 </i></td>
54 </tr>
55 <tr>
56 <td valign="top">Michael Hampton<br>
57 </td>
58 <td valign="top"><i>client software development<br>
59 </i></td>
60 </tr>
61 <tr>
62 <td style="vertical-align: top;">Urs Jannsen<br>
63 </td>
64 <td style="vertical-align: top;"><span style="font-style: italic;">text
65search algorithm</span><br>
66 </td>
67 </tr>
68 <tr>
69 <td valign="top">Andru Luvisi<br>
70 </td>
71 <td valign="top"><i>troubleshooting and development assistance<br>
72 </i></td>
73 </tr>
74 <tr>
75 <td valign="top">Daniel Malament<br>
76 </td>
77 <td valign="top"><i>string compare function for IMAP server<br>
78 </i></td>
79 </tr>
80 <tr>
81 <td valign="top">Stu Mark<br>
82 </td>
83 <td valign="top"><i>additional client features, IGnet protocol
84design<br>
85 </i></td>
86 </tr>
87 <tr>
88 <td valign="top">Ben Mehlman<br>
89 </td>
90 <td valign="top"><i>additional client features<br>
91 </i></td>
92 </tr>
93 <tr>
94 <td valign="top">Ari Samson<br>
95 </td>
96 <td valign="top"><i>assistance with project management<br>
97 </i></td>
98 </tr>
99 <tr>
100 <td valign="top">John Walker<br>
101 </td>
102 <td valign="top"><i>author of public domain base64
103encoder/decoder<br>
104 </i></td>
105 </tr>
106 <tr>
107 <td valign="top">Steve Williams<br>
108 </td>
109 <td valign="top"><i>documentation<br>
110 </i></td>
111 </tr>
112 <tr>
113 <td valign="top">Ethan Young<br>
114 </td>
115 <td valign="top"><i>IGnet protocol design<br>
116 </i></td>
117 </tr>
118 </tbody>
119</table>
120</div>
121<br>
122<div align="justify">The entire package is open source; you can
123redistribute and/or modify it under the terms of the GNU General Public
124License as published by the Free Software Foundation; either version 2
125of the License, or (at your option) any later version.<br>
126<br>
127This program is distributed in the hope that it will be useful, but
128WITHOUT ANY WARRANTY; without even the implied warranty of
129MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
130General Public License for more details. </div>
131<div align="justify"><br>
132For more information, visit either of these locations on
133the web:<br>
134<ul>
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>
138</ul>
139<hr width="100%" size="2">
140<h2 align="center">Table of Contents</h2>
141<ol>
142 <li><a href="#GPL">License</a></li>
143 <li><a href="#Installation">Installation</a></li>
144 <ol>
145 <li><a href="#Everything_in_its_place...">Everything in its
146place...</a></li>
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:
149prompt</a></li>
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
154external 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
159your host system to start the service</a></li>
160 <li><a href="#Logging_in_for_the_first_time">Logging in for
161the 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
164your own client features (doors)</a></li>
165 <li><a href="#Troubleshooting_and_getting_help">Troubleshooting and
166getting help</a><br>
167 </li>
168 </ol>
169 <li><a href="#sysop">System Administration</a></li>
170 <ol>
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
176editing user accounts</a></li>
177 <li><a href="#Deleting_and_moving_messages">Deleting and moving
178messages</a></li>
179 <li><a href="#Customizing_the_help_files">Customizing the help files</a></li>
180 <li><a href="#Site_configuration">Site configuration</a><br>
181 </li>
182 </ol>
183 <li> <a href="#Configuring_Citadel_for_Internet_e-mail">Configuring
184Citadel for Internet e-mail</a></li>
185 <ol>
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
189Internet mail protocols</a></li>
190 <li><a href="#Hosting_an_Internet_mailing_list">Hosting an Internet
191mailing list</a><br>
192 </li>
193 <li><a href="#citmail">Using Citadel in conjunction with another MTA</a></li>
194 </ol>
195 <li><a href="#Building_or_joining_a_Citadel_network">Building or
196joining a Citadel network</a></li>
197 <ol>
198 <li><a href="#Overview__">Overview</a></li>
199 <li><a href="#Conventions_and_etiquette_when">Conventions and
200etiquette when connecting to the public Citadel network</a></li>
201 <li><a href="#Getting_ready_to_join_the_network">Getting ready
202to 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
207interval</a></li>
208 </ol>
209 <li><a href="#Database_maintenance">Database maintenance</a></li>
210 <ol>
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
214your Citadel database</a><br>
215 </li>
216 </ol>
217 <li><a href="#utilities">Included utilities</a></li>
218 <ol>
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>
227 </ol>
228</ol>
229<br>
230<hr width="100%" size="2"><br>
231<h2 align="center"><a name="GPL"></a>GNU General Public License<br>
232</h2>
233</div>
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
239away your freedom to share and change it. By contrast, the GNU General
240Public License is intended to guarantee your freedom to share and
241change free software--to make sure the software is free for all its
242users. This General Public License applies to most of the Free Software
243Foundation's software and to any other program whose authors commit to
244using it. (Some other Free Software Foundation software is covered by
245the GNU Library General Public License instead.) You can apply it to
246your programs, too. </p>
247<div align="justify"> </div>
248<p align="justify"> When we speak of free software, we are referring to
249freedom, not price. Our General Public Licenses are designed to make
250sure 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
252or can get it if you want it, that you can change the software or use
253pieces of it in new free programs; and that you know you can do these
254things. </p>
255<div align="justify"> </div>
256<p align="justify"> To protect your rights, we need to make
257restrictions that forbid anyone to deny you these rights or to ask you
258to surrender the rights. These restrictions translate to certain
259responsibilities for you if you distribute copies of the software, or
260if you modify it. </p>
261<div align="justify"> </div>
262<p align="justify"> For example, if you distribute copies of such a
263program, whether gratis or for a fee, you must give the recipients all
264the rights that you have. You must make sure that they, too, receive or
265can get the source code. And you must show them these terms so they
266know their rights. </p>
267<div align="justify"> </div>
268<p align="justify"> We protect your rights with two steps: (1)
269copyright the software, and (2) offer you this license which gives you
270legal 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
273want to make certain that everyone understands that there is no
274warranty for this free software. If the software is modified by someone
275else and passed on, we want its recipients to know that what they have
276is not
277the original, so that any problems introduced by others will not
278reflect
279on the original authors' reputations. </p>
280<div align="justify"> </div>
281<p align="justify"> Finally, any free program is threatened constantly
282by
283software patents. We wish to avoid the danger that redistributors of a
284free
285program will individually obtain patent licenses, in effect making the
286program
287proprietary. To prevent this, we have made it clear that any patent
288must
289be 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,
292distribution 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
297program or other work which contains a notice placed by the copyright
298holder saying it may be distributed under the terms of this General
299Public License. The "Program", below, refers to any such program or
300work, and a "work based on the Program" means either the Program or any
301derivative work under copyright law: that is to say, a work containing
302the Program or a portion of it, either verbatim or with modifications
303and/or translated into another language. (Hereinafter, translation is
304included without limitation in the term "modification".) Each licensee
305is addressed as "you". </p>
306<p align="justify"> Activities other than copying, distribution and
307modification are not covered by this License; they are outside its
308scope. The act of running the Program is not restricted, and the output
309from the Program is covered only if its contents constitute a work
310based on the Program (independent of having been made by running the
311Program). Whether that is true depends on what the Program does. </p>
312<p align="justify"> <strong>1.</strong> You may copy and distribute
313verbatim copies of the Program's source code as you receive it, in any
314medium, provided that you conspicuously and appropriately publish on
315each copy an appropriate copyright notice and disclaimer of warranty;
316keep intact all the notices that refer to this License and to the
317absence of any warranty; and give any other recipients of the Program a
318copy of this License along with the Program. </p>
319<p align="justify"> You may charge a fee for the physical act of
320transferring a copy, and you may at your option offer warranty
321protection in exchange for a fee. </p>
322<p align="justify"> <strong>2.</strong> You may modify your copy or
323copies of the Program or any portion of it, thus forming a work based
324on the Program, and copy and distribute such modifications or work
325under the terms of Section 1 above, provided that you also meet all of
326these conditions: </p>
327<p align="justify"> </p>
328<div align="justify">
329<ul>
330 <li><strong>a)</strong> You must cause the modified files to carry
331prominent notices stating that you changed the files
332and the date of any change.
333 <p> </p>
334 </li>
335 <li><strong>b)</strong> You must cause any work that you distribute
336or publish, that in whole or in part contains
337or is derived from the Program or any part thereof, to be licensed
338as a whole at no charge to all third parties under the terms of this
339License.
340 <p> </p>
341 </li>
342 <li><strong>c)</strong> If the modified program normally reads
343commands interactively when run, you must cause it, when started
344running for such interactive use in the most ordinary way, to print or
345display an announcement including an appropriate copyright notice and a
346notice that there is no warranty (or else, saying that you provide a
347warranty) and that users may redistribute the program under these
348conditions, and telling the user how to view a copy of this License.
349(Exception: if the Program itself is interactive but does not normally
350print such an announcement, your work based on the Program is not
351required to print an announcement.) </li>
352</ul>
353These requirements apply to the modified work as a whole. If
354identifiable sections of that work are not derived from the Program,
355and can be reasonably considered independent and separate works in
356themselves, then this License, and its terms, do not apply to those
357sections when you distribute them as separate works. But when you
358distribute the same sections as part of a whole which is a work based
359on the Program, the distribution of the whole must be on the terms of
360this License, whose permissions for other licensees extend to the
361entire
362whole, 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
364rights
365or contest your rights to work written entirely by you; rather, the
366intent
367is to exercise the right to control the distribution of derivative or
368collective
369works based on the Program. </p>
370<p align="justify"> In addition, mere aggregation of another work not
371based on the Program with the Program (or with a work based on the
372Program) on a volume of a storage or distribution medium does not bring
373the other work under the scope of this License. </p>
374<p align="justify"> <strong>3.</strong> You may copy and distribute
375the Program (or a work based on it, under Section 2) in object code or
376executable form under the terms of Sections 1 and 2 above provided that
377you 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. -->
378</p>
379<div align="justify">
380<ul>
381 <li><strong>a)</strong> Accompany it with the complete corresponding
382machine-readable source code, which must be distributed under the terms
383of Sections 1 and 2 above on a medium customarily used for software
384interchange; or,
385 <p> </p>
386 </li>
387 <li><strong>b)</strong> Accompany it with a written offer, valid for
388at least three years, to give any third party, for a charge no more
389than your cost of physically performing source distribution, a complete
390machine-readable copy of the corresponding source code, to be
391distributed under the terms of Sections 1 and 2 above on a medium
392customarily used for software interchange; or,
393 <p> </p>
394 </li>
395 <li><strong>c)</strong> Accompany it with the information you
396received as to the offer to distribute corresponding source code. (This
397alternative is allowed only for noncommercial distribution and only if
398you received the program in object code or executable form with such an
399offer, in accord with Subsection b above.) </li>
400</ul>
401The source code for a work means the preferred form of the work for
402making modifications to it. For an executable work, complete source
403code means all the source code for all modules it contains, plus any
404associated interface definition files, plus the scripts used to control
405compilation and installation of the executable. However, as a special
406exception, the source code distributed need not include anything that
407is normally distributed (in either source or binary form) with the
408major components (compiler, kernel, and so on) of the operating system
409on which the executable runs, unless that component itself accompanies
410the executable. </div>
411<p align="justify"> If distribution of executable or object code is
412made by offering access to copy from a designated place, then offering
413equivalent access to copy the source code from the same place counts as
414distribution of the source code, even though third parties are not
415compelled to
416copy the source along with the object code. </p>
417<p align="justify"> <strong>4.</strong> You may not copy, modify,
418sublicense, or distribute the Program except as expressly provided
419under this License. Any attempt otherwise to copy, modify, sublicense
420or distribute the Program is void, and will automatically terminate
421your rights under this License. However, parties who have received
422copies, or rights, from
423you under this License will not have their licenses terminated so long
424as such parties remain in full compliance. </p>
425<p align="justify"> <strong>5.</strong> You are not required to accept
426this License, since you have not signed it. However, nothing else
427grants you permission to modify or distribute the Program or its
428derivative works. These actions are prohibited by law if you do not
429accept this License. Therefore, by modifying or distributing the
430Program (or any work based on the Program), you indicate your
431acceptance of this License to do so, and all its terms and conditions
432for copying, distributing or modifying the Program or works based on
433it. </p>
434<p align="justify"> <strong>6.</strong> Each time you redistribute the
435Program
436(or any work based on the Program), the recipient automatically
437receives a
438license from the original licensor to copy, distribute or modify the
439Program subject to these terms and conditions. You may not impose any
440further restrictions on the recipients' exercise of the rights granted
441herein. You are not responsible for enforcing compliance by third
442parties to this License. </p>
443<p align="justify"> <strong>7.</strong> If, as a consequence of a
444court judgment or allegation of patent infringement or for any other
445reason (not limited to patent issues), conditions are imposed on you
446(whether by court order, agreement or otherwise) that contradict the
447conditions of this License, they do not excuse you from the conditions
448of this License. If you cannot distribute so as to satisfy
449simultaneously your obligations under this License and any other
450pertinent obligations, then as a consequence you may not distribute the
451Program at all. For example, if a patent license would not permit
452royalty-free redistribution of the Program by all those who receive
453copies directly or indirectly through you, then the only way you could
454satisfy both it and this License would be to refrain entirely from
455distribution of the Program. </p>
456<p align="justify"> If any portion of this section is held invalid or
457unenforceable under any particular circumstance, the balance of the
458section is intended to apply and the section as a whole is intended to
459apply in other circumstances. </p>
460<p align="justify"> It is not the purpose of this section to induce you
461to
462infringe any patents or other property right claims or to contest
463validity of any such claims; this section has the sole purpose of
464protecting the integrity of the free software distribution system,
465which is implemented by public license practices. Many people have made
466generous contributions to the wide range of software distributed
467through that system in reliance on consistent application of that
468system; it is up to the author/donor to decide if he or she is willing
469to distribute software through any other system and a licensee cannot
470impose that choice. </p>
471<p align="justify"> This section is intended to make thoroughly clear
472what 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
474of
475the Program is restricted in certain countries either by patents or by
476copyrighted
477interfaces, the original copyright holder who places the Program under
478this
479License may add an explicit geographical distribution limitation
480excluding
481those countries, so that distribution is permitted only in or among
482countries
483not thus excluded. In such case, this License incorporates the
484limitation
485as if written in the body of this License. </p>
486<p align="justify"> <strong>9.</strong> The Free Software Foundation
487may publish revised and/or new versions of the General Public License
488from time to time. Such new versions will be similar in spirit to the
489present version, but may differ in detail to address new problems or
490concerns. </p>
491<p align="justify"> Each version is given a distinguishing version
492number. If the Program specifies a version number of this License which
493applies to it and "any later version", you have the option of following
494the terms and conditions either of that version or of any later version
495published by the Free Software Foundation. If the Program does not
496specify a version number of this License, you may choose any version
497ever published by
498the Free Software Foundation. </p>
499<p align="justify"> <strong>10.</strong> If you wish to incorporate
500parts of the Program into other free programs whose distribution
501conditions are different, write to the author to ask for permission.
502For software which is copyrighted by the Free Software Foundation,
503write to the Free Software Foundation; we sometimes make exceptions for
504this. Our decision will be guided by the two goals of preserving the
505free status of all
506derivatives of our free software and of promoting the sharing and reuse
507of 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
511LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE
512EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN
513WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM
514"AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
515INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
516MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK
517AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD
518THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
519SERVICING, REPAIR OR CORRECTION. </p>
520<p align="justify"> <strong>12.</strong> IN NO EVENT UNLESS REQUIRED
521BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
522ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS
523PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
524SPECIAL,
525INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY
526TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
527BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
528OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN
529IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
530SUCH
531DAMAGES. </p>
532<p align="justify"> </p>
533<h3>END OF TERMS AND CONDITIONS</h3>
534<br>
535<hr width="100%" size="2"><br>
536<div align="center">
537<h2><a name="Installation"></a>Installation</h2>
538</div>
539<div align="justify">
540<h3>Overview</h3>
541<p>Citadel/UX is an advanced, multiuser, client/server messaging system
542suitable for BBS, e-mail, and groupware applications. It is designed to
543handle the needs of both small dialup systems and large-scale
544Internet-connected systems. It was originally developed on an Altos
545system running Xenix, and has been installed and tested on various Unix
546and Unix-like platforms. The current development environment (and
547public BBS) is an ordinary Linux system. The current distribution
548includes: </p>
549<ul>
550 <li>The Citadel/UX server (this is the back end that does all
551processing) </li>
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>
557</ul>
558<p>Some knowledge of the Unix system is necessary to install and manage
559the system. It is mandatory that the sysop have "root" access to the
560operating system. The following are required to install Citadel/UX: </p>
561<ul>
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
565recommended build environment) </li>
566 <li>POSIX threads (already present on most systems) </li>
567 <li>TCP/IP </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
570newer (if you want the calendar service to work)<br>
571 </li>
572 <li>Enough disk space to hold all of the programs and data </li>
573</ul>
574<p>If you are running Citadel/UX on a Linux system, it is STRONGLY
575recommended 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
577distribution will have most or all of the prerequisite tools and
578libraries already integrated for you.</p>
579<h3>Now available:</h3>
580<ul>
581 <li>"WebCit", a gateway program to allow full access to Citadel via
582the World Wide Web. Interactive access through any Web browser. </li>
583 <li>Access to Citadel via <i>any</i> standards-compliant e-mail
584program, thanks to Citadel's built-in SMTP, POP, and IMAP services.
585 You can use Netscape/Mozilla, Evolution, Eudora, Pine, or even
586Microsoft
587VirusSpreader (better known as "Outlook") with Citadel. </li>
588</ul>
589<h3>Coming soon:</h3>
590<ul>
591 <li>Newer and better GUI-based clients.</li>
592</ul>
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
595directory. This is the directory in which all Citadel files are located
596and in
597which all activity will take place. Several subdirectories have already
598been created during the unpacking process, and others may be created
599by the software if needed. Make sure you have Berkeley DB installed on
600your system, and that you have all the development libraries and
601headers
602in place so that you can compile against them. If you don't, you can
603get the latest Berkeley DB at <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
604If your operating system uses a separate library to support POSIX
605threads (pthreads), make sure that library is installed as well. This
606is almost never the case with Linux, but some commercial Unix flavors
607might need it.<br>
608<br>
609</p>
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
612ID. Unlike other programs, however, this user ID will do double-duty as
613a public login for your system if you are running a BBS. This account
614is typically called "bbs" or "citadel" or something to that effect. You
615will tell Citadel what the user-id of that account is, and when someone
616logs 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
618be the one your Citadel installation resides in (in this example we
619will use <tt>/usr/local/citadel</tt>) and the shell should be either
620"citadel" in
621that directory, or a script that will start up the citadel client.
622Example:</p>
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
625username or user ID of the account you created is, so it knows what
626user to run as. If you create an account called <tt>bbs</tt>, <tt>guest</tt>,
627or <tt>citadel</tt>, the setup program will automatically pick up the
628user ID by default.</p>
629<p>For all other users in /etc/passwd, Citadel will automatically set
630up
631an account using the full name (or 'gecos' in Unixspeak) of the user.
632It'll also ignore any password you supply, because it uses the user's
633password
634on the host system. This allows a 'single sign on' type of environment.
635Note that this does have to be enabled at compile time -- it's the
636configure
637option called <tt>--enable-autologin</tt>. Keep in mind that these
638users
639can use *either* their Citadel login name or their login name on the
640host
641computer, and their password on the host computer.<br>
642<br>
643</p>
644<h3><a name="Bypassing_the_login:_prompt"></a>Bypassing the <tt>login:</tt>
645prompt</h3>
646<p>If you normally log in to your host system using some method other
647than telnet (such as ssh), you might want the telnet service to go
648straight into Citadel, instead of displaying the <tt>login:</tt>
649prompt first. You
650can do this by having telnetd start citadel directly instead of <tt>/bin/login</tt>.
651This is actually very simple to implement; all you need to do is make a
652simple change to your <tt>inetd</tt> or <tt>xinetd</tt>
653configuration. Here are some configuration examples.</p>
654<p>An example for <tt>inetd</tt> (put the following line in <tt>/etc/inetd.conf</tt>,
655replacing 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>
658then 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!
661If
662you are going to put Citadel somewhere other than <tt>/usr/local/citadel</tt>
663then change the directory name accordingly. If you know of any other
664local peculiarities which need to be observed, edit the above
665configuration
666accordingly as well. And, of course, if you're working remotely, make
667sure you can successfully log in using SSH <b>before</b> you start
668changing
669your telnet configuration, otherwise you could lock yourself out of
670your
671system (ask any networking specialist about the dangers of "working
672inband"
673-- then pull up a chair and get a fresh cup of coffee, because you're
674going
675to hear some war stories).<br>
676<br>
677</p>
678<h3><a name="Compiling_the_programs"></a>Compiling the programs</h3>
679<p>You can easily compile the Citadel system with the following
680commands:</p>
681<pre>./configure<br>make<br>make install<br></pre>
682<p>The 'configure' script will generate a Makefile from the
683Makefile.in,
684and it will also write the file "sysdep.h" to your Citadel directory.
685Please do not edit sysdep.h or Makefile.in yourself. The configure
686script will
687figure 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
689supported, now or in the future.) You need to install the Developer
690Tools CD, which you can purchase or download for free from <a
691 href="http://developer.apple.com">http://developer.apple.com</a>. Then
692run 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>.
695If 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
698can 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
701location,
702you'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
704Citadel to crash because someone couldn't access a file, but you also
705don't want shell users peeking into the binaries to do things like
706reading others' mail, finding private rooms, etc. The Citadel server
707needs to be started as root in order to bind to privileged ports, but
708as soon as its initialization is finished, it changes its user ID to
709your 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
712may be upgraded in place without the need to discard your existing data
713files.</p>
714<p>Upgrading to a new version uses the same build procedure as
715compiling
716the program for a fresh install, except that you want to do <tt>make
717install-exec</tt> instead of <tt>make install</tt>. This will
718overwrite the programs but not your data. <b>Be sure to shut down
719citserver during this process!</b> If Citadel is running while you
720upgrade, you may face data corruption issues.<br>
721</p>
722<p>After doing <tt>make install-exec</tt>, you should run <tt>setup</tt>
723again to bring your data files up to date. Please see the setup section
724below 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
727applications. Much of its command set and other behavior is
728configurable through a Run Control (RC) file. The standard client looks
729for this file in the following locations: </p>
730<ul>
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>
735</ul>
736The next couple of sections deal with client-side configuration.
737<h3><a name="Using_an_external_editor_for_message"></a>Using an
738external editor
739for message composition</h3>
740<p>Citadel/UX has a built-in message editor. However, you can also use
741your favorite text editor to write messages. To do this you simply put
742a 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
745the <tt><b>.E</b>nter <b>E</b>ditor</tt> command. You can also make
746it the default editor for the <tt><b>E</b>nter</tt> command by editing
747the <tt>citadel.rc</tt> file. <b>But be warned:</b> external editors
748on public systems can
749be a security hole, because they usually provide users with the ability
750to drop into a shell on the host system, or save files using names
751other
752than the name of the temporary file they are editing. If you intend to
753use an external editor on a public BBS, make sure you use one that has
754been
755hardened for such a purpose -- one which has had the 'shell' and 'save
756as'
757commands disabled, as well as any other functions which a destructive
758user 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
761else in your system. The variable <tt>PRINTCMD</tt> in <tt>citadel.rc</tt>
762specifies what command you use to print. Text is sent to the standard
763input (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
767printer named "local". There's tons of stuff you can do with this
768feature. For example, you could use a command like <tt>cat
769<<$HOME/archive</tt> to save copies of important messages in a
770textfile. Again, this is probably something you don't want to configure
771for a public BBS host -- most system administrators don't want remote
772users 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
775reading
776a message that has Internet URL's in it, you can select the <tt><b>U</b>RL-view</tt>
777command, and it will perform some pre-defined action (usually, this is
778to 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>
782<br>
783</p>
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
786program. 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
789procedure. It will ask you what directory to place your data files in
790-- the default is the current directory, which is usually the sensible
791thing to select. If you want to run more than one instance of Citadel
792on the same host, however, you can specify a different directory here
793-- just remember to specify the directory name again when you start up
794the server later on.</p>
795<p><tt>setup</tt> will then shut down the Citadel service if it is
796found to
797be running.</p>
798<p>You will then be prompted for the name of the system administrator.
799This is not merely a cosmetic option -- when you log in to your system
800a little while from now, you'll log in with this name, and it will
801automatically assign your account the highest access level.</p>
802<p>Next, you will be prompted for the User ID of the Citadel account on
803your host system. If you have an account called <tt>bbs</tt>, <tt>guest</tt>,
804or <tt>citadel</tt>, that account's UID will be the default. If you
805are upgrading or reconfiguring an existing system, the existing value
806will be preserved.</p>
807<p>Then you will be prompted for a server port number. This is the TCP
808port which Citadel clients use to connect to your Citadel server. In
809almost all cases, you want to use the default -- port 504, which is the
810official port number assigned by the IANA for Citadel implementations.</p>
811<p>The Citadel service will then be started, and you will see the
812following 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
815find out if you need to do anything else:</p>
816<h3><a name="Configuring_your_host_system_to_start"></a>Configuring
817your host
818system to start the service</h3>
819<p><b>Please note:</b> this topic involves modifications made to <tt>/etc/services</tt>
820and <tt>/etc/inittab</tt> in order to configure your host system to
821automatically start the Citadel service. <tt>setup</tt> will
822automatically perform these steps if it can, and if you allow it to --
823just answer 'Yes' when prompted, and everything will be taken care of
824for 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
826this 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
828your 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
832Citadel. There should not be any need to use a different port number,
833unless you are running multiple Citadels on the same computer and
834therefore need
835a different port for each one.</p>
836<p>The next step is to arrange for the server to start. The <tt>citserver</tt>
837program is the main Citadel server. Before we cover the recommended
838method 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.
842This should, of course, be a directory that you've run the <tt>setup</tt>
843program against to set up some data files. If a directory is not
844specified, the directory
845name which was specified in the <tt>Makefile</tt> will be used.</p>
846<p><tt>-xDebugLevel</tt> - Set the verbosity of trace messages printed.
847The
848available debugging levels are: </p>
849<ul>
850 <li>1 - Internal errors (failed thread creation, malloc problems,
851etc.) </li>
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>
857</ul>
858<p><tt>-tTraceFile</tt> - Tell the server where to send its debug/trace
859output. Normally it is sent to stdout.</p>
860<p><tt>-d</tt> - Run as a daemon; i.e. in the background. This switch
861would be necessary if you were starting the Citadel server, for
862example, from an rc.local script (which is not recommended, because
863this won't allow the server to automatically restart when it is shut
864down).</p>
865<p><tt>-f</tt> - Defragment all the databases upon startup. This
866currently 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
868entry in your /etc/inittab file. This will conveniently bring the
869server up when your system is up, and terminate it gracefully when your
870system is shutting down. The exact syntax for your system may vary, but
871here'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
874stuff output to one of the virtual consoles. It's important to remember
875to turn off any getty that is set up on that virtual console, if you do
876this. After making this change, the command <tt>init q</tt> works on
877most systems to tell init to re-read the file. If in doubt, just reboot
878the computer.<br>
879<br>
880</p>
881<h3><a name="Logging_in_for_the_first_time"></a>Logging in for the
882first time</h3>
883<p>At this point, your system is ready to run. Run the <tt>citadel</tt>
884program from the shell and log in as a new user. NOTE: the first user
885account to be created will automatically be set to access level 6
886(Aide). This overcomes some obvious logistical problems - normally,
887Aide access is given by another Aide, but since there aren't any on
888your system yet, this isn't possible.<br>
889<br>
890</p>
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
893several different messages) automatically mailed to new users upon
894their first login. Now there is a way to do this. If you create a room
895called <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
897into that room will automatically be delivered to all new users upon
898registration.</p>
899<p>You can put anything you want there: a welcome message, system
900policies, special information, etc. You can also put as many messages
901there as you want to (although it really doesn't make sense to clutter
902new users' mailboxes with lots of junk).</p>
903<p>Don't worry about wasting disk space, either. Citadel has a
904single-instance message store, so all the new users are actually
905looking at the same copy of the message on disk.<br>
906<br>
907</p>
908<h3><a name="Space_for_adding_your_own_client"></a>Space for adding
909your own
910client features (doors)</h3>
911<p><b>Please take note!</b> This function really represents the "old"
912way of doing things, and it doesn't fit in well with the client/server
913paradigm. Please consider it "deprecated" because it may be removed
914someday.</p>
915<p>The "doorway" feature is just a generic way to add features to the
916system. It is called "Doorway" to make it resemble the doors on
917non-Unix boards, but as we all know, us Unix types don't have to write
918special 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
922menu
923program to allow the users to pick one of a number of programs, etc. Do
924be aware that door programs will only be available when the client and
925server
926programs are running on the <i>same</i> computer, and when the user is
927running
928the text-mode client. Because of these restrictions, Door programs are
929being
930utilized less and less every day.<br>
931<br>
932</p>
933<h3><a name="Troubleshooting_and_getting_help"></a>Troubleshooting and
934getting help</h3>
935<p>That's just about all the information you need to install the
936system. But if you get stuck, you can visit <a
937 href="http://uncensored.citadel.org">UNCENSORED! BBS</a> and report a
938problem or ask for help. But if you intend to report a problem getting
939the Citadel server to run, <i>please</i> double-check the following
940things first: </p>
941<ul>
942 <li>Did you do <tt>./configure && make && make
943install</tt> ?? </li>
944 <li>Did you run setup? </li>
945 <li>Did you start the server? </li>
946</ul>
947<p>To report a problem, you can log on to <a
948 href="http://uncensored.citadel.org">UNCENSORED!</a> or any other BBS
949on the Citadel network which carries the <tt>Citadel/UX></tt> room.
950Please DO NOT e-mail the developers directly. Post a request for help
951on the BBS, with all of the following information: </p>
952<ul>
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
959distribution, and the version of the kernel, libc, and pthreads you
960are using (it would help to post the output of a <tt>ldd ./citserver</tt>
961command). </li>
962</ul>
963</div>
964<div align="center">
965<hr width="100%" size="2">
966<h2><a name="sysop"></a>System Administration</h2>
967</div>
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
971by itself. It is intended to be run unattended for extended periods of
972time, 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
974have
975no special privileges. Aides are selected people who have special
976access within
977the Citadel program. Room Aides only have this access in a certain
978room. Preferred users can be selected by Aides for access to preferred
979only rooms. A sysop is anyone who has access to the various sysop
980utilities - these
981are in their own executable files, which should have their permissions
982set
983to allow only sysops to run them. You should either create a sysops
984group
985in /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>
988in addition to being able to delete and move messages. The system room,
989<tt>Aide></tt>, is accessible only by those users designated as
990Aides.</p>
991<h3><a name="Aide_commands"></a>Aide commands</h3>
992<p>Aides have the following commands available to them that are not
993available to normal users. They are:</p>
994<table>
995 <tbody>
996 <tr>
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>
999 </tr>
1000 <tr>
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
1003is explained in greater detail below. </td>
1004 </tr>
1005 <tr>
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,
1008this command displays a list of users who have access to the current
1009room. </td>
1010 </tr>
1011 <tr>
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
1014on the system. </td>
1015 </tr>
1016 <tr>
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
1019registrations and allows you to set each new user's access level (or
1020simply delete the accounts). </td>
1021 </tr>
1022 <tr>
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
1025its purpose, which is displayed to users upon entering the room for the
1026first time (or in the room banner, for users of the Web client). This
1027command allows you to enter or edit that description. </td>
1028 </tr>
1029 <tr>
1030 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>I</b>nvite
1031user </tt></td>
1032 <td> Access control command to grant any specific user access to
1033a private room. </td>
1034 </tr>
1035 <tr>
1036 <td width="30%"><tt> .<b>A</b>ide <b>R</b>oom <b>K</b>ick
1037out user </tt></td>
1038 <td> Access control command to revoke any specifc user's access
1039to the current room. This works regardless of whether the room is
1040public or private. </td>
1041 </tr>
1042 <tr>
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
1045command may be used to delete files from it. </td>
1046 </tr>
1047 <tr>
1048 <td width="30%"><tt> .<b>A</b>ide <b>F</b>ile <b>S</b>end
1049over net </tt></td>
1050 <td> If the current room has an associated file directory, this
1051command may be used to transmit a copy of any file in that directory to
1052another node on a Citadel network. </td>
1053 </tr>
1054 <tr>
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
1057command may be used to move any file in that directory to another room.
1058The target room must also have an associated file directory. </td>
1059 </tr>
1060 <tr>
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
1063banners and messages which are displayed to users. Type the name of
1064the banner or message you wish to edit. </td>
1065 </tr>
1066 <tr>
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
1069message</tt> command available to all users, except that it allows you
1070to post using any user name. </td>
1071 </tr>
1072 <tr>
1073 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>G</b>eneral
1074 </tt></td>
1075 <td> This command allows configuration of a large number of
1076global settings for your Citadel system. These settings will be
1077explained in greater detail below. </td>
1078 </tr>
1079 <tr>
1080 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>I</b>nternet
1081 </tt></td>
1082 <td> This command allows configuration of settings which affect
1083how your Citadel system sends and receives messages on the Internet. </td>
1084 </tr>
1085 <tr>
1086 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1087check <b>M</b>essage base </tt></td>
1088 <td> Perform a consistency check on your message store. This is a
1089very time-consuming operation which should not be performed unless you
1090have reason to believe there is trouble with your database. </td>
1091 </tr>
1092 <tr>
1093 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration <b>N</b>etwork
1094 </tt></td>
1095 <td> Configure networking (e-mail, room sharing, etc.) with other
1096Citadel nodes. </td>
1097 </tr>
1098 <tr>
1099 <td width="30%"><tt> .<b>A</b>ide <b>S</b>ystem configuration
1100network <b>F</b>ilter list </tt></td>
1101 <td> If you are on a large public or semi-public network of
1102Citadel nodes and you find content from certain systems or individuals
1103objectionable, you can use this command to define a rule set to
1104automatically reject those messages when they arrive on your system. </td>
1105 </tr>
1106 <tr>
1107 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>N</b>ow
1108 </tt></td>
1109 <td> Immediately shut down the Citadel service, disconnecting any
1110users who are logged in. Please keep in mind that it will start
1111right back up again if you are running the service from <tt>/etc/inittab</tt>,
1112so in practice this command will probably not get much use. </td>
1113 </tr>
1114 <tr>
1115 <td width="30%"><tt> .<b>A</b>ide <b>T</b>erminate server <b>S</b>cheduled
1116 </tt></td>
1117 <td> Shut down the Citadel service the next time there are zero
1118users connected. This allows you to automatically wait until all users
1119are logged out. </td>
1120 </tr>
1121 <tr>
1122 <td width="30%"><tt> .<b>A</b>ide mailing <b>L</b>ist recipients
1123 </tt></td>
1124 <td> Any room may be made into a mailing list. Enter this command
1125to open an editor window containing the list of Internet e-mail
1126addresses to which every message posted in the room will be sent. </td>
1127 </tr>
1128 <tr>
1129 <td width="30%"><tt> .<b>A</b>ide mailing list <b>D</b>igest
1130recipients </tt></td>
1131 <td> Similar to the regular mailing list command, except the
1132messages will be sent out in 'digest' form -- recipients will see
1133messages from the address of the room itself rather than the address of
1134the author of each message, and a digest may contain more than one
1135message. Each room may have any combination of List and Digest
1136recipients. </td>
1137 </tr>
1138 <tr>
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
1141other Citadel nodes. Messages posted in this room on any Citadel system
1142will automatically be replicated to other Citadel systems carrying the
1143room. </td>
1144 </tr>
1145 </tbody>
1146</table>
1147<br>
1148<br>
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
1151to the room you wish to edit and enter the <tt><b>.A</b>ide <b>E</b>dit
1152room</tt> command. A series of prompts will be displayed. The existing
1153parameters will be displayed in brackets; simply press return if you
1154want
1155to 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
1160the room
1161is to be accessible by all users. Note that Citadel doesn't bother
1162users
1163about access to rooms every time they need to access the room. Once a
1164user
1165gains access to a private room, it then behaves like a public room to
1166them.
1167The following four questions will only be asked if you selected
1168Private...</p>
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
1171rooms</tt> listing, but if they <tt><b>.G</b>oto</tt> the room (typing
1172the 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
1175users 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
1177users can access the room is if an Aide explicitly invites them to the
1178room using the <tt><b>.A</b>ide <b>R</b>oom <b>I</b>nvite user</tt>
1179command.</p>
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
1182the room.</p>
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
1185level 5 (Preferred User) status (and Aides too, of course). You should
1186make the room public if you intend to do this, otherwise the two
1187restrictions 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
1190allowed to
1191post messages in it. Messages may only be posted by Aides, and by
1192utility programs such as the networker and the "aidepost" utility. This
1193is
1194useful in situations where a room is used exclusively for important
1195announcements, or if you've set up a room to receive an Internet
1196mailing
1197list and posting wouldn't make sense. Other uses will, of course,
1198become
1199apparent 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.
1203This can be used as a small file repository for files relevant to the
1204topic of the room. If you enter Yes, you will also be prompted with the
1205following 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
1208name of the directory created will be <tt><i><your Citadel
1209directory></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,
1218and
1219vice versa, but what this flag does is twofold: </p>
1220<ul>
1221 <li>It prevents people with no network access from entering messages
1222here </li>
1223 <li>Messages are displayed with the name of their originating
1224system in the header. </li>
1225</ul>
1226<pre>Permanent room [No]? No<br></pre>
1227<p>Citadel contains an 'auto purger' which is capable of removing rooms
1228which have not been posted in for a pre-defined period of time (by
1229default
1230this is set to two weeks). If you wish to keep this from happening to
1231a 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,
1233and 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
1236anonymous, and you can have rooms in which users are prompted whether
1237to make a
1238message anonymous when they enter it. The real identity of the author
1239of each message is still revealed to the Room Aide for this room, as
1240well
1241as 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
1244responsible for a room. Room Aides have access to a restricted set of
1245Aide commands, ONLY when they are in the room in which they have this
1246privilege. They can edit the room, delete the room, delete and move
1247messages, and invite or kick out users (if it is a private room), but
1248they cannot perform aide commands that are not room-related (such as
1249changing 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
1252listed in when users call up a <tt><b>K</b>nown Rooms</tt> listing.
1253Rooms with a lower listing order are displayed prior to rooms with a
1254higher listing order. It has no other effect. For users who list rooms
1255in floor order, the display will sort first by floor, then by listing
1256order.</p>
1257<pre>Message expire policy (? for list) [0]:<br></pre>
1258<p>This provides you with the opportunity to select how long each
1259message 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
1261messages around forever (or until they are manually deleted), until
1262they become a certain number of days old, or until a certain number of
1263additional messages are posted in the room, at which time the oldest
1264ones will scroll out.</p>
1265<p>You will notice that you can also fall back to the default expire
1266policy for the floor upon which the room resides. This is the default
1267setting. You can change the floor's default with the <tt><b>;A</b>ide <b>E</b>dit
1268floor</tt> command. The default setting for the floor default, in turn,
1269is 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
1273messed things up while editing.<br>
1274<br>
1275</p>
1276<h3><a name="File_directories"></a>File directories</h3>
1277<p>If you have created any directory rooms, you can attach file
1278descriptions to the filenames through a special file called <tt>filedir</tt>.
1279Each line contains the name of a file in the directory, followed by a
1280space 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>
1283and <tt>phluff</tt> which would be displayed along with the directory.
1284It should also be noted that when users upload files to your system,
1285they 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>
1287<br>
1288</p>
1289<h3><a name="Creating_and_editing_user_accounts"></a>Creating and
1290editing user accounts</h3>
1291<p>Anyone with Aide level access may use the <tt><b>.A</b>ide edit <b>U</b>ser</tt>
1292command to create and/or edit user accounts. There are several
1293parameters 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
1297command will
1298continue as if you were editing an existing account. Therefore the
1299remainder
1300of 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 --
1303personal
1304information such as full name, address, telephone number, etc. This
1305information
1306will comprise the user's vCard in both their user profile and in the
1307Global
1308Address Book.</p>
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
1313account. The access levels available are as follows: </p>
1314<ul>
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
1318probationary access) </li>
1319 <li>3 - User with no network privileges. Same access as a normal user
1320except 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>
1324</ul>
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
1327to 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
1330a
1331'registration' screen or set of prompts, the next time they log in
1332using
1333a Citadel client. This will prompt them for their full name, address,
1334telephone
1335number, etc.</p>
1336<pre>Times called [0]: <br>Messages posted [0]: <br></pre>
1337<p>These statistics are available for informational purposes only, so
1338there 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
1341deleting accounts which have not been accessed in a predefined period
1342of time. If you choose to perform this operation, you can 'touch' the
1343account
1344of a wayward user by setting their 'last call' time to 'now'. You can
1345also adjust, on a per-user basis, the amount of time which must pass
1346before
1347their account is purged by the system. This time is set in days. You
1348can also specify 0 days to indicate that you wish to use the system
1349default
1350setting.<br>
1351<br>
1352</p>
1353<h3><a name="Deleting_and_moving_messages"></a>Deleting and moving
1354messages</h3>
1355<p>Aides and Room Aides have the ability to delete and move messages.
1356After 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>
1359prompt will appear to confirm that you really want to delete the
1360message. Entering <tt><b>M</b>ove</tt> will prompt for a room to which
1361the message should be moved.<br>
1362<br>
1363</p>
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
1366files. There's nothing hard-coded into the system that dictates what
1367files
1368should be there. Whenever a user types the command <tt><b>.H</b>elp</tt>
1369followed by the name of a help file, it displays the contents of that
1370help file.</p>
1371<p>The help files that come with the system, of course, are enough to
1372guide a user through its operation. But you can add, change, or remove
1373help 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
1375be automatically
1376substituted 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
1382want to do is customize and tune it. This can be done from the
1383text-based client with the <tt><b>.A</b>ide <b>S</b>ystem
1384configuration <b>G</b>eneral</tt> command, or from WebCit (if you have
1385it installed) by clicking 'Advanced Options' followed by 'Edit
1386site-wide configuration.' Either method will offer the same
1387configuration options. This document shows the text mode client being
1388used.</p>
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
1393system is known on a Citadel network. Generally it will be the same as
1394the unqualified host name of your computer; this is, in fact, the
1395default setting.</p>
1396<p>Then enter the fully-qualified domain name (FQDN) of your system. If
1397you
1398are not on the Internet, you can simply set it to the same as your
1399unqualified host name. Otherwise you should set this value to the host
1400name by which your system is most commonly known.</p>
1401<p>The field called 'Human-readable node name' (also known as the 'node
1402title' or 'organization name' in other software) is used solely for
1403display purposes. Set it to the actual name of your system as you want
1404it to appear in
1405banners, messages, etc.</p>
1406<p>If you have a modem or bank of modems answering data calls for your
1407system, enter it in the field marked 'Modem dialup number.' Otherwise
1408you may leave it blank.</p>
1409<p>'Geographic location of this system' is another display field. Enter
1410a city and state, or city and country. </p>
1411<p>'Name of system administrator' is important! Any user who logs on
1412with the name you enter here will automatically be granted Aide
1413privileges. This is one of two ways for the system administrator to
1414grant himself/herself Aide access to the system when initially setting
1415it up. (The other is simply to have the first account created on a new
1416installation.)</p>
1417<p>The next set of options are your system's security settings. Before
1418delving into the actual options, we should review the various access
1419levels available on the system. Citadel has seven access levels:</p>
1420<ul>
1421 <li>0 (Deleted). A user whose access level is set to 0 will
1422automatically be deleted by the system. </li>
1423 <li>1 (New User). Users at this level may only read messages.
1424Entering messages is prohibited, except in the <tt>Mail></tt> room,
1425where 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
1428Citadel network. </li>
1429 <li>4 (Network User). May enter messages in every accessible
1430room. </li>
1431 <li>5 (Preferred User). Use of this level is up to the whim of the
1432system administrator. </li>
1433 <li>6 (Aide). Access is granted to the administrative functions of
1434the system. (This access level may also be granted to a user only for a
1435specific room, please see 'Room Aide' for more information.) </li>
1436</ul>
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
1439personal contact information (real name, address, telephone number,
1440etc.) into the system. When enabled, this information is stored as a
1441vCard object on the system in two places: the user's <tt>My Citadel
1442Config></tt>
1443room, and in the <tt>Global Address Book></tt> room. (Note: the
1444latter
1445should be made private on publicly-accessible systems, for obvious
1446reasons.)</p>
1447<p>If you answer Yes to 'Require registration for new users' then each
1448new user, upon creating a new account, will immediately be entered into
1449the registration process. On the other hand, if you answer Yes to
1450'Disable self-service user account creation' then new users will not be
1451able to
1452log 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)
1454if you would like to review each new user's registration info before
1455granting 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
1457registration, you should set the initial access level to 4 (Network
1458User).</p>
1459<p>Given the above options, it then becomes clear that there are
1460generally two ways you can set up your Citadel system, depending on its
1461purpose:</p>
1462<ul>
1463 <li><b>A public access BBS or message board</b> - since you do
1464not know who might want to log in, self-service account creation needs
1465to
1466stay enabled. If you want to be strict about users identifying
1467themselves,
1468then you should also require users to register (just remember to post a
1469privacy policy if you're going to collect personal information) -- then
1470set
1471the initial access level to 1 (New User), so new users cannot post
1472messages
1473until after you've validated them. For a more lax environment, you can
1474remove the registration requirement and grant new accounts level 4
1475(Normal
1476User) access on the first visit. </li>
1477 <li><b>A private email/groupware system for your organization</b> -
1478in this case, disable self-service account creation; you don't want
1479strangers welcoming themselves to your system. You'll probably also
1480want
1481to disable registration, because you or some other site administrator
1482will be entering users' contact info when you create their accounts.
1483Since this is also how you assign their Internet e-mail addresses, it's
1484probably a good idea to do it yourself instead of expecting them to do
1485it. </li>
1486</ul>
1487<p>'Access level required to create rooms' is up to you. You might wish
1488to
1489restrict the creation of new rooms only to Aides, or you might wish to
1490allow
1491anyone to create a room. The latter is one of the Citadel culture's
1492most
1493long-standing traditions; the former may be appropriate if users are
1494abusing
1495this privilege.</p>
1496<p>You have the ability to 'Automatically give room aide privs to a
1497user who creates a private room.' If you answer Yes, then any user who
1498creates a
1499guess-name, passworded, or invitation-only room will automatically
1500become the room aide, and will have access to a subset of the <tt><b>.A</b>ide</tt>
1501command set while in that room. If you would rather grant this
1502permission manually, answer No.</p>
1503<p>Another tradition in the Citadel culture is to refrain from deleting
1504problem users, but instead to 'twit' them (reduce their access level to
15052
1506[Problem User]). You can then 'Automatically move problem user messages
1507to twit room' (answer Yes, then specify 'Name of twit room' and
1508remember
1509to create that room). If you employ this logic, any user with level 2
1510(Problem
1511User) access will continue to have access to the same set of rooms, but
1512all
1513messages posted will automatically be routed to the Trashcan (or
1514whatever
1515you call your twit room).</p>
1516<p>If you have Internet mail configured, you have the option of
1517restricting its use on a user-by-user basis. If you wish to do this,
1518answer Yes to 'Restrict Internet mail to only those with that
1519privilege.' Obviously this makes no sense for an internal e-mail
1520system, but for a public BBS it
1521might be appropriate.</p>
1522<p>Normally, Aides have access to every room, public or private, except
1523for user mailboxes. They are also forbidden from <tt><b>Z</b>ap</tt>ping
1524rooms, because the review of content is considered one of their roles.
1525If you wish to change these policies, the next two options allow you
1526to. You may 'Allow Aides to Zap (forget) rooms', in which case they may
1527use the <tt><b>Z</b>ap</tt> command just like any other user.
1528Furthermore, if you 'Allow system Aides access to user mailboxes', then
1529they may <tt><b>.G</b>oto</tt> any private mailbox belonging to any
1530user, using a special room name format.</p>
1531<p>If your local security and/or privacy policy dictates that you keep
1532a
1533log of all pages (instant messages) that go through the system, then
1534answer
1535Yes to 'Log all pages'. If you answer Yes, you will be prompted for the
1536name of a room to which all pages will be logged. If you answer No,
1537then
1538only the sender and recipient of each individual message will receive a
1539copy.</p>
1540<p>The next set of options deals with the tuning of your system. It is
1541usually 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
1544client and server software. It is <b>not</b> an idle timer for the
1545user interface. 900 seconds (15 minutes) is the default and a sane
1546setting.</p>
1547<p>'Maximum concurrent sessions' is the highest number of user sessions
1548you wish to allow on your system at any given time. Citadel can scale
1549to hundreds of concurrent users, but if you have limited hardware or
1550(more likely) limited bandwidth, you might wish to set a maximum. You
1551can also set it to zero for no limit.</p>
1552<p>'Maximum message length' is just that. This could be a good way to
1553prevent enormous multimedia files from finding their way into your
1554message base. This maximum is enforced in all protocols and is also
1555advertised by the ESMTP service.</p>
1556<p>The minimum and maximum number of worker threads can be tuned to
1557your
1558liking. Citadel will attempt to keep one worker thread running per
1559session,
1560within these constraints. You should be aware that due to the use of
1561the
1562worker thread model, Citadel can handle a large number of concurrent
1563sessions
1564with a much smaller thread pool. If you don't know the programming
1565theory
1566behind 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
1570a
1571Citadel network. If your system is on a Citadel network, this
1572configuration
1573item dictates how often the Citadel server will contact other Citadel
1574servers to send and receive messages. In reality, this will happen more
1575frequently than you specify, because other Citadel servers will be
1576contacting yours at regular intervals as well.</p>
1577<p>Then you can specify TCP port numbers for the SMTP, POP3, and IMAP
1578services. For a system being used primarily for Internet e-mail, these
1579are essential, so you'll want to specify the standard port numbers: 25,
1580110, and 143. If Citadel is running alongside some other mail system,
1581though, then you might want to choose other, unused port numbers, or
1582enter -1 for any protocol
1583to disable it entirely.</p>
1584<p>The question about correcting forged From: lines affects how Citadel
1585behaves with authenticated SMTP clients. Citadel does not ever allow
1586third-party SMTP relaying from unauthenticated clients -- any incoming
1587messages must be
1588addressed to a user on the system or somewhere in a Citadel network. To
1589use Citadel with SMTP client software such as Netscape, Outlook,
1590Eudora, or
1591whatever, users must log in with a username and password. In order to
1592prevent
1593message forgeries, Citadel discards the <tt>From:</tt> line in any
1594message
1595entered by an authenticated user, and replaces it with a <tt>From:</tt>
1596line
1597containing the user's genuine name and e-mail address. Technically,
1598this
1599violates RFC822, because headers are never supposed to be altered, but
1600common
1601sense dictates that this is a good idea. Nevertheless, if you want to
1602suppress
1603this behavior, answer 'No' at the prompt (the default is 'Yes') and the
1604headers
1605will never be altered.</p>
1606<p>The final set of options configures system-wide defaults for the
1607auto-purger:</p>
1608<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>
1609<p>Any user who does not log in for the period specified in 'Default
1610user purge time' will be deleted the next time a purge is run. This
1611setting may be modified on a per-user basis.</p>
1612<p>'Default room purge time' behaves the same way, and may also be
1613modified on a per-room basis.</p>
1614<p>'System default message expire policy' defines the way in which old
1615messages are expired (purged) off the system. You can specify any of:</p>
1616<ul>
1617 <li>Purge by age (specify in days) </li>
1618 <li>Purge by message count in the room (specify number of messages) </li>
1619 <li>Do not purge at all </li>
1620</ul>
1621<p>Again, this setting may be overridden on a per-floor basis, and the
1622floor setting may be overridden on a per-room basis.</p>
1623<pre>Save this configuration? No<br></pre>
1624<p>When you're done, enter 'Yes' to confirm the changes, or 'No' to
1625discard the changes.</p>
1626</div>
1627<hr width="100%" size="2">
1628<h2 align="center"><a name="Configuring_Citadel_for_Internet_e-mail"></a>Configuring
1629Citadel for Internet e-mail</h2>
1630<div align="justify">
1631<h3><a name="Introduction"></a>Introduction</h3>
1632As you know by now, Citadel is a completely self-contained,
1633full-featured Internet e-mail system. When you run Citadel you do
1634not need any other mail software on your host system. This
1635eliminates the need for tedious mucking about with sendmail, qmail,
1636postfix, Cyrus, the UW IMAP
1637server, or any of countless other needlessly complex programs that lead
1638some people to the false assumption that Unix systems are difficult to
1639administer.<br>
1640<br>
1641Some of the many features supported by Citadel are:<br>
1642<ul>
1643 <li>Built-in SMTP and ESMTP service, for delivering and receiving
1644e-mail on the Internet</li>
1645 <li>Built-in POP3 service, for remote fetching of messages</li>
1646 <li>Built-in IMAP service, for access to mail using any standard mail
1647client program</li>
1648 <li>Web mail (implemented using the "WebCit" middleware, which is
1649installed separately)</li>
1650 <li>Support for mailing lists, in both "individual message" and
1651"digest" formats</li>
1652 <li>Multiple/virtual domain support</li>
1653 <li>Any user may have multiple Internet e-mail addresses, in multiple
1654domains</li>
1655 <li>Global address book (Users with addresses in a domain may be
1656spread out across many servers on a Citadel network)</li>
1657 <li>Easy-to-configure integration with <a
1658 href="http://www.spamassassin.org/">SpamAssassin</a> can block spam <i>before</i>
1659it enters the mail system</li>
1660 <li>Easy-to-configuration integration with most Realtime Blackhole
1661Lists (RBL) provide further defense against spammers</li>
1662</ul>
1663This section of the documentation will demonstrate how to configure
1664these features.<br>
1665<br>
1666<h3><a name="Basic_site_configuration"></a>Basic site configuration</h3>
1667<p>Basic configuration of your Citadel system for Internet e-mail
1668begins with
1669the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>I</b>nternet</tt>
1670command:</p>
1671<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>
1672<p>This is a "clean" setup. For a simple, standalone e-mail system you
1673simply have to enter the <tt><b>A</b>dd</tt> command:</p>
1674<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>
1675<p><b>localhost:</b> Basically what you're doing here is telling
1676Citadel
1677what any aliases for your machine are. If your machine were <tt>schmeep.splorph.com</tt>
1678and you also had a DNS entry set up for <tt>blah.com</tt>, you might
1679want to enter '1' and enter <tt>blah.com</tt> as your alias, so that
1680e-mail
1681sent to that address won't bounce.</p>
1682<p><i>Important tip:</i> if your system is known by one name and <i>only</i>
1683one domain, you might not even need to do this at all. You will recall
1684that you entered your system's fully qualified domain name earlier when
1685you went through the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
1686command. The domain name you entered there is automatically considered
1687by Citadel to be a 'localhost' entry in your Internet mail
1688configuration. It does not hurt to enter it in both locations, though.</p>
1689<p><b>gateway domain:</b> this is a simple way of mapping various
1690Citadel hosts in an Internet domain. For example, if you enter <tt>bar.com</tt>
1691as a gateway domain, then mail to users at <tt>foo.bar.com</tt> will
1692be forwarded to the host called <tt>foo</tt> on a Citadel network,
1693mail to users
1694at <tt>kunst.bar.com</tt> will be delivered to the Citadel server
1695called
1696<tt>kunst</tt>, etc. This feature has limited usefulness; if you are
1697operating
1698a network of Citadel servers, it is more likely that you will use the
1699'directory'
1700feature, explained below.</p>
1701<p><b>smart-host:</b> Normally, Citadel sends outbound Internet e-mail
1702directly to its destination. This may not be appropriate for some
1703sites; you may require (due to local convention, security policy, or
1704whatever) that all outbound mail be sent to an SMTP relay or forwarder.
1705To configure this
1706functionality, simply enter the domain name or IP address of your relay
1707as a 'smart-host' entry.</p>
1708<p><b>directory:</b> a domain for which you are participating in
1709directory services across any number of Citadel nodes. For example, if
1710users who have addresses in the domain <tt>citadel.org</tt> are spread
1711out across multiple Citadel servers on your network, then enter <tt>citadel.org</tt>
1712as a 'directory' entry. <i>For this to work, all Citadel servers
1713participating in directory service <b>must</b> carry and share the <tt>Global
1714Address Book></tt> room.</i></p>
1715<p><b>spamassassin:</b> if you are running a <a
1716 href="http://www.spamassassin.org">SpamAssassin</a> service anywhere
1717on your
1718<b>local</b> network, enter its name or IP address as a 'spamassassin'
1719entry. This may be (and, in fact, will usually be) <tt>127.0.0.1</tt>
1720to specify
1721that the service is running on the same host computer as the Citadel
1722server.</p>
1723<p>Please install SpamAssassin as per its own documentation. You will
1724want to run SpamAssassin in client/server mode, where a <tt>spamd</tt>
1725daemon is always running on your computer. Citadel does not utilize the
1726<tt>spamc</tt> client; instead, it implements SpamAssassin's protocol
1727on its own.</p>
1728<p>Connecting to a SpamAssassin service across a wide area network is
1729strongly discouraged. In order to determine whether an incoming e-mail
1730is spam, Citadel must feed the <i>entire message</i> to the
1731SpamAssassin service. Doing this over a wide area network would consume
1732time and bandwidth,
1733which would affect performance.</p>
1734<p>Citadel invokes the SpamAssassin service when incoming messages are
1735arriving via SMTP. Before a message is accepted, it is submitted to
1736SpamAssassin. If SpamAssassin determines that the message is spam, the
1737Citadel SMTP
1738service <i>rejects the message,</i> causing a delivery failure on the
1739sending
1740host. This is superior to software which files away spam in a separate
1741folder, because delivery failures will cause some spammers to assume
1742the
1743address is invalid and remove it from their mailing lists.</p>
1744<p><b>RBL:</b> Realtime Blackhole Lists (RBL's) provide defense against
1745spammers based on their source IP address. There are many such lists
1746available on the Internet, some of which may be utilized free of
1747charge. Since they are DNS based, the lists do not require storage on
1748your server -- they are queried during the SMTP conversation.</p>
1749<p>Citadel can utilize any RBL that uses the <tt>z.y.x.w.nameoflist.org</tt>
1750syntax, where <tt>w.x.y.z</tt> is the source IP address which is
1751attempting to deliver mail to your server. For example, <a
1752 href="http://www.spamcop.net">SpamCop</a> would use the query <tt>2.0.0.127.bl.spamcop.net</tt>
1753to determine whether the host at <tt>127.0.0.2</tt> is a known spammer
1754or open relay. In this case, you simply select option '6' to add an RBL
1755entry, and provide it with the domain suffix of <tt>bl.spamcop.net</tt>
1756(the IP address
1757and extra dot will be automatically prepended for each query).</p>
1758<p>Now select <tt><b>S</b>ave</tt> and you are just about ready for
1759Internet e-mail.</p>
1760<h3><a name="Enabling_the_Internet_mail_protocols"></a>Enabling the
1761Internet mail protocols</h3>
1762<p>As previously mentioned, Citadel contains its own SMTP, POP3, and
1763IMAP services. Enabling them is simple.</p>
1764<p>Check for the existance of a current MTA (sendmail, qmail, etc.) by
1765connecting to port 25 on your host. If you see something similar to the
1766following
1767you're running an MTA already and you'll need to shut it down:</p>
1768<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>
1769<p>In the above example, we see that the host already has Sendmail
1770listening on port 25. Before Citadel can use port 25, Sendmail must be
1771shut off. Please consult the documentation for your operating system
1772for instructions on how to do this. (On a Red Hat Linux system, for
1773example, you can run the <tt>ntsysv</tt> utility, un-checking <tt>sendmail</tt>
1774to disable it at
1775the next reboot; then, run <tt>service sendmail stop</tt> to shut off
1776the
1777currently running service.)</p>
1778<p>If you get a 'connection refused' message when you telnet to port 25
1779there's nothing running and you should be able to continue. You might
1780also want to turn off POP (try the above test substituting 110 for 25)
1781and IMAP (port 143) and use Citadel's POP and IMAP services.</p>
1782<p>Citadel will look for an existing pop/smtp server on startup. If
1783they
1784don't exist (and you've configured them properly) then Citadel should
1785enable
1786them at startup. You can check your logs to be sure, or you can start
1787the
1788server from a shell and watch it load. It might look something like
1789this:</p>
1790<font size="-2"> </font>
1791<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: citadel.html,v 606.5 2003/10/17 02:42:30 ajc Exp $<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: citadel.html,v 606.5 2003/10/17 02:42:30 ajc Exp $<br>Server-hosted upgrade level is 5.62<br>Loaded module: $Id: citadel.html,v 606.5 2003/10/17 02:42:30 ajc Exp $<br>Registered server command EXPI (Expire old system objects)<br>Registered server command FSCK (Check message ref counts)<br>Loaded module: $Id: citadel.html,v 606.5 2003/10/17 02:42:30 ajc Exp $<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: citadel.html,v 606.5 2003/10/17 02:42:30 ajc Exp $<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: citadel.html,v 606.5 2003/10/17 02:42:30 ajc Exp $<br>Registered a new message function (type 202)Loaded module: $Id: citadel.html,v 606.5 2003/10/17 02:42:30 ajc Exp $<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: citadel.html,v 606.5 2003/10/17 02:42:30 ajc Exp $<br>Changing uid to 513<br>Starting housekeeper thread<br></font></pre>
1792<p>The lines emphasized in boldface in the above log output tell you
1793that Citadel "can't bind" to various ports. The error 'address already
1794in use' generally means that something else is already running on the
1795requested port. Make SURE you've followed the above steps to remove
1796sendmail/pop and start your Citadel server again.</p>
1797<h3><a name="citmail"></a>Using Citadel in conjunction with another MTA</h3>
1798<p>Occationally it is not practical to remove a non-Citadel MTA on your
1799host system. For example, you might have multiple groups of users, some
1800of
1801which are using Citadel and some of which are using a legacy Unix mail
1802spool. This type of configuration is discouraged, but two tools are
1803provided
1804to allow it.</p>
1805<p>The tool is called <tt>citmail</tt> and it is, quite simply, a
1806local MDA (Mail Delivery Agent) which you can configure into your MTA
1807for final delivery of incoming messages to Citadel users. A full
1808discussion of the finer points of complex Sendmail configurations is
1809beyond the scope of this document; however, you might want to visit <a
1810 href="http://pixel.citadel.org/citadel/docs/">Pixel BBS</a> where some
1811useful HOWTO documents are provided.<br>
1812</p>
1813<p>The other tool is an <a href="http://www.faqs.org/rfcs/rfc2033.html">RFC2033</a>
1814compliant LMTP service running on a local socket. If you're
1815running a mailer that speaks LMTP (such as <a
1816 href="http://www.postfix.org/">Postfix</a>), you can simply point your
1817mailer at the socket called <span style="font-family: monospace;">citadel.socket</span>
1818in your Citadel directory. For example, in Postfix you might put
1819the following line into <span style="font-family: monospace;">main.cf</span>
1820in order to tell it to use Citadel to deliver mail to local recipients:<br>
1821</p>
1822<pre>local_transport = lmtp:unix:/usr/local/citadel/lmtp.socket<br></pre>
1823<p>Postfix also has something called a "fallback transport" which can
1824be used to implement Citadel as a "secondary" mail system on your
1825server, while keeping the existing Unix mailboxes intact.
1826However, it is beyond the scope of this document to detail the finer
1827points of the configuration of Postfix or any other mailer, so refer to
1828the documentation to those programs and keep in mind that Citadel has
1829LMTP support.<span style="font-family: monospace;"><br>
1830</span></p>
1831<p><span style="font-family: monospace;"></span>For outbound mail, you
1832can either allow Citadel to perform
1833deliveries directly
1834(this won't affect your other mail system because outbound mail doesn't
1835tie
1836up port 25) or enter <tt>127.0.0.1</tt> as your smart-host, which will
1837tell
1838Citadel to forward all of its outbound mail to your other mail system.</p>
1839<h3><a name="Hosting_an_Internet_mailing_list"></a>Hosting an Internet
1840mailing list</h3>
1841<p>Citadel has built in mailing list service (known in the 'net
1842vernacular as "listserv") functionality. You can turn any room
1843into a mailing list. Users can then choose how they participate
1844-- by logging on to your Citadel server directly, or by having the
1845room's contents mailed to
1846them somewhere else. Configuring this is easy.</p>
1847<p>Citadel supports two modes of mailing list delivery: </p>
1848<ul>
1849 <li>"List mode" -- each individual message is delivered as a single
1850e-mail to each list mode recipient. The "From:" header will
1851display the address of the message's original author.</li>
1852 <li>"Digest mode" -- groups of one or more messages are delivered
1853to digest mode recipients. The number of messages in the group
1854depends on how many new messages arrived since the last batch was
1855delivered. The "From:" header will display the address of the
1856room itself, which allows replies to be posted back to the room.</li>
1857</ul>
1858A room may have any combination of list mode and digest mode
1859recipients.
1860<p>As alluded to above, every room on your Citadel system has an
1861Internet e-mail address of its own. Messages sent to that address
1862will be
1863posted in the room (and sent back out to mailing list recipients, as
1864well
1865as to any other Citadels you share the room with). The address
1866format
1867is <tt>room_</tt> plus the name of the room, with any spaces replaced
1868by
1869underscores, followed by <tt>@</tt> and your hostname. For example, if
1870your
1871system is known as <tt>phlargmalb.orc.org</tt> on the Internet, and
1872you have
1873a room called <tt>Bubblegum Collectors</tt>, you can post to that room
1874from
1875anywhere on the Internet simply by sending an e-mail to <tt>room_bubblegum_collectors@phlargmalb.orc.org</tt>.
1876When the message arrives, it's automatically posted in that room.</p>
1877<p>To manually edit the list of "list mode" recipients, simply enter
1878the <tt><b>.A</b>ide
1879mailing <b>L</b>ist management</tt> command. Your text editor will
1880open
1881up and you will be able to create or edit a list of recipients, one per
1882line. Lines beginning with a hash (<tt>#</tt>) are comments.</p>
1883<p>To manually edit the list of "digest mode" recipients, enter the <tt><b>.A</b>ide
1884mailing list <b>D</b>igest recipients</tt> command. As with the
1885previous command, the text editor will open up and you can edit the
1886list of digest mode recipients, one per line.</p>
1887<p>Citadel also has a facility which allows users to subscribe or
1888unsubscribe to mailing lists using a web browser. In order to do this,
1889WebCit must also be running on your server in addition to Citadel.
1890WebCit is obtained and installed separately from the rest of the
1891Citadel system.</p>
1892<p>In order to prevent "just anyone" from subscribing to any room on
1893your system, there is a setting in the <tt><b>.A</b>ide <b>E</b>dit
1894room</tt> command:</p>
1895<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>
1896<p>When you answer "Yes" to self-service list subscribe/unsubscribe,
1897you are
1898enabling that feature. Now, all you have to do is tell the world about
1899the
1900web page they need to visit. It looks like this:</p>
1901<center><tt>http://foobar.baz.org:2000/listsub</tt></center>
1902<p>In this example, the server is called <tt>foobar.baz.org</tt> and
1903WebCit is running on port 2000. Edit appropriately.</p>
1904<p>Citadel offers a subscribe/unsubscribe facility that is more
1905intuitive than other listservs. With most systems, sending commands to
1906the listserv requires that you e-mail it commands in a special format.
1907It's easy to get it wrong. Citadel simply uses your web browser. You
1908select the list you want to subscribe or unsubscribe (hint: it's the
1909list of rooms you've enabled self-service for), select whether you want
1910list mode or digest mode, and enter your e-mail address. For security
1911purposes, a confirmation message is sent to the address you enter. But
1912you don't have to reply to the message in a weird format, either: the
1913confirmation contains another URL which
1914you simply click on (or paste into your browser if you can't click on
1915URL's
1916in your e-mail software) and the confirmation is automatically
1917completed.</p>
1918<hr width="100%" size="2">
1919<center>
1920<h2><a name="Building_or_joining_a_Citadel_network"></a>Building or
1921joining a Citadel network</h2>
1922</center>
1923<h3><a name="Overview__"></a>Overview</h3>
1924<p>If you are running Citadel as a BBS or other forum type of
1925application, one way to 'keep the conversation going' is to share rooms
1926with other Citadel systems. In a shared room, a message posted to the
1927room is automatically
1928propagated to every system on the network. It's kind of like a UseNet
1929newsgroup,
1930but without the spam.</p>
1931<p>If you are using Citadel as the e-mail and groupware platform for a
1932large organization, you can use its networking features to build a
1933large network of Citadel servers which share content (think of rooms as
1934public folders), redistribute e-mail throughout the organization, and
1935integrate the global address book. It might make sense, for
1936example, in a large corporation to give each department or location its
1937own Citadel server. Thanks
1938to Citadel's global address book features, you could still have all of
1939the
1940users share a single e-mail domain.</p>
1941<p>Obviously, the first thing you have to do is find another Citadel to
1942share rooms with, and make arrangements with them. The following
1943Citadels are a good place to start:</p>
1944<ul>
1945 <li>UNCENSORED! - <a href="http://uncensored.citadel.org">uncensored.citadel.org</a>
1946 </li>
1947 <li>The Dog Pound II - <a href="http://dogpound2.citadel.org">dogpound2.citadel.org</a>
1948 </li>
1949 <li>PixelBBS - <a href="http://pixel.citadel.org">pixel.citadel.org</a>
1950 </li>
1951</ul>
1952<p>You don't have to be a part of the citadel.org domain to participate
1953in the public Citadel network, but the DNS service is provided free of
1954charge by the Citadel community if you wish to do this.</p>
1955<h3><a name="Conventions_and_etiquette_when"></a>Conventions and
1956etiquette when connecting to the public Citadel network</h3>
1957<p>Before we get into the technical nitty gritty, there are two points
1958of etiquette to keep in mind. The first thing to keep in mind is that
1959the operator of any particular Citadel may not be willing to share some
1960of his/her rooms. Some sites are proud to offer exclusive content in
1961certain areas. Chances are, if a room is already being shared on the
1962network, it's available for anyone to share; if not, it can't hurt to
1963ask -- but take care not to demand it of them. Ask if you may share the
1964room instead of telling them that you wish to share the room. When
1965looking at a <tt><b>K</b></tt>nown rooms list, network rooms are the
1966ones ending in parentheses instead of angle brackets. For example, <tt>Gateway)</tt>
1967would be a network room, <tt>Lobby></tt> would not.</p>
1968<p>The other point of etiquette to remember is that you should be
1969making
1970the arrangements in advance, and then set it up. It is extremely rude
1971to
1972simply begin networking with another Citadel, or unilaterally start
1973sharing
1974a new room, without first obtaining permission from its operator.
1975Always
1976ask first. Most Citadel operators are more than happy to network with
1977you. Also, if later on you decide to take your system down, please take
1978the time
1979to notify the operators of any other Citadels you network with, so they
1980can
1981unconfigure their end.</p>
1982<h3><a name="Getting_ready_to_join_the_network"></a>Getting ready to
1983join the network</h3>
1984<p>Ok, first things first. On a Citadel room sharing network, the first
1985thing you need to know is your own system's node name. Presumably you
1986set
1987this up during installation, but if you want to change it you can do so
1988using
1989the <tt><b>.A</b>ide <b>S</b>ysconfig <b>G</b>eneral</tt> command:</p>
1990<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>
1991<p>The "node name" is important, it's how the network identifies
1992messages coming from your system. The "human readable node name" is
1993simply a label; it shows up in messages coming from your system. "Fully
1994qualified domain name" is your DNS name; it's used for routing messages
1995on the Internet. In the above example, the node name is "uncnsrd".</p>
1996<h3><a name="Defining_neighbor_nodes"></a>Defining neighbor nodes</h3>
1997<p>The next thing you need to do is configure your neighbor node(s).
1998You need to do this for each node you network with. Let's say you
1999wanted
2000to talk to a Citadel system called "frobozz". Use the <tt><b>.A</b>ide
2001<b>S</b>ysconfig <b>N</b>etwork</tt> command:</p>
2002<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>
2003<p>As you can see in the above example, you have to enter the Citadel
2004node name, the DNS name or IP address of the server, and the port
2005number the Citadel service is running on. The "shared secret" is a
2006password to allow the two Citadel nodes to connect to each other to
2007exchange network data. The password must be <i>identical</i> on both
2008ends of the connection -- when the operator of the other Citadel node
2009sets up the connection with
2010your system, he/she must use the same password.</p>
2011<h3><a name="Sharing_rooms"></a>Sharing rooms</h3>
2012<p>Now you're ready to share rooms. You have to do this for each room
2013you want to share, and you have to do it from BOTH ENDS -- again, when
2014you
2015share a room with another Citadel, they must share it with you as well.
2016Let's say you have a room called "Quiche Recipes>" and you want to
2017share
2018it with the node you set up above. First, edit the room and flag it as
2019a
2020network room:</p>
2021<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>
2022<p>Notice how the prompt changed? It was > before, but it's ) now.
2023That means it's a network room. Now you can tell Citadel that you want
2024to
2025share the room with frobozz. Enter this command:</p>
2026<pre>Quiche Recipes) . Aide Network room sharing<br></pre>
2027<p>Your text editor will pop up (you <i>did</i> configure Citadel to
2028use
2029your favorite text editor, right?) with a screen that looks like this:</p>
2030<pre># Configuration for room: Quiche Recipes<br># Nodes with which we share this room<br># Specify one per line.<br></pre>
2031<p>All you have to do is enter the name of the other Citadel node (i.e.
2032"frobozz" in our example) on a line by itself. As usual, lines starting
2033with a
2034"#" are comments. Just go to the end of the file, type "frobozz"
2035(without
2036the quotes), save the file... and you're done!</p>
2037<p>At this point, you just sit back and enjoy. Your Citadel and the
2038other one will begin polling each other at regular intervals (once per
2039hour
2040by default) and sharing messages.</p>
2041<h3><a name="Sending_mail"></a>Sending mail</h3>
2042<p>You can send mail to any user on any node of your Citadel network.
2043It may take a little while for your system to learn the entire node
2044list, though, as this is done by watching incoming messages on the
2045network and learning which nodes are out there.</p>
2046<p>To send a private message, just enter <tt>user @ host</tt> as the
2047recipient:</p>
2048<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>
2049<h3><a name="Changing_the_polling_interval"></a>Changing the polling
2050interval</h3>
2051<p>As previously mentioned, Citadel will poll other Citadel nodes for
2052messages once per hour. If this is not an acceptable interval, you can
2053change it using the <tt><b>.A</b>ide <b>S</b>ystem configuration <b>G</b>eneral</tt>
2054command. Enter this command and look for the option:</p>
2055<pre>How often to run network jobs (in seconds) [3600]:<br></pre>
2056<p>Change it to whatever you like. For example, 15 minutes is 900
2057seconds. So if you changed the default value to 900, network polling
2058would occur every 15 minutes.</p>
2059<hr>
2060<h2 align="center"><a name="Database_maintenance"></a>Database
2061maintenance</h2>
2062<h3><a name="Introduction_"></a>Introduction</h3>
2063The data store used by Citadel is reliable and self-maintaining.
2064 It requires very little maintenance. This is primarily due
2065to its use of the <a href="http://www.sleepycat.com">Berkeley DB</a>
2066record manager. It is robust, high-performance, and transactional.<br>
2067<br>
2068A few small data files are kept in your main Citadel directory, but the
2069databases are in the <tt>data/</tt> subdirectory. The files with
2070names that begin with "cdb" are the databases themselves; the files
2071with names that begin with "log" are the journals. Journal files
2072will come and go as you use your system; when the database engine has
2073determined that a particular log file is no longer needed, the file
2074will automatically be deleted. Nevertheless, you should always
2075ensure that there is ample disk space for the files to grow.<br>
2076<br>
2077There is no need to shut down Citadel during backups. The data
2078store may be backed up "hot." The makers of Berkeley DB suggest
2079that you should back up the data files <i>first</i> and the log files <i>second</i>.
2080 This is the only method that will guarantee that a database which
2081is being changed while you back it up will still be usable when you
2082restore it
2083from the tape later.<br>
2084<br>
2085<h3><a name="Database_repair"></a>Database repair</h3>
2086Although Citadel's data store is quite reliable, database corruption
2087can occur in rare instances. External factors such as an
2088operating
2089system crash or an unexpected loss of power might leave the database in
2090an unknown state. A utility is provided which may be able to
2091repair
2092your database if this occurs. If you find that your Citadel
2093server
2094is not running, and reading the logs shows that it is crashing because
2095of
2096an inability to validate a database, follow these steps:<br>
2097<ol>
2098 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2099"respawn" to "off." Type <tt>init q</tt> to make this setting
2100permanent.</li>
2101 <li><b>Make a backup of your data.</b> Either write it out to
2102tape or copy it to another directory, or a tarball.<br>
2103 </li>
2104 <li><tt>cd</tt> to your Citadel directory and type <tt>./database_cleanup.sh</tt></li>
2105 <li>Let the cleanup script run. <b>Do not interrupt this
2106process for any reason.</b><br>
2107 </li>
2108 <li>Edit <tt>/etc/inittab</tt> and switch the Citadel service from
2109"off" to "respawn". Type <tt>init q</tt> to activate your
2110changes.</li>
2111</ol>
2112If this procedure does not work, you must restore from your most recent
2113backup.<br>
2114<br>
2115<h3><a name="ImportingExporting_your_Citadel"></a>Importing/Exporting
2116your Citadel database<br>
2117</h3>
2118<p>Citadel/UX contains an importer/exporter module, affectionately
2119known as the "Art Vandelay" module (a not-so-obscure Seinfeld
2120reference). It
2121allows you to export the entire contents of your Citadel databases to a
2122flat file, which may then be imported on another system. (This
2123procedure
2124is also known as "dump and load" to database gurus.)</p>
2125<p>Why would you want to do this? Here are some scenarios: </p>
2126<ul>
2127 <li>You are moving a Citadel installation to another computer, which
2128uses a different CPU. Since Citadel stores data in an
2129architecture-dependent format, the data files wouldn't work on the new
2130computer as-is. </li>
2131 <li>Your computer crashed, lost power, etc. and you suspect that your
2132databases have become corrupted. </li>
2133 <li>You want to switch to a different back-end data store. (For
2134example, from GDBM to Berkeley DB) </li>
2135</ul>
2136<p>So ... how do we work this magic? Follow these steps <i>exactly</i>
2137as documented and you should be able to do it all with very little
2138trouble.</p>
2139<ol>
2140 <li>This should be obvious, but it's still worth mentioning: <b>Make
2141sure you have a backup of everything before you start this! </b>
2142You're performing a major operation here. Don't risk it. </li>
2143 <li>First, get all the users logged off from your system. Disconnect
2144it from the network if possible. You don't want anyone logging in while
2145you're doing this. </li>
2146 <li>Log on as root, or some other user that has read/write access to
2147all relevant files. </li>
2148 <li>Go to the directory that Citadel is installed in. For example,
2149issue a command like <tt>cd /usr/local/citadel</tt> </li>
2150 <li>Export the databases with the following command:<br>
2151 <br>
2152 <tt>./sendcommand "ARTV export" >exported.dat</tt><br>
2153 <br>
2154This command may run for a while. On a very large system it could take
2155an hour or more. Please be patient! </li>
2156 <li>When the export completes, check to make sure that <tt>exported.dat</tt>
2157exists and has some data in it. (Type "ls -l exported.dat") </li>
2158 <li>Shut down the Citadel server. If you have a line in <tt>/etc/inittab</tt>
2159that reads like this:<br>
2160 <br>
2161 <tt>c1:2345:respawn:/usr/local/citadel/citserver
2162-h/usr/local/citadel</tt> <br>
2163...then you should change the <tt>respawn</tt> to <tt>off</tt> and
2164then type <tt>/sbin/init q</tt> to make the changes take effect. </li>
2165 <li>Now it's time to delete your current binary databases. Type:<br>
2166 <br>
2167 <tt>rm -f citadel.config citadel.control data/*</tt> </li>
2168 <li>If you're moving Citadel to another computer, you should move the
2169 <i>entire</i> directory over at this time. <tt>exported.dat</tt>
2170only contains the information that was in the binary databases.
2171Information which was stored in portable formats doesn't need to be
2172exported/imported, so
2173you must bring it all over in its current form. </li>
2174 <li>Now get Citadel running on the new computer (or whatever). Run <tt>setup</tt>
2175and turn the service back on (from <tt>/etc/inittab</tt>) but DO NOT
2176log in. </li>
2177 <li>As root, run the import command:<br>
2178 <br>
2179 <tt>./sendcommand "ARTV import" <exported.dat</tt><br>
2180 <br>
2181This will import your databases. Again, it may run for a long time. </li>
2182 <li>Restart the Citadel server. You can do this any way you like.
2183From the command line, you can do it with a command like:<br>
2184 <br>
2185 <tt>./sendcommand "DOWN"</tt> <br>
2186 </li>
2187 <li>Now you're finished. Log in and test everything. You may delete
2188exported.dat at this time, or you might want to save it somewhere as a
2189sort of pseudo-backup. </li>
2190</ol>
2191<hr>
2192<center>
2193<h2><a name="utilities"></a>Utilities</h2>
2194</center>
2195<h3><a name="overview"></a>Overview</h3>
2196<p>The following utilities will be discussed: </p>
2197<ul>
2198 <li><b>aidepost</b> - Post standard input to the Aide> room </li>
2199 <li><b>whobbs</b> - Who is on the system </li>
2200 <li><b>msgform</b> - Format a binary message to the screen (stdin or
2201in a file) </li>
2202 <li><b>userlist</b> - Print the userlist </li>
2203 <li><b>sendcommand</b> - Send a server command </li>
2204</ul>
2205<p>It is up to you to decide which utilities should be made accessible
2206only to system administrators. It is important that you set the file
2207permissions correctly. All utilities should have access to the Citadel
2208data files. We
2209will attempt to address each program individually.</p>
2210<h3><a name="aidepost"></a>aidepost</h3>
2211<p>The nature of this program is rather simple. Standard input (stdin)
2212is converted into a message, filed in the main message store, and
2213posted in the Aide> room. This is useful for keeping transcripts of
2214system activity that has to do with Citadel operations. You might even
2215elect to send all of
2216your system logs there, too.</p>
2217<p><tt>aidepost</tt> also accepts the usage <tt>aidepost -rTargetRoom</tt>,
2218where TargetRoom is the name of a room to which you'd like the message
2219to be sent.</p>
2220<h3><a name="whobbs"></a>whobbs</h3>
2221<p>This program is similar to the <tt>who</tt> command. It lists all
2222of the users who are currently connected to your Citadel server, either
2223locally or
2224across a network. Unless you're running a standalone system, <tt>who</tt>
2225and <tt>whobbs</tt> will probably not have a one-to-one
2226correspondence. Remember
2227that you will see sessions for SMTP, POP, and IMAP users, as well as
2228users
2229running a Citadel client.</p>
2230<p>One thing to keep in mind is that the <tt>whobbs</tt> utility
2231actually opens a connection to the server. If the server is maxed out, <tt>whobbs</tt>
2232will still be able to provide a listing, because it doesn't need to log
2233in to execute the <tt>RWHO</tt> command. Note that whobbs does not
2234list its own session.</p>
2235<p>The <tt>whobbs</tt> utility is smart enough to know when it is
2236being invoked by a web server as a CGI program. In this situation, it
2237will output its listing
2238as a nicely formatted web page instead of plain text. This makes it
2239easy
2240to just put a link to the whobbs binary in your cgi-bin directory,
2241allowing
2242a quick and easy way for web surfers to see who is online.</p>
2243<p>Running the <tt><b>W</b>ho is online</tt> command from the Citadel
2244client does <b>not</b> call this utility. It has this functionality
2245built in.<br>
2246<br>
2247</p>
2248<h3><a name="msgform"></a>msgform</h3>
2249<p>The <tt>msgform</tt> utility reads its standard input (stdin)
2250looking for
2251Citadel messages stored in the internal format used on disk and over
2252the
2253network, and sends them in a human-readable format to standard output
2254(stdout). There is no longer much use for this program, but it is
2255included for hack
2256value.</p>
2257<h3><a name="userlist"></a>userlist</h3>
2258<p>This is a program to print the userlist. There are two flags that
2259may be
2260set when running this program. When called without any arguments, <tt>userlist</tt>
2261will display all users (except those who have chosen to be unlisted),
2262their user numbers, times called, messages posted, screen width, and
2263date of their most recent call.</p>
2264<p><tt>userlist</tt> is simply the same user listing code that is in
2265the
2266client, made into a standalone utility for convenience.<br>
2267</p>
2268<h3><a name="sendcommand"></a>sendcommand</h3>
2269<p><tt>sendcommand</tt> will interpret its arguments (except for <tt>-hDIRNAME</tt>)
2270as a server command, which is sent to the server. Commands which
2271require textual input will read it from stdin. Commands which generate
2272textual output will be sent to stdout.</p>
2273<p>This utility is intended to be used to enable Citadel server
2274commands to
2275be executed from shell scripts. Review the script called <tt>weekly</tt>
2276which ships with the Citadel distribution for an example of how this
2277can
2278be used.</p>
2279<p><b>NOTE:</b> be sure that this utility is not world-executable. It
2280connects to the server in privileged mode, and therefore could present
2281a security hole
2282if not properly restricted.</p>
2283</div>
2284<br>
2285</body>
2286</html>