ponymail-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From git-site-r...@apache.org
Subject incubator-ponymail-site git commit: Automatic Site Publish by Buildbot
Date Sun, 15 Jan 2017 23:08:05 GMT
Repository: incubator-ponymail-site
Updated Branches:
  refs/heads/asf-site e0ce656f0 -> 6417f456a


Automatic Site Publish by Buildbot


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/6417f456
Tree: http://git-wip-us.apache.org/repos/asf/incubator-ponymail-site/tree/6417f456
Diff: http://git-wip-us.apache.org/repos/asf/incubator-ponymail-site/diff/6417f456

Branch: refs/heads/asf-site
Commit: 6417f456a9d323cc05cd6385ab2b759f86134cfb
Parents: e0ce656
Author: buildbot <infrastructure@apache.org>
Authored: Sun Jan 15 23:08:01 2017 +0000
Committer: buildbot <infrastructure@apache.org>
Committed: Sun Jan 15 23:08:01 2017 +0000

----------------------------------------------------------------------
 content/docs/api.html            | 85 ++++++++++++++++++++++++++++-------
 content/docs/importing.html      | 26 +++++++----
 content/docs/install.ubuntu.html |  4 +-
 content/docs/installing.html     | 17 +++----
 4 files changed, 93 insertions(+), 39 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-ponymail-site/blob/6417f456/content/docs/api.html
----------------------------------------------------------------------
diff --git a/content/docs/api.html b/content/docs/api.html
index 74aae85..dac3dd6 100644
--- a/content/docs/api.html
+++ b/content/docs/api.html
@@ -38,9 +38,10 @@
 <h1 id='ponymailarchiveapi'>Pony Mail Archive API<a href='#ponymailarchiveapi' style='color:
rgba(0,0,0,0);'>&para;</a></h1>
 <h3 id='fetchingaspecificemail'>Fetching a specific email:<a href='#fetchingaspecificemail'
style='color: rgba(0,0,0,0);'>&para;</a></h3>
 <p>Usage:
-<code>GET /api/email.lua?id=$mid</code></p>
+<code>GET /api/email.lua?id=$mid[&amp;attachment=true&amp;file=$hash]</code></p>
 <p>Parameters: (cookie may be required)
