From 852f1abecb532112c96f36d398d6b8f5f61c252f Mon Sep 17 00:00:00 2001
From: z3APA3A <3APA3A@3proxy.ru>
Date: Sat, 30 Jan 2016 00:00:00 +0300
Subject: [PATCH] Documentation for TransparentPlugin added

---
 doc/html/plugins/TransparentPlugin.html    | 28 ++++++++++++++++++++
 doc/html/plugins/TransparentPlugin.ru.html | 30 ++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 doc/html/plugins/TransparentPlugin.html
 create mode 100644 doc/html/plugins/TransparentPlugin.ru.html

diff --git a/doc/html/plugins/TransparentPlugin.html b/doc/html/plugins/TransparentPlugin.html
new file mode 100644
index 0000000..9bce526
--- /dev/null
+++ b/doc/html/plugins/TransparentPlugin.html
@@ -0,0 +1,28 @@
+<h3>3proxy TransparentPlugin plugin (Linux only)</h3>
+
+Plugin can turn 3proxy into transparent proxy for virtually any TCP-based protocol
+and use all 3proxy features - redirections, parent proxies, ACLs, traffic limitations,
+etc. TransparentPlugin plugin takes destination IP:port from Linux and uses this
+information as a target IP in proxy. An example of usage:
+
+<pre>
+plugin /path/to/TransparentPlugin.ld.so transparent_plugin
+log /path/to/log
+auth iponly
+allow * * * 80
+parent 1000 http 0.0.0.0 0
+allow *
+parent 1000 socks5 SOCKS5_IP SOCKS5_PORT USER PASSWORD
+tcppm -iLOCAL_IP 12345 127.0.0.1 11111
+</pre>
+Now, any TCP traffic transparently redirected to port 12345 will be routed via
+parent SOCKSv5 proxy and logged, all URLs for web requests are visible in logs.
+Paremeters '127.0.0.1 11111' in this case are not used and are overwritten by
+destination IP:port for each transparent connection.
+
+<h4>Download:</h4>
+<ul>
+ <li>Plugin included into 3proxy 0.8
+</ul>
+
+&copy; Vladimir Dubrovin, License: BSD style
diff --git a/doc/html/plugins/TransparentPlugin.ru.html b/doc/html/plugins/TransparentPlugin.ru.html
new file mode 100644
index 0000000..f3a8715
--- /dev/null
+++ b/doc/html/plugins/TransparentPlugin.ru.html
@@ -0,0 +1,30 @@
+<h3>Плагин TransparentPlugin 3proxy (только для Linux)</h3>
+
+Плагин превращает 3proxy в транспарентный прокси для практически любых TCP-соединений
+и позволяет прозрачно для клиентов использовать весь фунционал прокси - редиректоры,
+родительские прокси, ACLи, ограничения трафика. TransparentPlugin получает IP:port
+назначения от Linux  и использует эту информацию в качестве конечного адреса назначения.
+<br>
+Пример использования:
+
+<pre>
+plugin /path/to/TransparentPlugin.ld.so transparent_plugin
+log /path/to/log
+auth iponly
+allow * * * 80
+parent 1000 http 0.0.0.0 0
+allow *
+parent 1000 socks5 SOCKS5_IP SOCKS5_PORT USER PASSWORD
+tcppm -iLOCAL_IP 12345 127.0.0.1 11111
+</pre>
+Теперь любые TCP-соединения транспарентно перенаправленные в локальный порт 12345 
+будут прологгированы и перенаправлены в родительский SOCKSv5 proxy, при этом для
+HTTP-запросов по порту TCP/80 будут видны параметры HTTP-запроса.
+Параметры '127.0.0.1 11111' в данном случае не оказывают влияния, т.к.
+будут перезаписываться IP и портом назначения для каждого TCP-соединения соответственно.
+<h4>Загрузить:</h4>
+<ul>
+ <li>Плагин включен в дистрибутив 3proxy 0.8
+</ul>
+
+&copy; Vladimir Dubrovin, License: BSD style