From 541f793cd727f1d59fde12148ac8e2289bb89a6c Mon Sep 17 00:00:00 2001 From: Art Cancro Date: Fri, 24 Aug 2018 12:42:58 -0400 Subject: [PATCH] random documentation updates --- citadel/docs/PAM.txt | 13 ++++++------- citadel/docs/delivery-list.txt | 8 ++++++-- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/citadel/docs/PAM.txt b/citadel/docs/PAM.txt index fb1d277ce..dc5d471e3 100644 --- a/citadel/docs/PAM.txt +++ b/citadel/docs/PAM.txt @@ -1,29 +1,28 @@ - The citadel.pam configuration file has been updated for Red Hat 7.1. +The citadel.pam configuration file has been updated for Red Hat 7.1. If you have such a system, it should Just Work; if you don't, you're going to have to tweak it, preferably BEFORE you do a make install. See below. Even if you have Red Hat 7.1, you should look at the file anyway and understand how it affects your system security. The original PAM.txt is included below: - - Citadel 5.53 and later include support for Pluggable Authentication -Modules (PAM.) However, we don't recommend enabling this feature (./configure +Citadel 5.53 and later include support for Pluggable Authentication +Modules (PAM). However, we don't recommend enabling this feature (./configure --with-pam) unless you understand exactly how it will affect your system's security. Specifically, the system administrator must supply a configuration for every authentication service which uses PAM. We have automated this process for Linux by supplying a file which is placed in /etc/pam.d during the installation process, but not on other systems, for 2 reasons: - 1) Other systems don't have /etc/pam.d; instead they use one big +1) Other systems don't have /etc/pam.d; instead they use one big configuration file, usually /etc/pam.conf. It's not quite as trivial to automatically modify this file in a safe and secure fashion. - 2) Other systems have a different set of available authentication +2) Other systems have a different set of available authentication modules; they are likely to lack all three of the ones we use in the Linux configuration. We don't have enough information about the features of the authentication modules on other platforms to be able to provide secure configurations. - That said, the configuration we've provided should work on at least +That said, the configuration we've provided should work on at least Red Hat Linux 4.2-5.2, (although we don't recommend building Citadel on Red Hat 4.x due to libc thread-safety issues) and if you understand PAM configuration on your system, feel free to build Citadel with PAM support, diff --git a/citadel/docs/delivery-list.txt b/citadel/docs/delivery-list.txt index e414917b0..59361c401 100644 --- a/citadel/docs/delivery-list.txt +++ b/citadel/docs/delivery-list.txt @@ -22,8 +22,12 @@ queue. a single instruction (usually a recipient). Fields are separated by the vertical bar character ("|") and there will always be at least one field on each line. + + When delivery to all listed recipients has either completed or permanently +failed, both the queue item and the message itself are deleted from the +queue room. - -- Once per Queue-Item -- + -- Once per queue item -- INSTRUCTION: msgid SYNTAX: msgid|0000000 @@ -84,7 +88,7 @@ fails). --- Once per Remote-part per Queue-Item -- +-- Once per recipient per queue item -- INSTRUCTION: remote SYNTAX: remote|friko@mumjiboolean.com|0|delivery status message -- 2.30.2