Merge pull request #2 from bobr-kun/MySQL_custom_port

[stg.git] / doc / help / ch4.xml

diff --git a/doc/help/ch4.xml b/doc/help/ch4.xml
index d3bb71f0fe160846d1b0b044104e73ebaf21bc92..b3dc7159123db8d8d124a8794d2cdc7507921086 100644 (file)
--- a/doc/help/ch4.xml
+++ b/doc/help/ch4.xml
@@ -1,81 +1,428 @@
 <chapter xml:id="ch4">
 <chapter xml:id="ch4">

-    <title>Настройка системы</title>
-    <para>После инсталляции система должна быть подвергнута процедуре настройки. Обычно следует начинать с настройки сервера.</para>
-    <para>Основные конфигурационные  файлы  сервера по умолчанию находятся в каталоге /etc/stargazer. Они включают в себя: основной конфигурационный файл stargazer.conf, файл описания направлений тарификации rules, набор скриптов On* и два каталога — conf-available.d и conf-enabled.d, содержащих конфигурационные файлы отдельных модулей. Для включения какого-либо модуля нужно сделать символическую ссылку на его конфигурационный файл в каталоге conf-enabled.d или прописать его конфигурационную секцию в разделе &lt;Modules&gt; файла stargazer.conf.</para>
-    <simplesect>
-        <title>Настройка конфигурационного файла /etc/stargazer/stargazer.conf</title>
-        <para>Файл имеет текстовый формат, содержащий пары ПАРАМЕТР = ЗНАЧЕНИЕ и секции &lt;ИМЯ_СЕКЦИИ ПАРАМЕТРЫ_СЕКЦИИ&gt;. Комментарии в файле начинаются с символа #. В файле описываются общие параметры, которые являются глобальными значениями для всего сервера биллинга, а также параметры соответствующих модулей. Параметры модулей должны быть заключены в секции:</para>
-        <programlisting linenumbering="unnumbered">
-        &lt;Module [имя модуля(имя файла модуля без mod_ и без .so)]&gt;
+  <title>Настройка системы</title>
+  <para>После инсталляции система должна быть подвергнута процедуре настройки. Обычно следует начинать с настройки сервера.</para>
+  <para>Основные конфигурационные  файлы  сервера по умолчанию находятся в каталоге /etc/stargazer. Они включают в себя: основной конфигурационный файл stargazer.conf, файл описания направлений тарификации rules, набор скриптов On* и два каталога — conf-available.d и conf-enabled.d, содержащих конфигурационные файлы отдельных модулей. Для включения какого-либо модуля нужно сделать символическую ссылку на его конфигурационный файл в каталоге conf-enabled.d или прописать его конфигурационную секцию в разделе &lt;Modules&gt; файла stargazer.conf.</para>
+  <simplesect>
+    <title>Конфигурационный файл /etc/stargazer/stargazer.conf </title>
+    <para>Файл имеет текстовый формат, содержащий пары ПАРАМЕТР = ЗНАЧЕНИЕ и секции &lt;ИМЯ_СЕКЦИИ ПАРАМЕТРЫ_СЕКЦИИ&gt;. Комментарии в файле начинаются с символа #. В файле описываются общие параметры, которые являются глобальными значениями для всего сервера биллинга, а также параметры соответствующих модулей. Параметры модулей должны быть заключены в секции:</para>
+    <programlisting linenumbering="unnumbered">
+    &lt;Module имя_модуля&gt;
+      список параметров модуля
+    &lt;/Module&gt;
+    </programlisting>
+    <para>Имя модуля представляет собой имя файла этого модуля без префикса mod_ и суффикса .so. Например, секция конфигурации модуля remote_script (имя файла: mod_remote_script.so) может выглядеть так:</para>
+    <programlisting linenumbering="unnumbered">
+    &lt;Module remote_script&gt;
+      SendPeriod = 15
+      SubnetFile = subnets
+      Password = 123456
+      UserParams = Cash Tariff EnabledDirs
+      Port = 9999
+    &lt;/Module&gt;
+    </programlisting>
+    <para>Описание глобальных параметров параметров:</para>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Rules – обязательный параметр, указывающий серверу, где находится файл с правилами для подсчета трафика клиентов. Стандартное значение: /etc/stargazer/rules.</para></listitem>
+      <listitem><para>LogFile – обязательный параметр, указывающий серверу расположение файла, в который будут заноситься все сообщения системы. Стандартное значение: /var/log/stargazer.log.</para></listitem>
+      <listitem><para>PidFile — необязательный параметр, указывающий серверу где находится файл хранящий PID (идентификатор процесса) дэмона. По умолчанию это /var/run/stargazer.pid. Используется скриптами запуска/останова.</para></listitem>
+      <listitem><para>ModulesPath – обязательный параметр, указывающий серверу путь, где находятся подключаемые модули (плагины). Стандартное значение: /usr/lib/stg.</para></listitem>
+      <listitem><para>DetailStatWritePeriod – обязательный параметр, указывающий серверу через какое время должна записываться детальная статистика клиента. Стандартное значение: 1/6. Данный параметр может принимать следующие значения: 3 - раз в три часа, 2 - раз в два часа, 1 - раз в чаc, 1/2 - раз в пол часа, 1/4 - раз в 15 минут, 1/6 - раз в 10 минут.</para></listitem>
+      <listitem><para>StatWritePeriod – необязательный параметр, указывающий серверу периодичность записи в БД информации о статистике пользователя в минутах. При большом количестве пользователей эту величину стоит увеличить, так как запись в БД может занимать длительное время. По умолчанию имеет значение 10.</para></listitem>
+      <listitem><para>DayFee – обязательный параметр, указывающий серверу, в какой день месяца снимать с клиентских счетов сумму абонплаты, в соответствии с тарифными планами клиентов. Может принимать значения от 0 до 31, стандартное значение: 1. Следует помнить, что в некоторых месяцах не более 28 дней. Значение 0 соответствует последнему дню месяца по календарю.</para></listitem>
+      <listitem><para>DayResetTraff – обязательный параметр, указывающий серверу в какой день месяца сбрасывать помесячную статистику клиентов и осуществлять переход на новый тариф, если он был изменен у клиента. Может принимать значения от 0 до 31, стандартное значение: 1. Следует помнить, что в некоторых месяцах не более 28 дней. Значение 0 соответствует последнему дню месяца по календарю.</para></listitem>
+      <listitem><para>SpreadFee – обязательный параметр, указывающий серверу производить ли «размазанное» снятие абонплаты. Может принимать значения yes и no. При указании значения yes сумма абонплаты указанная в тарифе пользователя будет сниматься не раз в месяц, а каждый день равными долями. Стандартное значение: no.</para></listitem>
+      <listitem><para>FreeMbAllowInet – обязательный параметр, указывающий серверу выполнять ли для пользователя скрипт OnConnect, если у него на балансе отсутствуют средства, но остался предоплаченный трафик. Может принимать значения yes и no. Стандартное значение: no.</para></listitem>
+      <listitem><para>WriteFreeMbTraffCost – обязательный параметр, определяющий как  будет писаться стоимость трафика в детальной статистике. Может принимать значения yes и no, стандартное значение: no. При указании значения yes в детальной статистике пользователя стоимость трафика будет писаться в любом случае, даже если он попадает в FreeMb. При указании значения no доя исчерпания FreeMb в детальной статистике будет указана нулевая стоимость трафика.</para></listitem>
+      <listitem><para>DayFeeIsLastDay – обязательный параметр, указывающий серверу когда снимать абонплату. Может принимать значения yes и no, стандартное значение: yes. Это влияет на то, как будет снята абонплата (АП) при переходе на новый тариф. Если у пользователя был тариф A с АП=100 и он хочет перейти на тариф B с АП=200, то при переходе на новый тариф со счета пользователя снимется 100, если указано значение yes (абонплата снята до смены тарифа), и 200, если указано значение no (абонплата снята перед сменой тарифа).</para></listitem>
+      <listitem><para>ExecutersNum – необязательный параметр который определяющий сколько скриптом может выполняться одновременно (регулирует количество процессов stg-exec). По умолчанию имеет значение 1. Если выполнение ваших скриптов занимает много времени имеет смысл увеличить это значение. Каждый исполнитель скриптов блокируется на время, пока отработает скрипт. Если исполнителей несколько — они принимают скрипты на выполнение по принципу «кто успел».</para></listitem>
+      <listitem><para>StgMsgKey – необязательный параметр отвечающий за идентификатор очереди сообщений для исполнителя скриптов. По умолчанию данный параметр имеет значение 5555. Рекомендуется не изменять значение параметра без нужды. Его изменение целесообразно лишь в том случае, если в системе требуется запустить более одной копии сервера биллинга.</para></listitem>
+      <listitem><para>ShowFeeInCash – необязательный параметр, определяющий как будет показано состояние счета абонента в авторизаторе и сколько денег ему будет разрешено использовать в текущем месяце. Может принимать значения yes и no, по умолчанию имеет значение yes. При указании no в авторизаторе будет показано состояние счета  без учета следующего снятия абонплаты. Так же эти деньги нельзя будет использовать для оплаты трафика в текущем месяце. Пример: у абонента на счету 200 денег при абонплате в 50 денег — в этом случае ему будет показано 150 денег в авторизаторе и он сможет в текущем месяце израсходовать только 150 денег, но снятие абонплаты не уведет его в «минус».</para></listitem>
+      <listitem><para>FullFee – необязательный параметр, указывающий серверу снимать полную абонплату, даже если учетная запись абонента была заморожена (или не существовала) часть учетного периода. Принимает значения yes и no, по умолчанию установлен в no.</para></listitem>
+      <listitem><para>MessagesTimeout — необязательный параметр, устанавливающий время жизни не отправленных сообщений абонентам. Время указывается в сутках. При превышении этого времени сообщение будет удалено, в т. ч. из БД. Если указано значение 0 то не отправленные сообщения никогда не будут удаляться из базы (в частности, это приведет к постепенному росту размера базы, увеличению нагрузки на сервер при авторизации абонентов и к тому что долго отсутствовавший абонент при авторизации получит все пропущенные сообщения). По умолчанию имеет значение 0.</para></listitem>
+      <listitem><para>FeeChargeType — необязательный параметр, регулирующий процесс снятия абонплаты. Может принимать значения 0, 1 и 2, по умолчанию имеет значение 0. При значении 0 абонплата снимается как обычно, при значении 1 абонплата снимается только если баланс пользователя положительный или равен нулю, при значении 2 абонплата снимается только если баланс пользователя больше или равен абонплате. Значение 2 следует использовать с осторожностью, т. к. при этом на безлимитных тарифах абоненты получат услугу бесплатно.</para></listitem>
+      <listitem><para>ReconnectOnTariffChange — необязательный параметр, указывающий серверу выполнить переподключение пользователя при смене тарифа. Может принимать значения yes и no, по умолчанию имеет значение no. При указании значения yes подключенные пользователи будут отключены непосредственно перед сменой тарифа и подключены сразу после нее. Может быть полезно для управления шейпером.</para></listitem>
+      <listitem>
+        <para>ScriptParams — необязательный параметр, который определяет дополнительный набор данных передаваемых в скрипты OnConnect и OnDisconnect. По умолчанию этот параметр пуст. В нем можно указать названия полей записи пользователя, разделенных пробелами, значения которых будут переданы в скрипты после стандартного набора, включающего login, ip, cash, id и dirs. Допустимые имена полей:</para>
+        <programlisting linenumbering="unnumbered">"cash", "upload", "download", "lastCashAdd", "passiveTime", "lastCashAddTime", "freeMb", "lastActivityTime", "password", "passive", "disabled", "disabledDetailStat", "alwaysOnline", "tariffName", "nextTariff", "address", "note", "group", "email", "phone", "realName", "credit", "creditExpire", "ips", "userdata0" ... "userdata9".</programlisting>
+        <para>Так, например, если указать ScriptParams = tariffName userdata0 то список параметров передаваемых в скрипты будет: login, ip, cash, id, dirs, tariffName, userdata0. Названия параметров регистронезависимые.</para>
+      </listitem>
+      <listitem><para>DisableSessionLog — необязательный параметр позволяющий отключать запить сессий пользователя в БД. Может принимать значения yes и no. По умолчанию установлен в no, то есть запись сессий включена.</para></listitem>
+      <listitem><para>FilterParamsLog — необязательный параметр который позволяет фильтровать запись в журнал изменений параметров. Может принимать значения "*" (разрешена запись жернала для всех параметров) или список названий полей записи пользователя, разделенный пробелами. Допустимые имена полей такие-же как и для ScriptParams. По умолчанию имеет значение "*", то есть разрешено журналирование всех параметров. Если указать FilterParamsLog = cash tariffName password то в журнал изменений будут попадать только изменения параметров cash, tariffName и password. Изменения других параметров, например note, group или address в журнал не попадут.</para></listitem>
+      <listitem><para>Для именования направлений учета трафика в конфигурационном файле используется секция DirNames:</para>
+      <programlisting linenumbering="unnumbered">
+      &lt;DirNames&gt;
+        DirName0 = «ИМЯ НАПРАВЛЕНИЯ»
+        ...
+        DirName9 = ПОСЛЕДНЕЕ_НАПРАВЛЕНИЕ
+      &lt;/DirNames&gt;
+      </programlisting>
+      <para>Всего предусмотрено 10 направлений с нумерацией от 0 до 9. Направления, наименование которых состоит из нескольких слов, должны быть заключены в кавычки. Если наименование направления не указано, то система считает что данное направление не используется и не будет производить по нему никаких действий. Пример: DirName0 = Мир, DirName5 = "Локальные игры". Необходимо заметить, что текущая версия системы требует, чтобы имена направлений были указаны в кодировке KOI8-R. В противном случае абоненты не смогут их прочитать в статистике авторизатора, а администраторы — в конфигураторе.</para></listitem>
+    </itemizedlist>
+    <para>Настройки всех модули (кроме store module), которые необходимо подключить к серверу в момент старта должны быть указанны внутри секции Modules:</para>
+    <programlisting linenumbering="unnumbered">
+    &lt;Modules&gt;
+      &lt;Module имя_модуля&gt;
+      список параметров модуля
+      &lt;/Module&gt;

 
 

