aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2013-12-22 11:53:56 -0200
committerSilvio Rhatto <rhatto@riseup.net>2013-12-22 11:53:56 -0200
commit53de49bf80e1ffffd681f78581271a03dfc6b2dc (patch)
treee9617e01740bad7308045cf0fdd5072e5bae5b29
parent3175da282e725a15f0020a0f41bfb0e0eca3843a (diff)
downloadfirma-53de49bf80e1ffffd681f78581271a03dfc6b2dc.tar.gz
firma-53de49bf80e1ffffd681f78581271a03dfc6b2dc.tar.bz2
Doc update
-rw-r--r--index.mdwn51
1 files changed, 33 insertions, 18 deletions
diff --git a/index.mdwn b/index.mdwn
index 2c5388b..caef784 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -125,16 +125,21 @@ 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 `/var/lib/firma/lists`
- but you can use anything, just edit firma and change `FIRMA_LIST_PATH`
- variable.
+### List folder
-2. Copy firma script to whatever you like, e.g. `/usr/local/bin` and check that
- it has no write permission
+Create a folder to store lists; by default firma use `/var/lib/firma/lists` but
+you can use anything, just edit firma and change `FIRMA_LIST_PATH` variable.
-3. Create a list-wide config file (default is `/var/lib/firma/firma.conf`) with
- the common definitions for all lists. You might just copy the sample
- firma.conf.dist and edit according to your needs.
+### Script installation
+
+Copy firma script to whatever you like, e.g. `/usr/local/bin` and check that it
+has no write permission
+
+### Global config
+
+Create a system-wide config file (default is `/var/lib/firma/firma.conf`) with
+the common definitions for all lists. You might just copy the sample
+firma.conf.dist and edit according to your needs.
All config variables can be overwritten at each list's own config file;
firma.conf should be chmoded as `600`, chowned `nobody.nobody` or whatever user
@@ -145,7 +150,9 @@ For a list of all config parameters, type
firma --help config
-4. Then create your lists with the command
+### List creation
+
+Then create your lists with the command
firma -c your-list
@@ -185,12 +192,14 @@ After that you can add some optional parameters on this list config file:
this doesn't affect the way email administration works,
when signature is mandatory
- For a list of all config parameters, type
+For a list of all config parameters, type
firma --help config
-6. Create an alias to the list at your MTA; on sendmail or postfix,
- add this to your aliases file:
+### MTA configuration
+
+Create an alias to the list at your MTA; on sendmail or postfix, add this to
+your aliases file:
your-list: "| /usr/local/bin/firma -p your-list"
your-list-request: "| /usr/local/bin/firma -e your-list"
@@ -202,8 +211,10 @@ and then run the command
alternatively, you can use a virtual mailbox table if you want
to easily host a lot of encrypted mailing lists.
-7. Admin tasks are performed through aliases like your-list-request@yourmachine
- or via command-line:
+### List administration
+
+Admin tasks are performed through aliases like your-list-request@yourmachine
+or via command-line:
firma -a your-list
@@ -225,15 +236,19 @@ following commands:
uses the given address for message delivery instead
of the primary address of a subscribed key
-8. To subscribe and unsubscribe manually the users and the list admins on, use
- a command line like
+### Subscription management
+
+To subscribe and unsubscribe manually the users and the list admins on, use
+a command line like
gpg --homedir [path-to-your-list-keyring] --import < file
and be sure that after this command the list keyring is owned by nobody.nobody.
-9. Send encrypted AND signed messages to `your-list@yourmachine` and look
- what happens :)
+### Testing the installation
+
+Send encrypted AND signed messages to `your-list@yourmachine` and look
+what happens :)
Tips
----