Documentation for TransparentProxy

1 files changed, 23 insertions, 0 deletions

diff --git a/doc/clamsmtpd.8 b/doc/clamsmtpd.8
index 2317b59..b25f082 100644
--- a/doc/clamsmtpd.8
+++ b/doc/clamsmtpd.8
@@ -114,6 +114,29 @@ Make sure the
 .Ar MaxConnections
 setting is set high enough to handle the mail from all the servers without refusing
 connections. 
+.Sh TRANSPARENT PROXY FEATURE
+A transparent proxy is a configuration on a gateway that routes certain types of 
+traffic through a proxy server without any changes on the client computers. 
+.Nm
+has support for transparent proxying of SMTP traffic by enabling the 
+.Ar TransparentProxy
+setting. This type of setup usually involves firewall rules which redirect traffic to 
+.Nm 
+and the setup varies from OS to OS. The SMTP traffic will be forwarded to it's 
+original destination after being scanned. 
+.Pp
+When doing transparent proxying for outgoing email it's probably a good idea to 
+turn on bounce notifications using the
+.Ar Bounce
+setting. Also note that some features (such as SSL/TLS) will not be available
+when going through the transparent proxy. 
+.Pp
+Make sure that the
+.Ar MaxConnections 
+setting is set high enough for your transparent proxying. Because 
+.Nm 
+is not being used as a filter inside a queue, which usually throttles the amount
+of email going through, this setting may need to be higher than usual. 
 .Sh SECURITY
 There's no reason to run this daemon as root. It is meant as a filter and should
 listen on a high TCP port. It's probably a good idea to run it using the same