[Amavisadmin-svn] SF.net SVN: amavisadmin: [41] amavisadmin/branches/documentation_1_0/docs/ installationguide.xml

[<str...@us...>]

Revision: 41
          http://amavisadmin.svn.sourceforge.net/amavisadmin/?rev=41&view=rev
Author:   streindl
Date:     2007-01-22 09:33:48 -0800 (Mon, 22 Jan 2007)

Log Message:
-----------
Updates to installation guide

Modified Paths:
--------------
    amavisadmin/branches/documentation_1_0/docs/installationguide.xml

Modified: amavisadmin/branches/documentation_1_0/docs/installationguide.xml
===================================================================
--- amavisadmin/branches/documentation_1_0/docs/installationguide.xml	2007-01-21 16:45:08 UTC (rev 40)
+++ amavisadmin/branches/documentation_1_0/docs/installationguide.xml	2007-01-22 17:33:48 UTC (rev 41)
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="US-ASCII"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 <!ENTITY sreindl "Stephen Reindl">
@@ -15,7 +15,7 @@
 
       <surname>Reindl</surname>
 
-      <address><street>Langster Str. 28</street>
+      <address><street>Langster Straße 28</street>
 <postcode>40668</postcode> <city>Meerbusch</city>
 <country>Germany&gt;</country></address>
 
@@ -48,7 +48,17 @@
     </legalnotice>
 
     <revhistory>
-      <revision><revnumber>0.1</revnumber><date>2007-01-20</date><authorinitials>sr</authorinitials><revdescription><para>Initial document</para></revdescription></revision>
+      <revision>
+        <revnumber>0.1</revnumber>
+
+        <date>2007-01-20</date>
+
+        <authorinitials>sr</authorinitials>
+
+        <revdescription>
+          <para>Initial document</para>
+        </revdescription>
+      </revision>
     </revhistory>
   </articleinfo>
 
@@ -193,30 +203,54 @@
       url="http://www.ijs.si/software/amavisd/">Amavisd-new home page</ulink>.
       Please ensure to at least use version 2.4.1, as this version is at least
       from documentation point of view SQL save according to the current data
-      model. The following commands taken from the file
-      <filename>INSTALL</filename> that is part of the Amavisd-new
-      distribution explains how to download a particular version of the
-      software:</para>
+      model. For installation of amavisd-new and about how to setup SQL
+      storage and lookup, please refer to the following documentation
+      files:</para>
 
-      <screen><prompt>$ </prompt><userinput>curl -s -S -O http://www.ijs.si/software/amavisd/amavisd-new-<replaceable>&lt;version&gt;</replaceable></userinput><co id="sc-amavis-curl" />
-<prompt>$ </prompt><userinput>gzip -d -c amavisd-new-<replaceable>&lt;version&gt;</replaceable>.tar.gz | tar xvf -</userinput>
-<computeroutput >amavisd-new-2.4.4
-amavisd-new-2.4.4/README_FILES
-amavisd-new-2.4.4/helper-progs
-amavisd-new-2.4.4/test-messages
-amavisd-new-2.4.4/AAAREADME.first
-amavisd-new-2.4.4/INSTALL
+      <itemizedlist>
+        <listitem>
+          <para><ulink
+          url="http://www.ijs.si/software/amavisd/INSTALL.txt">http://www.ijs.si/software/amavisd/INSTALL.txt</ulink>
+          describes how to download and install Amavisd-new in general</para>
+        </listitem>
+
+        <listitem>
+          <para><ulink
+          url="http://www.ijs.si/software/amavisd/README.sql.txt">http://www.ijs.si/software/amavisd/README.sql.txt</ulink>
+          describes how to setup SQL access.</para>
+        </listitem>
+      </itemizedlist>
+
+      <para>In addition, you have to make the PDP protocol available via
+      socket access. The PDP protocoll (see <ulink
+      url="http://www.ijs.si/software/amavisd/README.protocol.txt">http://www.ijs.si/software/amavisd/README.protocol.txt</ulink>
+      for reference) enables other applications to either perform SPAM/Virus
+      checks for mails or to release quarantined mails. To accomplish this,
+      the file <filename>/etc/amavisd.conf</filename> has to be adapted. The
+      following listing explains the changes in detail:</para>
+
+      <programlisting>...
+$inet_socket_port = (10024,<replaceable>10026</replaceable><co
+          id="pl-amavis-inet-socket-port" />);   # listen on this local TCP port(s) (see $protocol)
 ...
-tar: Read 4608 bytes from -</computeroutput>
-<prompt>$ </prompt><userinput>cd amavisd-new-<replaceable>&lt;version&gt;</replaceable></userinput></screen>
+$protocol='AM.PDP';<co id="pl-amavis-conf-protocol" />
+...</programlisting>
 
-        <calloutlist>
-          <callout arearefs="sc-amavis-curl">
-            <para>Other tools like <command>wget</command> or downloading via
-            your favourite web browser should work also.</para>
-          </callout>
-        </calloutlist>
+      <calloutlist>
+        <callout arearefs="pl-amavis-inet-socket-port">
+          <para>Please add here the port that should be used for communication
+          between AmavisAdmin and amavisd-new. This port number should be
+          selected with caution as there might be some inteference with other
+          application if you would select a port that is already in use by
+          another application.</para>
+        </callout>
 
+        <callout arearefs="pl-amavis-inet-socket-port">
+          <para>This line defines the general protocol to be used for talking
+          to amavisd-new. As described above, the PDP-protocol is the right
+          value here.</para>
+        </callout>
+      </calloutlist>
     </section>
   </section>
 </article>
\ No newline at end of file


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.