-  - $mid: The email ID or Message-ID: header</p>
+  - $mid: The email ID or Message-ID: header
+  - $hash: the file attachment hash</p>
 <p>Response example:</p>
 <pre>
 {
@@ -68,26 +69,51 @@
 
 <h3 id='fetchinglistdata'>Fetching list data<a href='#fetchinglistdata' style='color:
rgba(0,0,0,0);'>&para;</a></h3>
 <p>Usage:
-<code>GET /api/stats.lua?list=$list&amp;domain=$domain[&amp;d=$timespan][&amp;q=$query][&amp;header_from=$from][&amp;header_subject=$subject]</code></p>
-<p>Parameters:
-    - $list: The list prefix (e.g. <code>dev</code>). Wildcards may be used
-    - $domain: The list domain (e.g. <code>httpd.apache.org</code>). Wildcards
may be used
-    - $timespan: A <a href="#Timespans">timespan</a> value
-    - $query: A search query (may contain wildcards or negations):
-      - <code>foo</code>: Find all documents containing <code>foo</code>
in headers or body
-      - <code>-foo</code>: Find all documents NOT containing <code>foo</code>.
-      - <code>foo*</code>: Find all documents containing <code>foo</code>,
<code>fooa</code>, <code>foob</code> etc
-    - $from: Optional From: address
-    - $subject: Optional Subject: line</p>
+<code>GET /api/stats.lua?list=$list&amp;domain=$domain[&amp;d=$timespan][&amp;q=$query][&amp;header_from=$from][&amp;header_to=$to][&amp;header_subject=$subject][&amp;header_body=$body][&amp;quick][&amp;s=$s&amp;e=$e]</code></p>
+<p>Parameters:</p>
+<pre><code>- $list: The list prefix (e.g. `dev`). Wildcards may be used
+- $domain: The list domain (e.g. `httpd.apache.org`). Wildcards may be used
+- $timespan: A [timespan](#Timespans) value
+- $s: yyyy-mm start of month (day 1)
+- $e: yyyy-mm end of month (last day)
+- $query: A search query (may contain wildcards or negations):
+  - `foo`: Find all documents containing `foo` in headers or body
+  - `-foo`: Find all documents NOT containing `foo`.
+  - `foo*`: Find all documents containing `foo`, `fooa`, `foob` etc
+- $from: Optional From: address
+- $to: Optional To: address
+- $subject: Optional Subject: line
+- $body: Optional body text
+</code></pre>
 <p>Response example:</p>
 <pre>
 {
     "took": 437179,
     "firstYear": 2015,
-    "emails": {...},
+    "emails": {
+        {
+            "list_raw": "<dev.ponymail.apache.org>",
+            "gravatar": "66cf545ca7a1b8f595282bb9d8a59657",
+            "id": "b1d6446f5cc8f4846454cbabc48ddb08afbb601a77169f8e32e34102@<dev.ponymail.apache.org>",
+            "epoch": 1474883100,
+            "subject": "Re: Missing tag for 0.9 release",
+            "message-id": "<7f249f5e-e422-68a5-d57f-bfce585e638e@apache.org>",
+            "private": false,
+            "irt": "<CAOGo0VYrCOR=820LSDZA=czc==SOwCaRKasaEvVuxtUEXp9SDQ@mail.gmail.com>",
+            "from": "Daniel Gruno <h...@apache.org>",
+            "attachments": 0
+        },...
+    },
     "no_threads": 10,
     "domain": "ponymail.info",
-    "participants": {...},
+    "participants": {
+        {
+            "count": 3,
+            "name": "Daniel Gruno",
+            "gravatar": "66cf545ca7a1b8f595282bb9d8a59657",
+            "email": "hu...@apache.org"
+        }, ...
+    },
     "lastYear": 2015,
     "name": "dev",
     "cloud": {...},
@@ -101,11 +127,28 @@
 }
 </pre>
 
+<h3 id='anametimespansatimespans'><a name="Timespans"></a>Timespans<a
href='#anametimespansatimespans' style='color: rgba(0,0,0,0);'>&para;</a></h3>
+<p>Timespans supported by the &amp;d= parameter.</p>
+<pre><code>- d=yyyy-mm =&gt; equivalent to &amp;s=yyyy-mm&amp;e=yyyy-mm
+- d=lte=n[wMyd] (less than n[wMyd] ago, inclusive)
+- d=gte=n[wMyd] (more than n[wMyd] ago, inclusive)
+- d=.*dfr=yyyy-mm-dd.* (start date for search, inclusive)
+- d=.*dto=yyyy-mm-dd.* (end date for search, inclusive)
+- [wMyd] = weeks, Months, years, days
+- lte and gte are mutually exclusive
+- dfr and dto are normally both present
+</code></pre>
 <h3 id='fetchingpreferencesandquicklistoverview'>Fetching preferences and quick list
overview<a href='#fetchingpreferencesandquicklistoverview' style='color: rgba(0,0,0,0);'>&para;</a></h3>
 <p>Usage:
-<code>GET /api/preferences.lua[?logout=true]</code></p>
+<code>GET /api/preferences.lua[?logout][?associate=$email][?verify&amp;hash=$hash][?removealt=$email][?save][?addfav=$list][?remfav=$list]</code></p>
 <p>Parameters: (cookie required)
-  - logout: Whether to log out of the system (optional)</p>
+  - logout: Whether to log out of the system (optional)
+  - associate=$email - associate the account with the $email address
+  - verify&amp;hash=$hash - verify an association request $hash
+  - removealt=$email - remove an alternate $email address
+  - save - save preferences
+  - addfav=$list - add a favourite $list
+  - remfav=$list - remove a favourite $list</p>
 <p>Response example:</p>
 <pre>
 {
@@ -149,6 +192,14 @@
     "notifications": {...}
 }
 </pre>
+
+<h3 id='fetchingamonthsdataasanmboxfile'>Fetching a month's data as an mbox file<a
href='#fetchingamonthsdataasanmboxfile' style='color: rgba(0,0,0,0);'>&para;</a></h3>
+<p>Usage:
+<code>GET /api/mbox.lua?list=issues@ponymail.apache.org&amp;date=2016-06</code></p>
+<p>Response example:</p>
+<pre>
+TBA
+</pre>
 <h4><a id="disclaimer"></a>Disclaimer</h4>
 <p style="line-height: 12pt;">
     <a href="https://incubator.apache.org"><img src="/images/podling.svg" align="right"
width="220px" style="margin-left: 6px;"/></a>

http://git-wip-us.apache.org/repos/asf/incubator-ponymail-site/blob/6417f456/content/docs/importing.html
----------------------------------------------------------------------
diff --git a/content/docs/importing.html b/content/docs/importing.html
index 2854bed..1f4b884 100644
--- a/content/docs/importing.html
+++ b/content/docs/importing.html
@@ -39,27 +39,25 @@
 <p>Pony Mail supports many ways of importing your old mail archives via the
 <code>import-mbox.py</code> script. For command line argument tips, run <code>python3
 import-mbox.py --help</code>.</p>
-<p>Imports are digested equally every time, so you can
+<p>Imports are digested equally every time (*), so you can
 import from the same source multiple times without creating duplicate emails in
 the archive. Both the archiver and the importer use the same digest method, so
 they can overlap. Usually, you'll want to set up the archiver first, and when
 emails start flowing through it, you'll use the importer to import older emails.</p>
-<h2 id='importingattachments'>Importing attachments<a href='#importingattachments'
style='color: rgba(0,0,0,0);'>&para;</a></h2>
-<p>If you wish to import attached files, add the <code>--attachments</code>
flag to your import command, otherwise, attachments will be stripped.</p>
 <h2 id='importingfrommodmbox'>Importing from mod_mbox<a href='#importingfrommodmbox'
style='color: rgba(0,0,0,0);'>&para;</a></h2>
 <h3 id='importingasingledomain'>Importing a single domain<a href='#importingasingledomain'
style='color: rgba(0,0,0,0);'>&para;</a></h3>
 <p>Provided you have the main mod_mbox page at https://your.tld/mod_mbox/ and your
(sub)domain resources at
 https://your.tld/mod_mbox/$list-yourdomain/, you can import all lists from that domain using:</p>
 <p><code>python3 import-mbox.py --source https://your.tld/mod_mbox/ --mod-mbox
--project yourdomain</code></p>
-<p>For a quick update, which only imports the last 2 months of mail, append then <code>--quick</code>
flag.</p>
+<p>For a quick update, which only imports the last 2 months of mail, append the <code>--quick</code>
flag.</p>
 <p>You can also import just a single list by specifying that list ID:</p>
-<p><code>python3 import-mbox.py --source https://your.tld/mod_mbox/ --mod-mbox
--project yourdomain-listname</code></p>
+<p><code>python3 import-mbox.py --source https://your.tld/mod_mbox/ --mod-mbox
--project listname-yourdomain</code></p>
 <h3 id='importinganentirearchivemultipledomains'>Importing an entire archive (multiple
domains)<a href='#importinganentirearchivemultipledomains' style='color: rgba(0,0,0,0);'>&para;</a></h3>
 <p>To import an entire site, use the same command as above, but omit the <code>--project</code>
flag</p>
 <p><code>python3 import-mbox.py --source https://your.tld/mod_mbox/ --mod-mbox</code></p>
 <h3 id='settingthedomainorlistidproperlyincaseofvariance'>Setting the domain or list
id properly in case of variance<a href='#settingthedomainorlistidproperlyincaseofvariance'
style='color: rgba(0,0,0,0);'>&para;</a></h3>
 <p>If your old archive varies in terms of list IDs across time, you can force harmonization
by using the <code>--lid</code> or <code>--domain</code> flags:</p>
-<p><code>python3 import-mbox.py --source https://your.tld/mod_mbox/ --mod-mbox
--project listid-yourdomain --lid "&lt;listid.youdomain.tld&gt;"</code></p>
+<p><code>python3 import-mbox.py --source https://your.tld/mod_mbox/ --mod-mbox
--project listid-yourdomain --lid "&lt;listid.yourdomain.tld&gt;"</code></p>
 <p>This should only be done one list at a time.</p>
 <h2 id='importingfrompipermail'>Importing from Pipermail<a href='#importingfrompipermail'
style='color: rgba(0,0,0,0);'>&para;</a></h2>
 <p>To import from pipermail, you will have to run the import one list at a time. As
with mod_mbox imports, you must specify a source, but use <code>--pipermail</code>
instead of <code>--mod-mbox</code>:</p>
@@ -71,12 +69,22 @@ circumvent this by using the <code>--ignorebody "foo"</code>
arg to ignore all t
 <p>While the <code>project</code> flag is not needed here, you may wish
to specify the list ID for the import.</p>
 <h2 id='importingfromlocallystoredmboxfiles'>Importing from locally stored mbox files<a
href='#importingfromlocallystoredmboxfiles' style='color: rgba(0,0,0,0);'>&para;</a></h2>
 <p>To import from one or more local mbox files, specify a filesystem path as the source:</p>
-<p><code>python3 import-mbox.py --source /tmp/mylists/ --attachments</code></p>
-<p>If you have a mix of mbox and non-mbox files in the specific dir, you may wish to
let Pony Mail know which files to scan:</p>
-<p><code>python3 import-mbox.py --source /tmp/mylists/ --ext .mbox --attachments</code></p>
+<p><code>python3 import-mbox.py --source /tmp/mylists/</code></p>
+<p>This will recursively import all files with the extension '.mbox'.</p>
+<p>You can change the extension as follows:</p>
+<p><code>python3 import-mbox.py --source /tmp/mylists/ --ext .mbx</code></p>
+<p>To match all files with any non-empty extension:</p>
+<p><code>python3 import-mbox.py --source /tmp/mylists/ --ext '.*'</code></p>
+<p>To match files regardless of extension:</p>
+<p><code>python3 import-mbox.py --source /tmp/mylists/ --ext ''</code></p>
+<p>Or you can import a single file:</p>
+<p><code>python3 import-mbox.py --source 2016-11.mbox</code></p>
+<p>(This is supported in versions after 0.9)</p>
 <h2 id='testarchives'>Test archives<a href='#testarchives' style='color: rgba(0,0,0,0);'>&para;</a></h2>
 <p>We have a few test archives for those that wish to test large imports.
 They can be found in gzip format at <a href="http://ponymail.info/mboxes/">http://ponymail.info/mboxes/</a></p>
+<p>(*) The digest depends on the [archiver] generator setting in ponymail.cfg
+If that varies between imports, then duplicates will occur</p>
 <h4><a id="disclaimer"></a>Disclaimer</h4>
 <p style="line-height: 12pt;">
     <a href="https://incubator.apache.org"><img src="/images/podling.svg" align="right"
width="220px" style="margin-left: 6px;"/></a>

http://git-wip-us.apache.org/repos/asf/incubator-ponymail-site/blob/6417f456/content/docs/install.ubuntu.html
----------------------------------------------------------------------
diff --git a/content/docs/install.ubuntu.html b/content/docs/install.ubuntu.html
index 68c96a4..72083fd 100644
--- a/content/docs/install.ubuntu.html
+++ b/content/docs/install.ubuntu.html
@@ -95,14 +95,14 @@ sudo python3 setup.py
 </pre></p>
 <p>Set up Apache httpd by adding, for example, the following virtual host configuration
(e.g. in <code>/etc/apache2/sites-enabled/000-default.conf</code>):
 <pre>
-&lt;VirtualHost *:80&gt;
+<VirtualHost *:80>
     ServerName mylists.foo.tld
     DocumentRoot /var/www/ponymail/site
     AddHandler      lua-script .lua
     LuaScope        thread
     LuaCodeCache    stat
     AcceptPathInfo  On
-&lt;/VirtualHost&gt;
+</VirtualHost>
 </pre></p>
 <p>Enable mod_lua and start apache, if not already enabled:</p>
 <pre>

http://git-wip-us.apache.org/repos/asf/incubator-ponymail-site/blob/6417f456/content/docs/installing.html
----------------------------------------------------------------------
diff --git a/content/docs/installing.html b/content/docs/installing.html
index 7859b49..b4f904f 100644
--- a/content/docs/installing.html
+++ b/content/docs/installing.html
@@ -51,7 +51,8 @@ for detailed package installation instructions:</p>
 <li>ElasticSearch &gt;= 2.1</li>
 <li>Python 3.x for the archiver plugin (setup.py will handle dependencies) and importer</li>
 <li>Apache HTTP Server 2.4.x with mod_lua (see http://modlua.org/gs/installing if you
need to build mod_lua manually)</li>
-<li>Lua &gt;=5.1 with the following modules: cjson, luasec, luasocket</li>
+<li>Lua &gt;=5.1 with the following modules: cjson, luasec, luasocket
+  (Note: Lua 5.3 is not currently supported by httpd mod_lua or luasocket)</li>
 </ul>
 <h2 id='downloadandinstall'>Download and Install<a href='#downloadandinstall' style='color:
rgba(0,0,0,0);'>&para;</a></h2>
 <ul>
@@ -121,15 +122,8 @@ the --private arg to the python script to mark an email as private:
 - Mark entire lists are private or public</p>
 <p>Run <code>python3 edit-list.py --help</code> for CLI args.</p>
 <h2 id='settingupoauthforponymail'>Setting up OAuth for Pony Mail<a href='#settingupoauthforponymail'
style='color: rgba(0,0,0,0);'>&para;</a></h2>
-<p>If you want people to be able to log in and reply via the Web UI, you can either
-use the default Persona login (works for all email addresses) or specify an
-OAuth provider.</p>
-<h3 id='settingupordisablingpersona'>Setting up or disabling Persona<a href='#settingupordisablingpersona'
style='color: rgba(0,0,0,0);'>&para;</a></h3>
-<p>Persona is enabled by default, as it's a fast and convenient way to enable
-logins for <em>public</em> lists. Should you wish to disable Persona, set the
-<code>enabled</code> variable to <code>false</code> in the persona
section of <code>site/js/config.js</code>.
-Persona will only ever work for public lists. For private lists, you will need
-to specify and implement an OAuth provider.</p>
+<p>If you want people to be able to log in and reply via the Web UI, you
+can specify an OAuth provider.</p>
 <h3 id='settingupanoauthprovider'>Setting up an OAuth provider<a href='#settingupanoauthprovider'
style='color: rgba(0,0,0,0);'>&para;</a></h3>
 <p>Pony Mail comes with a few default OAuth examples in <code>site/js/config.js</code>,
such
 as ASF Oauth and Google OAuth. You can enable these by uncommenting the lines in
@@ -215,7 +209,8 @@ 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>
+setups.
+N.B. At present, all the generators have issues, see (#176 #177 #178)</p>
 <h4><a id="disclaimer"></a>Disclaimer</h4>
 <p style="line-height: 12pt;">
     <a href="https://incubator.apache.org"><img src="/images/podling.svg" align="right"
width="220px" style="margin-left: 6px;"/></a>


Mime
View raw message