X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fdocs%2Fcitadel.html;h=210728d3c01442cfc05a24ffc33d2495e0beb109;hb=b7d79f725dac5c4853a8a1ddf64c28a035388c12;hp=0f469185931b18dbfa79798d900421612e04d4ec;hpb=8cf0f48f7a5423a28aa9f4e3ebdeaa952b75043c;p=citadel.git diff --git a/citadel/docs/citadel.html b/citadel/docs/citadel.html index 0f4691859..210728d3c 100644 --- a/citadel/docs/citadel.html +++ b/citadel/docs/citadel.html @@ -8,9 +8,8 @@

C I T A D E L

-

a messaging and collaboration platform -for groupware and BBS applications

-Copyright ©1987-2005 by the Citadel development team:
+

an open source messaging and collaboration platform

+Copyright ©1987-2006 by the Citadel development team:

@@ -36,8 +35,7 @@ others
- @@ -59,17 +57,16 @@ developer
- - - - + - + + + + @@ -105,14 +107,13 @@ design
- - @@ -131,14 +132,13 @@ encoder/decoder
Art Cancro
overall system design and lead -developer
+
overall system design and lead developer
Michael Hampton
+
Wilfried Goesgens
client software development
+
build system patches
Urs Jannsen
-
text -search algorithm
+
Michael Hampton
client software development
+
Andru Luvisi
@@ -86,8 +83,13 @@ search algorithm
Stu Mark
additional client features, IGnet protocol -design
+
additional client features, IGnet protocol design
+
Edward S. Marshall
+
RBL checking function design
Trey Van Riper
portability enhancements
+
QA and portability enhancements
John Walker
author of public domain base64 -encoder/decoder
+
author of public domain base64 encoder/decoder

-
The entire package is open source; you can +
The entire package is open source software. You may redistribute and/or modify it under the terms of the GNU General Public -License as published by the Free Software Foundation; either version 2 -of the License, or (at your option) any later version.
+License, version 2, which is included in this manual.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

For more information, visit either of these locations on @@ -775,7 +775,9 @@ your favorite text editor to write messages. To do this you simply put a line in your citadel.rc file like this:

editor=/usr/bin/vi

The above example would make Citadel call the vi editor when using -the .Enter Editor command. You can also make +the .Enter Editor command, or when a user +selects the "Always compose messages with the full-screen +editor" option. You can also make it the default editor for the Enter command by editing the citadel.rc file. But be warned: external editors on public systems can @@ -1636,7 +1638,7 @@ database logs affect your ability to reliably backup your Citadel system.

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

-
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 (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]:
Allow unauthenticated SMTP clients to spoof my domains [No]: No
Instantly expunge deleted IMAP messages [No]: 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 @@ -1705,7 +1707,27 @@ 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.

+

"Instant expunge" affects what happens when IMAP users delete +messages. As you may already know, messages are not truly deleted +when an IMAP client sends a delete command; they are only marked for +deletion. The IMAP client must also send an "expunge" command +to actually delete the message. The Citadel server automatically expunges +messages when the client logs out or selects a different folder, but if you +select the Instant Expunge option, an expunge operation will automatically +follow any delete operation (and the client will be notified, preventing any +mailbox state problems). This is a good option to select, for example, if you +have users who leave their IMAP client software open all the time and are +wondering why their deleted messages show up again when they log in from a +different location (such as WebCit).

+

"Allow spoofing" refers to the security level applied to +non-authenticated SMTP clients. Normally, when another host connects to +Citadel via SMTP to deliver mail, Citadel will reject any attempt to send +mail whose sender (From) address matches one of your host's own domains. This +forces your legitimate users to authenticate properly, and prevents foreign +hosts (such as spammers) from forging mail from your domains. If, however, +this behavior is creating a problem for you, you can select this option to +bypass this particular security check.

Connect this Citadel to an LDAP directory [No]: No

@@ -1714,7 +1736,8 @@ 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) [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]:
+
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]:
+Perform journaling of email messages [No]:
Perform journaling of non-email messages [No]:
Email destination of journalized messages [example@example.com]:

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.

@@ -1762,8 +1785,17 @@ 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.
-

+made available in the near future.

+

The "Perform journaling..." options allow you to configure +your Citadel server to send an extra copy of every message, along with +recipient information if applicable, to the email address of your choice. +The journaling destination address may be an account on the local Citadel +server, an account on another Citadel server on your network, or an Internet +email address. These options, used in conjunction with an archiving service, +allow you to build an archive of all messages which flow through your Citadel +system. This is typically used for regulatory compliance in industries which +require such things. Please refer to the journaling +guide for more details on this subject.

Save this configuration? No

When you're done, enter 'Yes' to confirm the changes, or 'No' to @@ -1850,6 +1882,12 @@ whatever) that all outbound mail be sent to an SMTP relay or forwarder. To configure this functionality, simply enter the domain name or IP address of your relay as a 'smart-host' entry.

+

If your relay server is running on a port other +than the standard SMTP port 25, you can also specify the port number +using "host:port" syntax; i.e. relay99.myisp.com:2525

+

Furthermore, if your relay server requires authentication, you can +specify it using username:password@host or username:password@host:port +syntax; i.e. jsmith:pass123@relay99.myisp.com:25

directory: a domain for which you are participating in directory services across any number of Citadel nodes. For example, if users who have addresses in the domain citadel.org are spread