citadel/docs/siteconfig.txt

   1
   2
   3
   4 Site Configuration
   5 by IGnatius T Foobar (Art Cancro)
   6
   7     Once your Citadel server is up and running, the first thing you'll
   8 want to do is customize and tune it.  This can be done from the
   9 text-based client with the .Aide System configuration General command,
  10 or from WebCit (if you have it installed) by clicking "Advanced Options"
  11 followed by "Edit site-wide configuration."   This document will show the
  12 text client being used, but the available set of options are the same
  13 either way.
  14
  15     The first set of options deal with the identification of your system.
  16
  17
  18  Lobby> . Aide System configuration General
  19  Node name [uncnsrd]:
  20  Fully qualified domain name [uncensored.citadel.org]:
  21  Human readable node name [Uncensored]:
  22  Modem dialup number [US 914 999 9999]:
  23  Geographic location of this system [Mount Kisco, NY]:
  24  Name of system administrator [IGnatius T Foobar]:
  25  Paginator prompt [<jinkies!  more text on the next screen!>]:
  26
  27
  28
  29 For "node name" you should enter the "short" node name of your system.  It
  30 is used in a number of places, most notably for routing of messages
  31 across a Citadel network. Citadel will attempt to set the default value
  32 to the unqualified host name of your computer.
  33
  34 Then enter the fully-qualified domain name [FQDN] of your system.  If you
  35 are not on the Internet, you can simply set it to the same as your
  36 unqualified host name. Otherwise you should
  37 set this value to the host name by which your system is most commonly known.
  38
  39 The field "Human-readable node name" is also called the "node title" or
  40 "organization name."  It is used primarily for display purposes.  Set it to
  41 the actual name of your system as you want it to appear.
  42
  43 If you have a modem or bank of modems answering data calls for your
  44 system, enter it in the field marked "Modem dialup number."  Otherwise
  45 you may make something up.  This is used for interoperability with older
  46 Citadel-86 systems which use a telephone number for node identification.
  47
  48 "Geographic location of this system" is another display field.  Enter a
  49 city and state, or city and country.
  50
  51 "Name of system administrator" is important!  Any user who logs on with
  52 the name you enter here will automatically be granted Aide privileges.
  53 This is one of two ways for the system administrator to grant
  54 himself/herself Aide access to the system when initially setting it up.  (The
  55 other is simply to have the first account created on a new installation.)
  56
  57
  58     The next set of options are your system's security settings.  Before
  59 delving into the actual options, we should review the various access
  60 levels available on the system.  Citadel has seven access levels:
  61
  62      0 (Deleted).  A user whose access level is set to 0 will
  63        automatically be deleted by the system.
  64      1 (New User).   Users at this level may only read messages.  Entering
  65        messages is prohibited, except in the Mail> room, where a message
  66        to 'sysop' may be entered.
  67      2 (Problem User).  Also known as "Twit."
  68      3 (Local User).  May enter messages, except in rooms shared on a
  69        Citadel network.
  70      4 (Network User).  May enter messages in every accessible room.
  71      5 (Preferred User).  Use of this level is up to the whim of the
  72        system administrator.
  73      6 (Aide).  Access is granted to the administrative functions of the
  74        system.  (This access level may also be granted to a user only for
  75        a specific room, please see "Room Aide" for
  76        more information.)
  77
  78
  79  Require registration for new users  [No]: No
  80  Initial access level for new users [4]:
  81  Access level required to create rooms [4]:
  82  Automatically give room aide privs to a user who creates a private room [No]: No
  83  Automatically move problem user messages to twit room  [Yes]: Yes
  84  Name of twit room [Trashcan]:
  85  Restrict Internet mail to only those with that privilege  [No]: No
  86  Name of room to log pages [Page Log Scandal]:
  87
  88
  89
  90 "Registration" refers to the process of a user entering various personal
  91 contact information (real name, address, telephone number, etc.) into the
  92 system.  When enabled, this information is stored as a vCard object on
  93 the system in two places: the user's  My Citadel Config>  room, and in
  94 the  Global Address Book> room.  (Note: the latter should be made private
  95 on publicly-accessible systems, for obvious reasons.)
  96
  97 If you answer Yes to "Require registration for new users" then each new
  98 user, upon creating a new account, will immediately be entered into the
  99 registration process.
 100
 101 "Initial access level for new users" should be set to 1 (New User) if you
 102 would like to review each new user's registration info before granting
 103 them higher access.  This would be done periodically with the <.A>ide
 104 <V>alidate-new-users command.   If you do not require registration, you
 105 should set the initial access level to 4 (Network User).
 106
 107 "Access level required to create rooms" is up to you.  You might wish to
 108 restrict the creation of new rooms only to Aides, or you might wish to
 109 allow anyone to create a room.  The latter is one of the Citadel
 110 culture's most long-standing traditions; the former may be appropriate if
 111 users are abusing this privilege.
 112
 113 You have the ability to "Automatically give room aide privs to a user who
 114 creates a private room."  If you answer Yes, then any user who creates a
 115 guess-name, passworded, or invitation-only room will automatically become
 116 the room aide, and will have access to a subset of the <.A>ide command
 117 set while in that room.  If you would rather grant this permission
 118 manually, answer No.
 119
 120 Another tradition in the Citadel culture is to refrain from deleting
 121 problem users, but instead to "twit" them (reduce their access level to 2
 122 [Problem User]).   You can then "Automatically move problem user messages
 123 to twit room" (answer Yes, then specify "Name of twit room" and remember
 124 to create that room).  If you employ this logic, any user with level 2
 125 (Problem User) access will continue to have access to the same set of
 126 rooms, but all messages posted will automatically be routed to the
 127 Trashcan (or whatever you call your twit room).
 128
 129 If you have the Internet mail gateway installed, you have the option of
 130 restricting its use on a user-by-user basis.  If you wish to do this,
 131 answer Yes to "Restrict Internet mail to only those with that privilege."
 132
 133 "Name of room to log pages" is where you can specify a room to which all
 134 pages (also called express messages or instant messages) will be logged.
 135 You may wish to do this for security reasons.
 136
 137
 138     The next set of options deals with the tuning of your system.  It is
 139 safe to leave these untouched.
 140
 141
 142  Server connection idle timeout (in seconds) [900]:
 143  Maximum concurrent sessions [20]:
 144  Maximum message length [2147483647]:
 145  Minimum number of worker threads [5]:
 146  Maximum number of worker threads [256]:
 147  Server-to-server networking password [xxxxx]:
 148
 149
 150
 151
 152 The "Server connection idle timeout" is for the connection between client
 153 and server software.  It is not an idle timer for the user interface.
 154 900 seconds (15 minutes) is the default and a sane setting.
 155
 156 "Maximum concurrent sessions" is the highest number of user sessions you
 157 wish to allow on your system at any given time.  Citadel can scale to
 158 hundreds of concurrent users, but if you have limited hardware or (more
 159 likely) limited bandwidth, you might wish to set a maximum.  You can also
 160 set it to zero for no limit.
 161
 162 "Maximum message length" is just that.  This could be a good way to
 163 prevent enormous multimedia files from finding their way into your
 164 message base.
 165
 166 The minimum and maximum number of worker threads can be tuned to your
 167 liking.  Citadel will attempt to keep one worker thread running per
 168 session, within these constraints.  You should be aware that due to the
 169 use of the worker thread model, Citadel can handle a alarge number of
 170 concurrent sessions with a much smaller thread pool.  If you don't know
 171 the programming theory behind multithreaded servers, you should leave
 172 these parameters alone.
 173
 174 The "server-to-server networking password" may be set to some secret value
 175 to allow authenticated networking between Citadel servers.
 176
 177
 178     The final set of options deals with the purging or expiry of old
 179 objects off the system, and the new smtp/pop settings.
 180
 181 Please note:  POP and SMTP are now disabled  by default.  In order to use
 182 those two citadel servers you'll have to enable them manually.
 183
 184  POP3 server port (-1 to disable) [-1]:
 185  SMTP server port (-1 to disable) [-1]:
 186  Default user purge time (days) [61]:
 187  Default room purge time (days) [21]:
 188  System default message expire policy (? for list) [2]:
 189  Keep how many messages online? [150]:
 190  Save this configuration? Yes
 191
 192
 193
 194 New settings to (.A)ide (S)ystem (G)eneral:
 195
 196 POP/SMTP settings. Citadel is now capable of being it's own internet
 197 e-mail server (smtp) or pop server. If you want that functionality, enter
 198 in the correct ports. Normally this will be 110 for pop or 25 for smtp. More on this is in mailsetup.html.
 199
 200 Any user who does not log in for the period specified in "Default user
 201 purge time" will be deleted the next time a purge is run.  This setting
 202 may be modified on a per-user basis.
 203
 204 "Default room purge time" behaves the same way, and may also be modified
 205 on a per-room basis.
 206
 207 "System default message expire policy" defines the way in which old
 208 messages are expired (purged) off the system.  You can specify any of:
 209
 210      Purge by age (specify in days)
 211      Purge by message count in the room (specify number of messages)
 212      Do not purge at all
 213
 214   Again, this setting may be overridden on a per-floor basis, and the
 215 floor setting may be overridden on a per-room basis.
 216
 217
 218     When you're done, enter "Yes" to confirm the changes, or "No" to abort.