http://git-wip-us.apache.org/repos/asf/james-site/blob/f81a00ef/content/server/config-ssl-tls.html ---------------------------------------------------------------------- diff --git a/content/server/config-ssl-tls.html b/content/server/config-ssl-tls.html new file mode 100644 index 0000000..fdafe62 --- /dev/null +++ b/content/server/config-ssl-tls.html @@ -0,0 +1,554 @@ +<?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 2016-12-06 --> +<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 Server 3.0 - + Apache James Server 3 - SSL / TLS Configuration</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="20161206" /> + <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"/> + + <!-- 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="Apache James Server 3.0" /> + </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: 2016-12-06</span> + </div> + <div class="xright"> <a href="../../index.html" title="Home">Home</a> + | + <a href="../index.html" title="Server">Server</a> + | + <a href="../../hupa/index.html" title="Hupa">Hupa</a> + | + <a href="../../protocols/index.html" title="Protocols">Protocols</a> + | + <a href="../../mailet/index.html" title="Mailets">Mailets</a> + | + <a href="../../mailbox/index.html" title="Mailbox">Mailbox</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="../../mpt/index.html" title="MPT">MPT</a> + | + <a href="../../postage/index.html" title="Postage">Postage</a> + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + <h5>Overview</h5> + <ul> + <li class="none"> + <a href="index.html" title="Introduction">Introduction</a> + </li> + <li class="none"> + <a href="release-notes.html" title="Release Notes">Release Notes</a> + </li> + </ul> + <h5>Features</h5> + <ul> + <li class="none"> + <a href="feature-mailetcontainer.html" title="Mailet Container">Mailet Container</a> + </li> + <li class="none"> + <a href="feature-queue-priority.html" title="Queue Priority">Queue Priority</a> + </li> + <li class="none"> + <a href="feature-persistence.html" title="Persistence">Persistence</a> + </li> + <li class="none"> + <a href="feature-protocols.html" title="Protocols">Protocols</a> + </li> + <li class="none"> + <a href="feature-smtp-hooks.html" title="SMTP Hooks">SMTP Hooks</a> + </li> + <li class="none"> + <a href="feature-performance.html" title="Performance">Performance</a> + </li> + <li class="none"> + <a href="feature-security.html" title="Security">Security</a> + </li> + </ul> + <h5>User Manual</h5> + <ul> + <li class="none"> + <a href="quick-start.html" title="1. Quick Start">1. Quick Start</a> + </li> + <li class="none"> + <a href="install.html" title="2. Install James">2. Install James</a> + </li> + <li class="expanded"> + <a href="config.html" title="3. Configure James">3. Configure James</a> + <ul> + <li class="none"> + <a href="config-system.html" title="System">System</a> + </li> + <li class="none"> + <a href="config-domainlist.html" title="Domain List">Domain List</a> + </li> + <li class="none"> + <a href="config-users.html" title="Users">Users</a> + </li> + <li class="none"> + <a href="config-recipientrewritetable.html" title="Recipient Rewrite">Recipient Rewrite</a> + </li> + <li class="none"> + <a href="config-mailbox.html" title="Mailbox">Mailbox</a> + </li> + <li class="none"> + <a href="config-mailrepositorystore.html" title="Mail Repository Stores">Mail Repository Stores</a> + </li> + <li class="none"> + <a href="config-dnsservice.html" title="DNS Service">DNS Service</a> + </li> + <li class="none"> + <a href="config-smtp-lmtp.html" title="SMTP LMTP">SMTP LMTP</a> + </li> + <li class="none"> + <a href="config-pop3.html" title="POP3">POP3</a> + </li> + <li class="none"> + <a href="config-imap4.html" title="IMAP4">IMAP4</a> + </li> + <li class="none"> + <a href="config-mailetcontainer.html" title="Mailet Container">Mailet Container</a> + </li> + <li class="none"> + <a href="config-fetchmail.html" title="FetchMail">FetchMail</a> + </li> + <li class="none"> + <strong>SSL/TLS</strong> + </li> + <li class="none"> + <a href="config-sieve.html" title="Sieve">Sieve</a> + </li> + <li class="none"> + <a href="config-antispam.html" title="Anti Spam">Anti Spam</a> + </li> + </ul> + </li> + <li class="collapsed"> + <a href="manage.html" title="4. Manage">4. Manage</a> + </li> + <li class="collapsed"> + <a href="monitor.html" title="5. Monitor">5. Monitor</a> + </li> + <li class="collapsed"> + <a href="upgrade.html" title="6. Upgrade">6. Upgrade</a> + </li> + </ul> + <h5>Developers Corner</h5> + <ul> + <li class="none"> + <a href="dev.html" title="Architecture">Architecture</a> + </li> + <li class="none"> + <a href="dev-build.html" title="Build from source">Build from source</a> + </li> + <li class="none"> + <a href="dev-database-schema.html" title="Database Schema">Database Schema</a> + </li> + <li class="collapsed"> + <a href="dev-extend.html" title="Develop Extensions">Develop Extensions</a> + </li> + <li class="collapsed"> + <a href="dev-provided.html" title="Provided Extensions">Provided Extensions</a> + </li> + </ul> + <h5>References</h5> + <ul> + <li class="none"> + <a href="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> + </ul> + <h5>About James</h5> + <ul> + <li class="none"> + <a href="../../index.html" title="Overview">Overview</a> + </li> + <li class="none"> + <a href="../../newsarchive.html" title="News">News</a> + </li> + <li class="none"> + <a href="../../mail.html" title="Mailing Lists">Mailing Lists</a> + </li> + <li class="none"> + <a href="../../contribute.html" title="Contributing">Contributing</a> + </li> + <li class="none"> + <a href="../../guidelines.html" title="Guidelines">Guidelines</a> + </li> + <li class="none"> + <a href="http://wiki.apache.org/james"; title="Wiki">Wiki</a> + </li> + <li class="none"> + <a href="../../team-list.html" title="Who We Are">Who We Are</a> + </li> + <li class="none"> + <a href="../../license.html" title="License">License</a> + </li> + <li class="none"> + <a href="../../thanks.html" title="Thanks">Thanks</a> + </li> + <li class="none"> + <a href="../../support.html" title="Professional support">Professional support</a> + </li> + </ul> + <h5>Download</h5> + <ul> + <li class="none"> + <a href="../../download.cgi" title="Releases">Releases</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"> + <!-- 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. --> + + + + <div class="section"> +<h2>SSL / TLS Configuration<a name="SSL__TLS_Configuration"></a></h2> + + +<p>This document explains how to enable James 3.0 servers to use Transport Layer Security (TLS) for encrypted client-server communication.</p> + + +<div class="section"> +<h3>Configure a Server to Use SSL/TLS<a name="Configure_a_Server_to_Use_SSLTLS"></a></h3> + + +<p>Each of the servers <a href="config-smtp-lmtp.html">SMTP</a>, + <a href="config-pop3.html">POP3</a> and <a href="config-imap.html">IMAP</a> + supports use of SSL/TLS.</p> + + +<p>TLS (Transport Layer Security) and SSL (Secure Sockets Layer) are protocols that provide + data encryption and authentication between applications in scenarios where that data is + being sent across an insecure network, such as checking your email + (How does the Secure Socket Layer work?). The terms SSL and TLS are often used + interchangeably or in conjunction with each other (TLS/SSL), + but one is in fact the predecessor of the other — SSL 3.0 served as the basis + for TLS 1.0 which, as a result, is sometimes referred to as SSL 3.1.</p> + + +<p>You need to add a block in the corresponding configuration file (smtpserver.xml, pop3server.xml, imapserver.xml,..)</p> + + +<div class="source"> +<pre> +<tls socketTLS="false" startTLS="false"> + <keystore>file://conf/keystore</keystore> + <secret>yoursecret</secret> + <provider>org.bouncycastle.jce.provider.BouncyCastleProvider</provider> +</tls> +</pre></div> + + +<p>Each of these block has an optional boolean configuration element <b>socketTLS</b> and <b>startTLS</b> which is used to toggle + use of SSL or TLS for the service.</p> + + +<p>With socketTLS (SSL/TLS in Thunderbird), all the communication is encrypted.</p> + + +<p>With startTLS (STARTTLS in Thunderbird), the preamble is readable, but the rest is encrypted.</p> + +<tt> +* OK JAMES IMAP4rev1 Server Server 192.168.1.4 is ready. +* CAPABILITY IMAP4rev1 LITERAL+ CHILDREN WITHIN STARTTLS IDLE NAMESPACE UIDPLUS UNSELECT AUTH=PLAIN +1 OK CAPABILITY completed. +2 OK STARTTLS Begin TLS negotiation now. +... rest is encrypted... +</tt> + + +<p>You can only enable one of the both at the same time for a service.</p> + + +<p>It is also recommended to change the port number on which the service will listen:</p> + +<ul> + +<li>POP3 - port 110, Secure POP3 - port 995</li> + +<li>IMAP - port 143, Secure IMAP4 - port 993</li> + +<li>SMTP - port 25, Secure SMTP - port 465</li> + </ul> + + +<p>You will now need to create your certificate store and place it in the james/conf/ folder with the name you defined in the keystore tag.</p> + + </div> + + +<div class="section"> +<h3>Certificate Keystores<a name="Certificate_Keystores"></a></h3> + + +<p>To use TLS/SSL inside James you will need a certificate keystore.</p> + +<p></p> + + +<p><b>Creating your own Certificate Keystore</b></p> + +<p>(Adapted from the Tomcat 4.1 documentation)</p> + +<p>James currently operates only on JKS format keystores. This is Java's standard "Java KeyStore" format, and is the format created by the keytool command-line utility. This tool is included in the JDK.</p> + +<p>To import an existing certificate into a JKS keystore, please read the documentation (in your JDK documentation package) about keytool.</p> + +<p>To create a new keystore from scratch, containing a single self-signed Certificate, execute the following from a terminal command line:</p> + +<p><tt>keytool -genkey -alias james -keyalg RSA -keystore your_keystore_filename</tt></p> + +<p>(The RSA algorithm should be preferred as a secure algorithm, and this also ensures general compatibility with other servers and components.)</p> + +<p>As a suggested standard, create the keystore in the james/conf directory, with a name like james.keystore.</p> + +<p>After executing this command, you will first be prompted for the keystore password.</p> + +<p>Next, you will be prompted for general information about this Certificate, such as company, contact name, and so on. This information may be displayed to users when importing into the certificate store of the client, so make sure that the information provided here matches what they will expect.</p> + +<p>Important: in the "distinguished name", set the "common name" (CN) to the DNS name of your James server, the one you will use to access it from your mail client (like "mail.xyz.com").</p> + +<p>Finally, you will be prompted for the key password, which is the password specifically for this Certificate (as opposed to any other Certificates stored in the same keystore file).</p> + +<p>If everything was successful, you now have a keystore file with a Certificate that can be used by your server.</p> + +<p>You MUST have only one certificate in the keystore file used by James.</p> + +<p></p> + + +<p><b>Installing a Certificate provided by a Certificate Authority</b></p> + +<p>(Adapted from the Tomcat 4.1 documentation</p> + +<p>To obtain and install a Certificate from a Certificate Authority (like verisign.com, thawte.com or trustcenter.de) you should have read the previous section and then follow these instructions:</p> + +<p>Create a local Certificate Signing Request (CSR)</p> + +<p>In order to obtain a Certificate from the Certificate Authority of your choice you have to create a so called Certificate Signing Request (CSR). That CSR will be used by the Certificate Authority to create a Certificate that will identify your James server as "secure". To create a CSR follow these steps:</p> + +<p>Create a local Certificate as described in the previous section.</p> + +<p>The CSR is then created with:</p> + +<p>keytool -certreq -keyalg RSA -alias james -file certreq.csr -keystore your_keystore_filename</p> + +<p>Now you have a file called certreq.csr. The file is encoded in PEM format. You can submit it to the Certificate Authority (look at the documentation of the Certificate Authority website on how to do this). In return you get a Certificate.</p> + +<p></p> + +<p>Now that you have your Certificate you can import it into you local keystore. First of all you may have to import a so called Chain Certificate or Root Certificate into your keystore (the major Certificate Authorities are already in place, so it's unlikely that you will need to perform this step). After that you can procede with importing your Certificate.</p> + +<p>Optionally Importing a so called Chain Certificate or Root Certificate</p> + +<p>Download a Chain Certificate from the Certificate Authority you obtained the Certificate from.</p> + +<p>For Verisign.com go to: http://www.verisign.com/support/install/intermediate.html</p> + +<p>For Trustcenter.de go to: http://www.trustcenter.de/certservices/cacerts/en/en.htm#server</p> + +<p>For Thawte.com go to: http://www.thawte.com/certs/trustmap.html (seems no longer valid)</p> + +<p>Import the Chain Certificate into you keystore</p> + +<p>keytool -import -alias root -keystore your_keystore_filename -trustcacerts -file filename_of_the_chain_certificate</p> + +<p></p> + +<p>And finally import your new Certificate (It must be in X509 format):</p> + +<p>keytool -import -alias james -keystore your_keystore_filename -trustcacerts -file your_certificate_filename</p> + +<p></p> + +<p>See also: http://www.agentbob.info/agentbob/79.html</p> + + </div> + + +<div class="section"> +<h3>Verifying a SSL/TLS-enabled James Server<a name="Verifying_a_SSLTLS-enabled_James_Server"></a></h3> + + +<p>After you've configured a particular server to use TLS/SSL connections, the server port + should no longer accept unencrypted TCP/IP connections. This can be tested by using a telnet + client to directly connect to the server port. The telnet connection should simply hang until + the client times out.</p> + + +<p>To validate that the port is properly accepting SSL connections an SSL client can be used to + open a connection to the server port. One such client is OpenSSL, available from the + <a class="externalLink" href="http://www.openssl.org";>OpenSSL web site</a>. Follow the instructions provided with + the SSL client to create a connection to the server port. Upon connection, the usual + server greeting should appear.</p> + + +<div class="source"> +<pre> +/usr/bin/openssl s_client -quiet -connect localhost:465 +depth=0 /C=Unknown/ST=Unknown/L=Unknown/O=Unknown/OU=Unknown/CN=Unknown +verify error:num=18:self signed certificate +verify return:1 +depth=0 /C=Unknown/ST=Unknown/L=Unknown/O=Unknown/OU=Unknown/CN=Unknown +verify return:1 +220 192.168.0.208 SMTP Server (JAMES SMTP Server) ready Thu, 9 Jun +2011 20:31:07 +0200 (CEST) +</pre></div> + + </div> + + </div> + + + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">Copyright © 2002-2016 + <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/f81a00ef/content/server/config-system.html ---------------------------------------------------------------------- diff --git a/content/server/config-system.html b/content/server/config-system.html new file mode 100644 index 0000000..80cbe7c --- /dev/null +++ b/content/server/config-system.html @@ -0,0 +1,549 @@ +<?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 2016-12-06 --> +<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 Server 3.0 - + Apache James Server 3 - Server Wide Configuration</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="20161206" /> + <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"/> + + <!-- 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="Apache James Server 3.0" /> + </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: 2016-12-06</span> + </div> + <div class="xright"> <a href="../../index.html" title="Home">Home</a> + | + <a href="../index.html" title="Server">Server</a> + | + <a href="../../hupa/index.html" title="Hupa">Hupa</a> + | + <a href="../../protocols/index.html" title="Protocols">Protocols</a> + | + <a href="../../mailet/index.html" title="Mailets">Mailets</a> + | + <a href="../../mailbox/index.html" title="Mailbox">Mailbox</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="../../mpt/index.html" title="MPT">MPT</a> + | + <a href="../../postage/index.html" title="Postage">Postage</a> + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + <h5>Overview</h5> + <ul> + <li class="none"> + <a href="index.html" title="Introduction">Introduction</a> + </li> + <li class="none"> + <a href="release-notes.html" title="Release Notes">Release Notes</a> + </li> + </ul> + <h5>Features</h5> + <ul> + <li class="none"> + <a href="feature-mailetcontainer.html" title="Mailet Container">Mailet Container</a> + </li> + <li class="none"> + <a href="feature-queue-priority.html" title="Queue Priority">Queue Priority</a> + </li> + <li class="none"> + <a href="feature-persistence.html" title="Persistence">Persistence</a> + </li> + <li class="none"> + <a href="feature-protocols.html" title="Protocols">Protocols</a> + </li> + <li class="none"> + <a href="feature-smtp-hooks.html" title="SMTP Hooks">SMTP Hooks</a> + </li> + <li class="none"> + <a href="feature-performance.html" title="Performance">Performance</a> + </li> + <li class="none"> + <a href="feature-security.html" title="Security">Security</a> + </li> + </ul> + <h5>User Manual</h5> + <ul> + <li class="none"> + <a href="quick-start.html" title="1. Quick Start">1. Quick Start</a> + </li> + <li class="none"> + <a href="install.html" title="2. Install James">2. Install James</a> + </li> + <li class="expanded"> + <a href="config.html" title="3. Configure James">3. Configure James</a> + <ul> + <li class="none"> + <strong>System</strong> + </li> + <li class="none"> + <a href="config-domainlist.html" title="Domain List">Domain List</a> + </li> + <li class="none"> + <a href="config-users.html" title="Users">Users</a> + </li> + <li class="none"> + <a href="config-recipientrewritetable.html" title="Recipient Rewrite">Recipient Rewrite</a> + </li> + <li class="none"> + <a href="config-mailbox.html" title="Mailbox">Mailbox</a> + </li> + <li class="none"> + <a href="config-mailrepositorystore.html" title="Mail Repository Stores">Mail Repository Stores</a> + </li> + <li class="none"> + <a href="config-dnsservice.html" title="DNS Service">DNS Service</a> + </li> + <li class="none"> + <a href="config-smtp-lmtp.html" title="SMTP LMTP">SMTP LMTP</a> + </li> + <li class="none"> + <a href="config-pop3.html" title="POP3">POP3</a> + </li> + <li class="none"> + <a href="config-imap4.html" title="IMAP4">IMAP4</a> + </li> + <li class="none"> + <a href="config-mailetcontainer.html" title="Mailet Container">Mailet Container</a> + </li> + <li class="none"> + <a href="config-fetchmail.html" title="FetchMail">FetchMail</a> + </li> + <li class="none"> + <a href="config-ssl-tls.html" title="SSL/TLS">SSL/TLS</a> + </li> + <li class="none"> + <a href="config-sieve.html" title="Sieve">Sieve</a> + </li> + <li class="none"> + <a href="config-antispam.html" title="Anti Spam">Anti Spam</a> + </li> + </ul> + </li> + <li class="collapsed"> + <a href="manage.html" title="4. Manage">4. Manage</a> + </li> + <li class="collapsed"> + <a href="monitor.html" title="5. Monitor">5. Monitor</a> + </li> + <li class="collapsed"> + <a href="upgrade.html" title="6. Upgrade">6. Upgrade</a> + </li> + </ul> + <h5>Developers Corner</h5> + <ul> + <li class="none"> + <a href="dev.html" title="Architecture">Architecture</a> + </li> + <li class="none"> + <a href="dev-build.html" title="Build from source">Build from source</a> + </li> + <li class="none"> + <a href="dev-database-schema.html" title="Database Schema">Database Schema</a> + </li> + <li class="collapsed"> + <a href="dev-extend.html" title="Develop Extensions">Develop Extensions</a> + </li> + <li class="collapsed"> + <a href="dev-provided.html" title="Provided Extensions">Provided Extensions</a> + </li> + </ul> + <h5>References</h5> + <ul> + <li class="none"> + <a href="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> + </ul> + <h5>About James</h5> + <ul> + <li class="none"> + <a href="../../index.html" title="Overview">Overview</a> + </li> + <li class="none"> + <a href="../../newsarchive.html" title="News">News</a> + </li> + <li class="none"> + <a href="../../mail.html" title="Mailing Lists">Mailing Lists</a> + </li> + <li class="none"> + <a href="../../contribute.html" title="Contributing">Contributing</a> + </li> + <li class="none"> + <a href="../../guidelines.html" title="Guidelines">Guidelines</a> + </li> + <li class="none"> + <a href="http://wiki.apache.org/james"; title="Wiki">Wiki</a> + </li> + <li class="none"> + <a href="../../team-list.html" title="Who We Are">Who We Are</a> + </li> + <li class="none"> + <a href="../../license.html" title="License">License</a> + </li> + <li class="none"> + <a href="../../thanks.html" title="Thanks">Thanks</a> + </li> + <li class="none"> + <a href="../../support.html" title="Professional support">Professional support</a> + </li> + </ul> + <h5>Download</h5> + <ul> + <li class="none"> + <a href="../../download.cgi" title="Releases">Releases</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"> + <!-- 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. --> + + + + <div class="section"> +<h2>Server Wide Configuration<a name="Server_Wide_Configuration"></a></h2> + + +<div class="section"> +<h3>Introduction<a name="Introduction"></a></h3> + + +<p>There are a number of global configuration files that do not fall into any one + component. They have effects that are global in scope across the server.</p> + + +<p>Some of these files are crucial, while others can be ignored by any but the most sophisticated + server administrators.</p> + + </div> + + +<div class="section"> +<h3>spring-server.xml<a name="spring-server.xml"></a></h3> + + +<p>In James distribution, the spring files are located under conf/context folder and splitted into a main + file (james-server-context.xml) which imports 4 other files (1 per mailbox type): james-mailbox-jcr-context.xml, james-mailbox-jpa-context.xml, + james-mailbox-maildir-context.xml, james-mailbox-memory-context.xml.</p> + + +<p>Consult <a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/container/spring/src/main/resources/META-INF/org/apache/james/spring-server.xml";>spring-server.xml</a> in GIT to + get some examples and hints.</p> + + +<p>spring beans files are the place where the Apache James Server wiring is done. It should be modified only by expert-users.</p> + + +<p>In combination with james-database.properties and META-INF/persistence.xml, the datasource to access the database is defined in spring-server.xml</p> + + </div> + + +<div class="section"> +<h3>james-database.properties<a name="james-database.properties"></a></h3> + + +<p>Consult <a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/james-database-template.properties";>james-database.properties</a> in GIT to get some examples and hints.</p> + + +<p>The database connection in database.properties</p> + + +<p>James has the capacity to use a JDBC-compatible database for storage of both message and user + data. This section explains how to configure James to utilize a database for storage.</p> + + +<p>To avoid vendor-specific issues, the JPA (Java Persistence Architecture) is used (using the Apache OpenJPA implementation).</p> + + +<p>There must be a database instance accessible from the James server. An account with appropriate + privileges (select, insert, delete into tables, and on initial startup creation of tables) and + with sufficient quota for the data to be inserted into the database must be available.</p> + + +<p>Also, since James will use JDBC to access the database, an appropriate JDBC driver must be + available for installation. You can place the JDBC driver jar in the conf/lib folder, it will + be automatically loaded.</p> + + +<dl> + +<dt><b>database.driverClassName</b></dt> + +<dd>he class name of the database driver to be used.</dd> + +<dt><b>database.url</b></dt> + +<dd>The JDBC connection URL for your database/driver.</dd> + +<dt><b>database.username</b></dt> + +<dd>The user id of the database account to be used by this connection.</dd> + +<dt><b>database.password</b></dt> + +<dd>The password of the database account to be used by this connection.</dd> + +<dt><b>vendorAdapter.database</b></dt> + +<dd>Supported adapters are: DB2, DERBY, H2, HSQL, INFORMIX, MYSQL, ORACLE, POSTGRESQL, SQL_SERVER, SYBASE .</dd> + +<dt><b>openjpa.streaming</b></dt> + +<dd>true or false - Use streaming for Blobs. This is only supported on a limited set of databases atm. You + should check if its supported by your DB before enable it. See <a class="externalLink" href="http://openjpa.apache.org/builds/latest/docs/manual/ref_guide_mapping_jpa.html";>http://openjpa.apache.org/builds/latest/docs/manual/ref_guide_mapping_jpa.html</a> (#7.11. LOB Streaming).</dd> + </dl> + + +<p>Note for postgresql databases: Add standard_conforming_strings=off to your postgresql.xml, otherwise you + will get ""Invalid escape string Hint: Escape string must be empty or one character. {prepstmnt 174928937 + SELECT t0.mailbox_id, t0.mailbox_highest_modseq, t0.mailbox_last_uid, t0.mailbox_name, t0.mailbox_namespace, + t0.mailbox_uid_validity, t0.user_name FROM public.james_mailbox t0 WHERE (t0.mailbox_name LIKE ? + ESCAPE '\\' AND t0.user_name = ? AND t0.mailbox_namespace = ?) [params=?, ?, ?]} [code=0, state=22025]"</p> + + </div> + + +<div class="section"> +<h3>META-INF/persistence.xml<a name="META-INFpersistence.xml"></a></h3> + + +<p>Consult <a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/META-INF/persistence.xml";>META-INF/persistence.xml</a> in GIT to get some examples and hints.</p> + + +<p>The JPA mapping and properties are defined in the in META-INF/persistence.xml.</p> + + +<p>You can override the definition in external file and importing the external file in the persistence.xml (see jpa-mappings.xml provided example in GIT)</p> + + +<div class="source"> +<pre> +<mapping-file>META-INF/jpa-mappings.xml</mapping-file></pre></div> + + </div> + + +<div class="section"> +<h3>jmx.properties<a name="jmx.properties"></a></h3> + + +<p>Consult <a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/jmx-template.properties";>jmx.properties</a> in GIT to get some examples and hints.</p> + + +<p>This is used to configure the JMX MBean server via which all management is achieved (also used by via the james-cli).</p> + + +<dl> + +<dt><b>jmx.address</b></dt> + +<dd>The IP address (host name) the MBean Server will bind/listen to.</dd> + +<dt><b>jmx.port</b></dt> + +<dd>The port number the MBean Server will bind/listen to.</dd> + </dl> + + +<p>To access from a remote location, it has been reported that -Dcom.sun.management.jmxremote.ssl=false is + needed in the startup script.</p> + + </div> + + +<div class="section"> +<h3>sqlResources.xml<a name="sqlResources.xml"></a></h3> + + +<p>Consult <a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/sqlResources.xml";>sqlResources.xml</a> in GIT to get some examples and hints.</p> + + +<p>This file is deprecated but some mailets... still need it. The standard way to access database + is JPA, but some functionalities are not yet migrated and still need the sqlResources.xml resources.</p> + + +<p>The precise SQL statements used by Apache James Server to modify and view data stored in the database + are specified in sqlResources.xml file.</p> + + +<p>If you are using a SQL database with unusual SQL commands or data types, you may + need to add special entries to this file. The James team + does try to keep sqlResources.xml updated, so if you do run into a + special case, please let us know.</p> + + +<p>Also, if the database tables are not created a priori, but rather are to be created by James + upon startup, special attention should be paid to the "create table" statements in this file. Such + statements tend to be both very database and very database instance specific.</p> + + </div> + + +<div class="section"> +<h3>JCR Repository Configuration<a name="JCR_Repository_Configuration"></a></h3> + + +<p>Consult <a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/jcr-repository-template.xml";>jcr-repository.xml</a> in GIT to get some examples and hints.</p> + + +<p>Used to configure the JCR mailbox (if configure in mailbox.xml).</p> + + </div> + + </div> + + + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">Copyright © 2002-2016 + <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/f81a00ef/content/server/config-users.html ---------------------------------------------------------------------- diff --git a/content/server/config-users.html b/content/server/config-users.html new file mode 100644 index 0000000..50b8b0e --- /dev/null +++ b/content/server/config-users.html @@ -0,0 +1,601 @@ +<?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 2016-12-06 --> +<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 Server 3.0 - + Apache James Server 3 - Users Configuration</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="20161206" /> + <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"/> + + <!-- 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="Apache James Server 3.0" /> + </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: 2016-12-06</span> + </div> + <div class="xright"> <a href="../../index.html" title="Home">Home</a> + | + <a href="../index.html" title="Server">Server</a> + | + <a href="../../hupa/index.html" title="Hupa">Hupa</a> + | + <a href="../../protocols/index.html" title="Protocols">Protocols</a> + | + <a href="../../mailet/index.html" title="Mailets">Mailets</a> + | + <a href="../../mailbox/index.html" title="Mailbox">Mailbox</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="../../mpt/index.html" title="MPT">MPT</a> + | + <a href="../../postage/index.html" title="Postage">Postage</a> + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + <h5>Overview</h5> + <ul> + <li class="none"> + <a href="index.html" title="Introduction">Introduction</a> + </li> + <li class="none"> + <a href="release-notes.html" title="Release Notes">Release Notes</a> + </li> + </ul> + <h5>Features</h5> + <ul> + <li class="none"> + <a href="feature-mailetcontainer.html" title="Mailet Container">Mailet Container</a> + </li> + <li class="none"> + <a href="feature-queue-priority.html" title="Queue Priority">Queue Priority</a> + </li> + <li class="none"> + <a href="feature-persistence.html" title="Persistence">Persistence</a> + </li> + <li class="none"> + <a href="feature-protocols.html" title="Protocols">Protocols</a> + </li> + <li class="none"> + <a href="feature-smtp-hooks.html" title="SMTP Hooks">SMTP Hooks</a> + </li> + <li class="none"> + <a href="feature-performance.html" title="Performance">Performance</a> + </li> + <li class="none"> + <a href="feature-security.html" title="Security">Security</a> + </li> + </ul> + <h5>User Manual</h5> + <ul> + <li class="none"> + <a href="quick-start.html" title="1. Quick Start">1. Quick Start</a> + </li> + <li class="none"> + <a href="install.html" title="2. Install James">2. Install James</a> + </li> + <li class="expanded"> + <a href="config.html" title="3. Configure James">3. Configure James</a> + <ul> + <li class="none"> + <a href="config-system.html" title="System">System</a> + </li> + <li class="none"> + <a href="config-domainlist.html" title="Domain List">Domain List</a> + </li> + <li class="none"> + <strong>Users</strong> + </li> + <li class="none"> + <a href="config-recipientrewritetable.html" title="Recipient Rewrite">Recipient Rewrite</a> + </li> + <li class="none"> + <a href="config-mailbox.html" title="Mailbox">Mailbox</a> + </li> + <li class="none"> + <a href="config-mailrepositorystore.html" title="Mail Repository Stores">Mail Repository Stores</a> + </li> + <li class="none"> + <a href="config-dnsservice.html" title="DNS Service">DNS Service</a> + </li> + <li class="none"> + <a href="config-smtp-lmtp.html" title="SMTP LMTP">SMTP LMTP</a> + </li> + <li class="none"> + <a href="config-pop3.html" title="POP3">POP3</a> + </li> + <li class="none"> + <a href="config-imap4.html" title="IMAP4">IMAP4</a> + </li> + <li class="none"> + <a href="config-mailetcontainer.html" title="Mailet Container">Mailet Container</a> + </li> + <li class="none"> + <a href="config-fetchmail.html" title="FetchMail">FetchMail</a> + </li> + <li class="none"> + <a href="config-ssl-tls.html" title="SSL/TLS">SSL/TLS</a> + </li> + <li class="none"> + <a href="config-sieve.html" title="Sieve">Sieve</a> + </li> + <li class="none"> + <a href="config-antispam.html" title="Anti Spam">Anti Spam</a> + </li> + </ul> + </li> + <li class="collapsed"> + <a href="manage.html" title="4. Manage">4. Manage</a> + </li> + <li class="collapsed"> + <a href="monitor.html" title="5. Monitor">5. Monitor</a> + </li> + <li class="collapsed"> + <a href="upgrade.html" title="6. Upgrade">6. Upgrade</a> + </li> + </ul> + <h5>Developers Corner</h5> + <ul> + <li class="none"> + <a href="dev.html" title="Architecture">Architecture</a> + </li> + <li class="none"> + <a href="dev-build.html" title="Build from source">Build from source</a> + </li> + <li class="none"> + <a href="dev-database-schema.html" title="Database Schema">Database Schema</a> + </li> + <li class="collapsed"> + <a href="dev-extend.html" title="Develop Extensions">Develop Extensions</a> + </li> + <li class="collapsed"> + <a href="dev-provided.html" title="Provided Extensions">Provided Extensions</a> + </li> + </ul> + <h5>References</h5> + <ul> + <li class="none"> + <a href="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> + </ul> + <h5>About James</h5> + <ul> + <li class="none"> + <a href="../../index.html" title="Overview">Overview</a> + </li> + <li class="none"> + <a href="../../newsarchive.html" title="News">News</a> + </li> + <li class="none"> + <a href="../../mail.html" title="Mailing Lists">Mailing Lists</a> + </li> + <li class="none"> + <a href="../../contribute.html" title="Contributing">Contributing</a> + </li> + <li class="none"> + <a href="../../guidelines.html" title="Guidelines">Guidelines</a> + </li> + <li class="none"> + <a href="http://wiki.apache.org/james"; title="Wiki">Wiki</a> + </li> + <li class="none"> + <a href="../../team-list.html" title="Who We Are">Who We Are</a> + </li> + <li class="none"> + <a href="../../license.html" title="License">License</a> + </li> + <li class="none"> + <a href="../../thanks.html" title="Thanks">Thanks</a> + </li> + <li class="none"> + <a href="../../support.html" title="Professional support">Professional support</a> + </li> + </ul> + <h5>Download</h5> + <ul> + <li class="none"> + <a href="../../download.cgi" title="Releases">Releases</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"> + <!-- 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. --> + + + + <div class="section"> +<h2>Users Repositories<a name="Users_Repositories"></a></h2> + + +<div class="section"> +<h3>Introduction<a name="Introduction"></a></h3> + + +<p>User repositories are required to store James user information and authentication data</p> + + +<p>Consult <a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/app/src/main/resources/usersrepository-template.xml";>usersrepository.xml</a> in GIT to get some examples and hints.</p> + + </div> + + +<div class="section"> +<h3>JPA Users Repository<a name="JPA_Users_Repository"></a></h3> + + +<p>JPA (database via OpenJPA) based user repository. This is the default implementation.</p> + + +<p>The usersrepository tag as 2 attributes: name="LocalUsers" and class="org.apache.james.user.file.UsersFileRepository"></p> + + +<dl> + +<dt><b>algorithm</b></dt> + +<dd>Algorithm to has passwords. Supported password algorithm are: MD5, SHA-256, SHA-512, NONE</dd> + +<dt><b>enableVirtualHosting</b></dt> + +<dd>true (default) or false. Defines if the usernames must (true) or may not contain (false) a domain part ([email protected]).</dd> + </dl> + + </div> + + +<div class="section"> +<h3>File Users Repository<a name="File_Users_Repository"></a></h3> + + +<p>The File UsersRepository implementations below are DEPRECATED and will get removed in the next release</p> + +<p>It just listed here for backward-compatibility</p> + + +<p>File-based user repositories Use these configurations to store user info in the filesystem.</p> + + +<p>The usersrepository tag as 2 attributes:name="LocalUsers" class="org.apache.james.user.file.UsersFileRepository"></p> + + +<dl> + +<dt><b>destination</b></dt> + +<dd>Example: file://var/users/.</dd> + +<dt><b>ignoreCase</b></dt> + +<dd>true or false.</dd> + +<dt><b>enableAliases</b></dt> + +<dd>true or false.</dd> + +<dt><b>enableForwarding</b></dt> + +<dd>true or false.</dd> + +<dt><b>enableVirtualHosting</b></dt> + +<dd>true (default) or false. Defines if the usernames must (true) or may not contain (false) a domain part ([email protected]).</dd> + </dl> + + </div> + + +<div class="section"> +<h3>JDBC Users Repository<a name="JDBC_Users_Repository"></a></h3> + + +<p>The JDBC UsersRepository implementations below are DEPRECATED and will get removed in the next release.</p> + +<p>It just listed here for backward-compatibility.</p> + + </div> + + +<div class="section"> +<h3>LDAP Users Repository<a name="LDAP_Users_Repository"></a></h3> + + +<p>Read-Only LDAP based UsersRepository</p> + + +<p>Example:</p> + + +<div class="source"> +<pre> +<repository name="LocalUsers" class="org.apache.james.user.ldap.ReadOnlyUsersLDAPRepository" ldapHost="ldap://myldapserver:389" + principal="uid=ldapUser,ou=system" credentials="password" userBase="ou=People,o=myorg.com,ou=system" userIdAttribute="uid"/></pre></div> + +<!-- <p>This section explains how to enable Apache James Server to use an LDAP directory as a + Users Repository.</p> + + <p>We have tried to make the LDAP implementation of UsersRepository as + flexible a possible, recognising that each installation will have a unique + directory schema.</p> + + <p>We assume that all users that a James Mailserver will handle fall + within one single-rooted tree. The root of this tree, ie the lowest node + in the directory which is an ancestor for all users served by this + mailserver and the mailserver, is called the LDAPRoot. (See diagram)</p> + + <p>It is entirely possible that an organization may have more than one + mail server. Consequently, the fact that a user is in the Directory does + not imply that this mailserver should handle mail for them.</p> + + <p>This implementation of UsersRepository creates one node (object) for + each set of mail users. The set called 'LocalUsers' is the set of users + whose mail is handled by this server. Other sets include any mail-lists + handled by the server. Each member of a set is recorded as an attribute + of these objects. These nodes are child nodes of the mailserver.</p> + + <p>The mailserver will accept mail for local delivery if the user part of + the email address matches a member of LocalUsers and if the domain/host + part of the email address matches the first servername . + (Set servernames autodetect to false and enter the domain served as the + first servername, e.g. apache.org).</p> + + <p>For POP3 authentication, the mailserver first finds the user entry in + the directory, underLDAPRoot, whose attribute, specified as + MailAttribute in conf, matches user@domain. The mailserver authenticates + the POP3 user if it can bind to the directory as that user entry with + the offered password.</p> + + <p>This implementation does not set passwords in the directory. Use a dummy + password when invoking adduser in RemoteManger.</p> + + <p>If ManageGroupAttribute is set to TRUE (as it is by default), then the + RemoteManger will add/remove the full DN of the email group to/from the + user entry. This facilty allows users to ask the directory what is my + mailserver and what email lists am I subscribed to?</p> + + <table cellspacing="0"> + <tr> + <td> </td> + <td align="center">Root of Directory + <br>Example: dc=org</br> + <br>May not be referenced in conf.xml</br> + <br>|</br> + <br>|</br> + </td> + <td> </td> + </tr> + <tr> + <td colspan="3" align="center"> - - - - - - - - - - -</td> + </tr> + <tr> + <td align="center" valign="top">| + <br>Subtree not served by James</br> + <br> e.g.: dc=w3c, dc=org</br> + </td> + <td align="center" valign="top">| + <br>Subtree served by James</br> + <br> e.g.: dc=apache, dc=org </br> + <br>"LDAPRoot"</br> + <br>|</br> + </td> + <td align="center" valign="top">| + <br>Subtree not served by James</br> + <br> e.g.: dc=xml, dc=org</br> + </td> + </tr> + <tr> + <td> </td> + <td> + <table cellspace="0"> + <tr> + <td colspan="4" align="center"> - - - - - - - - - - - - - - - - - - - - - - - - - -</td> + </tr> + <tr> + <td align="center" valign="top">| + <br>This mailserver </br> + <br>cn=mailserver.apache.org</br> + <br>|</br> + <br> - - - - - - - -</br> + </td> + <td align="center" valign="top">| + <br>A user </br> + <br>cn=King Arthur</br> + <br> memberOfGroup=</br> + <br>cn=LocalUsers etc</br> + </td> + <td align="center" valign="top">| + <br>A user </br> + <br>cn=Morgan LeFay </br> + </td> + <td align="center" valign="top">| + <br>Another mailserver </br> + <br>cn=oldmail.apache.org</br> + </td> + </tr> + <tr> + <td> + <table cellspace="0"> + <tr> + <td align="center" valign="top"> | + <br>LocalUsers</br> + <br>member=Arthur</br> + </td> + <td align="center" valign="top"> | + <br>list-james</br> + <br>member=Arthur</br> + </td> + </tr> + </table> + </td> + <td> </td> + <td> </td> + <td> </td> + </tr> + </table> + </td> + <td> </td> + </tr> + </table> --> +<!-- <p>Six entries in JAMES.xml.xml must be set for this to work: + <ul> + <li>change usersManager - type to ldap.</li> + <li>Set the ldapServer element to point to the correct host and port</li> + <li>Set LDAPRoot and ThsServerRDN.</li> + <li>Set the direcory FDN and password that should be used to write to the directory.</li> + <li>Unless all your users have email addresses of the form, name@the-machine-running-James, set servernames-autodetect to false and apecify the your email domain as the first servername.</li> + </ul> + </p> --> + </div> + + </div> + + + + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">Copyright © 2002-2016 + <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]
