commit ff69aabbb2d2a4a6e3c9d4a8c4eafdd1ad084ed5
author humbedooh <humbedooh@apache.org> Wed Jun 01 15:31:07 2016 +0200
committer humbedooh <humbedooh@apache.org> Wed Jun 01 15:31:07 2016 +0200
tree 4d14c234f51442bf903f9ac1b8f5796b2bc962e3
parent 33856f66b6bdb5cb4a638fa1afa0f9dcb4b29d94

add a note about MID generators

content/docs/installing.html

diff --git a/content/docs/installing.html b/content/docs/installing.html
index 8132e08..2fc22a1 100644
--- a/content/docs/installing.html
+++ b/content/docs/installing.html
@@ -207,6 +207,13 @@
 <h3 id='anoteonemailheaders'>A note on email headers<a href='#anoteonemailheaders' style='color: rgba(0,0,0,0);'>&para;</a></h3>
 <p>By default, headers such as to/cc are not shown in the normal email view.
 To enable these headers, set <code>full_headers</code> to <code>true</code> in the <code>site/api/lib/config.lua</code> file.</p>
+<h3 id='lastlyanoteaboutmessageidmidgenerators'>Lastly, a note about Message-ID (MID) generators<a href='#lastlyanoteaboutmessageidmidgenerators' style='color: rgba(0,0,0,0);'>&para;</a></h3>
+<p>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
+setups.</p>
 <h4><a id="disclaimer"></a>Disclaimer</h4>
 <p style="font-size: 8pt; line-height: 12pt;">
     <a href="https://incubator.apache.org"><img src="/images/podling.svg" align="right" width="220px"/></a>

source/markdown/docs/INSTALLING.md

diff --git a/source/markdown/docs/INSTALLING.md b/source/markdown/docs/INSTALLING.md
index e663a7f..8a5ccaf 100644
--- a/source/markdown/docs/INSTALLING.md
+++ b/source/markdown/docs/INSTALLING.md
@@ -209,3 +209,11 @@
 ### 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
+setups.
\ No newline at end of file