aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rwxr-xr-xREADME35
1 files changed, 17 insertions, 18 deletions
diff --git a/README b/README
index e6d6a7d..a136347 100755
--- a/README
+++ b/README
@@ -129,17 +129,16 @@ Development Guidelines
Setup
-----
- Note for Debian users: you'll need the packages "metamail" and "expect" to
- run firma.
+ Note for Debian users: you'll need the "expect" package to run firma.
Firma installation is quite simple:
1 - Create a folder to store lists; by default firma use /usr/local/etc/lists
but you can use anything, just edit firma and change FIRMA_LIST_PATH
variable.
-
+
2 - Copy firma script to whatever you like, e.g. /usr/local/bin and check that
- it has no write permission
+ it has no write permission
3 - Create a list-wide config file (default is /usr/local/etc/firma.conf) with
the common definitions for all lists,
@@ -150,7 +149,7 @@ Setup
LISTS_DIR= path to the mailing lists directory
All those variables can be overwritten at each list's own config file;
- firma.conf should be chmoded as 600, chowned nobody.nobdy or whatever
+ firma.conf should be chmoded as 600, chowned nobody.nobody or whatever
user your MTA runs. If you run postfix, the user is specified by the
main.cf parameter "default_privs".
@@ -167,17 +166,17 @@ Setup
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
+ defaults to "nobody"; 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
+ 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")
+ (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
@@ -230,9 +229,9 @@ Setup
KEYSERVER= default keyserver to import/export keys
(defaults to keyserver.noreply.org)
- REQUIRE_SIGNATURE= wheter messages sent to the list should be (yes) or dont
- need to be signed to be processed (no); defaults to yes;
- this doesnt affect the way email administration works,
+ REQUIRE_SIGNATURE= whether messages sent to the list should be (1) or don't
+ need to be (0) signed to be processed; defaults to '1';
+ this doesn't affect the way email administration works,
when signature is mandatory
For a list of all config parameters, type
@@ -270,7 +269,7 @@ Setup
unsubscribe all keys with email-address IDs (currently not
implemented)
- use email-address
+ use email-address
uses the given address for message delivery instead
of the primary address of a subscribed key
@@ -293,13 +292,13 @@ Tips
- Use ramdisk to FIRMA_LIST_PATH so all keys and passwords vanishes if the server friezes
- Use a big PASSPHRASE, 25+ chars with alpha-numeric and special ascii keys
-Design and features
+Design and features (OUTDATED)
-------------------
Firma is simple but its simplicity doesn't reflect in lack of design.
- Uses a gpg keyring to store both the keys and the subscribers options
-
+
- Command line is simple to avoid admin tasks resting in some .bash_history
- Non-pgp blocks in a message are discarded since we don't want to deal with
@@ -309,16 +308,16 @@ Design and features
the message
- Firma doesn't use any disk write when processing a message; no temp files
- that may rest in the system; everything goes in memory (but take care,
- sometimes it will use the swap and then is best to make it encrypted)
+ that may rest in the system; everything goes in memory (but take care,
+ sometimes it will use the swap and then is best to make it encrypted)
- By default it doesn't archive messages in the server
- By default it removes the Subject header and put it inside the encrypted
message, as Subject are outside the PGP/MIME context
- - Messages appear to be sent To: Undisclosed Recipients
-
+ - Messages appear to be sent To: Undisclosed Recipients
+
Major features are:
- Keyring support