blob: ae6446b12ff2366c8f5abc38ae2592d32aa4f075 [file] [log] [blame]
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Apache Pony Mail (Incubating)</title>
<link rel="stylesheet" type="text/css" href="/css/default.css"/>
<link rel="stylesheet" type="text/css" href="/css/fa/fa.css"/>
<link rel="apple-touch-icon" sizes="57x57" href="/icons/apple-icon-57x57.png">
<link rel="apple-touch-icon" sizes="60x60" href="/icons/apple-icon-60x60.png">
<link rel="apple-touch-icon" sizes="72x72" href="/icons/apple-icon-72x72.png">
<link rel="apple-touch-icon" sizes="76x76" href="/icons/apple-icon-76x76.png">
<link rel="apple-touch-icon" sizes="114x114" href="/icons/apple-icon-114x114.png">
<link rel="apple-touch-icon" sizes="120x120" href="/icons/apple-icon-120x120.png">
<link rel="apple-touch-icon" sizes="144x144" href="/icons/apple-icon-144x144.png">
<link rel="apple-touch-icon" sizes="152x152" href="/icons/apple-icon-152x152.png">
<link rel="apple-touch-icon" sizes="180x180" href="/icons/apple-icon-180x180.png">
<link rel="icon" type="image/png" sizes="192x192" href="/android-icon-192x192.png">
<link rel="icon" type="image/png" sizes="32x32" href="/icons/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="96x96" href="/icons/favicon-96x96.png">
<link rel="icon" type="image/png" sizes="16x16" href="/icons/favicon-16x16.png">
<link rel="manifest" href="/icons/manifest.json">
<meta name="msapplication-TileColor" content="#ffffff">
<meta name="msapplication-TileImage" content="/icons/ms-icon-144x144.png">
<meta name="theme-color" content="#ffffff">
</head><body>
<div id="titlebar">
<a href="/contribute.html"><img align='left' style="width: 130px; height: 125px; position: relative; left: -6px; top: -6px; border: 0;" src="/images/devme.png" alt="Fork/Hack on Pony Mail"></a>
<a href='/'><img src="/images/ponymail.svg" style="width: 110px; margin-left: -10px; margin-right: 20px; height: auto;" align="left"/></a>
<h1><a id="title" href="/" style="color: #FFF !important;">Apache Pony Mail&trade; (Incubating)</a></h1>
<div id="menubar">
<ul>
<li><a href="/docs.html"><i class="fa fa-book"></i><span>Documentation</span></a></li>
<li><a href="/source.html"><i class="fa fa-git-square"></i><span>Source</span></a></li>
<li><a href="/downloads.html"><i class="fa fa-cloud-download"></i><span>Download</span></a></li>
<li><a href="/support.html"><i class="fa fa-question-circle"></i><span>Get support</span></a></li>
<li><a href="/contribute.html"><i class="fa fa-share-alt"></i><span>Contribute</span></a></li>
<li><a href="/about.html"><i class="fa fa-users"></i><span>About</span></a></li>
</ul>
</div>
</div>
<h1 id='installingponymailonubuntu1404or1604'>Installing Pony Mail on Ubuntu 14.04 or 16.04:<a href='#installingponymailonubuntu1404or1604' style='color: rgba(0,0,0,0);'>&para;</a></h1>
<p>Start by installing the following Ubuntu packages:</p>
<ul>
<li>apache2</li>
<li>git</li>
<li>liblua5.2-dev</li>
<li>lua-sec</li>
<li>lua-cjson</li>
<li>lua-socket</li>
<li>python3</li>
<li>python3-pip</li>
<li>subversion</li>
</ul>
<pre>
sudo apt-get install apache2 git liblua5.2-dev lua-cjson lua-sec lua-socket python3 python3-pip subversion
</pre>
<p>Install the required Python 3 modules:
<pre>
sudo pip3 install elasticsearch formatflowed netaddr
</pre></p>
<p>Install ElasticSearch:
<pre>
wget -qO - https://packages.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add -
echo "deb http://packages.elastic.co/elasticsearch/2.x/debian stable main" | sudo tee -a /etc/apt/sources.list.d/elasticsearch-2.x.list
sudo apt-get update &amp;&amp; sudo apt-get install elasticsearch default-jre-headless
</pre></p>
<p>Compile and install mod_lua if necessary (httpd &lt; 2.4.17 on Ubuntu):
<pre>
sudo apt-get install apache2-dev
svn co https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x/modules/lua/
cd lua/
sudo apxs -I/usr/include/lua5.2 -cia mod_lua.c lua_*.c -lm -llua5.2
</pre></p>
<p>Check out a copy of Pony Mail:
<pre>
sudo git clone https://github.com/apache/incubator-ponymail-foal.git /var/www/ponymail
</pre></p>
<p>Configure Elasticsearch to automatically start during bootup. For Ubuntu &lt;= 14.10:
<pre>
sudo update-rc.d elasticsearch defaults 95 10
</pre></p>
<p>For Ubuntu &gt;= 15.04:
<pre>
sudo /bin/systemctl daemon-reload
sudo /bin/systemctl enable elasticsearch.service
</pre></p>
<p>Start up ElasticSearch:</p>
<pre>
sudo service elasticsearch start
</pre>
<p>Set up Pony Mail:
<pre>
cd /var/www/ponymail/tools
sudo python3 setup.py
[... answer questions asked by the setup script ...]
</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>
<VirtualHost *:80>
ServerName mylists.foo.tld
DocumentRoot /var/www/ponymail/site
AddHandler lua-script .lua
LuaScope thread
LuaCodeCache stat
AcceptPathInfo On
</VirtualHost>
</pre></p>
<p>Enable mod_lua and start apache, if not already enabled:</p>
<pre>
sudo a2enmod lua
sudo service apache start
</pre>
<p>Once this is done, you should now have a <em>working copy</em> of Pony Mail!</p>
<p>You may wish to tweak the settings in <code>site/js/config.js</code> and your
elasticsearch settings once Pony mail is up and running.</p>
<p>Refer to the <a href="installing.html">General installation documentation</a> for
detailed information about archiving messages, OAuth, mail settings and
much more.</p>
<div style="display: inline-block; background: #BBB; margin: -10px; padding: 10px;">
<h4><a id="disclaimer"></a>Disclaimer</h4>
<div style="width: 65%; float: left;">
<p style="line-height: 12pt;">
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>
</div>
<div style="width: 20%; float: left; padding-top: 16px; margin-left: -8px;">
<a href="https://incubator.apache.org"><img src="https://incubator.apache.org/images/incubator_feather_egg_logo_sm.png"/></a>
</div>
<div style="width: 15%; float: left; line-height: 15px; padding-left: 22px;">
<a class="item" target="_blank" href="https://incubator.apache.org/">Apache Incubator</a><br/>
<a class="item" target="_blank" href="https://www.apache.org/">About the ASF<span></span></a><br/>
<a class="item" target="_blank" href="https://www.apache.org/foundation/policies/conduct.html">Code of Conduct<span></span></a><br/>
<a class="item" target="_blank" href="https://www.apache.org/foundation/thanks.html">Thanks<span></span></a><br/>
<a class="item" target="_blank" href="https://www.apache.org/foundation/sponsorship.html">Become a Sponsor<span></span></a><br/>
<a class="item" target="_blank" href="https://www.apache.org/security/">Security<span></span></a><br/>
<a class="item" target="_blank" href="https://www.apache.org/licenses/LICENSE-2.0">License<span></span></a><br/>
</div>
</div>
</body></html>