content/index.html - incubator-ponymail-site - Git at Google

 <!DOCTYPE html><html><head><meta charset="utf-8"><title>Apache Pony Mail (Incubating)</title>
 <link rel="stylesheet" type="text/css" href="css/default.css"/>
 </head><body>
 <h1><a id="Pony_Mail_0"></a>Apache Pony Mail (Incubating)</h1>
 <p><img src="images/logo_large.png" alt="logo"></p>
 <p>Apache Pony Mail (Incubating) is a web-based mail archive browser
 licensed under the Apache License v/2.0 and built to scale
 to millions of archived messages with hundreds of requests
 per second.</p>
 <p>Pony Mail allows you to browse and interact with mailing lists
 using Mozilla Persona or OAuth2 (Google, GitHub, Facebook etc) for authentication.</p>
 <p><img src="images/demo.png" width="800" alt="Ponies"></p>
 <p><img src="images/demo_trends.png" width="800" alt="Trends"></p>
 <p>See <a href="https://lists.apache.org">https://lists.apache.org.org</a> for a demo.</p>
 <p>Pony Mail works in both public, private and mixed-mode, allowing you
 to have one unified place for all your communication, both public and
 private.</p>
 <h3><a id="Features_include_23"></a>Features include:</h3>
 <ul>
 <li>Importing from standard mbox files, maildir directory, Pipermail or an mod_mbox-driven site</li>
 <li>Public and private list viewing based on auth</li>
 <li>Cross-list threading</li>
 <li>OpenSearch support for browsers (can add as search engine)</li>
 <li>In-browser reply to mailing lists</li>
 <li>Fast and intuitive searching</li>
 <li>Threaded, flat and tree view modes</li>
 <li>Notifications of replies to emails sent via Pony Mail</li>
 <li>Email and list statistics</li>
 <li>Multi-site, multi-list handling</li>
 <li>Word clouds</li>
 <li>Fuzzy-logic email grouping/threading (based in part on JWZ’s ideas)</li>
 <li>Supports both custom OAuth, Google Auth, OAuth.online and Mozilla Persona</li>
 <li>Atom feeds for all lists (including private ones!)</li>
 <li>Source view and custom range mbox export</li>
 <li>Customized trend analysis and n-grams</li>
 </ul>
 <h3><a id="Requirements_42"></a>Requirements:</h3>
 <ul>
 <li>Linux operating system (tested on Ubuntu, Debian, Fedora and CentOS - Windows or OS/X may work)</li>
 <li>ElasticSearch backend</li>
 <li>Apache HTTP Server frontend with mod_lua loaded OR
 <ul>
 <li>Nginx with nginx-extras (ng-lua module) AND lua-apr installed</li>
 </ul>
 </li>
 <li>Python 3.x for importing (with elasticsearch and formatflowed via pip)</li>
 <li>A mailing list system:
 <ul>
 <li>MailMan3 if you fancy that (we have a python3 archive plugin)</li>
 <li>OR any mailing list system of your choice (use archiver plugin with stdin)</li>
 </ul>
 </li>
 <li>Lua &gt;=5.1 + lua-cjson, luasec and luasocket</li>
 </ul>
 <h3><a id="Getting_started_55"></a>Getting started</h3>
 <p>(Optionally see the <a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALLING.md">detailed installation instructions</a> for more information)</p>
 <h4><a id="Supported_Linux_Distributions_58"></a>Supported Linux Distributions</h4>
 <p>For a quick guide to installing Pony Mail, please see the guides for:</p>
 <ul>
 <li><a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALL.debian.md">Debian (Jessie) Installation Instructions</a></li>
 <li><a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALL.ubuntu.md">Ubuntu (14.04) Installation Instructions</a></li>
 <li><a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALL.centos.md">CentOS (7.1) Installation Instructions</a></li>
 <li><a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALL.fedora.md">Fedora (22) Installation Instructions</a></li>
 </ul>
 <h4><a id="Generic_installation_instructions_65"></a>Generic installation instructions</h4>
 <ol>
 <li>Install Apache httpd + mod_lua and the lua libs (see <a href="http://modlua.org/gs/installing">http://modlua.org/gs/installing</a> if need be)</li>
 <li>Install ElasticSearch</li>
 <li>go to tools/ and run python <a href="http://setup.py">setup.py</a> - follow the instructions and enter info</li>
 <li>Fiddle a bit with site/js/config.js for now</li>
 <li>Add Pony Mail as an archiver for your lists. <a href="https://github.com/apache/incubator-ponymail/tree/master/docs/ARCHIVING.md">see this doc</a>.</li>
 <li>import mbox data with <a href="http://import-mbox.py">import-mbox.py</a> if need be (see <a href="docs/IMPORTING.md">this doc</a> for details)</li>
 <li>All done :) But please see the <a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALLING.md">detailed installation instructions</a> for more details</li>
 </ol>
 <h3><a id="Contributing_to_Pony_Mail_76"></a>Contributing to Pony Mail</h3>
 <p>We’d LOVE if more people would contribute to Pony Mail!
 Any form of contribution is most welcome, whether it be programming,
 documentation, evangelism, marketing, or helping out other users.</p>
 <p>To contribute to Pony Mail, follow these steps (also see <a href="https://github.com/apache/incubator-ponymail/tree/master/docs/CONTRIBUTING.md">this doc</a>):</p>
 <ul>
 <li>Fork the repo</li>
 <li>Subscribe to the Pony Mail dev list:
 <ul>
 <li>Either send an email to <a href="mailto:dev-subscribe@ponymail.incubator.apache.org">dev-subscribe@ponymail.incubator.apache.org</a> OR</li>
 <li>Visit <a href="https://lists.apache.org/list.html?dev@ponymail.apache.org">https://lists.apache.org/list.html?dev@ponymail.apache.org</a> (You can use Persona or ASF OAuth)</li>
 </ul>
 </li>
 <li>Find something to fix or help out with</li>
 <li>Let us know what you want to do, and we’ll add you to our contributors list!</li>
 <li>Join us on #ponymail on the Freenode IRC network</li>
 </ul>
 <h3><a id="Development_Benchmarking_91"></a>Development Benchmarking</h3>
 <p>Pony Mail has been built for and tested with the mail archives of the Apache
 Software Foundation, which span more than 15 million emails sent across more
 than 20 years. To put things into perspective, importing all this on a modern
 machine (2xSSD with 64GB RAM) took around 12 hours and resulted in a performance
 at around 100 archive search requests per second per ES node, depending on mailing
 list size and available bandwidth.</p>
 <h3><a id="TODO_99"></a>TODO:</h3>
 <p>This is a list of what we would love to get done:</p>
 <ul>
 <li><s>Set up dir structure</s> (<em>DONE</em>)</li>
 <li><s>Import site data</s> (<em>DONE</em>)</li>
 <li><s>Import tools</s> (<em>DONE</em>)</li>
 <li><s>Import settings / setup tools</s> (<em>DONE</em>)</li>
 <li><s>Import, fix archiver</s> (<em>DONE</em>)</li>
 <li><s>Add license headers (ALv2) to everything</s> (<em>DONE(?)</em>)</li>
 <li><s>Have reply feature actually work</s> (<em>DONE</em>)</li>
 <li><s>Split JS into smaller files for development, bundle together for releases</s> (<em>DONE</em>)</li>
 <li>Start on documentation (WIP)</li>
 <li>Rework JS, turn those ugly innerHTML hacks into proper DOM handling</li>
 <li>Set up notification system (depends on reply system) (works, but still <em>WIP!</em>)</li>
 <li>Have it work with ES with auth mode or via HTTPS</li>
 </ul>

 <h2><a id="downloads">Downloads and Source</a></h2>
 <p>
     You can check out our canonical source repository at: <br/>
     <a href="https://git-wip-us.apache.org/repos/asf/incubator-ponymail.git">https://git-wip-us.apache.org/repos/asf/incubator-ponymail.git</a>
 </p>
 <p>
     While we do not have any official Apache releases yet, you may check out previous non-Apache releases on our GitHub repo, at
     <a href="https://github.com/apache/incubator-ponymail">https://github.com/apache/incubator-ponymail</a>. While these are all
     Apache License v/2-approved, they have not gone through the traditional Apache release process, and as such, are not officially
     endorsed by the Apache Pony Mail project in any way.
 </p>

 <h2><a id="disclaimer">Disclaimer</a></h2>
 <p>
     <a href="https://incubator.apache.org"><img src="images/podling.svg" align="right" width="220px"/></a>
     Apache Pony Mail (Incubating) is an effort undergoing incubation at
     The Apache Software Foundation (ASF), sponsored by the <a href="https://incubator.apache.org">
     Apache Incubator</a>. Incubation is required of all newly accepted projects
     until a further review indicates that the infrastructure,
     communications, and decision making process have stabilized in a
     manner consistent with other successful ASF projects. While
     incubation status is not necessarily a reflection of the
     completeness or stability of the code, it does indicate that the
     project has yet to be fully endorsed by the ASF.
 </p>
 <p>
     Copyright 2016, the Apache Software Foundation.<br/>
     Apache Pony Mail is a trademark of the Apache Software Foundation.
     Apache and the Apache feather are registered trademarks of the
     Apache Software Foundation.
 </p>
 </body></html>
	<!DOCTYPE html><html><head><meta charset="utf-8"><title>Apache Pony Mail (Incubating)</title>
	<link rel="stylesheet" type="text/css" href="css/default.css"/>
	</head><body>
	<h1><a id="Pony_Mail_0"></a>Apache Pony Mail (Incubating)</h1>
	<p><img src="images/logo_large.png" alt="logo"></p>
	<p>Apache Pony Mail (Incubating) is a web-based mail archive browser
	licensed under the Apache License v/2.0 and built to scale
	to millions of archived messages with hundreds of requests
	per second.</p>
	<p>Pony Mail allows you to browse and interact with mailing lists
	using Mozilla Persona or OAuth2 (Google, GitHub, Facebook etc) for authentication.</p>
	<p><img src="images/demo.png" width="800" alt="Ponies"></p>
	<p><img src="images/demo_trends.png" width="800" alt="Trends"></p>
	<p>See <a href="https://lists.apache.org">https://lists.apache.org.org</a> for a demo.</p>
	<p>Pony Mail works in both public, private and mixed-mode, allowing you
	to have one unified place for all your communication, both public and
	private.</p>
	<h3><a id="Features_include_23"></a>Features include:</h3>
	<ul>
	<li>Importing from standard mbox files, maildir directory, Pipermail or an mod_mbox-driven site</li>
	<li>Public and private list viewing based on auth</li>
	<li>Cross-list threading</li>
	<li>OpenSearch support for browsers (can add as search engine)</li>
	<li>In-browser reply to mailing lists</li>
	<li>Fast and intuitive searching</li>
	<li>Threaded, flat and tree view modes</li>
	<li>Notifications of replies to emails sent via Pony Mail</li>
	<li>Email and list statistics</li>
	<li>Multi-site, multi-list handling</li>
	<li>Word clouds</li>
	<li>Fuzzy-logic email grouping/threading (based in part on JWZ’s ideas)</li>
	<li>Supports both custom OAuth, Google Auth, OAuth.online and Mozilla Persona</li>
	<li>Atom feeds for all lists (including private ones!)</li>
	<li>Source view and custom range mbox export</li>
	<li>Customized trend analysis and n-grams</li>
	</ul>
	<h3><a id="Requirements_42"></a>Requirements:</h3>
	<ul>
	<li>Linux operating system (tested on Ubuntu, Debian, Fedora and CentOS - Windows or OS/X may work)</li>
	<li>ElasticSearch backend</li>
	<li>Apache HTTP Server frontend with mod_lua loaded OR
	<ul>
	<li>Nginx with nginx-extras (ng-lua module) AND lua-apr installed</li>
	</ul>
	</li>
	<li>Python 3.x for importing (with elasticsearch and formatflowed via pip)</li>
	<li>A mailing list system:
	<ul>
	<li>MailMan3 if you fancy that (we have a python3 archive plugin)</li>
	<li>OR any mailing list system of your choice (use archiver plugin with stdin)</li>
	</ul>
	</li>
	<li>Lua >=5.1 + lua-cjson, luasec and luasocket</li>
	</ul>
	<h3><a id="Getting_started_55"></a>Getting started</h3>
	<p>(Optionally see the <a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALLING.md">detailed installation instructions</a> for more information)</p>
	<h4><a id="Supported_Linux_Distributions_58"></a>Supported Linux Distributions</h4>
	<p>For a quick guide to installing Pony Mail, please see the guides for:</p>
	<ul>
	<li><a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALL.debian.md">Debian (Jessie) Installation Instructions</a></li>
	<li><a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALL.ubuntu.md">Ubuntu (14.04) Installation Instructions</a></li>
	<li><a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALL.centos.md">CentOS (7.1) Installation Instructions</a></li>
	<li><a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALL.fedora.md">Fedora (22) Installation Instructions</a></li>
	</ul>
	<h4><a id="Generic_installation_instructions_65"></a>Generic installation instructions</h4>
	<ol>
	<li>Install Apache httpd + mod_lua and the lua libs (see <a href="http://modlua.org/gs/installing">http://modlua.org/gs/installing</a> if need be)</li>
	<li>Install ElasticSearch</li>
	<li>go to tools/ and run python <a href="http://setup.py">setup.py</a> - follow the instructions and enter info</li>
	<li>Fiddle a bit with site/js/config.js for now</li>
	<li>Add Pony Mail as an archiver for your lists. <a href="https://github.com/apache/incubator-ponymail/tree/master/docs/ARCHIVING.md">see this doc</a>.</li>
	<li>import mbox data with <a href="http://import-mbox.py">import-mbox.py</a> if need be (see <a href="docs/IMPORTING.md">this doc</a> for details)</li>
	<li>All done :) But please see the <a href="https://github.com/apache/incubator-ponymail/tree/master/docs/INSTALLING.md">detailed installation instructions</a> for more details</li>
	</ol>
	<h3><a id="Contributing_to_Pony_Mail_76"></a>Contributing to Pony Mail</h3>
	<p>We’d LOVE if more people would contribute to Pony Mail!
	Any form of contribution is most welcome, whether it be programming,
	documentation, evangelism, marketing, or helping out other users.</p>
	<p>To contribute to Pony Mail, follow these steps (also see <a href="https://github.com/apache/incubator-ponymail/tree/master/docs/CONTRIBUTING.md">this doc</a>):</p>
	<ul>
	<li>Fork the repo</li>
	<li>Subscribe to the Pony Mail dev list:
	<ul>
	<li>Either send an email to <a href="mailto:dev-subscribe@ponymail.incubator.apache.org">dev-subscribe@ponymail.incubator.apache.org</a> OR</li>
	<li>Visit <a href="https://lists.apache.org/list.html?dev@ponymail.apache.org">https://lists.apache.org/list.html?dev@ponymail.apache.org</a> (You can use Persona or ASF OAuth)</li>
	</ul>
	</li>
	<li>Find something to fix or help out with</li>
	<li>Let us know what you want to do, and we’ll add you to our contributors list!</li>
	<li>Join us on #ponymail on the Freenode IRC network</li>
	</ul>
	<h3><a id="Development_Benchmarking_91"></a>Development Benchmarking</h3>
	<p>Pony Mail has been built for and tested with the mail archives of the Apache
	Software Foundation, which span more than 15 million emails sent across more
	than 20 years. To put things into perspective, importing all this on a modern
	machine (2xSSD with 64GB RAM) took around 12 hours and resulted in a performance
	at around 100 archive search requests per second per ES node, depending on mailing
	list size and available bandwidth.</p>
	<h3><a id="TODO_99"></a>TODO:</h3>
	<p>This is a list of what we would love to get done:</p>
	<ul>
	<li><s>Set up dir structure</s> (<em>DONE</em>)</li>
	<li><s>Import site data</s> (<em>DONE</em>)</li>
	<li><s>Import tools</s> (<em>DONE</em>)</li>
	<li><s>Import settings / setup tools</s> (<em>DONE</em>)</li>
	<li><s>Import, fix archiver</s> (<em>DONE</em>)</li>
	<li><s>Add license headers (ALv2) to everything</s> (<em>DONE(?)</em>)</li>
	<li><s>Have reply feature actually work</s> (<em>DONE</em>)</li>
	<li><s>Split JS into smaller files for development, bundle together for releases</s> (<em>DONE</em>)</li>
	<li>Start on documentation (WIP)</li>
	<li>Rework JS, turn those ugly innerHTML hacks into proper DOM handling</li>
	<li>Set up notification system (depends on reply system) (works, but still <em>WIP!</em>)</li>
	<li>Have it work with ES with auth mode or via HTTPS</li>
	</ul>

	<h2><a id="downloads">Downloads and Source</a></h2>
	<p>
	You can check out our canonical source repository at: <br/>
	<a href="https://git-wip-us.apache.org/repos/asf/incubator-ponymail.git">https://git-wip-us.apache.org/repos/asf/incubator-ponymail.git</a>
	</p>
	<p>
	While we do not have any official Apache releases yet, you may check out previous non-Apache releases on our GitHub repo, at
	<a href="https://github.com/apache/incubator-ponymail">https://github.com/apache/incubator-ponymail</a>. While these are all
	Apache License v/2-approved, they have not gone through the traditional Apache release process, and as such, are not officially
	endorsed by the Apache Pony Mail project in any way.
	</p>

	<h2><a id="disclaimer">Disclaimer</a></h2>
	<p>
	<a href="https://incubator.apache.org"><img src="images/podling.svg" align="right" width="220px"/></a>
	Apache Pony Mail (Incubating) is an effort undergoing incubation at
	The Apache Software Foundation (ASF), sponsored by the <a href="https://incubator.apache.org">
	Apache Incubator</a>. Incubation is required of all newly accepted projects
	until a further review indicates that the infrastructure,
	communications, and decision making process have stabilized in a
	manner consistent with other successful ASF projects. While
	incubation status is not necessarily a reflection of the
	completeness or stability of the code, it does indicate that the
	project has yet to be fully endorsed by the ASF.
	</p>
	<p>
	Copyright 2016, the Apache Software Foundation.<br/>
	Apache Pony Mail is a trademark of the Apache Software Foundation.
	Apache and the Apache feather are registered trademarks of the
	Apache Software Foundation.
	</p>
	</body></html>