From 4dfb497930813bbbde182f05e42c34eeafa43b3d Mon Sep 17 00:00:00 2001 From: Art Cancro Date: Fri, 3 Jun 2005 04:01:35 +0000 Subject: [PATCH] * Documentation update --- citadel/ChangeLog | 1 + citadel/docs/citadel.html | 131 +++++++++++++++++++++++++++----------- 2 files changed, 96 insertions(+), 36 deletions(-) diff --git a/citadel/ChangeLog b/citadel/ChangeLog index 7d417c34f..3c075a649 100644 --- a/citadel/ChangeLog +++ b/citadel/ChangeLog @@ -6764,3 +6764,4 @@ Sat Jul 11 00:20:48 EDT 1998 Nathan Bryant Fri Jul 10 1998 Art Cancro * Initial CVS import + diff --git a/citadel/docs/citadel.html b/citadel/docs/citadel.html index 1530cee0b..f61182283 100644 --- a/citadel/docs/citadel.html +++ b/citadel/docs/citadel.html @@ -8,11 +8,11 @@

C I T A D E L

-

a messaging and collaboration platform for BBS and groupware +

a messaging and collaboration platform for BBS bbnd groupware applications

Copyright ©1987-2005 by the Citadel development team:

- +
Clint Adams
@@ -142,7 +142,7 @@ the web:
  • UNCENSORED! BBS, the home of Citadel: http://uncensored.citadel.org
  • -
    +

    Table of Contents

    1. License
    2. @@ -247,7 +247,7 @@ LDAP Connector for Citadel

    -

    +

    GNU General Public License

    @@ -552,7 +552,7 @@ DAMAGES.

    END OF TERMS AND CONDITIONS


    -

    +

    Installation

    @@ -1004,7 +1004,7 @@ command).
    -
    +

    System Administration

    @@ -1304,9 +1304,10 @@ messages around forever (or until they are manually deleted), until they become a certain number of days old, or until a certain number of additional messages are posted in the room, at which time the oldest ones will scroll out.

    -

    When a new Citadel system is first installed, the default system-wide +

    When a new Citadel system is first installed, the default +system-wide expire policy is set to 'manual' -- no automatic purging of messages -takes place anywhere. For public message boards, you will probably want +takes place anywhere. For public message boards, you will probably want to set some sort of automatic expire policy, in order to prevent your message base from growing forever.

    You will notice that you can also fall back to the default expire @@ -1572,7 +1573,8 @@ rooms, because the review of content is considered one of their roles. If you wish to change these policies, the next two options allow you to. You may 'Allow Aides to Zap (forget) rooms', in which case they may use the Zap command just like any other user. -Aides may also .Goto any private mailbox belonging to any +Aides may also .Goto any private mailbox belonging to +any user, using a special room name format.

    If your local security and/or privacy policy dictates that you keep a @@ -1585,7 +1587,7 @@ only the sender and recipient of each individual message will receive a copy.

    The next set of options deals with the tuning of your system. It is usually safe to leave these untouched.

    -
    Server connection idle timeout (in seconds) [900]: 
    Maximum concurrent sessions [20]:
    Maximum message length [2147483647]:
    Minimum number of worker threads [5]:
    Maximum number of worker threads [256]:
    +
    Server connection idle timeout (in seconds) [900]: 
    Maximum concurrent sessions [20]:
    Maximum message length [10000000]:
    Minimum number of worker threads [5]:
    Maximum number of worker threads [256]:

    The 'Server connection idle timeout' is for the connection between client and server software. It is not an idle timer for the user interface. 900 seconds (15 minutes) is the default and a sane @@ -1611,15 +1613,14 @@ with a much smaller thread pool. If you don't know the programming theory behind multithreaded servers, you should leave these parameters alone.

    The next set of options affect how Citadel behaves on a network.

    -
    How often to run network jobs (in seconds) [3600]: 

    POP3 server port (-1 to disable) [110]:

    IMAP server port (-1 to disable) [143]:

    SMTP MTA server port (-1 to disable) [25]:

    SMTP MSA server port (-1 to disable) [587]:

    Correct forged From: lines during authenticated SMTP [Yes]:

    -

    "How often to run network jobs" refers to the sharing of content on -a -Citadel network. If your system is on a Citadel network, this -configuration -item dictates how often the Citadel server will contact other Citadel -servers to send and receive messages. In reality, this will happen more -frequently than you specify, because other Citadel servers will be -contacting yours at regular intervals as well.

    +
    Server IP address (0.0.0.0 for 'any') [0.0.0.0]:
    POP3 server port (-1 to disable) [110]:
    POP3S server port (-1 to disable) [995]:
    IMAP server port (-1 to disable) [143]:
    IMAPS server port (-1 to disable) [993]:
    SMTP MTA server port (-1 to disable) [25]:
    SMTP MSA server port (-1 to disable) [587]:
    SMTPS server port (-1 to disable) [465]:
    Correct forged From: lines during authenticated SMTP [Yes]:
    +

    "Server IP address" refers to the IP address on your server to which Citadel's +protocol services should be bound.  Normally you will leave this +set to 0.0.0.0, which will cause Citadel to listen on all of your +server's interfaces.  However, if you are running multiple +Citadels on a server with multiple IP addresses, this is where you +would specify which one to bind this instance of Citadel to.

    Then you can specify TCP port numbers for the SMTP, POP3, and IMAP services. For a system being used primarily for Internet e-mail, these are essential, so you'll want to specify the standard port numbers: 25, @@ -1627,16 +1628,39 @@ are essential, so you'll want to specify the standard port numbers: 25, though, then you might want to choose other, unused port numbers, or enter -1 for any protocol to disable it entirely.

    -

    You'll also notice that you can specify two port numbers for SMTP: one -for MTA (Mail Transport Agent) and one for MSA (Mail Submission Agent). The -traditional ports to use for these purposes are 25 and 587. If you are -running an external MTA, such as Postfix (which submits mail to Citadel using +

    You'll also notice that you can specify two port numbers for SMTP: +one +for MTA (Mail Transport Agent) and one for MSA (Mail Submission Agent). +The +traditional ports to use for these purposes are 25 and 587. If you are +running an external MTA, such as Postfix (which submits mail to Citadel +using LMTP) or Sendmail (which submits mail to Citadel using the 'citmail' -delivery agent), that external MTA will be running on port 25, and you should -specify "-1" for the Citadel MTA port to disable it. The MSA port (again, -usually 587) would be the port used by end-user mail client programs such as -Aethera, Thunderbird, Eudora, or Outlook, to submit mail into the system. -All connections to the MSA port must use Authenticated SMTP.

    +delivery agent), that external MTA will be running on port 25, and you +should +specify "-1" for the Citadel MTA port to disable it. The MSA port +(again, +usually 587) would be the port used by end-user mail client programs +such as +Aethera, Thunderbird, Eudora, or Outlook, to submit mail into the +system. +All connections to the MSA port must use Authenticated SMTP.
    +

    +

    The protocols ending in "S" (POP3S, IMAPS, and SMTPS) are +SSL-encrypted.  Although all of these protocols support the +STARTTLS command, older client software sometimes requires connecting +to "always encrypted" server ports.  Usually when you are looking +at a client program that gives you a choice of "SSL or TLS," the SSL +option will connect to one of these dedicated ports, while the TLS +option will connect to the unencrypted port and then issue a STARTTLS +command to begin encryption.  (It is worth noting that this is not the proper use of the acronyms +SSL and TLS, but that's how they're usually used in many client +programs.)
    +

    +

    All of the default port numbers, including the encrypted ones, are +the standard ones.
    +

    The question about correcting forged From: lines affects how Citadel behaves with authenticated SMTP clients. Citadel does not ever allow third-party SMTP relaying from unauthenticated clients -- any incoming @@ -1658,10 +1682,16 @@ sense dictates that this is a good idea. Nevertheless, if you want to suppress this behavior, answer 'No' at the prompt (the default is 'Yes') and the headers -will never be altered.

    +will never be altered.
    +
    +Connect this Citadel to an LDAP directory [No]: No

    +

    +

    The LDAP configuration options are discussed elsewhere in this +document.
    +

    The final set of options configures system-wide defaults for the auto-purger:

    -
    Default user purge time (days) [120]: 

    Default room purge time (days) [30]:

    System default message expire policy (? for list) [2]:

    Keep how many messages online? [150]:

    Mailbox default message expire policy (? for list) [1]:

    +
    Default user purge time (days) [120]: 
    Default room purge time (days) [30]:
    System default message expire policy (? for list) [0]:
    Keep how many messages online? [150]:
    Mailbox default message expire policy (? for list) [0]:
    How often to run network jobs (in seconds) [1800]:
    Enable full text search index (warning: resource intensive) [Yes]: Yes
    Hour to run purges (0-23) [4]:

    Any user who does not log in for the period specified in 'Default user purge time' will be deleted the next time a purge is run. This setting may be modified on a per-user basis.

    @@ -1681,12 +1711,39 @@ want to. This can allow you, for example, to set a policy under which old messages scroll out of public rooms, but private mail stays online indefinitely -until deleted by the mailbox owners.

    -
    Save this configuration? No
    +until deleted by the mailbox owners.
    +

    +

    "How often to run network jobs" refers to the sharing of content on +a +Citadel network. If your system is on a Citadel network, this +configuration +item dictates how often the Citadel server will contact other Citadel +servers to send and receive messages. In reality, this will happen more +frequently than you specify, because other Citadel servers will be +contacting yours at regular intervals as well.
    +

    +

    "Hour to run purges" determines when expired and/or deleted objects +are purged from the database.  These purge operations are +typically run overnight and automatically, sometime during whatever +hour you specify.  If your site is much busier at night than +during the day, you may choose to have the auto-purger run during the +day.

    +

    "Enable full text search index," if enabled, instructs the server to +build and maintain a searchable index of all messages on the +system.  This is a time and resource intensive process -- it could +take days to build the index if you enable it on a large +database.  Once enabled, however, it will be updated incrementally +and will not have any noticeable impact on the interactive response +time of your system.  The full text index is currently only +searchable when using IMAP clients; other search facilities will be +made available in the near future.
    +

    +

    Save this configuration? No
    +

    When you're done, enter 'Yes' to confirm the changes, or 'No' to discard the changes.

    -
    +

    Configuring Citadel for Internet e-mail

    @@ -1982,7 +2039,7 @@ you simply click on (or paste into your browser if you can't click on URL's in your e-mail software) and the confirmation is automatically completed.

    -
    +

    Building or joining a Citadel network

    @@ -2316,8 +2373,10 @@ Authority when you order the certificate.
  • When the certificate is received, simply save it as citadel.cer and restart the Citadel server.
  • -
  • If your certificate authority delivers a 'chained' certificate (one -with intermediate certificate authorities), simply append the intermediate +
  • If your certificate authority delivers a 'chained' certificate +(one +with intermediate certificate authorities), simply append the +intermediate certificate after your server's own certificate in the citadel.cer file.
  • -- 2.39.2