]> git.stg.codes - stg.git/blobdiff - doc/help/ch6.xml
Add missing CMakeLists.txt
[stg.git] / doc / help / ch6.xml
index 208d7f77d561569a1107e3ce034ab4060078fb1d..5325f75dca2c5fef1eb28951fc3a4ae432cf10e7 100644 (file)
 <chapter xml:id="ch6">
 <chapter xml:id="ch6">
-    <title>Описание работы с GUI-авторизатором</title>
+    <title>Описание работы с авторизатором InetAccess.</title>
     <para>Клиентский авторизатор предназначен для выдачи клиентам сети. С помощью него возможно узнать состояние счета, а так же состояние перекачанного трафика по направлениям. Сервер системы может работать со старыми версиями авторизаторов, т. е. сохраняется обратная совместимость, однако по мере возможности необходимо обновлять клиентские авторизаторы до последних версий.</para>
     <para>Клиентский авторизатор предназначен для выдачи клиентам сети. С помощью него возможно узнать состояние счета, а так же состояние перекачанного трафика по направлениям. Сервер системы может работать со старыми версиями авторизаторов, т. е. сохраняется обратная совместимость, однако по мере возможности необходимо обновлять клиентские авторизаторы до последних версий.</para>
-    <para>
-        Основное окно авторизатора показано ниже:
+    <para>Основное окно авторизатора показано ниже:
         <mediaobject>
             <imageobject>
                 <imagedata fileref="images/inetaccess-main.png" format="PNG"/>
             </imageobject>
         </mediaobject>
     </para>
         <mediaobject>
             <imageobject>
                 <imagedata fileref="images/inetaccess-main.png" format="PNG"/>
             </imageobject>
         </mediaobject>
     </para>