-        &lt;/Module&gt;
-        </programlisting>
-        <para>Описание глобальных параметров параметров:</para>
-        <itemizedlist mark="opencircle">
-            <listitem><para>Rules – параметр, указывающий серверу, где находится файл с правилами для подсчета трафика клиентов, по умолчанию Rules=/etc/stargazer/rules</para></listitem>
-            <listitem><para>LogFile – параметр, указывающий серверу расположение файла, в который будут заноситься все сообщения системы, по умолчанию LogFile=/var/log/stargazer.log</para></listitem>
-            <listitem><para>PidFile — параметр, указывающий серверу где находится файл хранящий PID (идентификатор процесса) дэмона, по умолчанию это /var/run/stargazer.pid. Используется скриптами запуска/останова.</para></listitem>
-            <listitem><para>ModulesPath – параметр, указывающий серверу путь, где находятся подключаемые модули (плагины). По умолчанию ModulesPath = /usr/lib/stg.</para></listitem>
-            <listitem><para>DetailStatWritePeriod – параметр, указывающий серверу через какое время должна записываться детальная статистика клиента, по умолчанию StatTime=1/6. Данный параметр может принимать следующие значения: 3 - раз в три часа, 2 - раз в два часа, 1 - раз в чаc, 1/2 - раз в пол часа, 1/4 - раз в 15 минут, 1/6 - раз в 10 минут.</para></listitem>
-            <listitem><para>StatWritePeriod – параметр, указывающий серверу периодичность записи в БД информации о статистике пользователя (в минутах). При большом количестве пользователей эту величину стоит увеличить, так как запись в БД может занимать длительное время. По умолчанию StatWritePeriod = 10.</para></listitem>
-            <listitem><para>DayFee – параметр, показывающий серверу, в какой день месяца снимать с клиентских счетов сумму абонплаты, в соответствии с тарифными планами клиентов. По умолчанию DayFee=21. Следует помнить, что в некоторых месяцах не более 28 дней. Данный параметр также может принять значение 0; если параметр равен 0, тогда система выполнит действия в последний день текущего месяца; определение последнего дня месяца проводится автоматически.</para></listitem>
-            <listitem><para>DayResetTraff – параметр указывает серверу в какой день месяца очищать статистику клиентов; так же в этот день сервер осуществляет переход на новый тариф, если он был изменен у клиента. По умолчанию DayResetTraff = 28. Следует помнить, что в некоторых месяцах не более 28 дней. Данный параметр также может принять значение 0; если параметр равен 0, тогда система выполнит действия в последний день текущего месяца; определение последнего дня месяца проводится автоматически.</para></listitem>
-            <listitem><para>SpreadFee – параметр, указывающий серверу, производить ли «размазанное» снятие абонплаты. Т. е. сумма абонплаты указанная в тарифе пользователя будет сниматься не раз в месяц, а каждый день ровными долями. По умолчанию SpreadFee = no.</para></listitem>
-            <listitem><para>FreeMbAllowInet – параметр, указывающий серверу выполнять ли для пользователя скрипт OnConnect, если у него на балансе отсутствуют средства, но остался предоплаченный трафик. По умолчанию FreeMbAllowInet = no.</para></listitem>
-            <listitem><para>WriteFreeMbTraffCost – параметр, определяющий, что будет писаться в стоимость трафика в детальной статистике. Если у клиента еще есть предоплаченный трафик и WriteFreeMbTraffCost = no, то в детальную статистику будет записываться стоимость со значением = 0. Если у пользователя уже нет предоплаченного трафика и WriteFreeMbTraffCost = no, то в детальную статистику будет записана стоимость трафика. При WriteFreeMbTraffCost = yes стоимость трафика будет записана в любом случае. По умолчанию WriteFreeMbTraffCost = no.</para></listitem>
-            <listitem><para>DayFeeIsLastDay – параметр, указывающий серверу, когда абонплата снимается в последний (yes) или первый (no) день учетного периода. Это влияет на то, как будет снята абонплата (АП) при переходе на новый тариф. Если у пользователя был тариф A с АП=100 и он хочет перейти на тариф B с АП=200, то при переходе на новый тариф со счета пользователя снимется 100, если DayFeeIsLastDay = yes, и 200, если DayFeeIsLastDay = no. По умолчанию DayFeeIsLastDay = yes.</para></listitem>
-            <listitem><para>ExecutersNum – параметр который показывает, сколько процессов исполнителя скриптов может быть запущено одновременно. Количество процессов означает сколько скриптов могут выполнятся одновременно. По умолчанию ExecutersNum = 1. Если выполнение ваших скриптов занимает много времени следует увеличить это значение. Каждый исполнитель скриптов блокируется на время, пока отработает скрипт. Если исполнителей несколько — они принимают скрипты на выполнение по принципу «кто успел».</para></listitem>
-            <listitem><para>StgMsgKey – параметр отвечающий за идентификатор очереди сообщений для исполнителя скриптов. По умолчанию данный параметр закомментирован и равен 5555. Рекомендуется не изменять значение параметра без нужды. Его изменение целесообразно лишь в том случае, если в системе требуется запустить более одной копии сервера биллинга.</para></listitem>
-            <listitem><para>ShowFeeInCash – показывать на счету и позволять использовать абонплату пользователю. Принимает значения yes и no. Параметр не является обязательным, по умолчанию установлен в yes.</para></listitem>
-            <listitem><para>FullFee – снимать полную абонплату, даже если пользователь был заморожен часть учетного периода. Принимает значения yes и no. Параметр не является обязательным, по умолчанию установлен в no.</para></listitem>
-            <listitem><para>MessagesTimeout — устанавливает время жизни не отправленных сообщений пользователям. Время указывается в сутках. При превышении этого времени сообщение будет удалено, в т.ч. из БД. Если указан 0 то значения не будут удаляться из базы. По умолчанию 0.</para></listitem>
-            <listitem><para>FeeChargeType — регулирует процесс снятия абонплаты. Может принимать значения 0, 1 и 2. При значении 0 абонплата снимается как обычно. При значении 1 абонплата снимается только если баланс пользователя положительный. При значении 2 абонплата снимается только если баланс пользователя больше абонплаты.</para></listitem>
-            <listitem><para>ReconnectOnTariffChange — позволяет выполнить переподключение пользователя при смене тарифа. Может принимать значения yes и no. При указании ReconnectOnTariffChange = yes при смене тарифа пользователя если он был подключен произойдет его отключение и подключение заново. Может быть полезно для управления шейпером.</para></listitem>
-            <listitem><para>Именования направлений в конфигурационном файле должны быть заключены в теги:
-                <programlisting linenumbering="unnumbered">
-                &lt;DirNames&gt;
-                    DirName0 = "ИМЯ НАПРАВЛЕНИЯ"
-                    ...
-                    DirName9 = ПОСЛЕДНЕЕ_НАПРАВЛЕНИЕ
-                &lt;/DirNames&gt;
-                </programlisting>
-                Всего предусмотрено 10 направлений с нумерацией от 0 до 9. Внутри данных тегов указывается названия направлений. Направления, наименование которых состоит из нескольких слов, должны быть заключены в кавычки. Если наименование направления не указано, то система считает что данное направление не используется и не будет производить по нему никаких действий. Пример: DirName0 = Локаль, DirName5 = "Локальные игры". Необходимо заметить, что текущая версия системы требует, чтобы имена направлений были указаны в кодировке KOI8-R. В противном случае пользователи не смогут их прочитать в статистике авторизатора, а администраторы — в конфигураторе.</para></listitem>
+      &lt;Module имя_модуля&gt;
+      список параметров модуля
+      &lt;/Module&gt;
+    &lt;/Modules&gt;
+    </programlisting>
+    <para>Если модуль не имеет настраиваемых параметров, то он все равно должен быть указан. Некоторые модули, такие как store module, обязательно требуются при старте и без их подключения система не может быть запущена. По умолчанию для указания конфигурации модулей используются отдельные файлы из каталога conf-enabled.d. Для этого используется директива &lt;IncludeFile ПУТЬ_К_ФАЙЛУ&gt;&lt;/IncludeFile&gt;. Одна директива указана в секции Modules, а вторая в корне файла конфигурации (для store module).</para>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля InetAccess (auth_ia) для работы с авторизаторами абонентов:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Port – обязательный параметр, определяющий на каком порту сервер будет принимать обращения авторизаторов абонентов. Стандартное значение: 5555.</para></listitem>
+      <listitem><para>UserTimeout – обязательный параметр, указывающий серверу, через какое время в секундах абонент будет отключен если авторизатор не отвечает серверу на запросы. Может принимать значения от 15 до 1200, стандартное значение: 65.</para></listitem>
+      <listitem><para>UserDelay – обязательный параметр, указывающий серверу время в секундах, через которое происходит опрос авторизатора абонента. Сервер шлет абоненту запрос подтверждения работы авторизатора, а авторизатор абонента должен прислать ответ что он находится в рабочем состоянии. Так же это время, через которое в авторизаторе обновляется статистика. Может принимать значения от 5 до 600, стандартное значение: 60. Следует заметить что значение UserDelay должно быть меньше чем значение UserTimeout.</para></listitem>
+      <listitem>
+        <para>FreeMb – обязательный параметр, определяющий в каком виде абоненту будет показано значение FreeMb. Данный параметр может принимать следующие значения:</para>
+        <itemizedlist mark="none">
+          <listitem><para>0 - количество бесплатных мегабайт в пересчете на цену нулевого направления;</para></listitem>
+          <listitem><para>1 - количество бесплатных мегабайт в пересчете на цену первого направления;</para></listitem>
+          <listitem><para>2 - количество бесплатных мегабайт в пересчете на цену второго направления;</para></listitem>
+          <listitem><para>...</para></listitem>
+          <listitem><para>9 - количество бесплатных мегабайт в пересчете на цену девятого направления;</para></listitem>
+          <listitem><para>cash - количество денег на которые клиент может бесплатно работать;</para></listitem>
+          <listitem><para>none - ничего не передавать.</para></listitem>

         </itemizedlist>
         </itemizedlist>

