| <?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 2021-11-12 --> |
| <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 – Apache James Server 3 - 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="20211112" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| |
| <!-- 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="https://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: 2021-11-12</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> |
| |
| |
| </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="collapsed"> |
| <a href="../server/install.html" title="3. Install James">3. Install James</a> |
| </li> |
| <li class="expanded"> |
| <strong>4. Configure James</strong> |
| <ul> |
| <li class="none"> |
| <a href="../server/config-listeners.html" title="Additional mailbox listeners">Additional mailbox listeners</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-antispam.html" title="Anti Spam">Anti Spam</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-blob-export.html" title="Blob Export">Blob Export</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-blobstore.html" title="BlobStore">BlobStore</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-cassandra.html" title="Cassandra">Cassandra</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-elasticsearch.html" title="ElasticSearch">ElasticSearch</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-vault.html" title="Deleted Messages Vault">Deleted Messages Vault</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-dnsservice.html" title="DNS Service">DNS Service</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-domainlist.html" title="Domain List">Domain List</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-fetchmail.html" title="FetchMail">FetchMail</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-guice.html" title="Guice">Guice</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-imap4.html" title="IMAP4">IMAP4</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-jmap.html" title="JMAP">JMAP</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-mailrepositorystore.html" title="Mail Repository Stores">Mail Repository Stores</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-mailbox.html" title="Mailbox">Mailbox</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-mailetcontainer.html" title="Mailet Container">Mailet Container</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-healthcheck.html" title="Periodical Health Checks">Periodical Health Checks</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-pop3.html" title="POP3">POP3</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-quota.html" title="Quota">Quota</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-rabbitmq.html" title="RabbitMQ">RabbitMQ</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-recipientrewritetable.html" title="Recipient Rewrite">Recipient Rewrite</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-smtp-lmtp.html" title="SMTP LMTP">SMTP LMTP</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-sieve.html" title="Sieve">Sieve</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-ssl-tls.html" title="SSL/TLS">SSL/TLS</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-system.html" title="System">System</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-spring-jpa-postgres.html" title="Spring JPA Postgres">Spring JPA Postgres</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-users.html" title="Users">Users</a> |
| </li> |
| <li class="none"> |
| <a href="../server/config-webadmin.html" title="WebAdmin">WebAdmin</a> |
| </li> |
| </ul> |
| </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="../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"> |
| |
| |
| |
| |
| <section> |
| <h2><a name="Configure_Apache_James_Server"></a>Configure Apache James Server</h2> |
| |
| |
| <p>All configuration files resides in the ./conf and ./conf/META-INF folder.</p> |
| |
| |
| <p>With default Spring wiring, we ship with default configuration. It gets automatically deployed in the conf folder while unzipping. |
| Of course, you can change the files *.xml the settings to match your needs.</p> |
| |
| |
| <p> For Guice based wiring, you are encouraged to take a look at default configuration of the |
| <a class="externalLink" href="https://hub.docker.com/r/apache/james">James docker images</a>.</p> |
| |
| |
| <p>Please note that the configuration is dependent of the wiring you have chosen. Some configuration files are specific to |
| some back-ends, to some protocols. Please also note that some configuration files are not required for Guice. In this |
| case, it will be specified.</p> |
| |
| |
| <p>In every configuration files, you can use the following notation to use an environment variable: ${env:MY_VAR}. |
| If MY_VAR exists, it will be replaced by the matching environment variable. |
| If it does not, ${env:MY_VAR} will be kept as is.</p> |
| |
| |
| <p>You can/must configure James for the following:</p> |
| |
| |
| <table border="0" class="bodyTable"> |
| |
| |
| <tr class="a"> |
| |
| <th>Config File Sample</th> |
| |
| <th>Config Area</th> |
| |
| <th>Config Comment</th> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/dnsservice.xml">dnsservice.xml</a></td> |
| |
| <td><a href="config-dnsservice.html">DNS Service Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/domainlist.xml">domainlist.xml</a></td> |
| |
| <td><a href="config-domainlist.html">Domain List Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/events.xml">events.xml</a></td> |
| |
| <td><a href="config-events.html">Event system Configuration (Spring only)</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/fetchmail.xml">fetchmail.xml</a></td> |
| |
| <td><a href="config-fetchmail.html">FetchMail Configuration (Spring only)</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/imapserver.xml">imapserver.xml</a></td> |
| |
| <td><a href="config-imap4.html">IMAP4 Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/jmap.properties">jmap.properties</a></td> |
| |
| <td><a href="config-jmap.html">JMAP Configuration (Guice only)</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/lmtpserver.xml">lmtpserver.xml</a></td> |
| |
| <td><a href="config-smtp-lmtp.html">LMTP Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/mailrepositorystore.xml">mailrepositorystore.xml</a></td> |
| |
| <td><a href="config-mailrepositorystore.html">Mail Repository Stores Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/mailbox.xml">mailbox.xml</a></td> |
| |
| <td><a href="config-mailbox.html">Mailbox Configuration (Spring only)</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/mailetcontainer.xml">mailetcontainer.xml</a></td> |
| |
| <td><a href="config-mailetcontainer.html">Mailet Container Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/pop3server.xml">pop3server.xml</a></td> |
| |
| <td><a href="config-pop3.html">POP3 Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/quota.xml">mailbox.xml</a></td> |
| |
| <td><a href="config-quota.html">Quota Configuration (Spring only)</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/recipientrewritetable.xml">recipientrewritetable.xml</a></td> |
| |
| <td><a href="config-recipientrewritetable.html">Recipient Rewrite Table Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/smtpserver.xml">smtpserver.xml</a></td> |
| |
| <td><a href="config-smtp-lmtp.html">SMTP Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/usersrepository.xml">usersrepository.xml</a></td> |
| |
| <td><a href="config-users.html">Users Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/blob/master/server/apps/distributed-app/sample-configuration/webadmin.properties">webadmin.properties</a></td> |
| |
| <td><a href="config-webadmin.html">WebAdmin Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| </table> |
| |
| |
| <p>For most advanced system configuration, you can configure James for the following:</p> |
| |
| |
| <table border="0" class="bodyTable"> |
| |
| |
| <tr class="a"> |
| |
| <th>System Config File Sample</th> |
| |
| <th>System Config Area</th> |
| |
| <th>System Config Comment</th> |
| </tr> |
| |
| |
| <tr class="b"> |
| |
| <td><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></td> |
| |
| <td><a href="config-system.html">System Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/james-database.properties">james-database.properties</a></td> |
| |
| <td><a href="config-system.html">System Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/META-INF/persistence.xml">META-INF/persistence.xml</a></td> |
| |
| <td><a href="config-system.html">System Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td> |
| <a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/jmx.properties">jmx.properties</a><br /> |
| </td> |
| |
| <td><a href="config-system.html">System Configuration</a></td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="b"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/log4j.properties">log4j.properties</a></td> |
| |
| <td>See <a href="monitor-logging.html">monitoring with log4j</a> section.</td> |
| |
| <td></td> |
| </tr> |
| |
| <tr class="a"> |
| |
| <td><a class="externalLink" href="https://github.com/apache/james-project/tree/master/server/apps/spring-app/src/main/resources/sqlResources.xml">sqlResources.xml</a></td> |
| |
| <td><a href="config-system.html">System Configuration</a></td> |
| |
| <td>Deprecated</td> |
| </tr> |
| |
| </table> |
| |
| |
| <p>See also more specific configurations related to <a href="config-ssl-tls.html">TLS</a>, |
| <a href="config-sieve.html">Sieve</a> and |
| <a href="config-antispam.html">Antispam</a>.</p> |
| |
| </section> |
| |
| |
| |
| |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright">Copyright © 2006-2021 |
| <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |
