[Amavisadmin-svn] SF.net SVN: amavisadmin: [56] amavisadmin/trunk/docs
Status: Beta
Brought to you by:
streindl
Menu
▾
▴
[Amavisadmin-svn] SF.net SVN: amavisadmin: [56] amavisadmin/trunk/docs
|
From: <str...@us...> - 2007-01-28 11:22:11
|
Revision: 56
http://amavisadmin.svn.sourceforge.net/amavisadmin/?rev=56&view=rev
Author: streindl
Date: 2007-01-28 03:22:04 -0800 (Sun, 28 Jan 2007)
Log Message:
-----------
Merge from documentation branch
Modified Paths:
--------------
amavisadmin/trunk/docs/user_guide.xml
Added Paths:
-----------
amavisadmin/trunk/docs/architecture.sdr
Copied: amavisadmin/trunk/docs/architecture.sdr (from rev 55, amavisadmin/branches/documentation_1_0/docs/architecture.sdr)
===================================================================
(Binary files differ)
Modified: amavisadmin/trunk/docs/user_guide.xml
===================================================================
--- amavisadmin/trunk/docs/user_guide.xml 2007-01-28 11:19:34 UTC (rev 55)
+++ amavisadmin/trunk/docs/user_guide.xml 2007-01-28 11:22:04 UTC (rev 56)
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<article>
- <articleinfo>
+<book>
+ <bookinfo>
<title>AmavisAdmin</title>
<subtitle>User Manual</subtitle>
@@ -48,7 +48,7 @@
<revision>
<revnumber>0.1</revnumber>
- <date>2007-01-22</date>
+ <date>2007-01-28</date>
<authorinitials>sr</authorinitials>
@@ -57,9 +57,9 @@
</revdescription>
</revision>
</revhistory>
- </articleinfo>
+ </bookinfo>
- <section>
+ <preface>
<title>Preface</title>
<para>This document describes how to use AmavisAdmin from a user's
@@ -69,18 +69,115 @@
found in the <citetitle id="ref-installation-manual">installation
manual</citetitle>.</para>
- <section>
- <title>Bibliography</title>
+ <para>The manual is splitted into two major parts:</para>
- <bibliography>
- <biblioentry id="maler96">
- <title>From Text to Model to Markup</title>
+ <orderedlist>
+ <listitem>
+ <para>The first part describes how to use and work with
+ AmavisAdmin</para>
+ </listitem>
- <subtitle></subtitle>
- </biblioentry>
- </bibliography>
+ <listitem>
+ <para>The second part describes how to adminstrate AmavisAdmin</para>
+ </listitem>
+ </orderedlist>
+ </preface>
- <para></para>
- </section>
- </section>
-</article>
\ No newline at end of file
+ <part id="part-how-to-use">
+ <title>How to use AmavisAdmin</title>
+
+ <partintro>
+ <para>This part shows how to use AmavisAdmin as a regular user. It
+ describes all the standard use cases and helps to understand how
+ AmavisAdmin is working.</para>
+
+ <para>In addition, <xref linkend="chp-what-is-amavisadmin" /> describes
+ how AmavisAdmin is working and how it interacts with the current
+ system.</para>
+ </partintro>
+
+ <chapter id="chp-what-is-amavisadmin">
+ <title>What is AmavisAdmin</title>
+
+ <para>AmavisAdmin is a tool desiged to support you in handling SPAM,
+ virus or mails with banned attachments. Basically Amavisd-new (the SPAM
+ and virus filter that is used in your network to prevent you from
+ reciving malcious mails) is storing all mails that are not delivered to
+ a user in a database. It is now up to the user to decide if the mails
+ that have been blocked are going to be release (i.e. sent anyhow) or if
+ they can be deleted from the system. For security reasons mails are not
+ delivered automatically in case the user has requested to release the
+ mail. They are marked with a special status and are going to be released
+ only after an administrator has approved the request.</para>
+
+ <figure id="fig-architecture">
+ <title>Architecture of a system receiving mails and processing them
+ trough Amavisd-new</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="architecture.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Figure xx gives an overview about the general architecture
+ and how AmavisAdmin fits into the figure. The flow for incoming mails
+ (either internet or intranet) is as follows:</para>
+
+ <procedure>
+ <step>
+ <para>The postfix daemon accepts an incoming mail. First basic
+ checks are done like correct mail header, relay checks, ...</para>
+ </step>
+
+ <step>
+ <para>Postfix sends the mail towards amavis for further checks.
+ Amavis does several checks now to analyse the mail (e.g. checking
+ for banned attachments, does the mail contain virus).</para>
+
+ <substeps>
+ <step>
+ <para>The Virus-Scanner checks in parallel if the mail contains
+ any known virus.</para>
+ </step>
+ </substeps>
+ </step>
+
+ <step>
+ <para>After performing the checks, general mail informartion is
+ stored in the quarantine database. If the mail is containing
+ problematic contents (i.e. viruses, SPAM, banned attachments,) also
+ the mail content is stored in the database. </para>
+ </step>
+
+ <step>
+ <para>Amavis now is either sending the mail contents back to Postfix
+ to deliver the mail to the user or in case the mail has been
+ rejected (i.e. a virus mail or banned content,) the user gets an
+ information about what happened to his mail.</para>
+ </step>
+
+ <step>
+ <para>Postfix is delivering the mail now to the IMAP-Server that is
+ responsible for sending the mail to the user's mail box.</para>
+ </step>
+
+ <step>
+ <para>After the mail is stored in the user's mail box, the user can
+ read his mail or informational mail.</para>
+ </step>
+ </procedure>
+ </chapter>
+
+ <chapter>
+ <title>Logging in</title>
+
+ <section>
+ <title>Logging in the first time</title>
+
+ <para></para>
+ </section>
+ </chapter>
+ </part>
+</book>
\ No newline at end of file
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