-        <para>Все модули (кроме Store module), которые необходимо подключить к серверу в момент старта должны идти внутри секции:</para>
-        <programlisting linenumbering="unnumbered">
-        &lt;Modules&gt;
-            &lt;Module [имя модуля]&gt;
-                ПАРАМЕТРЫ_МОДУЛЯ
-            &lt;/Module&gt;
-        &lt;/Modules&gt;
-        </programlisting>
-        <para>Если модуль не имеет настраиваемых параметров, то он все равно должен задаваться в тегах Module … /Module чтобы быть успешно загруженным. Некоторые модули, такие как store module обязательно требуются при старте и без их подключения система не может быть запущена. По умолчанию для указания конфигурации модулей используются отдельные файлы из каталога conf-enabled.d. Для этого используется директива &lt;IncludeFile ПУТЬ_К_ФАЙЛУ&gt;&lt;/IncludeFile&gt;. Одна директива указана в секции &lt;Modules&gt;, а вторая в корне файла конфигурации (для store module).</para>
-        <formalpara>
-            <title>Описание параметров модуля InetAccess (auth_ia) для работы с клиентскими авторизаторами:</title>
-            <itemizedlist mark="opencircle">
-                <listitem><para>Port – параметр, определяющий на каком порту сервер будет принимать обращения авторизаторов клиентов, по умолчанию UserPort=5555.</para></listitem>
-                <listitem><para>UserTimeout – параметр, показывающий серверу, через какое время в секундах клиент будет отключен, если авторизатор не отвечает серверу на запросы. По умолчанию UserTimeout=60. Значение данного параметра должно лежать в диапазоне от 15 до 1200.</para></listitem>
-                <listitem><para>UserDelay – время в секундах, через которое сервер опрашивает клиента. Сервер шлет клиенту запрос подтверждения работы авторизатора, а клиент должен прислать ответ что авторизатор находится в рабочем состоянии. Так же это время, через которое у клиента обновляется статистика, по умолчанию UserDelay=5. Следует заметить что значение UserDelay должно быть в 3…10 раз меньше чем значение UserTimeout и данные значения не могут содержать одинаковые таймауты. Значение данного параметра должно лежать в диапазоне от 5 до 600.</para></listitem>
-                <listitem>
-                    <para>FreeMb – параметр, указывающий серверу что будет передаваться авторизатору клиента от сервера. Данный параметр может принимать следующие значения:</para>
-                    <itemizedlist mark="none">
-                        <listitem><para>0 - количество бесплатных мегабайт в пересчете на цену нулевого направления;</para></listitem>
-                        <listitem><para>1 - количество бесплатных мегабайт в пересчете на цену первого направления;</para></listitem>
-                        <listitem><para>2 - количество бесплатных мегабайт в пересчете на цену второго направления;</para></listitem>
-                        <listitem><para>...</para></listitem>
-                        <listitem><para>9 - количество бесплатных мегабайт в пересчете на цену девятого направления;</para></listitem>
-                        <listitem><para>cash - количество денег на которые клиент может бесплатно работать;</para></listitem>
-                        <listitem><para>none - ничего не передавать.</para></listitem>
-                    </itemizedlist>
-                </listitem>
-                <listitem><para></para></listitem>
-                <listitem><para></para></listitem>
-                <listitem><para></para></listitem>
-                <listitem><para></para></listitem>
-                <listitem><para></para></listitem>
-                <listitem><para></para></listitem>
-                <listitem><para></para></listitem>
+      </listitem>
+      <listitem><para>LogProtocolErrors – не обязательный параметр, включающий расширенное журналирование ошибок протокола. Может принимать значения yes или no, значение по умолчанию: no.</para></listitem>
+    </itemizedlist>
+    <para>Обмен данными авторизатора с сервером осуществляется по протоколу UDP. Можно указать несколько модулей авторизатора auth_ia для авторизации с разных портов.</para>
+  </simplesect>
+  <simplesect>
+    <title>Модуль авторизации auth_ao.</title>
+    <para>Модуль параметров не имеет. Используется для поддержки режима Always Online у абонентов. Без включения этого модуля установка параметра alwaysOnline для абонента эффекта иметь не будет. В режиме Always Online абонент находится в авторизованном состоянии все время, независимо от использования авторизатора. Тем не менее он может быть отключен по причине отсутствия средств на счету, заблокирован администратором или «заморожен». В этом режиме так же возможно использование авторизатора за одним исключением — абонент не может сам вызвать «отключение».</para>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля SGConfig (conf_sg) для работы с конфигуратором:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Port – обязательный параметр, определяющий, на каком порту сервер будет принимать обращения конфигураторов. Стандартное значение: 5555.</para></listitem>
+    </itemizedlist>
+    <para>Обмен конфигуратора с сервером осуществляется по протоколу TCP. Можно указать несколько модулей конфигуратора с указанием разных портов.</para>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля файловой БД:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>WorkDir – обязательный параметр, указывающий серверу где находится рабочая директория с файлами БД. Стандартное значение: /var/stargazer.</para></listitem>
+      <listitem><para>ConfOwner, ConfGroup, ConfMode – обязательные параметры, описывающие владельца, группу и права доступа на файлы конфигурации (conf) абонента соответственно. ConfOwner должен содержать корректное имя пользователя системы (см. файл /etc/passwd), стандартное значение: root. ConfGroup должен содержать корректное название группы в системе (см. файл /etc/group), стандарное значение: root. ConfMode должен содержать корректные права на файл (только ugo-биты), стандартное значение: 640.</para></listitem>
+      <listitem><para>StatOwner, StatGroup, StatMode – обязательные параметры, описывающие владельца, группу и права доступа на файлы статистики (stat) абонента соответственно. StatOwner должен содержать корректное имя пользователя системы (см. файл /etc/passwd), стандартное значение: root. StatGroup должен содержать корректное название группы в системе (см. файл /etc/group), стандарное значение: root. StatMode должен содержать корректные права на файл (только ugo-биты), стандартное значение: 640.</para></listitem>
+      <listitem><para>UserLogOwner, UserLogGroup, UserLogMode – обязательные параметры, описывающие владельца, группу и права доступа на файлы журналов (log) абонента соответственно. UserLogOwner должен содержать корректное имя пользователя системы (см. файл /etc/passwd), стандартное значение: root. UserLogGroup должен содержать корректное название группы в системе (см. файл /etc/group), стандарное значение: root. UserLogMode должен содержать корректные права на файл (только ugo-биты), стандартное значение: 640.</para></listitem>
+    </itemizedlist>
+    <para>При создании каталогов (например для записи детальной статистики) используются те-же права, но с добавлением x-бита для всех ненулевых полей. Например: для 640 будут права 750, а для 644 будут 755. Для записи детальной статистики используются параметры StatOwner, StatGroup и StatMode. Для записи сообщений используются параметры ConfOwner, ConfGroup и ConfMode.</para>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля для работы с СУБД Firebird:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Server – необязательный параметр, описывающий адрес сервера, на котором расположена СУБД. Может быть доменным именем или IP-адресом. Значение по умолчанию: localhost.</para></listitem>
+      <listitem><para>Database – необязательный параметр, описывающий путь к БД на сервере или ее псевдоним (alias). Значение по умолчанию: /var/stg/stargazer.fdb.</para></listitem>
+      <listitem><para>User – необязательный параметр, описывающий имя пользователя БД. Значение по умолчанию: stg.</para></listitem>
+      <listitem><para>Password – необязательный параметр, описывающий пароль пользователя БД. Значение по умолчанию: 123456.</para></listitem>
+      <listitem><para>IsolationLevel — Не обязательный параметр, описывающий уровень изоляции транзакций. Может принимать значения:</para>
+        <itemizedlist mark="square">
+          <listitem><para>Concurrency (используется по умолчанию);</para></listitem>
+          <listitem><para>DirtyRead;</para></listitem>
+          <listitem><para>ReadCommitted;</para></listitem>
+          <listitem><para>Consistensy.</para></listitem>
+        </itemizedlist>
+        </listitem>
+      <listitem><para>LockResolution — Не обязательный параметр, описывающий действие при блокировке. Может принимать значения значения:</para>
+        <itemizedlist mark="square">
+          <listitem><para>Wait (используется по умолчанию);</para></listitem>
+          <listitem><para>NoWait.</para></listitem>
+        </itemizedlist>
+        </listitem>
+    </itemizedlist>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля для работы с СУБД PostgreSQL:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Server – необязательный параметр, описывающий адрес сервера, на котором расположена СУБД. Может быть доменным именем или IP-адресом. Значение по умолчанию: localhost.</para></listitem>
+      <listitem><para>Database – необязательный параметр, описывающий имя БД. Значение по умолчанию: stargazer.</para></listitem>
+      <listitem><para>User – необязательный параметр, описывающий имя пользователя БД. Значение по умолчанию: stg.</para></listitem>
+      <listitem><para>Password – необязательный параметр, описывающий пароль пользователя БД. Значение по умолчанию: 123456.</para></listitem>
+      <listitem><para>Retries — необязательный параметр, описывающий количество попыток переподключения к СУБД в случае потери связи. Попытки производятся с интервалом в 1 секунду. Значение по умолчанию: 3.</para></listitem>
+    </itemizedlist>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля для работы с СУБД MySQL:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Server – обязательный параметр, описывающий адрес сервера, на котором расположена СУБД. Стандартное значение: localhost.</para></listitem>
+      <listitem><para>Database – обязательный параметр, описывающий название БД. Стандартное значение: stg.</para></listitem>
+      <listitem><para>User – обязательный параметр, описывающий имя пользователя БД. Стандартное значение: stg.</para></listitem>
+      <listitem><para>Password – обязательный параметр, описывающий пароль пользователя БД. Стандартное значение: 123456.</para></listitem>
+    </itemizedlist>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля ping для пингования абонентов:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>PingDelay – обязательный параметр, определяющий, время в секундах между пингами одного и того же абонента. Стандартное значение: 15.</para></listitem>
+    </itemizedlist>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля Remote Script Executer (remote_script) для передачи команд на исполнение скриптов на NAS:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>SendPeriod – обязательный параметр, определяющий время в секундах между посылками подтверждений того, что клиент находится в состоянии Online. Стандартное значение: 15.</para></listitem>
+      <listitem><para>Password – обязательный параметр, определяющий пароль для шифрования обмена между сервером биллинга и клиентом. Стандартное значение: 123456.</para></listitem>
+      <listitem><para>UserParams – обязательный параметр, определяющий какие параметры и в каком порядке передаются на NAS. Названия параметров должны быть разделены пробелом. Доступными параметрами являются: Cash, FreeMb, Passive, Disabled, AlwaysOnline, TariffName, NextTariff, Address, Note, Group, Email, RealName, Credit, EnabledDirs, Userdata0...Userdata9. Стандартное значение: Cash Tariff EnabledDirs.</para></listitem>
+      <listitem><para>Port – обязательный параметр, определяющий номер порта через который будет происходить обмен данными между сервером биллинга и клиентом. Может принимать значения от 1 до 65535, стандартное значение: 9999.</para></listitem>
+      <listitem><para>SubnetFile — обязательный параметр, представляющий собой путь к файлу с описанием соответствия сетей и NAS'ов. Стандартное значение: subnets. При указании относительного пути поиск будет производиться в каталоге с настройками (обычно это /etc/stargazer, но может быть переопределено указанием пути в качестве параметра при старте дэмона). Файл имеет формат: &lt;сеть в CIDR-нотации&gt; &lt;адрес NAS'а&gt;. Количество сетей не ограничено. Файл перечитывается заново при посылке процессу сигнала SIGHUP. Если файл содержит ошибки при старте дэмона — система не будет запущена. Если файл содержит ошибки при перечитывании — будут использоваться старые значения.</para></listitem>
+    </itemizedlist>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля radius для поддержки авторизации и аккаунтинга пользователей через сервер FreeRADIUS:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Port — обязательный параметр, определяющий порт, на который будут приходить запросы от FreeRADIUS. Может принимать значение от 1 до 65535, стандартное значение: 6666.</para></listitem>
+      <listitem><para>Password — обязательный параметр, задающий пароль для шифрования данных, передаваемых на FreeRADIUS. Должен совпадать с паролем в настройке плагина FreeRADIUS (rlm_stg.so). Стандартное значение: 123456.</para></listitem>
+      <listitem><para>AuthServices — необязательный параметр, задающий список сервисов которым будет позволена только авторизация с использованием БД Stargazer. При успешной авторизации абонент не переходит в состояние Online и для него не производится подсчет трафика. Названия сервисов в списке должны разделяться пробелами, по умолчанию этот параметр пуст.</para></listitem>
+      <listitem><para>AcctServices — необязательный параметр, задающий список сервисов, по которым будет производится аккаунтинг. При успешной авторизации в этих сервисах абонент переходит в состояние Online и для него производится подсчет трафика. Необходимо заметить, что в этом случае трафик захватывается как обычно, без использования возможностей протокола RADIUS (через пакет аккаунтинга InterimUpdate), т.к. это не позволяет классифицировать полученный трафик по направлениям. Названия сервисов в списке должны разделяться пробелами, по умолчанию этот параметр пуст.</para></listitem>
+    </itemizedlist>
+    <para>Обмен данными между плагином и FreeRADIUS происходит по протоколу UDP.</para>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля XML-RPC (conf_rpc) для поддержки протокола управления XML-RPC:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Port — обязательный параметр, определяющий порт на который будут приходить запросы XML-RPC. Может принимать значения от 1 до 65535, стандартное значение: 8080.</para></listitem>
+      <listitem><para>CookieTimeout — необязательный параметр, задающий время существования авторизационного Cookie в случае отсутствия активности в секундах. Значение по умолчанию: 1800 (30 минут).</para></listitem>
+    </itemizedlist>
+  </simplesect>
+  <simplesect>
+    <title>Модуль захвата трафика cap_ether (только для ОС Linux).</title>
+    <para>Модуль не имеет параметров. Для захвата трафика используются так называемые «raw sockets», которые позволяют получить доступ к Ethernet-фреймам. Перехватывается весь трафик попадающий в сетевую подсистему ядра. При использовании обычной маршрутизации трафик будет посчитан два раза: на входящем интерфейсе и на исходящем. При использовании NAT удвоения трафика не происходит, так как NAT заменяет адрес источника. При интенсивном сетевом обмене или при высокой нагрузке на сервер, на котором происходит захват трафика, модуль может терять отдельные пакеты. Процент потерь тем выше чем выше скорость прохождения пакетов и чем выше загрузка сервера. Модуль рекомендуется использовать для ознакомления или в небольших сетях до 100 абонентов с трафиком до 100 Мбит.</para>
+  </simplesect>
+  <simplesect>
+    <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">
+      <listitem><para>iface — обязательный параметр, определяющий на каком интерфейсе будет происходить захват трафика. Параметр может быть задан более одного раза.</para></listitem>
+    </itemizedlist>
+    <para>Для захвата трафика используется инфраструктура Berkeley Packet Filter, представляющая собой «продвинутый» аналог «raw sockets». Так как интерфейсы для перехвата указываются явно, дублирования трафика при обычной маршрутизации не наблюдается. Фильтрование пакетов не используется, перехват происходит по мере возможности, по этому этот модуль, как и cap_ether, тоже может терять пакеты при высокой нагрузке на сервер или высокой скорости прохождения пакетов. Рекомендуется использовать для ознакомления или для небольших сетей до 100 абонентов с трафиком до 100 Мбит.</para>
+  </simplesect>
+  <simplesect>
+    <title>Модуль захвата трафика cap_divert (только для ОС FreeBSD).</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Port — необязательный параметр, указывающий порт на который будет происходить перенаправление трафика. Значение по умолчанию: 15701.</para></listitem>
+      <listitem><para>DisableForwarding — необязательный параметр, отключающий форвардинг пакетов. Значение по умолчанию: no.</para></listitem>
+    </itemizedlist>
+    <para>Для захвата трафика используются divert-сокеты. Как и IPQ эта технология использует прохождение пакетов через пространство пользователя. Для работы модуля требуется поддержка divert-сокетов в ядре и специальная настройка файрвола. Для передачи пакета в пространство пользователя в файрволе используется правило divert или tee. Первое правило работает аналогично цели QUEUE для iptables — пропускает пакет через пространство пользователя перед отправкой. Соответственно, это может вызвать те-же проблемы с пропускной способностью роутера. Правило tee передает в пространство пользователя копию пакета, а оригинал отправляет дальше. Такой подход позволяет избежать снижения пропускной способности сервера при высокой нагрузке на него, так как исключается ожидание пакета в время его нахождения в пространстве пользователя. При использовании правила tee рекомендуется отключать форвардинг пакетов.</para>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля cap_nf для захвата трафика:</title>
+    <itemizedlist mark="opencircle">
+      <listitem><para>TCPPort — необязательный параметр, указывающий порт который будет использоваться для приема данных при работе с NetFlow-proxy. Стандартное значение: 9996. Если параметр не указан — прием по протоколу TCP производиться не будет.</para></listitem>
+      <listitem><para>UDPPort — необязательный параметр, указывающий порт для приема NetFlow-дагарамм. Стандартное значение: 9996. Если параметр не указан — прием датаграмм по протоколу UDP производиться не будет.</para></listitem>
+    </itemizedlist>
+    <para>В явном виде захват трафика не происходит. Данные о нем поступают от NetFlow-сенсора посредством протокола NetFlow. Это позволяет физически разделить перехват трафика и его учет. NetFlow-сенсор перехватывает трафик, и собирает данные о сессиях (в контексте UDP это передача данных между двумя портами в одном направлении). Информация о сессии включает в себя IP-адреса источника и назначения потока пакетов, номера портов источника и назначения, суммарную длину пакетов и различные дополнительные данные. NetFlow-трафик существенно меньше трафика, который он описывает, так как передается мета-информация а не сами данные. С учетом этого факта и того что биллинговый сервер теперь может не заниматься маршрутизацией пакетов и NAT'ом это существенно снижает нагрузку на него. Этот плагин рекомендуется использоваться в крупных сетях с развитой топологией, включающей несколько NAS'ов. Возможно использование совместно с аппаратными маршрутизаторами Cisco (они единственные имеют лицензию на аппаратную реализацию NetFlow). В качестве NetFlow-сенсоров можно использовать такие утилиты как fprobe, softflowd или ipcad. Так же можно использовать модуль ядра ipt_netflow (Linux) или ng_netflow (FreeBSD).</para>
+    <itemizedlist mark="opencircle">
+      <listitem><para>Server — обязательный параметр, указывающий IP-адрес сервера на котором находится snmpd. Стандартное значение: 127.0.0.1.</para></listitem>
+      <listitem><para>Port — обязательный параметр, указывающий порт на сервере через который будет происходить взаимодействие с snmpd. Стандартное значение: 199.</para></listitem>
+      <listitem><para>Password — необязательный параметр, задающий пароль для авторизации плагина в snmpd. По умолчанию пароль не используется.</para></listitem>
+    </itemizedlist>
+  </simplesect>
+  <simplesect>
+    <title>Описание параметров модуля smux для мониторинга состояния Stargazer:</title>
+    <para>Модуль позволяет производить мониторинг биллинга средствами протокола SNMP. Он не реализует полноценный SNMP-сервер а лишь взаимодействует с существующим дэмоном snmpd, регистрируясь в нем для обслуживания определенного дерева параметров. В комплекте с биллингом идет MIB, описывающий доступные параметры для мониторинга. Параметры разделены на 6 секций, находящихся в узле stg24:</para>
+    <itemizedlist mark="opencircle">
+      <listitem><para>users (1) — секция, содержащая параметры относящиеся к абонентам:</para>
+        <itemizedlist mark="square">
+          <listitem><para>totalUsers (1) — параметр, описывающий общее количество абонентов в системе;</para></listitem>
+          <listitem><para>onlineUsers (2) — параметр, описывающий количество подключенных абонентов;</para></listitem>
+          <listitem><para>authorizedUsers (3) — параметр, описывающий количество авторизованных абонентов в системе;</para></listitem>
+          <listitem><para>alwaysOnlineUsers (4) — параметр, описывающий количество абонентов работающих в режиме always online;</para></listitem>
+          <listitem><para>noCashUsers (5) — параметр, описывающий количество абонентов с нулевым или отрицательным балансом;</para></listitem>
+          <listitem><para>disabledDetailStatsUsers (6) — параметр, описывающий количество абонентов с отключенным учетом детальной статистики;</para></listitem>
+          <listitem><para>disabledUsers (7) — параметр, описывающий количество принудительно отключенных абонентов;</para></listitem>
+          <listitem><para>passiveUsers (8) — параметр, описывающий количество «замороженных» абонентов;</para></listitem>
+          <listitem><para>creditUsers (9) — параметр, описывающий количество абонентов с положительным кредитом;</para></listitem>
+          <listitem><para>freeMbUsers (10) — параметр, описывающий количество абонентов с неизрасходованными «бесплатными мегабайтами»;</para></listitem>
+          <listitem><para>tariffChangeUsers (11) — параметр, описывающий количество абонентов у которых с началом месяца будет изменен тариф;</para></listitem>
+          <listitem><para>activeUsers (12) — параметр, описывающий количество абонентов у которых имеется посчитанный трафик за сессию.</para></listitem>
+        </itemizedlist>
+      </listitem>
+      <listitem><para>tariffs (2) — секция, содержащая параметры относящиеся к тарифам:</para>
+        <itemizedlist mark="square">
+          <listitem><para>totalTariffs (1) — параметр, описывающий общее количество тарифов;</para></listitem>
+          <listitem><para>tariffUsageTable (2) — таблица использования тарифов, состоит из записей вида:</para>
+            <itemizedlist mark="square">
+              <listitem><para>tariffIndex (1) — числовой индекс в таблице;</para></listitem>
+              <listitem><para>tariffName (2) — название тарифа (строка);</para></listitem>
+              <listitem><para>userCount (3) — количество абонентов использующих этот тариф.</para></listitem>

             </itemizedlist>
             </itemizedlist>