+    <para>В поля Имя и Пароль вводятся, выданные администрацией сети, логин и пароль соответственно.</para>
+    <para>Кнопка «Сообщения» служит для просмотра истории сообщений, отправленных администрацией сети:
+    <mediaobject>
+        <imageobject>
+            <imagedata fileref="images/messages.png" format="PNG"/>
+        </imageobject>
+    </mediaobject>
+    </para>
+    <para>В отключенном состоянии авторизатор имеет следующий вид:
+        <mediaobject>
+            <imageobject>
+                <imagedata fileref="images/of-authorities.png" format="PNG"/>
+            </imageobject>
+        </mediaobject>
+    </para>
+    <para>Для того чтобы авторизоваться, необходимо заполнить все поля, выбрать при необходимости те направления, к которым следует подключиться и нажать кнопку «Подключиться». Направления необходимо выбрать с помощью кнопки
+        <mediaobject>
+            <imageobject>
+                <imagedata fileref="images/key.png" format="PNG"/>
+            </imageobject>
+        </mediaobject>
+        до подключения:
+        <mediaobject>
+            <imageobject>
+                <imagedata fileref="images/internet-access.png" format="PNG"/>
+            </imageobject>
+        </mediaobject>
+    </para>
+    <para>После подключения направления, выбранные для подключения будут отмечены символом «V», а направления к которым подключаться не требуется, будете отмечены символом «Х» в колонке авторизатора «V/X».</para>
+    <para>При успешном подключении окно авторизатора примет следующий вид:
+        <mediaobject>
+            <imageobject>
+                <imagedata fileref="images/window-of-authorities.png" format="PNG"/>
+            </imageobject>
+        </mediaobject>
+    </para>
+    <para>Если же по каким-то причинам подключение не удастся, то авторизатор сообщит об этом:
+        <mediaobject>
+            <imageobject>
+                <imagedata fileref="images/error.png" format="PNG"/>
+            </imageobject>
+        </mediaobject>
+    </para>
+    <para>При этом будет сообщено именно о той ошибке, которая имеет место в вашей ситуации.</para>
+    <simplesect>
+        <title>Описание настроек авторизатора.</title>
+        <para>Для вызова диалога настроек авторизатора нажмите кнопку
+          <mediaobject>
+              <imageobject>
+                  <imagedata fileref="images/settings-key.png" format="PNG"/>
+              </imageobject>
+          </mediaobject>
+          в окне. Откроется следующий диалог:
+          <mediaobject>
+              <imageobject>
+                  <imagedata fileref="images/set-of-authorities.png" format="PNG"/>
+              </imageobject>
+          </mediaobject>
+        </para>
+        <para>В данном окне сосредоточены все настройки авторизатора:</para>
+        <itemizedlist mark="opencircle">
+            <listitem><para>IP – адрес сервера, к которому производится подключение. Выдается администрацией сети.</para></listitem>
+            <listitem><para>Порт – порт сервера, на который будет обращаться программа авторизации, чаще всего 5555. Выдается администрацией сети.</para></listitem>
+            <listitem><para>Признак «Автоподключение» позволяет автоматически выполнять подключение к серверу при старте авторизатора.</para></listitem>
+            <listitem><para>Признак «Сохранять пароль» позволяет сохранять пароль клиента в файле настройки авторизатора. Следует помнить, что если признак «Сохранять пароль» не установлен, то признак «Автоподключение» автоматически становится неактивным.</para></listitem>
+            <listitem><para>Признак «Переподключение» позволяет автоматически переподключаться в случае обрыва связи с сервером или в других непредвиденных случаях.</para></listitem>
+            <listitem><para>Признак «Привязывать пароль к HDD» позволяет зашифровать сохраненный в файле настройки пароль. При это если даже произойдет кража файла с паролем, то он не сможет быть декодирован на компьютере с другим HDD. Очень рекомендуется выставлять опцию включенной.</para></listitem>
+            <listitem><para>Признак «Минимизировать при нажатии на Х» позволяет при закрытии главного окна авторизатора, не выгружать программу из памяти, а сворачивать её в системный трей.</para></listitem>
+            <listitem><para>Отображение статистики:
+                <mediaobject>
+                    <imageobject>
+                        <imagedata fileref="images/display-statistics-floating.png" format="PNG"/>
+                    </imageobject>
+                </mediaobject>
+                - данное меню позволяет выбрать, в каком виде измерений будут выводиться данные о прошедшем трафике. Если выбрано «Плавающая», то данные будут отражаться в зависимости от объёма в тех или иных единицах.</para>
+                <para>
+                    <mediaobject>
+                        <imageobject>
+                            <imagedata fileref="images/up-down.png" format="PNG"/>
+                        </imageobject>
+                    </mediaobject>
+                    - данное меню позволяет выбирать каким образом будут отображаться данные о прошедшем трафике в разрезе «отправлено» и «принято». Если выбрана опция
+                    <mediaobject>
+                        <imageobject>
+                            <imagedata fileref="images/upload-dowload.png" format="PNG"/>
+                        </imageobject>
+                    </mediaobject>
+                    , то отображаться будет сумма обоих трафиков, как отправленного, так и принятого. Если выбрана опция 
+                    <mediaobject>
+                        <imageobject>
+                            <imagedata fileref="images/dowload.png" format="PNG"/>
+                        </imageobject>
+                    </mediaobject>
+                    то отражаться будет только принятая часть трафика. И если выбрана опция
+                    <mediaobject>
+                        <imageobject>
+                            <imagedata fileref="images/up-down-option.png" format="PNG"/>
+                        </imageobject>
+                    </mediaobject>
+                    , то отражаться трафик будет раздельно.
+                </para>
+            </listitem>
+            <listitem><para>Признаки «Выводить подсказку по остатку денег» и «Выводить подсказку по трафику» - позволяют выводить при наведении на значок в системном трее информацию об остатке денежных средств на счету и об переданном трафике соответственно. Для опции «Выводить подсказку по трафику» необходимо выбрать направление, по которому будет выводиться подсказка.</para></listitem>
+            <listitem><para>Признак «Мигать иконкой, если денег меньше» отвечает за включение сигнализации, если сумма денег на балансе клиента станет меньше установленной.</para></listitem>
+        </itemizedlist>
+        <para>В конфигурационном файле авторизатора (InetAccess.ini) можно указать параметры, которые не могут быть изменены с помощью окна «Настройка». Параметр IPEditable, если он принимает значение 1, то в окне настроек авторизатора становится недоступным поле IP адрес сервера. Параметр PortEditable, если он принимает значение 1, то в окне настроек авторизатора становится недоступным поле порт сервера. Рекомендуется при выдаче пользователям авторизатора, выдавать и файл настроек с прописанными значениями IP и порта сервера биллинга, а также прописывать IPEditable=1 и PortEditable=1. Параметр NeverSavePassword отвечает за возможность установки флага «Сохранять пароль». Если значение данного параметра равно 1, то авторизатор не позволит установить этот признак, и соответственно не будет сохранять и восстанавливать пароль. Параметр Currency позволяет задать название валюты для отображения в авторизаторе, в которой ведется учет в биллинговой системе.</para>
+        <para>Авторизатор имеет возможность смены иконок, которые будут отображаться в системном трее. Для того, чтобы авторизатор принял пользовательские иконки, следует в том каталоге, где расположен InetAccess.exe создать папку ico и положить туда файлы с иконками. Файлы должны иметь определенные имена: ia_green.bmp, ia_grey.bmp, ia_red.bmp, ia_yellow.bmp. Если пользовательские иконки не будут заданы или будет отсутствовать папка ico, то будут использованы стандартные иконки, встроенные в авторизатор.</para>
+    </simplesect>
 </chapter>
 </chapter>