| <?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 Apr 17, 2012 -->
|
| <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 - Configuring the NNTP Service</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="20120417" />
|
| <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-server-logo.gif">
|
|
|
|
|
| <img src="images/logos/james-server-logo.gif" alt="Apache James Server 3.0" />
|
| </a>
|
| <a href="http://www.apache.org/index.html" id="bannerRight">
|
|
|
|
|
| <img src="images/logos/asf-logo-reduced.gif" alt="The Apache Software Foundation" />
|
| </a>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| <div id="breadcrumbs">
|
|
|
|
|
| <div class="xleft">
|
| <span id="publishDate">Last Published: 2012-04-17</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="../../imap/index.html" title="IMAP">IMAP</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="collapsed">
|
| <a href="config.html" title="3. Configure James">3. Configure James</a>
|
| </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>
|
| <li class="none">
|
| <a href="https://repository.apache.org/content/repositories/snapshots/org/apache/james/apache-james/" title="Nightly builds">Nightly builds</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>
|
| </ul>
|
| <h5>Download</h5>
|
| <ul>
|
| <li class="none">
|
| <a href="../../download.cgi" title="Releases">Releases</a>
|
| </li>
|
| <li class="none">
|
| <a href="https://repository.apache.org/content/repositories/snapshots/org/apache/james/" title=""></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>NNTP Configuration<a name="NNTP_Configuration"></a></h2> |
| <p>The NNTP service is controlled by a two configuration blocks in the config.xml. These are the nntpserver block and the nntp-repository block.</p> |
| <div class="section"><h3>The nntpserver block<a name="The_nntpserver_block"></a></h3> |
| <p>The nntpserver tag defines the boundaries of the configuration block. It encloses |
| much of the relevant configuration for the NNTP server.</p> |
| |
| <p>This tag has an optional boolean attribute - <b>enabled</b> - that defines whether the service is active or not. The value defaults to "true" if |
| not present.</p> |
| <p>The standard children of the nntpserver tag are:</p> |
| <ul> |
| <li><b>port</b> - This is an optional integer value. This value is the port on which this NNTP server is configured |
| to listen.If the tag or value is omitted, the value will default to the standard NNTP port, 119.</li> |
| <li><b>bind</b> - This is an optional value. If present, this value is a string describing |
| the IP address to which this service should be bound. If the tag or value is absent then the service |
| will bind to all network interfaces for the machine.</li> |
| <li><b>useTLS</b> - This is an optional boolean value. If this value is true, then the "ssl" |
| server socket factory is used to generate the server socket for this service. If it is false, the |
| "plain" server socket factory is used. In either case this behavior is overridden by the serverSocketType |
| tag which is described under the expert configuration options.</li> |
| <li><b>handler</b> - This is an artifact preserved for backwards compatibility. This tag |
| was used to group related parameters. It should disappear in future versions.</li> |
| <ul> |
| <li><b>helloName</b> - This is a required tag with an optional body that defines the server name |
| used in the initial service greeting. The tag may have an optional attribute - <b>autodetect</b>. If |
| the autodetect attribute is present and true, the service will use the local hostname |
| returned by the Java libraries. If autodetect is absent or false, the body of the tag will be used. In |
| this case, if no body is present, the value "localhost" will be used.</li> |
| <li><b>connectionTimeout</b> - This is an optional tag with a non-negative integer body. </li> |
| <li><b>authRequired</b> - This is an optional tag with a boolean body. If true, then the server will |
| require authentication before allowing the client to view news articles. If this tag is absent, or the value |
| is false then the client will not be prompted for authentication. Only simple user/password authentication is |
| supported at this time.</li> |
| </ul> |
| </ul> |
| <p>There are a few additional children of the nntpserver tag that are appropriate for advanced |
| configurations. These should only be used by expert administrators. All tags in this group are optional.</p> |
| <ul> |
| <li><b>serverSocketFactory</b> - This is an optional tag with a string body. If the tag is present, |
| the body must be the name of one of the server socket factories specified in the socket manager block. Any other |
| value will result in an error. If present, this tag overrides the useTLS tag.</li> |
| <li><b>threadGroup</b> - This is an optional tag with a string body. If the tag is present, |
| the body must be the name of one of the thread groups specified in the thread manager block. Any other |
| value will result in an error. This tag is best used to fine tune thread allocation between the services.</li> |
| <li><b>connectionLimit</b> - The connectionLimit parameter specifies the maximum number of client |
| connections that this service will allow. If no value is specified, the value defaults to that specified in |
| the connectionmanager block. A value of 0 means that there is no limit imposed |
| by the service, although resource limitations imposed by other components |
| (i.e. max # of threads) may serve to limit the number of open connections.</li> |
| </ul> |
| </div> |
| <div class="section"><h3>The nntp-repository block<a name="The_nntp-repository_block"></a></h3> |
| The remainder of the NNTP service configuration is controlled by the nntp-repository configuration block. This |
| section of configuration data relates to the server-side NNTP article repository. |
| <ul> |
| <li><b>readOnly</b> - This is a required boolean tag. If the value is true, posting will not be |
| permitted by the NNTP server.</li> |
| <li><b>rootPath</b> - This is a required string tag. It must be in the form of a URL with a "file:" prefix. This |
| specifies the root directory for the NNTP repository. Groups hosted on the NNTP server will be represented as |
| folders under this root, and articles will be stored in the appropriate folders.</li> |
| <li><b>tempPath</b> - This is a required string tag. It must be in the form of a URL with a "file:" prefix. This |
| specifies the directory where the NNTP server will store posted articles before they are added to the spool.</li> |
| <li><b>articleIDPath</b> - This is a required string tag. It must be in the form of a URL with a "file:" prefix. This |
| specifies the directory where the NNTP server will store the mappings between article ID and the groups containing that article.</li> |
| <li><b>articleIDDomainSuffix</b> - This is a required string tag. It is the suffix appended to all article IDs generated |
| by this NNTP server.</li> |
| <li><b>newsgroups</b> - This is a required container tag. It has a single <b>newsgroup</b> child for each newsgroup |
| hosted on the server. The body of each of those <b>newsgroup</b> tags is the name of the newsgroup.</li> |
| </ul> |
| </div> |
| </div> |
| |
|
|
| </div>
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| <div id="footer">
|
| <div class="xright">Copyright © 2002-2012
|
| <a href="http://www.apache.org/">The Apache Software Foundation</a>.
|
| All Rights Reserved.
|
|
|
| </div>
|
| <div class="clear">
|
| <hr/>
|
| </div>
|
| </div>
|
| </body>
|
| </html>
|