From b162d5cacde85999353afa87a4210c5b5d42ceab Mon Sep 17 00:00:00 2001
From: rhatto <rhatto>
Date: Fri, 6 Oct 2006 22:12:14 +0000
Subject: added permission checking on configuration (both local and global)
 and keyring files

---
 README | 53 +++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 49 insertions(+), 4 deletions(-)

(limited to 'README')

diff --git a/README b/README
index e626415..69f9b5b 100755
--- a/README
+++ b/README
@@ -153,11 +153,40 @@ Setup
       user your MTA runs. If you run postfix, the user is specified by the
       main.cf parameter "default_privs".
 
-      We suggest you to use
+      we suggest you to use
 
        MAIL_AGENT=/usr/sbin/sendmail
        MAIL_AGENT_ARGS=-t
 
+      as optional parameters, you can also set
+
+       USER= user that runs firma (usually the same as your MTA user);
+             defaults to "nobody"; you can also specify this parameter
+             in each mailing list config file if you plan to have one
+             user per mailing list
+
+       GROUP= group that runs firma (usually the same as your MTA group);
+              defaults to "nogroup"; you can also specify this parameter
+              in each mailing list config file if you plan to have one
+              group per mailing list
+
+       LOG_TO_SYSLOG= set to "1" to log errors and warnings to syslog, else firma
+                      will print errors to STDERR
+
+       LOGGER_BINARY= if logging to syslog, set the path to logger's binary
+
+       SYSLOG_PRIORITY= if logging to syslog, set a priority for the error messages
+                        (defaults to "user.err")
+
+       USE_GPG_HIDDEN_RECIPIENT_OPTION= set to '1' to use GnuPG's --hidden-recipient
+                                        option, available from version 1.4.0 onwards
+                                        (try 'man gpg' for more information)
+
+       REMOVE_THESE_HEADERS_ON_ALL_LISTS= headers that should be stripped from list
+                                          messages on all lists running under firma
+                                          (space separated case-insensitive entries)
+                                          (may include regexps (e.g., X-.*)
+
  4 - then create your lists with the command
 
        firma -c your-list
@@ -174,6 +203,22 @@ Setup
      the owner of the config file and keyring should be nobody.nobody
      (or the user your MTA run as) and its permissions must be 600.
 
+     after it you can add some optional parameters on this list config file:
+
+       SUBJECT_PREFIX= prefix to be included in the subject of list messages
+
+       REMOVE_THESE_HEADERS= headers that should be stripped from list messages
+                             (space separated case-insensitive entries)
+                             (may include regexps (e.g., X-.*)
+
+       REPLIES_SHOULD_GO_TO_LIST= set to '1' to add a Reply-To header containing the
+                                  list address
+
+       SILENTLY_DISCARD_INVALID_MESSAGES= set to '1' to silently discard invalid
+                                          messages (message not signed/encrypted,
+                                          sender not subscribed to the list, etc.)
+                                          instead of sending bounces back to sender
+
  5 - create an alias to the list at your MTA; on sendmail or postfix,
      add this to your aliases file:
 
@@ -186,8 +231,8 @@ Setup
 
      alternatively, you can use a virtual ...
 
- 6 - admin tasks are performed through your-list-request@yourmachine or
-     via command-line:
+ 6 - admin tasks are performed through your-list-request@yourmachine (currently
+     not implemente) or via command-line:
 
        firma -a your-list
 
@@ -199,7 +244,7 @@ Setup
          subscribe key-id pubkey from file or keyserver (currently not
          implemented)
 
-       unsure email-address
+       unsub email-address
 
           unsubscribe all keys with email-address IDs (currently not
           implemented)
-- 
cgit v1.2.3