From: Adam Dickmeiss <adam@indexdata.dk>
Date: Wed, 7 Apr 2010 08:34:20 +0000 (+0200)
Subject: Document all frontend_net configuration
X-Git-Tag: v1.1.3~5
X-Git-Url: http://lists.indexdata.dk/?a=commitdiff_plain;h=235ec6eb8e28884ca223a5d451aa83b18909acd9;p=metaproxy-moved-to-github.git

Document all frontend_net configuration
---

diff --git a/doc/frontend_net.xml b/doc/frontend_net.xml
index 852f45c..c48e539 100644
--- a/doc/frontend_net.xml
+++ b/doc/frontend_net.xml
@@ -23,6 +23,30 @@
    sends HTTP/Z39.50 messages to other filters.
   </para>
  </refsect1>
+
+ <refsect1><title>CONFIGURATION</title>
+  <para>
+   Element <literal>port</literal> is a repeating element (1 or more). The
+   text content specifies a listening port.
+  </para>
+  <para>
+   Element <literal>threads</literal> is an optional element. The
+   text content specifies number of worker threads for the following
+   filters to use. The default value is 5 (5 worker threads).
+  </para>
+  <para>
+   Element <literal>timeout</literal> is an optional element. The
+   text content is treated as an integer that specifies the session timeout
+   in seconds for a client session (using the frontend net filter). The
+   default value is 300 (5 minutes).
+  </para>
+  <para>
+   Element <literal>connect-max</literal> is an optional element. The
+   text content is treated as an integer that specifies maximum number
+   of TCP sessions from the same original IP. The special value 0 means
+   : no connection limit. This is also the default if this element is omitted.
+  </para>
+ </refsect1>
  
  <refsect1><title>EXAMPLES</title>
   <para>