ponymail-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject incubator-ponymail git commit: Synch with site docs
Date Sun, 15 Jan 2017 23:07:04 GMT
Repository: incubator-ponymail
Updated Branches:
  refs/heads/master 8b28dbaf9 -> 5bf994353

Synch with site docs

Project: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/commit/5bf99435
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/tree/5bf99435
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ponymail/diff/5bf99435

Branch: refs/heads/master
Commit: 5bf9943530882b94da40c44890aca60355dad696
Parents: 8b28dba
Author: Sebb <sebb@apache.org>
Authored: Sun Jan 15 23:06:05 2017 +0000
Committer: Sebb <sebb@apache.org>
Committed: Sun Jan 15 23:06:05 2017 +0000

 docs/INSTALLING.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/docs/INSTALLING.md b/docs/INSTALLING.md
index fd2405c..e0cc0b6 100644
--- a/docs/INSTALLING.md
+++ b/docs/INSTALLING.md
@@ -28,7 +28,7 @@ You will need the following software installed on your machine:
 - Run setup.py in the `tools` dir:
       $cd tools
-      $python3 setup.py [--defaults]
+      $python3 setup.py
       ...[follow instructions in the setup script]
 - Edit `site/js/config.js` to suit your needs (usually very little editing is needed)
@@ -203,3 +203,12 @@ An example footer could be:
 ### A note on email headers ###
 By default, headers such as to/cc are not shown in the normal email view.
 To enable these headers, set `full_headers` to `true` in the `site/api/lib/config.lua` file.
+### Lastly, a note about Message-ID (MID) generators
+The default MID generator is called 'medium' and digests the message
+body, timestamp and list-ID to generate the MID. There is also a 'short'
+that only digests the body, and a 'full' that uses the entire message as
+a bytestring to generate an ID. Medium is recommended for most setups
+(especially clustered setups), while full can be used for single-machine
+N.B. At present, all the generators have issues, see (#176 #177 #178)

View raw message