ponymail-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From humbed...@apache.org
Subject [1/2] incubator-ponymail-site git commit: add a bit about picking a generator
Date Sun, 04 Jun 2017 14:17:02 GMT
Repository: incubator-ponymail-site
Updated Branches:
  refs/heads/asf-site a0d9013c1 -> f1cd2859f

add a bit about picking a generator

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

Branch: refs/heads/asf-site
Commit: 75f4eb1229c21234c8f8ca04be3f20ecd442e804
Parents: a0d9013
Author: Daniel Gruno <humbedooh@apache.org>
Authored: Sun Jun 4 16:16:32 2017 +0200
Committer: Daniel Gruno <humbedooh@apache.org>
Committed: Sun Jun 4 16:16:32 2017 +0200

 source/markdown/docs/ARCHIVING.md  | 13 +++++++++++++
 source/markdown/docs/INSTALLING.md |  8 +-------
 2 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/source/markdown/docs/ARCHIVING.md b/source/markdown/docs/ARCHIVING.md
index 75246ba..4fe88f8 100644
--- a/source/markdown/docs/ARCHIVING.md
+++ b/source/markdown/docs/ARCHIVING.md
@@ -69,6 +69,19 @@ defined as a member via OAuth full access to all private lists.
 If you use LDAP, you can modify the LDAP queries in the example AAA file to suit
 your organization.
+## Using the right ID generator
+Pony Mail relies on ID generators to produce a unique document ID for each email.
+Depending on the setup of your installation, we recommend using one of two generators:
+- If you have a single-node setup, we recommend using the `full` generator. This generator
+  uses the full message body, including MTA trails (Received headers etc), to generate an
+- If you have a clustered/redundant setup (multiple archiver nodes), we recommend using the
+  `redundant` generator. This will use as many unique traits in an email as possible, but
+  discard the MTA trail (which differs from machine to machine).
+We do not recommend using the older generators (`medium` and `short`)
+for new installations, as they are theoretically prone to create
+duplicate IDs (See issues #176 #177 #178).
 ## Importing/Archiving HTML-only emails
 Should you need to import HTML-only emails into the archive, you may enable this

diff --git a/source/markdown/docs/INSTALLING.md b/source/markdown/docs/INSTALLING.md
index e7244de..e45ef64 100644
--- a/source/markdown/docs/INSTALLING.md
+++ b/source/markdown/docs/INSTALLING.md
@@ -205,10 +205,4 @@ 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)
+Please see [this paragraph](archiving.html#usingtherightidgenerator) about document ID generators.

View raw message