-        </formalpara>
-    </simplesect>
+            </listitem>
+        </itemizedlist>
+      </listitem>
+      <listitem><para>admins (3) — секция, содержащая параметры относящиеся к администраторам системы:</para>
+        <itemizedlist mark="square">
+          <listitem><para>totalAdmins (1) — параметр, описывающий общее количество администраторов, зарегистрированных в системе.</para></listitem>
+        </itemizedlist>
+      </listitem>
+      <listitem><para>services (4) — секция, содержащая параметры относящиеся к услугам:</para>
+      <itemizedlist mark="square">
+          <listitem><para>totalServices (1) — параметр, описывающий общее количество услуг по которым ведется учет в системе.</para></listitem>
+        </itemizedlist>
+      </listitem>
+      <listitem><para>traffcounter (6) — секция, содержащая параметры относящиеся к учету трафика:</para>
+      <itemizedlist mark="square">
+          <listitem><para>totalRules (1) — параметр, описывающий общее количество правил классификации трафика.</para></listitem>
+        </itemizedlist>
+      </listitem>
+    </itemizedlist>
+    <para>К параметрам можно обращаться по цифровым OID'ам или по именам. Для обращения к параметрам по именам нужно предоставить системе файл STG-MIB.mib содержащий информацию об именах, типах и OID'ах параметров с кратким описанием. Этот файл можно поместить в каталог ~/.snmp/mibs (в этом случае он будет доступен лишь одному пользователю) или в каталог /usr/share/snmp/mibs (в этом случае он будет доступен всем пользователям системы). Так же большинство утилит позволяют загружать mib-файлы из произвольного места явным указанием пути к ним. Для доступа к параметрам можно использовать утилиты из пакета NetSNMP (http://net-snmp.sourceforge.net/). Для того чтобы просмотреть иерархию параметров можно выполнить такую команду: snmptranslate -m +STG-MIB -Tp -IR stg24. Вывод команды должен быть приблизительно таким:</para>
+    <programlisting linenumbering="unnumbered">
+    +--stg24(1)
+       |
+       +--users(1)
+       |  |
+       |  +-- -R-- Integer32 totalUsers(1)
+       |  +-- -R-- Integer32 onlineUsers(2)
+       |  +-- -R-- Integer32 authorizedUsers(3)
+       |  +-- -R-- Integer32 alwaysOnlineUsers(4)
+       |  +-- -R-- Integer32 noCashUsers(5)
+       |  +-- -R-- Integer32 disabledDetailStatsUsers(6)
+       |  +-- -R-- Integer32 disabledUsers(7)
+       |  +-- -R-- Integer32 passiveUsers(8)
+       |  +-- -R-- Integer32 creditUsers(9)
+       |  +-- -R-- Integer32 freeMbUsers(10)
+       |  +-- -R-- Integer32 tariffChangeUsers(11)
+       |  +-- -R-- Integer32 activeUsers(12)
+       |
+       +--tariffs(2)
+       |  |
+       |  +-- -R-- Integer32 totalTariffs(1)
+       |  |
+       |  +--tariffUsageTable(2)
+       |     |
+       |     +--tariffUsageTableEntry(1)
+       |        |  Index: tariffIndex
+       |        |
+       |        +-- ---- Integer32 tariffIndex(1)
+       |        |        Range: 0..255
+       |        +-- -R-- String    tariffName(2)
+       |        |        Textual Convention: DisplayString
+       |        |        Size: 0..255
+       |        +-- -R-- Integer32 userCount(3)
+       |
+       +--admins(3)
+       |  |
+       |  +-- -R-- Integer32 totalAdmins(1)
+       |
+       +--services(4)
+       |  |
+       |  +-- -R-- Integer32 totalServices(1)
+       |
+       +--corporations(5)
+       |  |
+       |  +-- -R-- Integer32 totalCorporations(1)
+       |
+       +--traffcounter(6)
+          |
+          +-- -R-- Integer32 totalRules(1)
+
+    </programlisting>
+    <para>Если в качестве ответа будет строчка «Unknown object identifier: stg24» то это означает что команда не смогла найти mib-файл. Для исправления этой ошибки следует либо скопировать файл STG-MIB.mib по одному из указанных выше путей или указать путь к каталогу где он находится с помощью ключа -M. Символ «+» перед STG-MIB обозначает что данные этого файла должны использоваться совместно с загружаемыми по умолчанию. Без этого символа данные будут использоваться автономно. Ключ -M работает схожим образом: символ «+» говорит о том что указанный путь нужно добавить к путям поиска mib-файлов, используемым по умолчанию. Без символа «+» будет использоваться единственный путь — указанный.</para>
+    <para>Для доступа к значениями параметров можно использовать следующую команду: snmpget -v2c -ccommunity_w -m +STG-MIB 10.0.0.1 stg24.users.totalUsers. Ключ -v указывает используемую версию протокола. На сегодняшний день существует 3 версии протокола: 1, 2 и 3. Версия 1 считается устаревшей и почти не используется. Версия 2 существует в двух модификациях: user-based (с суффиксом «u») и community-based (с суффиксом «c»). Версия 3 является самой новой и предоставляет широкие средства аутентификации, контроля целостности и шифрования. Ключ -c задает community для доступа к серверу. Ключ -m позволяет подключать дополнительные mib-файлы. При использовании доступа к параметрам по названию необходимо подключить mib-файл STG-MIB. Далее следуют два аргумента: адрес SNMP-сервера и название параметра. Утилита snmpget позволяет получить значение скалярных параметров — параметров имеющих только одно значение. Для доступа к таблицам и деревьям используется утилита snmpwalk имеющая такой-же синтаксис.</para>
+    <para>Можно обращаться к параметрам по цифровому OID: snmpwalk -v2c -ccommunity_w 10.0.0.1 .1.3.6.1.4.1.38313.1.2. В этом случае загружать дополнительные mib-файлы не требуется. «.1.3.6.1.4.1» - OID enterprise-ветки всего дерева SNMP. «38313» - официально полученный от IANA (http://www.iana.org) enterprise-номер, уникально идентифицирующий дерево параметров Stargazer. Следующая за ним цифра 1 говорит о том что мы работаем с узлом stg24. «.1.3.6.1.4.1.38313.1.2» - OID таблицы tariffUsageTable.</para>
+    <para>Для того чтобы установить взаимодействие между плагином smux и дэмоном snmpd нужно провести дополнительную настройку последнего. А именно: указать в конфигурационном файле (обычно это /stc/snmp/snmpd.conf) параметр smuxpeer (OID обслуживаемый плагином, в нашем случае это .1.3.6.1.4.1.38313) и smuxsocket (IP-адрес с которого будут приходить пакеты от smux-плагина).</para>
+  </simplesect>
+  <simplesect>
+    <title>Конфигурационный файл /etc/stargazer/rules</title>
+    <para>Файл rules описывает парвила классификации трафика по направлениям тарификации. Это текстовый файл, каждая строка которого описывает одно правило классификации. Формат строки файла:</para>
+  <programlisting linenumbering="unnumbered">  
+  &lt;протокол&gt; &lt;CIDR&gt;[:&lt;порт&gt;[-&lt;порт&gt;]] &lt;направление&gt;
+  </programlisting>
+  <para>Допустимы следующие варианты указания протокола:</para>
+  <itemizedlist mark="opencircle">
+    <listitem><para>TCP — под правило будет попадать только TCP-трафик;</para></listitem>
+    <listitem><para>UDP — под правило будет попадать только UDP-трафик;</para></listitem>
+    <listitem><para>ICMP — под правило будет попадать только ICMP-трафик;</para></listitem>
+    <listitem><para>TCP_UDP — под правило будет попадать только TCP- и UDP-трафик;</para></listitem>
+    <listitem><para>ALL — под правило будет попадать любой трафик.</para></listitem>
+  </itemizedlist>
+  <para>Варианты указания фильтра по IP-адресу и портам:</para>
+  <itemizedlist mark="opencircle">
+    <listitem><para>192.168.0.1 — под правило будет попадать только трафик хоста 192.168.0.1;</para></listitem>
+    <listitem><para>192.168.0.1/32 — правило действует аналогично предыдущему;</para></listitem>
+    <listitem><para>192.168.0.0/24 — под правило будет попадать только трафик сети 192.168.0.0/24;</para></listitem>
+    <listitem><para>192.168.0.1:80 — под правило будет попадать только web-трафик хоста 192.168.0.1;</para></listitem>
+    <listitem><para>192.168.0.0/24:80 — под правило будет попадать только web-трафик сети 192.168.0.0/24;</para></listitem>
+    <listitem><para>192.168.0.1:1024-65535 — под правило будет попадать только трафик с высоких номеров портов хоста 192.168.0.1;</para></listitem>
+    <listitem><para>192.168.0.1/24:1024-65535 — под правило будет попадать только трафик с высоких номеров портов сети 192.168.0.0/24.</para></listitem>
+  </itemizedlist>
+  <para>В качестве направления указывается один из идентификаторов DIR0-DIR9 или NULL. Трафик классифицируемый по направлению NULL системой никак не учитывается.</para>
+  <para>В файле допустимо наличие пустых строк и комментариев. Комментарием считается строка начинающаяся с символа #. Текст следующий за этим символом до конца строки не учитывается.</para>
+  <para>Классификация трафика происходит путем последовательного сравнения информации из заголовка пакета с правилами в файле сверху-вниз до первого совпадения. По этому более «узкие» правила должны описываться перед более «широкими». Например, чтобы выделить web-трафик определенного хоста в отдельное направление порядок указания правил должен быть следующим:</para>
+  <programlisting linenumbering="unnumbered">
+  TCP 192.168.0.1:80 DIR1
+  ALL 192.168.0.1 DIR2
+  </programlisting>
+  <para>Если поменять эти строки местами то весь трафик хоста 192.168.0.1 попадет под первое правило.</para>
+  </simplesect>
+  <simplesect>
+    <title>Использование скриптов OnConnect, OnDisconnect, OnUserAdd, OnUserDel, OnChange</title>
+    <para>Для реакции на различные события в системе используются файлы OnConnect, OnDisconnect, OnUserAdd, OnUserDel, OnChange. Эти файлы расположены в каталоге с конфигурационными файлами системы и должны иметь бит выполнения. Обычно это скрипты на одном из скриптовых языков программирования (sh, perl, python, php), но могут быть и полноценными программами.</para>
+    <para>Наиболее часто используются файлы OnConnect и OnDisconnect. Система запускает их, соответственно, при включении и при выключении доступа для отдельных абонентов. Обычно эти файлы содержат в себе скрипты управления файрволом для разрешения и запрещения прохождения трафика от определенных абонентов. Файл OnConnect запускается при включении доступа абоненту, а файл OnDisconnect — при выключении.. При запуске файла OnConnect в него передаются следующие параметры (по порядку):</para>
+    <orderedlist numeration="arabic">
+      <listitem><para>login — логин абонента;</para></listitem>
+      <listitem><para>ip — ip-адрес абонента;</para></listitem>
+      <listitem><para>cash — состояние счета абонента;</para></listitem>
+      <listitem><para>id — уникальный целочисленный идентификатор абонента (уникальность сохраняется в пределах одного запуска системы);</para></listitem>
+      <listitem><para>dirs — список открываемых направлений (представлен строкой вида «0101100101», где первая цифра соответствует направлению DIR0 а последняя — DIR9).</para></listitem>
+    </orderedlist>
+    <para>При запуске файла OnDisconnect в него передаются следующие параметры (по порядку):</para>
+    <orderedlist numeration="arabic">
+      <listitem><para>login — логин абонента;</para></listitem>
+      <listitem><para>ip — ip-адрес абонента;</para></listitem>
+      <listitem><para>cash — состояние счета абонента;</para></listitem>
+      <listitem><para>id — уникальный целочисленный идентификатор абонента (уникальность сохраняется в пределах одного запуска системы);</para></listitem>
+      <listitem><para>dirs — список открытых направлений (представлен строкой вида «0101100101», где первая цифра соответствует направлению DIR0 а последняя — DIR9).</para></listitem>
+    </orderedlist>
+    <para>Файлы OnUserAdd и OnUserDel запускаются при добавлении и удалении абонента. В качестве параметра в них передается логин абонента.</para>
+    <para>Файл OnChange запускается при внесении изменений в учетную запись абонента. Его можно использовать для дополнительного журналирования изменений. В качестве параметров при запуске в него передаются (по порядку):</para>
+    <orderedlist numeration="arabic">
+      <listitem><para>login — логин абонента;</para></listitem>
+      <listitem><para>parameter — название изменяемого параметра;</para></listitem>
+      <listitem><para>old value — старое значение параметра;</para></listitem>
+      <listitem><para>new value — новое значение параметра.</para></listitem>
+    </orderedlist>
+  </simplesect>
+  <simplesect>
+  <title>Описание конфигурационного файла stg.conf для плагина FreeRADIUS rlm_stg.so</title>
+  <itemizedlist mark="opencircle">
+    <listitem><para>local_port — необязательный параметр. Указывает, с какого локального порта будет происходить обмен данными с Stargazer.</para></listitem>
+    <listitem><para>server — IP-адрес сервера Stargazer.</para></listitem>
+    <listitem><para>port — порт для обмена данными со Stargazer.</para></listitem>
+    <listitem><para>password — пароль, который будет использован для шифрования обмена данными с Stargazer.</para></listitem>
+  </itemizedlist>
+  <para>Пример секции параметров rlm_stg.so для radiusd.conf:</para>
+  <programlisting linenumbering="unnumbered">
+  stg {
+          local_port = 6667
+          server = localhost
+          port = 6666
+          password = 123456
+  }
+  </programlisting>
+  <para>Модуль необходимо прописать в секцию instantiate, authorize. В секции authenticate модуль необходимо прописать в подсекциях AuthType до соответствующих модулей аутентификации. Например:</para>
+  <programlisting linenumbering="unnumbered">
+  Auth-Type PAP {
+          stg
+          pap
+  }
+  </programlisting>
+  <para>Также модуль должен быть прописан в секции accounting и post-auth.</para>
+  </simplesect>

 </chapter>
 </chapter>