http://git-wip-us.apache.org/repos/asf/james-site/blob/0e4c47ea/content/server/features.html ---------------------------------------------------------------------- diff --git a/content/server/features.html b/content/server/features.html index c4050a5..f096554 100644 --- a/content/server/features.html +++ b/content/server/features.html @@ -18,7 +18,7 @@ under the License. --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<!-- Generated by Apache Maven Doxia at 2017-06-15 --> +<!-- Generated by Apache Maven Doxia at 2017-08-09 --> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -37,7 +37,7 @@ <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20170615" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> <link rel="meta" href="http://james.apache.org//doap_james-project.rdf" title="DOAP" type="application/rdf+xml"/> @@ -77,7 +77,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2017-06-15</span> + <span id="publishDate">Last Published: 2017-08-09</span> </div> <div class="xright"> <a href="../index.html" title="Home">Home</a> | @@ -108,7 +108,7 @@ <li class="collapsed"> <a href="../documentation.html" title="About James">About James</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/index.html" title="Server">Server</a> <ul> <li class="none"> @@ -117,7 +117,7 @@ <li class="none"> <a href="../server/objectives.html" title="Objectives">Objectives</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/quick-start.html" title="User Manual">User Manual</a> <ul> <li class="expanded"> @@ -149,10 +149,10 @@ <li class="none"> <a href="../server/packaging.html" title="2. Packaging">2. Packaging</a> </li> - <li class="none"> + <li class="collapsed"> <a href="../server/install.html" title="3. Install James">3. Install James</a> - </li> - <li class="collapsed"> + </li> + <li class="collapsed"> <a href="../server/config.html" title="4. Configure James">4. Configure James</a> </li> <li class="collapsed">
http://git-wip-us.apache.org/repos/asf/james-site/blob/0e4c47ea/content/server/index.html ---------------------------------------------------------------------- diff --git a/content/server/index.html b/content/server/index.html index 1164540..d357e50 100644 --- a/content/server/index.html +++ b/content/server/index.html @@ -18,7 +18,7 @@ under the License. --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<!-- Generated by Apache Maven Doxia at 2017-07-25 --> +<!-- Generated by Apache Maven Doxia at 2017-08-09 --> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -37,10 +37,10 @@ <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20170725" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> -<link title="DOAP" rel="meta" type="application/rdf+xml" href="http://james.apache.org//doap_james-project.rdf"/> +<link rel="meta" href="http://james.apache.org//doap_james-project.rdf" title="DOAP" type="application/rdf+xml"/> <script type="text/javascript" src="./js/index.js"></script> <!-- Google Analytics --> <script type="text/javascript"> @@ -77,7 +77,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2017-07-25</span> + <span id="publishDate">Last Published: 2017-08-09</span> </div> <div class="xright"> <a href="../index.html" title="Home">Home</a> | @@ -108,7 +108,7 @@ <li class="collapsed"> <a href="../documentation.html" title="About James">About James</a> </li> - <li class="expanded"> + <li class="expanded"> <strong>Server</strong> <ul> <li class="none"> @@ -117,7 +117,7 @@ <li class="none"> <a href="../server/objectives.html" title="Objectives">Objectives</a> </li> - <li class="collapsed"> + <li class="collapsed"> <a href="../server/quick-start.html" title="User Manual">User Manual</a> </li> <li class="none"> http://git-wip-us.apache.org/repos/asf/james-site/blob/0e4c47ea/content/server/install.html ---------------------------------------------------------------------- diff --git a/content/server/install.html b/content/server/install.html index baab82c..299da1f 100644 --- a/content/server/install.html +++ b/content/server/install.html @@ -18,7 +18,7 @@ under the License. --> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<!-- Generated by Apache Maven Doxia at 2017-07-25 --> +<!-- Generated by Apache Maven Doxia at 2017-08-09 --> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> @@ -37,10 +37,10 @@ <script type="text/javascript" src="../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> <script type="text/javascript" src="../js/fancybox/jquery.fancybox-1.3.4.js"></script> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" /> - <meta name="Date-Revision-yyyymmdd" content="20170725" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> <meta http-equiv="Content-Language" content="en" /> -<link title="DOAP" rel="meta" type="application/rdf+xml" href="http://james.apache.org//doap_james-project.rdf"/> +<link rel="meta" href="http://james.apache.org//doap_james-project.rdf" title="DOAP" type="application/rdf+xml"/> <!-- Google Analytics --> <script type="text/javascript"> @@ -77,7 +77,7 @@ <div class="xleft"> - <span id="publishDate">Last Published: 2017-07-25</span> + <span id="publishDate">Last Published: 2017-08-09</span> </div> <div class="xright"> <a href="../index.html" title="Home">Home</a> | @@ -108,7 +108,7 @@ <li class="collapsed"> <a href="../documentation.html" title="About James">About James</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/index.html" title="Server">Server</a> <ul> <li class="none"> @@ -117,18 +117,29 @@ <li class="none"> <a href="../server/objectives.html" title="Objectives">Objectives</a> </li> - <li class="expanded"> + <li class="expanded"> <a href="../server/quick-start.html" title="User Manual">User Manual</a> <ul> <li class="collapsed"> <a href="../server/features.html" title="1. Features">1. Features</a> </li> <li class="none"> - <a href="../server/wiring.html" title="2. Wiring">2. Wiring</a> + <a href="../server/packaging.html" title="2. Packaging">2. Packaging</a> </li> - <li class="none"> + <li class="expanded"> <strong>3. Install James</strong> - </li> + <ul> + <li class="none"> + <a href="../server/install/guice-cassandra.html" title="Cassandra-guice">Cassandra-guice</a> + </li> + <li class="none"> + <a href="../server/install/guice-jpa.html" title="JPA-guice">JPA-guice</a> + </li> + <li class="none"> + <a href="../server/install/guice-jpa-smtp.html" title="JPA-SMTP-guice">JPA-SMTP-guice</a> + </li> + </ul> + </li> <li class="collapsed"> <a href="../server/config.html" title="4. Configure James">4. Configure James</a> </li> @@ -331,6 +342,11 @@ Guice Cassandra quick-start</a> </p> +<p>Note that install instructions from command line are available for <a href="install/cassandra-guice.html">Cassandra-Guice</a>, + <a href="install/jpa-guice.html">JPA-Guice</a> and <a href="install/jpa-smtp-guice.html">JPA-SMTP-Guice</a>. + </p> + + <p>A <a class="externalLink" href="https://github.com/apache/james-project/blob/9502cfebfd9a4eaebbba7dda802d1fe0ad3589b7/dockerfiles/run/docker-compose.yml"> docker-compose</a> is available for Guice + Cassandra + ElasticSearch</p> </div> @@ -386,12 +402,9 @@ </div> --> <p>After unpacking the binary, the next step is to adjust the initial configuration. - All configuration files are embedded in jars. We ship in the conf folder template configuration files. + All configuration files are embedded in jars. We ship in the conf folder the configuration files that can be edited to match your needs. </p> - - -<p>You can override the default configuration : copy the conf folder any ...-template... you need and update according to your needs.</p> - + <p>Additional system files reside under the./conf/META-INF folder.</p> http://git-wip-us.apache.org/repos/asf/james-site/blob/0e4c47ea/content/server/install/guice-cassandra.html ---------------------------------------------------------------------- diff --git a/content/server/install/guice-cassandra.html b/content/server/install/guice-cassandra.html new file mode 100644 index 0000000..68976b8 --- /dev/null +++ b/content/server/install/guice-cassandra.html @@ -0,0 +1,316 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Generated by Apache Maven Doxia at 2017-08-09 --> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Apache James Project - </title> + <style type="text/css" media="all"> + @import url("../../css/james.css"); + @import url("../../css/maven-base.css"); + @import url("../../css/maven-theme.css"); + @import url("../../css/site.css"); + @import url("../../js/jquery/css/custom-theme/jquery-ui-1.8.5.custom.css"); + @import url("../../js/jquery/css/print.css"); + @import url("../../js/fancybox/jquery.fancybox-1.3.4.css"); + </style> + <script type="text/javascript" src="../../js/jquery/js/jquery-1.4.2.min.js"></script> + <script type="text/javascript" src="../../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> + <script type="text/javascript" src="../../js/fancybox/jquery.fancybox-1.3.4.js"></script> + <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> + <meta http-equiv="Content-Language" content="en" /> + +<link rel="meta" href="http://james.apache.org//doap_james-project.rdf" title="DOAP" type="application/rdf+xml"/> + + <!-- Google Analytics --> + <script type="text/javascript"> + + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-1384591-1']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script').item(0); s.parentNode.insertBefore(ga, s); + })(); + + </script> + </head> + <body class="composite"> + <div id="banner"> + <a href="../../index.html" id="bannerLeft" title="james-logo.png"> + + + <img src="../../images/logos/james-logo.png" alt="James Project" /> + </a> + <a href="http://www.apache.org/index.html" id="bannerRight"> + + + <img src="images/logos/asf_logo_small.png" alt="The Apache Software Foundation" /> + </a> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + + <div class="xleft"> + <span id="publishDate">Last Published: 2017-08-09</span> + </div> + <div class="xright"> <a href="../../index.html" title="Home">Home</a> + | + <a href="../../documentation.html" title="James">James</a> + | + <a href="../../mime4j/index.html" title="Mime4J">Mime4J</a> + | + <a href="../../jsieve/index.html" title="jSieve">jSieve</a> + | + <a href="../../jspf/index.html" title="jSPF">jSPF</a> + | + <a href="../../jdkim/index.html" title="jDKIM">jDKIM</a> + | + <a href="../../hupa/index.html" title="Hupa">Hupa</a> + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + <h5>James components</h5> + <ul> + <li class="collapsed"> + <a href="../../documentation.html" title="About James">About James</a> + </li> + <li class="expanded"> + <a href="../../server/index.html" title="Server">Server</a> + <ul> + <li class="none"> + <a href="../../server/advantages.html" title="Advantages">Advantages</a> + </li> + <li class="none"> + <a href="../../server/objectives.html" title="Objectives">Objectives</a> + </li> + <li class="expanded"> + <a href="../../server/quick-start.html" title="User Manual">User Manual</a> + <ul> + <li class="collapsed"> + <a href="../../server/features.html" title="1. Features">1. Features</a> + </li> + <li class="none"> + <a href="../../server/packaging.html" title="2. Packaging">2. Packaging</a> + </li> + <li class="expanded"> + <a href="../../server/install.html" title="3. Install James">3. Install James</a> + <ul> + <li class="none"> + <strong>Cassandra-guice</strong> + </li> + <li class="none"> + <a href="../../server/install/guice-jpa.html" title="JPA-guice">JPA-guice</a> + </li> + <li class="none"> + <a href="../../server/install/guice-jpa-smtp.html" title="JPA-SMTP-guice">JPA-SMTP-guice</a> + </li> + </ul> + </li> + <li class="collapsed"> + <a href="../../server/config.html" title="4. Configure James">4. Configure James</a> + </li> + <li class="collapsed"> + <a href="../../server/manage.html" title="5. Manage">5. Manage</a> + </li> + <li class="collapsed"> + <a href="../../server/monitor.html" title="6. Monitor">6. Monitor</a> + </li> + <li class="collapsed"> + <a href="../../server/upgrade.html" title="7. Upgrade">7. Upgrade</a> + </li> + <li class="collapsed"> + <a href="../../server/dev.html" title="8. Developers Corner">8. Developers Corner</a> + </li> + </ul> + </li> + <li class="none"> + <a href="../../mail.html#James_Mailing_lists" title="Mailing Lists">Mailing Lists</a> + </li> + <li class="none"> + <a href="../../server/release-notes.html" title="Release Notes">Release Notes</a> + </li> + <li class="none"> + <a href="../../server/apidocs/index.html" title="Javadoc">Javadoc</a> + </li> + <li class="none"> + <a href="https://issues.apache.org/jira/browse/JAMES" title="Issue Tracker">Issue Tracker</a> + </li> + <li class="none"> + <a href="https://github.com/apache/james-project" title="Sources">Sources</a> + </li> + <li class="none"> + <a href="../../server/rfcs.html" title="RFCs">RFCs</a> + </li> + <li class="none"> + <a href="../../other-versions.html" title="Other versions">Other versions</a> + </li> + <li class="none"> + <a href="../../download.cgi#Apache_James_Server" title="Download releases">Download releases</a> + </li> + </ul> + </li> + <li class="collapsed"> + <a href="../../mailet/index.html" title="Mailets">Mailets</a> + </li> + <li class="collapsed"> + <a href="../../mailbox/index.html" title="Mailbox">Mailbox</a> + </li> + <li class="collapsed"> + <a href="../../protocols/index.html" title="Protocols">Protocols</a> + </li> + <li class="collapsed"> + <a href="../../mpt/index.html" title="MPT">MPT</a> + </li> + </ul> + <h5>Apache Software Foundation</h5> + <ul> + <li> + <strong> + <a title="ASF" href="http://www.apache.org/">ASF</a> + </strong> + </li> + <li> + <a title="Get Involved" href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a> + </li> + <li> + <a title="FAQ" href="http://www.apache.org/foundation/faq.html">FAQ</a> + </li> + <li> + <a title="License" href="http://www.apache.org/licenses/" >License</a> + </li> + <li> + <a title="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> + </li> + <li> + <a title="Thanks" href="http://www.apache.org/foundation/thanks.html">Thanks</a> + </li> + <li> + <a title="Security" href="http://www.apache.org/security/">Security</a> + </li> + </ul> + <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /> + </a> + + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + <h1>Guice-Cassandra installation guide</h1> +<div class="section"> +<h2>Building<a name="Building"></a></h2> +<div class="section"> +<h3>Requirements<a name="Requirements"></a></h3> + +<ul> + +<li>Java 8 SDK</li> + +<li>Docker ∕ ElasticSearch 2.2.1 and Cassandra 2.2.3</li> + +<li>Maven 3</li> +</ul></div> +<div class="section"> +<h3>Building the artifacts<a name="Building_the_artifacts"></a></h3> +<p>An usual compilation using maven will produce two artifacts into server/container/guice/cassandra-guice/target directory:</p> + +<ul> + +<li>james-server-cassandra-guice.jar</li> + +<li>james-server-cassandra-guice.lib</li> +</ul> +<p>You can for example run in the base of <a class="externalLink" href="https://github.com/apache/james-project">this git repository</a>:</p> + +<div class="source"> +<pre>mvn clean install +</pre></div></div></div> +<div class="section"> +<h2>Running<a name="Running"></a></h2> +<div class="section"> +<h3>Requirements<a name="Requirements"></a></h3> + +<ul> + +<li>Cassandra</li> + +<li>ElasticSearch 1.5.2</li> +</ul></div> +<div class="section"> +<h3>James Launch<a name="James_Launch"></a></h3> +<p>To run james, you have to create a directory containing required configuration files.</p> +<p>James requires the configuration to be in a subfolder of working directory that is called <b>conf</b>. You can get a sample directory for configuration from <a class="externalLink" href="https://github.com/apache/james-project/tree/master/dockerfiles/run/guice/cassandra/destination/conf">dockerfiles/run/guice/cassandra/destination/conf</a>. You might need to adapt it to your needs.</p> +<p>You also need to generate a keystore in your conf folder with the following command:</p> + +<div class="source"> +<pre>$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore +</pre></div> +<p>You need to have a Cassandra and an ElasticSearch instance running. You can either install the servers or launch them via docker:</p> + +<div class="source"> +<pre>$ docker run -d --port 9042:9042 --name=cassandra cassandra:2.2.3 +$ docker run -d --port 9200:9200 --port 9300:9300 --name=elasticsearch elasticsearch:2.2.1 +</pre></div> +<p>Once everything is set up, you just have to run the jar with:</p> + +<div class="source"> +<pre>$ java -Dworking.directory=. -jar target/james-server-cassandra-guice.jar +</pre></div></div></div> +<div class="section"> +<h2>Guice-cassandra-ldap<a name="Guice-cassandra-ldap"></a></h2> +<p>You can follow the same guide to build and run guice-cassandra-ldap artifact, except that: - The <b>jar</b> and <b>libs</b> needs to be retrieve from server/container/guice/cassandra-ldap-guice/target after compilation - The sample configuration can be found in <a class="externalLink" href="https://github.com/apache/james-project/tree/master/dockerfiles/run/guice/cassandra-ldap/destination/conf">dockerfiles/run/guice/cassandra-ldap/destination/conf</a> - You need a running LDAP server to connect to. - You can then launch James via this command:</p> + +<div class="source"> +<pre>$ java -Dworking.directory=. -jar target/james-server-cassandra-ldap-guice.jar +</pre></div></div> + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">Copyright © 2006-2017 + <a href="https://www.apache.org/">The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html> http://git-wip-us.apache.org/repos/asf/james-site/blob/0e4c47ea/content/server/install/guice-jpa-smtp.html ---------------------------------------------------------------------- diff --git a/content/server/install/guice-jpa-smtp.html b/content/server/install/guice-jpa-smtp.html new file mode 100644 index 0000000..570cbc5 --- /dev/null +++ b/content/server/install/guice-jpa-smtp.html @@ -0,0 +1,289 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Generated by Apache Maven Doxia at 2017-08-09 --> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Apache James Project - </title> + <style type="text/css" media="all"> + @import url("../../css/james.css"); + @import url("../../css/maven-base.css"); + @import url("../../css/maven-theme.css"); + @import url("../../css/site.css"); + @import url("../../js/jquery/css/custom-theme/jquery-ui-1.8.5.custom.css"); + @import url("../../js/jquery/css/print.css"); + @import url("../../js/fancybox/jquery.fancybox-1.3.4.css"); + </style> + <script type="text/javascript" src="../../js/jquery/js/jquery-1.4.2.min.js"></script> + <script type="text/javascript" src="../../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> + <script type="text/javascript" src="../../js/fancybox/jquery.fancybox-1.3.4.js"></script> + <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> + <meta http-equiv="Content-Language" content="en" /> + +<link rel="meta" href="http://james.apache.org//doap_james-project.rdf" title="DOAP" type="application/rdf+xml"/> + + <!-- Google Analytics --> + <script type="text/javascript"> + + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-1384591-1']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script').item(0); s.parentNode.insertBefore(ga, s); + })(); + + </script> + </head> + <body class="composite"> + <div id="banner"> + <a href="../../index.html" id="bannerLeft" title="james-logo.png"> + + + <img src="../../images/logos/james-logo.png" alt="James Project" /> + </a> + <a href="http://www.apache.org/index.html" id="bannerRight"> + + + <img src="images/logos/asf_logo_small.png" alt="The Apache Software Foundation" /> + </a> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + + <div class="xleft"> + <span id="publishDate">Last Published: 2017-08-09</span> + </div> + <div class="xright"> <a href="../../index.html" title="Home">Home</a> + | + <a href="../../documentation.html" title="James">James</a> + | + <a href="../../mime4j/index.html" title="Mime4J">Mime4J</a> + | + <a href="../../jsieve/index.html" title="jSieve">jSieve</a> + | + <a href="../../jspf/index.html" title="jSPF">jSPF</a> + | + <a href="../../jdkim/index.html" title="jDKIM">jDKIM</a> + | + <a href="../../hupa/index.html" title="Hupa">Hupa</a> + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + <h5>James components</h5> + <ul> + <li class="collapsed"> + <a href="../../documentation.html" title="About James">About James</a> + </li> + <li class="expanded"> + <a href="../../server/index.html" title="Server">Server</a> + <ul> + <li class="none"> + <a href="../../server/advantages.html" title="Advantages">Advantages</a> + </li> + <li class="none"> + <a href="../../server/objectives.html" title="Objectives">Objectives</a> + </li> + <li class="expanded"> + <a href="../../server/quick-start.html" title="User Manual">User Manual</a> + <ul> + <li class="collapsed"> + <a href="../../server/features.html" title="1. Features">1. Features</a> + </li> + <li class="none"> + <a href="../../server/packaging.html" title="2. Packaging">2. Packaging</a> + </li> + <li class="expanded"> + <a href="../../server/install.html" title="3. Install James">3. Install James</a> + <ul> + <li class="none"> + <a href="../../server/install/guice-cassandra.html" title="Cassandra-guice">Cassandra-guice</a> + </li> + <li class="none"> + <a href="../../server/install/guice-jpa.html" title="JPA-guice">JPA-guice</a> + </li> + <li class="none"> + <strong>JPA-SMTP-guice</strong> + </li> + </ul> + </li> + <li class="collapsed"> + <a href="../../server/config.html" title="4. Configure James">4. Configure James</a> + </li> + <li class="collapsed"> + <a href="../../server/manage.html" title="5. Manage">5. Manage</a> + </li> + <li class="collapsed"> + <a href="../../server/monitor.html" title="6. Monitor">6. Monitor</a> + </li> + <li class="collapsed"> + <a href="../../server/upgrade.html" title="7. Upgrade">7. Upgrade</a> + </li> + <li class="collapsed"> + <a href="../../server/dev.html" title="8. Developers Corner">8. Developers Corner</a> + </li> + </ul> + </li> + <li class="none"> + <a href="../../mail.html#James_Mailing_lists" title="Mailing Lists">Mailing Lists</a> + </li> + <li class="none"> + <a href="../../server/release-notes.html" title="Release Notes">Release Notes</a> + </li> + <li class="none"> + <a href="../../server/apidocs/index.html" title="Javadoc">Javadoc</a> + </li> + <li class="none"> + <a href="https://issues.apache.org/jira/browse/JAMES" title="Issue Tracker">Issue Tracker</a> + </li> + <li class="none"> + <a href="https://github.com/apache/james-project" title="Sources">Sources</a> + </li> + <li class="none"> + <a href="../../server/rfcs.html" title="RFCs">RFCs</a> + </li> + <li class="none"> + <a href="../../other-versions.html" title="Other versions">Other versions</a> + </li> + <li class="none"> + <a href="../../download.cgi#Apache_James_Server" title="Download releases">Download releases</a> + </li> + </ul> + </li> + <li class="collapsed"> + <a href="../../mailet/index.html" title="Mailets">Mailets</a> + </li> + <li class="collapsed"> + <a href="../../mailbox/index.html" title="Mailbox">Mailbox</a> + </li> + <li class="collapsed"> + <a href="../../protocols/index.html" title="Protocols">Protocols</a> + </li> + <li class="collapsed"> + <a href="../../mpt/index.html" title="MPT">MPT</a> + </li> + </ul> + <h5>Apache Software Foundation</h5> + <ul> + <li> + <strong> + <a title="ASF" href="http://www.apache.org/">ASF</a> + </strong> + </li> + <li> + <a title="Get Involved" href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a> + </li> + <li> + <a title="FAQ" href="http://www.apache.org/foundation/faq.html">FAQ</a> + </li> + <li> + <a title="License" href="http://www.apache.org/licenses/" >License</a> + </li> + <li> + <a title="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> + </li> + <li> + <a title="Thanks" href="http://www.apache.org/foundation/thanks.html">Thanks</a> + </li> + <li> + <a title="Security" href="http://www.apache.org/security/">Security</a> + </li> + </ul> + <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /> + </a> + + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + <h1>Guice-JPA-SMTP installation guide</h1> +<div class="section"> +<h2>Building<a name="Building"></a></h2> +<div class="section"> +<h3>Requirements<a name="Requirements"></a></h3> + +<ul> + +<li>Java 8 SDK</li> + +<li>Docker</li> + +<li>Maven</li> +</ul></div> +<div class="section"> +<h3>Building the artifacts<a name="Building_the_artifacts"></a></h3> +<p>An usual compilation using maven of this <a class="externalLink" href="https://github.com/apache/james-project">Git repository content</a> will produce two artifacts into server/container/guice/jpa-smtp/target directory :</p> + +<ul> + +<li>james-server-jpa-smtp-${version}.jar</li> + +<li>james-server-jpa-smtp-${version}.lib</li> +</ul></div></div> +<div class="section"> +<h2>Running<a name="Running"></a></h2> +<div class="section"> +<h3>James Launch<a name="James_Launch"></a></h3> +<p>To run james, you have to create a directory containing required configuration files names <b>conf</b>.</p> +<p>A <a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/container/guice/jpa-smtp/sample-configuration">sample directory</a> is provided with some default value you may need to replace.</p> +<p>You also need to generate a keystore with the following command :</p> + +<div class="source"> +<pre>$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore +</pre></div> +<p>Once everything is set up, you just have to run the jar with :</p> + +<div class="source"> +<pre>$ java -Dworking.directory=. -jar target/james-server-jpa-smtp-${version}.jar +</pre></div></div></div> + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">Copyright © 2006-2017 + <a href="https://www.apache.org/">The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html> http://git-wip-us.apache.org/repos/asf/james-site/blob/0e4c47ea/content/server/install/guice-jpa.html ---------------------------------------------------------------------- diff --git a/content/server/install/guice-jpa.html b/content/server/install/guice-jpa.html new file mode 100644 index 0000000..3d21b3f --- /dev/null +++ b/content/server/install/guice-jpa.html @@ -0,0 +1,294 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Generated by Apache Maven Doxia at 2017-08-09 --> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <title>Apache James Project - </title> + <style type="text/css" media="all"> + @import url("../../css/james.css"); + @import url("../../css/maven-base.css"); + @import url("../../css/maven-theme.css"); + @import url("../../css/site.css"); + @import url("../../js/jquery/css/custom-theme/jquery-ui-1.8.5.custom.css"); + @import url("../../js/jquery/css/print.css"); + @import url("../../js/fancybox/jquery.fancybox-1.3.4.css"); + </style> + <script type="text/javascript" src="../../js/jquery/js/jquery-1.4.2.min.js"></script> + <script type="text/javascript" src="../../js/jquery/js/jquery-ui-1.8.5.custom.min.js"></script> + <script type="text/javascript" src="../../js/fancybox/jquery.fancybox-1.3.4.js"></script> + <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" /> + <meta name="Date-Revision-yyyymmdd" content="20170809" /> + <meta http-equiv="Content-Language" content="en" /> + +<link rel="meta" href="http://james.apache.org//doap_james-project.rdf" title="DOAP" type="application/rdf+xml"/> + + <!-- Google Analytics --> + <script type="text/javascript"> + + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-1384591-1']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script').item(0); s.parentNode.insertBefore(ga, s); + })(); + + </script> + </head> + <body class="composite"> + <div id="banner"> + <a href="../../index.html" id="bannerLeft" title="james-logo.png"> + + + <img src="../../images/logos/james-logo.png" alt="James Project" /> + </a> + <a href="http://www.apache.org/index.html" id="bannerRight"> + + + <img src="images/logos/asf_logo_small.png" alt="The Apache Software Foundation" /> + </a> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + + <div class="xleft"> + <span id="publishDate">Last Published: 2017-08-09</span> + </div> + <div class="xright"> <a href="../../index.html" title="Home">Home</a> + | + <a href="../../documentation.html" title="James">James</a> + | + <a href="../../mime4j/index.html" title="Mime4J">Mime4J</a> + | + <a href="../../jsieve/index.html" title="jSieve">jSieve</a> + | + <a href="../../jspf/index.html" title="jSPF">jSPF</a> + | + <a href="../../jdkim/index.html" title="jDKIM">jDKIM</a> + | + <a href="../../hupa/index.html" title="Hupa">Hupa</a> + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + <h5>James components</h5> + <ul> + <li class="collapsed"> + <a href="../../documentation.html" title="About James">About James</a> + </li> + <li class="expanded"> + <a href="../../server/index.html" title="Server">Server</a> + <ul> + <li class="none"> + <a href="../../server/advantages.html" title="Advantages">Advantages</a> + </li> + <li class="none"> + <a href="../../server/objectives.html" title="Objectives">Objectives</a> + </li> + <li class="expanded"> + <a href="../../server/quick-start.html" title="User Manual">User Manual</a> + <ul> + <li class="collapsed"> + <a href="../../server/features.html" title="1. Features">1. Features</a> + </li> + <li class="none"> + <a href="../../server/packaging.html" title="2. Packaging">2. Packaging</a> + </li> + <li class="expanded"> + <a href="../../server/install.html" title="3. Install James">3. Install James</a> + <ul> + <li class="none"> + <a href="../../server/install/guice-cassandra.html" title="Cassandra-guice">Cassandra-guice</a> + </li> + <li class="none"> + <strong>JPA-guice</strong> + </li> + <li class="none"> + <a href="../../server/install/guice-jpa-smtp.html" title="JPA-SMTP-guice">JPA-SMTP-guice</a> + </li> + </ul> + </li> + <li class="collapsed"> + <a href="../../server/config.html" title="4. Configure James">4. Configure James</a> + </li> + <li class="collapsed"> + <a href="../../server/manage.html" title="5. Manage">5. Manage</a> + </li> + <li class="collapsed"> + <a href="../../server/monitor.html" title="6. Monitor">6. Monitor</a> + </li> + <li class="collapsed"> + <a href="../../server/upgrade.html" title="7. Upgrade">7. Upgrade</a> + </li> + <li class="collapsed"> + <a href="../../server/dev.html" title="8. Developers Corner">8. Developers Corner</a> + </li> + </ul> + </li> + <li class="none"> + <a href="../../mail.html#James_Mailing_lists" title="Mailing Lists">Mailing Lists</a> + </li> + <li class="none"> + <a href="../../server/release-notes.html" title="Release Notes">Release Notes</a> + </li> + <li class="none"> + <a href="../../server/apidocs/index.html" title="Javadoc">Javadoc</a> + </li> + <li class="none"> + <a href="https://issues.apache.org/jira/browse/JAMES" title="Issue Tracker">Issue Tracker</a> + </li> + <li class="none"> + <a href="https://github.com/apache/james-project" title="Sources">Sources</a> + </li> + <li class="none"> + <a href="../../server/rfcs.html" title="RFCs">RFCs</a> + </li> + <li class="none"> + <a href="../../other-versions.html" title="Other versions">Other versions</a> + </li> + <li class="none"> + <a href="../../download.cgi#Apache_James_Server" title="Download releases">Download releases</a> + </li> + </ul> + </li> + <li class="collapsed"> + <a href="../../mailet/index.html" title="Mailets">Mailets</a> + </li> + <li class="collapsed"> + <a href="../../mailbox/index.html" title="Mailbox">Mailbox</a> + </li> + <li class="collapsed"> + <a href="../../protocols/index.html" title="Protocols">Protocols</a> + </li> + <li class="collapsed"> + <a href="../../mpt/index.html" title="MPT">MPT</a> + </li> + </ul> + <h5>Apache Software Foundation</h5> + <ul> + <li> + <strong> + <a title="ASF" href="http://www.apache.org/">ASF</a> + </strong> + </li> + <li> + <a title="Get Involved" href="http://www.apache.org/foundation/getinvolved.html">Get Involved</a> + </li> + <li> + <a title="FAQ" href="http://www.apache.org/foundation/faq.html">FAQ</a> + </li> + <li> + <a title="License" href="http://www.apache.org/licenses/" >License</a> + </li> + <li> + <a title="Sponsorship" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> + </li> + <li> + <a title="Thanks" href="http://www.apache.org/foundation/thanks.html">Thanks</a> + </li> + <li> + <a title="Security" href="http://www.apache.org/security/">Security</a> + </li> + </ul> + <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> + <img class="poweredBy" alt="Built by Maven" src="../../images/logos/maven-feather.png" /> + </a> + + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + <h1>Guice-JPA installation guide</h1> +<div class="section"> +<h2>Building<a name="Building"></a></h2> +<div class="section"> +<h3>Requirements<a name="Requirements"></a></h3> + +<ul> + +<li>Java 8 SDK</li> + +<li>Docker</li> + +<li>Maven 3</li> +</ul></div> +<div class="section"> +<h3>Building the artifacts<a name="Building_the_artifacts"></a></h3> +<p>An usual compilation using maven of this <a class="externalLink" href="https://github.com/apache/james-project">Git repository content</a> will produce two artifacts into server/container/guice/jpa-guice/target directory:</p> + +<ul> + +<li>james-server-jpa-guice.jar</li> + +<li>james-server-jpa-guice.lib</li> +</ul> +<p>You can for example run in the base of this git repository:</p> + +<div class="source"> +<pre>mvn clean install +</pre></div></div></div> +<div class="section"> +<h2>Running<a name="Running"></a></h2> +<div class="section"> +<h3>James Launch<a name="James_Launch"></a></h3> +<p>To run james, you have to create a directory containing required configuration files.</p> +<p>James requires the configuration to be in a subfolder of working directory that is called <b>conf</b>. You can get a sample directory for configuration from <a class="externalLink" href="https://github.com/apache/james-project/tree/master/dockerfiles/run/guice/jpa/destination/conf">dockerfiles/run/guice/jpa/destination/conf</a>. You might need to adapt it to your needs.</p> +<p>You also need to generate a keystore in your conf folder with the following command:</p> + +<div class="source"> +<pre>$ keytool -genkey -alias james -keyalg RSA -keystore conf/keystore +</pre></div> +<p>Once everything is set up, you just have to run the jar with:</p> + +<div class="source"> +<pre>$ java -Dworking.directory=. -jar target/james-server-jpa-guice.jar +</pre></div></div></div> + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">Copyright © 2006-2017 + <a href="https://www.apache.org/">The Apache Software Foundation</a>. + All Rights Reserved. + + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
