From: Maksym Mamontov <madf@madf.info>
Date: Sun, 28 Jun 2020 15:14:08 +0000 (+0300)
Subject: Add missing documentation.
X-Git-Tag: 2.409~11
X-Git-Url: https://git.stg.codes/stg.git/commitdiff_plain/28e7683d83570df1fc6b44a74e8eb0782b8bd9a2?ds=sidebyside;hp=3b51da05ef42ecf59b78a6c29664d3e555bc57da

Add missing documentation.
---

diff --git a/doc/help/ch4.xml b/doc/help/ch4.xml
index 7374ce96..178154e7 100644
--- a/doc/help/ch4.xml
+++ b/doc/help/ch4.xml
@@ -90,6 +90,7 @@
           <listitem><para>none - ничего не передавать.</para></listitem>
         </itemizedlist>
       </listitem>
+      <listitem><para>LogProtocolErrors – не обязательный параметр, включающий расширенное журналирование ошибок протокола. Может принимать значения yes или no, значение по умолчанию: no.</para></listitem>
     </itemizedlist>
     <para>Обмен данными авторизатора с сервером осуществляется по протоколу UDP. Можно указать несколько модулей авторизатора auth_ia для авторизации с разных портов.</para>
   </simplesect>
@@ -194,9 +195,16 @@
     <para>Модуль не имеет параметров. Для захвата трафика используются так называемые «raw sockets», которые позволяют получить доступ к Ethernet-фреймам. Перехватывается весь трафик попадающий в сетевую подсистему ядра. При использовании обычной маршрутизации трафик будет посчитан два раза: на входящем интерфейсе и на исходящем. При использовании NAT удвоения трафика не происходит, так как NAT заменяет адрес источника. При интенсивном сетевом обмене или при высокой нагрузке на сервер, на котором происходит захват трафика, модуль может терять отдельные пакеты. Процент потерь тем выше чем выше скорость прохождения пакетов и чем выше загрузка сервера. Модуль рекомендуется использовать для ознакомления или в небольших сетях до 100 абонентов с трафиком до 100 Мбит.</para>
   </simplesect>
   <simplesect>
-    <title>Модуль захвата трафика cap_ipq (только для ОС Linux).</title>
+    <title>Модуль захвата трафика cap_ipq (устаревший, только для ОС Linux).</title>
     <para>Модуль не имеет параметров. Для захвата трафика используются передача пакетов из пространства ядра в пространство пользователя посредством очередей (ip queue). Для его работы требуется поддержка ip queueing в ядре (модуль ip_queue.ko) и специальная настройка файрвола (правило QUEUE для iptables). Следует обратить внимание на то что обычно требуется два правила в файрволе для полного перехвата: одно для входящих пакетов и одно для исходящих. Модуль гарантирует 100% перехват трафика, но так как пакет перед отправкой обязательно проходить через плагин — может приводить к снижению пропускной способности роутера. При этом следует обратить внимание на нагрузку на процессор, возможно имеет смысл заменить его на более производительный. В противном случае стоит рассмотреть использование модуля cap_nf для захвата трафика.</para>
   </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля захвата трафика cap_nfqueue (только для ОС Linux).</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>queueNumber — не обязательный параметр, определяющий номер очереди netfilter из которой будет происходить захват трафика.</para></listitem>
+    </itemizedlist>
+    <para>Для захвата трафика используются передача пакетов из пространства ядра в пространство пользователя посредством очередей (netfilter queue). Модуль является заменой устаревшего cap_ipq. Для его работы требуется поддержка netfilter queueing в ядре (модуль xt_NFQUEUE.ko) и специальная настройка файрвола (правило NFQUEUE для iptables). Следует обратить внимание на то что обычно требуется два правила в файрволе для полного перехвата: одно для входящих пакетов и одно для исходящих. Модуль гарантирует 100% перехват трафика, но так как пакет перед отправкой обязательно проходить через плагин — может приводить к снижению пропускной способности роутера. При этом следует обратить внимание на нагрузку на процессор, возможно имеет смысл заменить его на более производительный. В противном случае стоит рассмотреть использование модуля cap_nf для захвата трафика.</para>
+  </simplesect>
   <simplesect>
     <title>Описание параметров модуля cap_bpf для захвата трафика (только для ОС FreeBSD):</title>
     <itemizedlist mark="opencircle">