From: Maxim Mamontov Date: Sun, 4 Sep 2016 16:36:22 +0000 (+0300) Subject: Improved doc generation. X-Git-Tag: 2.409~101^2~3 X-Git-Url: https://git.stg.codes/stg.git/commitdiff_plain/d4d0006dd2a603fc5c17774d6eacc186f689cbfc?hp=11db4a3e1d499a2e2da4cf312db1655eb0f055fc Improved doc generation. --- diff --git a/doc/help/Makefile b/doc/help/Makefile index 47cf0407..72c3bef9 100644 --- a/doc/help/Makefile +++ b/doc/help/Makefile @@ -1,5 +1,15 @@ -all: +.PHONY: all clean + +all: book/index.html help.pdf + +book/index.html: ch*.xml help.xml + mkdir -p book/images + cp images/*.png book/images/ xsltproc -o book/ --xinclude ../xslt/html/chunk.xsl help.xml +help.pdf: ch*.xml help.xml + dblatex -b xetex -I. help.xml + clean: - rm book/*html + rm -r book + rm help.pdf diff --git a/doc/help/book/images/administrators.png b/doc/help/book/images/administrators.png deleted file mode 100644 index b6e6b39f..00000000 Binary files a/doc/help/book/images/administrators.png and /dev/null differ diff --git a/doc/help/book/images/autoupdate.png b/doc/help/book/images/autoupdate.png deleted file mode 100644 index ef4e976f..00000000 Binary files a/doc/help/book/images/autoupdate.png and /dev/null differ diff --git a/doc/help/book/images/change-in-tariff-user.png b/doc/help/book/images/change-in-tariff-user.png deleted file mode 100644 index 18699023..00000000 Binary files a/doc/help/book/images/change-in-tariff-user.png and /dev/null differ diff --git a/doc/help/book/images/coloring.png b/doc/help/book/images/coloring.png deleted file mode 100644 index 8813f715..00000000 Binary files a/doc/help/book/images/coloring.png and /dev/null differ diff --git a/doc/help/book/images/confirm-delete-user.png b/doc/help/book/images/confirm-delete-user.png deleted file mode 100644 index ccf108a8..00000000 Binary files a/doc/help/book/images/confirm-delete-user.png and /dev/null differ diff --git a/doc/help/book/images/create-new-user.png b/doc/help/book/images/create-new-user.png deleted file mode 100644 index 65eba711..00000000 Binary files a/doc/help/book/images/create-new-user.png and /dev/null differ diff --git a/doc/help/book/images/data-editor.png b/doc/help/book/images/data-editor.png deleted file mode 100644 index 7e866005..00000000 Binary files a/doc/help/book/images/data-editor.png and /dev/null differ diff --git a/doc/help/book/images/delete-user.png b/doc/help/book/images/delete-user.png deleted file mode 100644 index f526e782..00000000 Binary files a/doc/help/book/images/delete-user.png and /dev/null differ diff --git a/doc/help/book/images/display-statistics-floating.png b/doc/help/book/images/display-statistics-floating.png deleted file mode 100644 index aaba6d93..00000000 Binary files a/doc/help/book/images/display-statistics-floating.png and /dev/null differ diff --git a/doc/help/book/images/dowload.png b/doc/help/book/images/dowload.png deleted file mode 100644 index 2e59cdba..00000000 Binary files a/doc/help/book/images/dowload.png and /dev/null differ diff --git a/doc/help/book/images/editor-rate-plans.png b/doc/help/book/images/editor-rate-plans.png deleted file mode 100644 index a46bcd63..00000000 Binary files a/doc/help/book/images/editor-rate-plans.png and /dev/null differ diff --git a/doc/help/book/images/error.png b/doc/help/book/images/error.png deleted file mode 100644 index 548cebdb..00000000 Binary files a/doc/help/book/images/error.png and /dev/null differ diff --git a/doc/help/book/images/filter.png b/doc/help/book/images/filter.png deleted file mode 100644 index 59cadd6d..00000000 Binary files a/doc/help/book/images/filter.png and /dev/null differ diff --git a/doc/help/book/images/firebird-erd.png b/doc/help/book/images/firebird-erd.png deleted file mode 100644 index b114ec50..00000000 Binary files a/doc/help/book/images/firebird-erd.png and /dev/null differ diff --git a/doc/help/book/images/inetaccess-main.png b/doc/help/book/images/inetaccess-main.png deleted file mode 100644 index aba4667a..00000000 Binary files a/doc/help/book/images/inetaccess-main.png and /dev/null differ diff --git a/doc/help/book/images/inform-admin.png b/doc/help/book/images/inform-admin.png deleted file mode 100644 index 35d45f87..00000000 Binary files a/doc/help/book/images/inform-admin.png and /dev/null differ diff --git a/doc/help/book/images/information.png b/doc/help/book/images/information.png deleted file mode 100644 index 629b9ef7..00000000 Binary files a/doc/help/book/images/information.png and /dev/null differ diff --git a/doc/help/book/images/informserver.png b/doc/help/book/images/informserver.png deleted file mode 100644 index 570f9ad7..00000000 Binary files a/doc/help/book/images/informserver.png and /dev/null differ diff --git a/doc/help/book/images/interface.png b/doc/help/book/images/interface.png deleted file mode 100644 index fb1d2004..00000000 Binary files a/doc/help/book/images/interface.png and /dev/null differ diff --git a/doc/help/book/images/internet-access.png b/doc/help/book/images/internet-access.png deleted file mode 100644 index 86d02cdf..00000000 Binary files a/doc/help/book/images/internet-access.png and /dev/null differ diff --git a/doc/help/book/images/ip-search.png b/doc/help/book/images/ip-search.png deleted file mode 100644 index 579d2c86..00000000 Binary files a/doc/help/book/images/ip-search.png and /dev/null differ diff --git a/doc/help/book/images/key-admin.png b/doc/help/book/images/key-admin.png deleted file mode 100644 index 72206232..00000000 Binary files a/doc/help/book/images/key-admin.png and /dev/null differ diff --git a/doc/help/book/images/key-settingsconfig.png b/doc/help/book/images/key-settingsconfig.png deleted file mode 100644 index 7ec90105..00000000 Binary files a/doc/help/book/images/key-settingsconfig.png and /dev/null differ diff --git a/doc/help/book/images/key.png b/doc/help/book/images/key.png deleted file mode 100644 index 5a5f3d86..00000000 Binary files a/doc/help/book/images/key.png and /dev/null differ diff --git a/doc/help/book/images/login.png b/doc/help/book/images/login.png deleted file mode 100644 index 8950f954..00000000 Binary files a/doc/help/book/images/login.png and /dev/null differ diff --git a/doc/help/book/images/messages.png b/doc/help/book/images/messages.png deleted file mode 100644 index 1b07d881..00000000 Binary files a/doc/help/book/images/messages.png and /dev/null differ diff --git a/doc/help/book/images/network-settings.png b/doc/help/book/images/network-settings.png deleted file mode 100644 index 66f182ec..00000000 Binary files a/doc/help/book/images/network-settings.png and /dev/null differ diff --git a/doc/help/book/images/new-customer.png b/doc/help/book/images/new-customer.png deleted file mode 100644 index 79e2c6e3..00000000 Binary files a/doc/help/book/images/new-customer.png and /dev/null differ diff --git a/doc/help/book/images/notification-letters.png b/doc/help/book/images/notification-letters.png deleted file mode 100644 index 51b9ccd2..00000000 Binary files a/doc/help/book/images/notification-letters.png and /dev/null differ diff --git a/doc/help/book/images/of-authorities.png b/doc/help/book/images/of-authorities.png deleted file mode 100644 index dcfe756e..00000000 Binary files a/doc/help/book/images/of-authorities.png and /dev/null differ diff --git a/doc/help/book/images/other-settings.png b/doc/help/book/images/other-settings.png deleted file mode 100644 index 391cb8db..00000000 Binary files a/doc/help/book/images/other-settings.png and /dev/null differ diff --git a/doc/help/book/images/send-message.png b/doc/help/book/images/send-message.png deleted file mode 100644 index 575434a7..00000000 Binary files a/doc/help/book/images/send-message.png and /dev/null differ diff --git a/doc/help/book/images/set-of-authorities.png b/doc/help/book/images/set-of-authorities.png deleted file mode 100644 index e56029ad..00000000 Binary files a/doc/help/book/images/set-of-authorities.png and /dev/null differ diff --git a/doc/help/book/images/settings-key.png b/doc/help/book/images/settings-key.png deleted file mode 100644 index 5638b9bf..00000000 Binary files a/doc/help/book/images/settings-key.png and /dev/null differ diff --git a/doc/help/book/images/sgconfig-main.png b/doc/help/book/images/sgconfig-main.png deleted file mode 100644 index c4dfbbff..00000000 Binary files a/doc/help/book/images/sgconfig-main.png and /dev/null differ diff --git a/doc/help/book/images/statistics.png b/doc/help/book/images/statistics.png deleted file mode 100644 index 733cd065..00000000 Binary files a/doc/help/book/images/statistics.png and /dev/null differ diff --git a/doc/help/book/images/tariff-plans.png b/doc/help/book/images/tariff-plans.png deleted file mode 100644 index 5756817a..00000000 Binary files a/doc/help/book/images/tariff-plans.png and /dev/null differ diff --git a/doc/help/book/images/tariff.png b/doc/help/book/images/tariff.png deleted file mode 100644 index de049e5f..00000000 Binary files a/doc/help/book/images/tariff.png and /dev/null differ diff --git a/doc/help/book/images/up-down-option.png b/doc/help/book/images/up-down-option.png deleted file mode 100644 index ffa4b9ee..00000000 Binary files a/doc/help/book/images/up-down-option.png and /dev/null differ diff --git a/doc/help/book/images/up-down.png b/doc/help/book/images/up-down.png deleted file mode 100644 index fba0144c..00000000 Binary files a/doc/help/book/images/up-down.png and /dev/null differ diff --git a/doc/help/book/images/update.png b/doc/help/book/images/update.png deleted file mode 100644 index dda7bf42..00000000 Binary files a/doc/help/book/images/update.png and /dev/null differ diff --git a/doc/help/book/images/upload-dowload.png b/doc/help/book/images/upload-dowload.png deleted file mode 100644 index 826d37fa..00000000 Binary files a/doc/help/book/images/upload-dowload.png and /dev/null differ diff --git a/doc/help/book/images/user-button.png b/doc/help/book/images/user-button.png deleted file mode 100644 index ffbd164c..00000000 Binary files a/doc/help/book/images/user-button.png and /dev/null differ diff --git a/doc/help/book/images/username.png b/doc/help/book/images/username.png deleted file mode 100644 index 02a4bf79..00000000 Binary files a/doc/help/book/images/username.png and /dev/null differ diff --git a/doc/help/book/images/view-letter.png b/doc/help/book/images/view-letter.png deleted file mode 100644 index d37eebad..00000000 Binary files a/doc/help/book/images/view-letter.png and /dev/null differ diff --git a/doc/help/book/images/window-of-authorities.png b/doc/help/book/images/window-of-authorities.png deleted file mode 100644 index cd2df63a..00000000 Binary files a/doc/help/book/images/window-of-authorities.png and /dev/null differ diff --git a/doc/help/ch4.xml b/doc/help/ch4.xml index 00130ea0..7374ce96 100644 --- a/doc/help/ch4.xml +++ b/doc/help/ch4.xml @@ -3,7 +3,7 @@ После инсталляции система должна быть подвергнута процедуре настройки. Обычно следует начинать с настройки сервера. Основные конфигурационные файлы сервера по умолчанию находятся в каталоге /etc/stargazer. Они включают в себя: основной конфигурационный файл stargazer.conf, файл описания направлений тарификации rules, набор скриптов On* и два каталога — conf-available.d и conf-enabled.d, содержащих конфигурационные файлы отдельных модулей. Для включения какого-либо модуля нужно сделать символическую ссылку на его конфигурационный файл в каталоге conf-enabled.d или прописать его конфигурационную секцию в разделе <Modules> файла stargazer.conf. - Настройка конфигурационного файла /etc/stargazer/stargazer.conf + Конфигурационный файл /etc/stargazer/stargazer.conf Файл имеет текстовый формат, содержащий пары ПАРАМЕТР = ЗНАЧЕНИЕ и секции <ИМЯ_СЕКЦИИ ПАРАМЕТРЫ_СЕКЦИИ>. Комментарии в файле начинаются с символа #. В файле описываются общие параметры, которые являются глобальными значениями для всего сервера биллинга, а также параметры соответствующих модулей. Параметры модулей должны быть заключены в секции: <Module имя_модуля> @@ -41,7 +41,11 @@ MessagesTimeout — необязательный параметр, устанавливающий время жизни не отправленных сообщений абонентам. Время указывается в сутках. При превышении этого времени сообщение будет удалено, в т. ч. из БД. Если указано значение 0 то не отправленные сообщения никогда не будут удаляться из базы (в частности, это приведет к постепенному росту размера базы, увеличению нагрузки на сервер при авторизации абонентов и к тому что долго отсутствовавший абонент при авторизации получит все пропущенные сообщения). По умолчанию имеет значение 0. FeeChargeType — необязательный параметр, регулирующий процесс снятия абонплаты. Может принимать значения 0, 1 и 2, по умолчанию имеет значение 0. При значении 0 абонплата снимается как обычно, при значении 1 абонплата снимается только если баланс пользователя положительный или равен нулю, при значении 2 абонплата снимается только если баланс пользователя больше или равен абонплате. Значение 2 следует использовать с осторожностью, т. к. при этом на безлимитных тарифах абоненты получат услугу бесплатно. ReconnectOnTariffChange — необязательный параметр, указывающий серверу выполнить переподключение пользователя при смене тарифа. Может принимать значения yes и no, по умолчанию имеет значение no. При указании значения yes подключенные пользователи будут отключены непосредственно перед сменой тарифа и подключены сразу после нее. Может быть полезно для управления шейпером. - ScriptParams — необязательный параметр, который определяет дополнительный набор данных передаваемых в скрипты OnConnect и OnDisconnect. По умолчанию этот параметр пуст. В нем можно указать названия полей записи пользователя, разделенных пробелами, значения которых будут переданы в скрипты после стандартного набора, включающего login, ip, cash, id и dirs. Допустимые имена полей: "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". Так, например, если указать ScriptParams = tariffName userdata0 то список параметров передаваемых в скрипты будет: login, ip, cash, id, dirs, tariffName, userdata0. Названия параметров регистронезависимые. + + ScriptParams — необязательный параметр, который определяет дополнительный набор данных передаваемых в скрипты OnConnect и OnDisconnect. По умолчанию этот параметр пуст. В нем можно указать названия полей записи пользователя, разделенных пробелами, значения которых будут переданы в скрипты после стандартного набора, включающего login, ip, cash, id и dirs. Допустимые имена полей: + "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". + Так, например, если указать ScriptParams = tariffName userdata0 то список параметров передаваемых в скрипты будет: login, ip, cash, id, dirs, tariffName, userdata0. Названия параметров регистронезависимые. + DisableSessionLog — необязательный параметр позволяющий отключать запить сессий пользователя в БД. Может принимать значения yes и no. По умолчанию установлен в no, то есть запись сессий включена. FilterParamsLog — необязательный параметр который позволяет фильтровать запись в журнал изменений параметров. Может принимать значения "*" (разрешена запись жернала для всех параметров) или список названий полей записи пользователя, разделенный пробелами. Допустимые имена полей такие-же как и для ScriptParams. По умолчанию имеет значение "*", то есть разрешено журналирование всех параметров. Если указать FilterParamsLog = cash tariffName password то в журнал изменений будут попадать только изменения параметров cash, tariffName и password. Изменения других параметров, например note, group или address в журнал не попадут. Для именования направлений учета трафика в конфигурационном файле используется секция DirNames: @@ -67,7 +71,8 @@ </Modules> Если модуль не имеет настраиваемых параметров, то он все равно должен быть указан. Некоторые модули, такие как store module, обязательно требуются при старте и без их подключения система не может быть запущена. По умолчанию для указания конфигурации модулей используются отдельные файлы из каталога conf-enabled.d. Для этого используется директива <IncludeFile ПУТЬ_К_ФАЙЛУ></IncludeFile>. Одна директива указана в секции Modules, а вторая в корне файла конфигурации (для store module). - + + Описание параметров модуля InetAccess (auth_ia) для работы с авторизаторами абонентов: Port – обязательный параметр, определяющий на каком порту сервер будет принимать обращения авторизаторов абонентов. Стандартное значение: 5555. @@ -87,19 +92,19 @@ Обмен данными авторизатора с сервером осуществляется по протоколу UDP. Можно указать несколько модулей авторизатора auth_ia для авторизации с разных портов. - - + + Модуль авторизации auth_ao. Модуль параметров не имеет. Используется для поддержки режима Always Online у абонентов. Без включения этого модуля установка параметра alwaysOnline для абонента эффекта иметь не будет. В режиме Always Online абонент находится в авторизованном состоянии все время, независимо от использования авторизатора. Тем не менее он может быть отключен по причине отсутствия средств на счету, заблокирован администратором или «заморожен». В этом режиме так же возможно использование авторизатора за одним исключением — абонент не может сам вызвать «отключение». - - + + Описание параметров модуля SGConfig (conf_sg) для работы с конфигуратором: Port – обязательный параметр, определяющий, на каком порту сервер будет принимать обращения конфигураторов. Стандартное значение: 5555. Обмен конфигуратора с сервером осуществляется по протоколу TCP. Можно указать несколько модулей конфигуратора с указанием разных портов. - - + + Описание параметров модуля файловой БД: WorkDir – обязательный параметр, указывающий серверу где находится рабочая директория с файлами БД. Стандартное значение: /var/stargazer. @@ -107,9 +112,9 @@ StatOwner, StatGroup, StatMode – обязательные параметры, описывающие владельца, группу и права доступа на файлы статистики (stat) абонента соответственно. StatOwner должен содержать корректное имя пользователя системы (см. файл /etc/passwd), стандартное значение: root. StatGroup должен содержать корректное название группы в системе (см. файл /etc/group), стандарное значение: root. StatMode должен содержать корректные права на файл (только ugo-биты), стандартное значение: 640. UserLogOwner, UserLogGroup, UserLogMode – обязательные параметры, описывающие владельца, группу и права доступа на файлы журналов (log) абонента соответственно. UserLogOwner должен содержать корректное имя пользователя системы (см. файл /etc/passwd), стандартное значение: root. UserLogGroup должен содержать корректное название группы в системе (см. файл /etc/group), стандарное значение: root. UserLogMode должен содержать корректные права на файл (только ugo-биты), стандартное значение: 640. - При создании каталогов (например для записи детальной статистики) используются те-же права, но с добавлением x-бита для всех ненулевых полей. Например: для 640 будут права 750, а для 644 будут 755. Для записи детальной статистики используются параметры StatOwner, StatGroup и StatMode. Для записи сообщений используются параметры ConfOwner, ConfGroup и ConfMode. - - + При создании каталогов (например для записи детальной статистики) используются те-же права, но с добавлением x-бита для всех ненулевых полей. Например: для 640 будут права 750, а для 644 будут 755. Для записи детальной статистики используются параметры StatOwner, StatGroup и StatMode. Для записи сообщений используются параметры ConfOwner, ConfGroup и ConfMode. + + Описание параметров модуля для работы с СУБД Firebird: Server – необязательный параметр, описывающий адрес сервера, на котором расположена СУБД. Может быть доменным именем или IP-адресом. Значение по умолчанию: localhost. @@ -131,8 +136,8 @@ - - + + Описание параметров модуля для работы с СУБД PostgreSQL: Server – необязательный параметр, описывающий адрес сервера, на котором расположена СУБД. Может быть доменным именем или IP-адресом. Значение по умолчанию: localhost. @@ -141,8 +146,8 @@ Password – необязательный параметр, описывающий пароль пользователя БД. Значение по умолчанию: 123456. Retries — необязательный параметр, описывающий количество попыток переподключения к СУБД в случае потери связи. Попытки производятся с интервалом в 1 секунду. Значение по умолчанию: 3. - - + + Описание параметров модуля для работы с СУБД MySQL: Server – обязательный параметр, описывающий адрес сервера, на котором расположена СУБД. Стандартное значение: localhost. @@ -150,14 +155,14 @@ User – обязательный параметр, описывающий имя пользователя БД. Стандартное значение: stg. Password – обязательный параметр, описывающий пароль пользователя БД. Стандартное значение: 123456. - - + + Описание параметров модуля ping для пингования абонентов: PingDelay – обязательный параметр, определяющий, время в секундах между пингами одного и того же абонента. Стандартное значение: 15. - - + + Описание параметров модуля Remote Script Executer (remote_script) для передачи команд на исполнение скриптов на NAS: SendPeriod – обязательный параметр, определяющий время в секундах между посылками подтверждений того, что клиент находится в состоянии Online. Стандартное значение: 15. @@ -166,8 +171,8 @@ Port – обязательный параметр, определяющий номер порта через который будет происходить обмен данными между сервером биллинга и клиентом. Может принимать значения от 1 до 65535, стандартное значение: 9999. SubnetFile — обязательный параметр, представляющий собой путь к файлу с описанием соответствия сетей и NAS'ов. Стандартное значение: subnets. При указании относительного пути поиск будет производиться в каталоге с настройками (обычно это /etc/stargazer, но может быть переопределено указанием пути в качестве параметра при старте дэмона). Файл имеет формат: <сеть в CIDR-нотации> <адрес NAS'а>. Количество сетей не ограничено. Файл перечитывается заново при посылке процессу сигнала SIGHUP. Если файл содержит ошибки при старте дэмона — система не будет запущена. Если файл содержит ошибки при перечитывании — будут использоваться старые значения. - - + + Описание параметров модуля radius для поддержки авторизации и аккаунтинга пользователей через сервер FreeRADIUS: Port — обязательный параметр, определяющий порт, на который будут приходить запросы от FreeRADIUS. Может принимать значение от 1 до 65535, стандартное значение: 6666. @@ -176,47 +181,47 @@ AcctServices — необязательный параметр, задающий список сервисов, по которым будет производится аккаунтинг. При успешной авторизации в этих сервисах абонент переходит в состояние Online и для него производится подсчет трафика. Необходимо заметить, что в этом случае трафик захватывается как обычно, без использования возможностей протокола RADIUS (через пакет аккаунтинга InterimUpdate), т.к. это не позволяет классифицировать полученный трафик по направлениям. Названия сервисов в списке должны разделяться пробелами, по умолчанию этот параметр пуст. Обмен данными между плагином и FreeRADIUS происходит по протоколу UDP. - - + + Описание параметров модуля XML-RPC (conf_rpc) для поддержки протокола управления XML-RPC: Port — обязательный параметр, определяющий порт на который будут приходить запросы XML-RPC. Может принимать значения от 1 до 65535, стандартное значение: 8080. CookieTimeout — необязательный параметр, задающий время существования авторизационного Cookie в случае отсутствия активности в секундах. Значение по умолчанию: 1800 (30 минут). - - + + Модуль захвата трафика cap_ether (только для ОС Linux). Модуль не имеет параметров. Для захвата трафика используются так называемые «raw sockets», которые позволяют получить доступ к Ethernet-фреймам. Перехватывается весь трафик попадающий в сетевую подсистему ядра. При использовании обычной маршрутизации трафик будет посчитан два раза: на входящем интерфейсе и на исходящем. При использовании NAT удвоения трафика не происходит, так как NAT заменяет адрес источника. При интенсивном сетевом обмене или при высокой нагрузке на сервер, на котором происходит захват трафика, модуль может терять отдельные пакеты. Процент потерь тем выше чем выше скорость прохождения пакетов и чем выше загрузка сервера. Модуль рекомендуется использовать для ознакомления или в небольших сетях до 100 абонентов с трафиком до 100 Мбит. - - + + Модуль захвата трафика cap_ipq (только для ОС Linux). Модуль не имеет параметров. Для захвата трафика используются передача пакетов из пространства ядра в пространство пользователя посредством очередей (ip queue). Для его работы требуется поддержка ip queueing в ядре (модуль ip_queue.ko) и специальная настройка файрвола (правило QUEUE для iptables). Следует обратить внимание на то что обычно требуется два правила в файрволе для полного перехвата: одно для входящих пакетов и одно для исходящих. Модуль гарантирует 100% перехват трафика, но так как пакет перед отправкой обязательно проходить через плагин — может приводить к снижению пропускной способности роутера. При этом следует обратить внимание на нагрузку на процессор, возможно имеет смысл заменить его на более производительный. В противном случае стоит рассмотреть использование модуля cap_nf для захвата трафика. - - + + Описание параметров модуля cap_bpf для захвата трафика (только для ОС FreeBSD): iface — обязательный параметр, определяющий на каком интерфейсе будет происходить захват трафика. Параметр может быть задан более одного раза. Для захвата трафика используется инфраструктура Berkeley Packet Filter, представляющая собой «продвинутый» аналог «raw sockets». Так как интерфейсы для перехвата указываются явно, дублирования трафика при обычной маршрутизации не наблюдается. Фильтрование пакетов не используется, перехват происходит по мере возможности, по этому этот модуль, как и cap_ether, тоже может терять пакеты при высокой нагрузке на сервер или высокой скорости прохождения пакетов. Рекомендуется использовать для ознакомления или для небольших сетей до 100 абонентов с трафиком до 100 Мбит. - - + + Модуль захвата трафика cap_divert (только для ОС FreeBSD). Модуль не имеет параметров. Для захвата трафика используются divert-сокеты. Как и IPQ эта технология использует прохождение пакетов через пространство пользователя. Для работы модуля требуется поддержка divert-сокетов в ядре и специальная настройка файрвола. Для передачи пакета в пространство пользователя в файрволе используется правило divert или tee. Первое правило работает аналогично цели QUEUE для iptables — пропускает пакет через пространство пользователя перед отправкой. Соответственно, это может вызвать те-же проблемы с пропускной способностью роутера. Правило tee передает в пространство пользователя копию пакета, а оригинал отправляет дальше. Такой подход позволяет избежать снижения пропускной способности сервера при высокой нагрузке на него, так как исключается ожидание пакета в время его нахождения в пространстве пользователя. - - + + Описание параметров модуля cap_nf для захвата трафика: TCPPort — необязательный параметр, указывающий порт который будет использоваться для приема данных при работе с NetFlow-proxy. Стандартное значение: 9996. Если параметр не указан — прием по протоколу TCP производиться не будет. UDPPort — необязательный параметр, указывающий порт для приема NetFlow-дагарамм. Стандартное значение: 9996. Если параметр не указан — прием датаграмм по протоколу UDP производиться не будет. В явном виде захват трафика не происходит. Данные о нем поступают от NetFlow-сенсора посредством протокола NetFlow. Это позволяет физически разделить перехват трафика и его учет. NetFlow-сенсор перехватывает трафик, и собирает данные о сессиях (в контексте UDP это передача данных между двумя портами в одном направлении). Информация о сессии включает в себя IP-адреса источника и назначения потока пакетов, номера портов источника и назначения, суммарную длину пакетов и различные дополнительные данные. NetFlow-трафик существенно меньше трафика, который он описывает, так как передается мета-информация а не сами данные. С учетом этого факта и того что биллинговый сервер теперь может не заниматься маршрутизацией пакетов и NAT'ом это существенно снижает нагрузку на него. Этот плагин рекомендуется использоваться в крупных сетях с развитой топологией, включающей несколько NAS'ов. Возможно использование совместно с аппаратными маршрутизаторами Cisco (они единственные имеют лицензию на аппаратную реализацию NetFlow). В качестве NetFlow-сенсоров можно использовать такие утилиты как fprobe, softflowd или ipcad. Так же можно использовать модуль ядра ipt_netflow (Linux) или ng_netflow (FreeBSD). - - Server — обязательный параметр, указывающий IP-адрес сервера на котором находится snmpd. Стандартное значение: 127.0.0.1. Port — обязательный параметр, указывающий порт на сервере через который будет происходить взаимодействие с snmpd. Стандартное значение: 199. Password — необязательный параметр, задающий пароль для авторизации плагина в snmpd. По умолчанию пароль не используется. + + Описание параметров модуля smux для мониторинга состояния Stargazer: Модуль позволяет производить мониторинг биллинга средствами протокола SNMP. Он не реализует полноценный SNMP-сервер а лишь взаимодействует с существующим дэмоном snmpd, регистрируясь в нем для обслуживания определенного дерева параметров. В комплекте с биллингом идет MIB, описывающий доступные параметры для мониторинга. Параметры разделены на 6 секций, находящихся в узле stg24: @@ -320,10 +325,9 @@ Для доступа к значениями параметров можно использовать следующую команду: 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 имеющая такой-же синтаксис. Можно обращаться к параметрам по цифровому 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. Для того чтобы установить взаимодействие между плагином smux и дэмоном snmpd нужно провести дополнительную настройку последнего. А именно: указать в конфигурационном файле (обычно это /stc/snmp/snmpd.conf) параметр smuxpeer (OID обслуживаемый плагином, в нашем случае это .1.3.6.1.4.1.38313) и smuxsocket (IP-адрес с которого будут приходить пакеты от smux-плагина). - - Настройка конфигурационного файла /etc/stargazer/rules + Конфигурационный файл /etc/stargazer/rules Файл rules описывает парвила классификации трафика по направлениям тарификации. Это текстовый файл, каждая строка которого описывает одно правило классификации. Формат строки файла: <протокол> <CIDR>[:<порт>[-<порт>]] <направление> diff --git a/doc/help/ch5.xml b/doc/help/ch5.xml index 9c3d6e5c..741a5aa3 100644 --- a/doc/help/ch5.xml +++ b/doc/help/ch5.xml @@ -1,7 +1,7 @@ - Описание работы с конфигуратором - Как и говорилось выше, конфигуратор предназначен для выполнения различных административных действий над клиентами и над некоторыми параметрами сервера. - + Описание работы с конфигуратором + Как и говорилось выше, конфигуратор предназначен для выполнения различных административных действий над клиентами и над некоторыми параметрами сервера. + Общий вид окна конфигуратора при работе показан ниже: @@ -9,166 +9,166 @@ - В окне расположены: меню, кнопки быстрого доступа к элементам меню, таблица с информацией о клиентах, панель с дополнительной информацией о клиенте, панель состояния. Следует помнить что почти все команды, вызываемые из конфигуратора будут работоспособны в случае успешного входа на сервер. При этом в панели состояния изменится статус, и появиться имя пользователя, который вошел в систему: - + В окне расположены: меню, кнопки быстрого доступа к элементам меню, таблица с информацией о клиентах, панель с дополнительной информацией о клиенте, панель состояния. Следует помнить что почти все команды, вызываемые из конфигуратора будут работоспособны в случае успешного входа на сервер. При этом в панели состояния изменится статус, и появиться имя пользователя, который вошел в систему: + - - Обзор меню: - - Файл — Сохранить — команда сохраняет таблицу с клиентами в указанный текстовый файл по указанному пути. - Файл — Login… — команда, предназначенная для доступа на сервер. При этом выведется следующее окно, в котором необходимо ввести учетные данные администратора, как они заданы при вводе администратора: - + + Обзор меню: + + Файл — Сохранить — команда сохраняет таблицу с клиентами в указанный текстовый файл по указанному пути. + Файл — Login… — команда, предназначенная для доступа на сервер. При этом выведется следующее окно, в котором необходимо ввести учетные данные администратора, как они заданы при вводе администратора: + - - В случае успешного входа конфигуратор отобразит список клиентов, и даст, в зависимости от ограничений администратора доступ к функциям. После первой установки и старта системы, по-умолчанию логин и пароль на вход равны admin и 123456 соответственно. - - Файл — Logout… — команда, выполняющая выход из системы, при этом таблица клиентов очищается. - Файл — Печатать всех… — команда выводит предварительный просмотр списка клиентов с указанием трафика по направлениям. - Файл — Выход — выполняет выход из системы и закрытие окна конфигуратора. - Правка — Редактировать пользователя... — команда предназначена редактирования данных клиента (дублируется кнопкой - + + В случае успешного входа конфигуратор отобразит список клиентов, и даст, в зависимости от ограничений администратора доступ к функциям. После первой установки и старта системы, по-умолчанию логин и пароль на вход равны admin и 123456 соответственно. + + Файл — Logout… — команда, выполняющая выход из системы, при этом таблица клиентов очищается. + Файл — Печатать всех… — команда выводит предварительный просмотр списка клиентов с указанием трафика по направлениям. + Файл — Выход — выполняет выход из системы и закрытие окна конфигуратора. + Правка — Редактировать пользователя... — команда предназначена редактирования данных клиента (дублируется кнопкой + - ), при её вызове будет вызвано следующее окно: - + ), при её вызове будет вызвано следующее окно: + - - В данном окне отображаются все настройки клиента, так как они будут записаны в конфигурационный файл. Опции и настройки данного окна описаны выше. Все числовые величины должны разделяться только знаком «.» (точка), IP адреса разделяются символом «,» (запятая), если клиенту необходимо иметь доступ с любого IP адреса, то в это поле необходимо занести символ * (звёздочка). В нижней части окна расположена индивидуальная статистика клиента, её можно изменять, для этого необходимо два раза щелкнуть на подлежащему изменению числе, после редактирование подтвердить изменение кнопкой «Enter». Кнопка «?» предназначена для автоматического поиска свободного IP адреса из указанного в настройках диапазона: - + + В данном окне отображаются все настройки клиента, так как они будут записаны в конфигурационный файл. Опции и настройки данного окна описаны выше. Все числовые величины должны разделяться только знаком «.» (точка), IP адреса разделяются символом «,» (запятая), если клиенту необходимо иметь доступ с любого IP адреса, то в это поле необходимо занести символ * (звёздочка). В нижней части окна расположена индивидуальная статистика клиента, её можно изменять, для этого необходимо два раза щелкнуть на подлежащему изменению числе, после редактирование подтвердить изменение кнопкой «Enter». Кнопка «?» предназначена для автоматического поиска свободного IP адреса из указанного в настройках диапазона: + - - Признак «Заморожен» предназначен для того, чтобы на определенное время прекратить любые денежные действия со счетом клиента, при установке этого признака со счета клиента снимается сумма, указанная в тарифе. Для того чтобы увидеть пароль клиента, сгенерированный кнопкой «Сгенерировать пароль», необходимо нажать на кнопку «Показать пароль», при этом в первом окне пароля отобразится текущий пароль (через 10 секунд он сам исчезнет снова). Следует помнить что при записи пароли и в первом поле ввода и во втором должны совпадать, иначе система выведет предупреждение и не даст записать данные на клиента. Если данные после изменения успешно записаны, то будет выведено сообщение: - + + Признак «Заморожен» предназначен для того, чтобы на определенное время прекратить любые денежные действия со счетом клиента, при установке этого признака со счета клиента снимается сумма, указанная в тарифе. Для того чтобы увидеть пароль клиента, сгенерированный кнопкой «Сгенерировать пароль», необходимо нажать на кнопку «Показать пароль», при этом в первом окне пароля отобразится текущий пароль (через 10 секунд он сам исчезнет снова). Следует помнить что при записи пароли и в первом поле ввода и во втором должны совпадать, иначе система выведет предупреждение и не даст записать данные на клиента. Если данные после изменения успешно записаны, то будет выведено сообщение: + - - В случае изменения тарифа будет выведен вопрос о времени перевода клиента на новый вид тарифа: - + + В случае изменения тарифа будет выведен вопрос о времени перевода клиента на новый вид тарифа: + - - Если был выбран вариант «Немедленно», то тариф применится к клиентскому аккаунту немедленно, иначе в случае выбора варианта «В следующем месяце» тариф применится с 1 числа следующего месяца автоматически, при этом строка с клиентом, у которого изменится тариф примет вид: - + + Если был выбран вариант «Немедленно», то тариф применится к клиентскому аккаунту немедленно, иначе в случае выбора варианта «В следующем месяце» тариф применится с 1 числа следующего месяца автоматически, при этом строка с клиентом, у которого изменится тариф примет вид: + - - Т. е. в колонке «Тариф» появится запись двойного тарифа, где перед знаком «/» находится текущий, а после – тот тариф, который будет применен со следующего месяца. Следует учитывать что при переходе на другой тариф в течении месяца (выбрана опция «Немедленно») система пересчитает средства на счёте следующим образом: если в тарифе есть абонплата, то с переходом на новый тариф с клиента будет снята часть абонплаты от того тарифа с которого переходят и в конце месяца с него будет снята часть абонплаты от того тарифа на который перевели. Аналогично клиент получит только часть бесплатных Мб от того тарифа на который его перевели. - - Правка - Добавить пользователя... – команда, позволяющая добавить нового клиента в систему (дублируется кнопкой - + + Т. е. в колонке «Тариф» появится запись двойного тарифа, где перед знаком «/» находится текущий, а после – тот тариф, который будет применен со следующего месяца. Следует учитывать что при переходе на другой тариф в течении месяца (выбрана опция «Немедленно») система пересчитает средства на счёте следующим образом: если в тарифе есть абонплата, то с переходом на новый тариф с клиента будет снята часть абонплаты от того тарифа с которого переходят и в конце месяца с него будет снята часть абонплаты от того тарифа на который перевели. Аналогично клиент получит только часть бесплатных Мб от того тарифа на который его перевели. + + Правка - Добавить пользователя... – команда, позволяющая добавить нового клиента в систему (дублируется кнопкой + - ). При вызове этой команды будет выведено окно для заполнения свойств клиента: - + ). При вызове этой команды будет выведено окно для заполнения свойств клиента: + - - Обязательными к заполнению являются поля: логин, пароль и его подтверждение, IP-адрес(а), тарифный план. Остальные поля и опции являются необязательными. В случае если какой то обязательный параметр не заполнен, система сообщит об ошибке и предложит ввести недостающие данные, если же все данные указаны верно, то система запишет нового клиента в систему. Также при добавлении нового клиента система выставит количество бесплатных Мб которое стоит в тарифе, установленном клиенту, пропорционально времени оставшемуся до обнуления статистики. Также с клиента будет снята абонаплата выставленная в тарифе пропорционально времени до конца месяца. - - Правка - Удалить пользователя... – команда позволяющая удалить клиента из системы, при этом все клиентские настройки не удаляются физически на сервере, а переносятся в специальную папку /deleted_users.Команда дублируется кнопкой - + + Обязательными к заполнению являются поля: логин, пароль и его подтверждение, IP-адрес(а), тарифный план. Остальные поля и опции являются необязательными. В случае если какой то обязательный параметр не заполнен, система сообщит об ошибке и предложит ввести недостающие данные, если же все данные указаны верно, то система запишет нового клиента в систему. Также при добавлении нового клиента система выставит количество бесплатных Мб которое стоит в тарифе, установленном клиенту, пропорционально времени оставшемуся до обнуления статистики. Также с клиента будет снята абонаплата выставленная в тарифе пропорционально времени до конца месяца. + + Правка - Удалить пользователя... – команда позволяющая удалить клиента из системы, при этом все клиентские настройки не удаляются физически на сервере, а переносятся в специальную папку /deleted_users.Команда дублируется кнопкой + . - При вызове этой команды будет вызвано подтверждение на удаление: - + При вызове этой команды будет вызвано подтверждение на удаление: + . - - - Правка – Тарифные планы... – команда вызывающая редактор тарифных планов (дублируется кнопкой - + + + Правка – Тарифные планы... – команда вызывающая редактор тарифных планов (дублируется кнопкой + - ): - + ): + - - Цены вводятся через знак «/» - это разделение цены до/после перехода порога по направлению, если цена будет введена без знака «/», то она будет применена как к трафику до, так и после превышения одинаково. Порог устанавливается в поле «Порог (Мб)», если установлен признак «Без порога», то цена вводиться одна. В стоимость заморозки устанавливается сумма, которая будет снята с клиента при установке признака «Заморожен». - После изменения тарифного плана необходимо нажать кнопку «Сохранить» для записи данных. Измененный тарифный план начинает применяться сразу после записи. - - Правка – Администраторы – команда, позволяющая изменять права администраторов и добавлять/удалять их. Дублируется кнопкой - + + Цены вводятся через знак «/» - это разделение цены до/после перехода порога по направлению, если цена будет введена без знака «/», то она будет применена как к трафику до, так и после превышения одинаково. Порог устанавливается в поле «Порог (Мб)», если установлен признак «Без порога», то цена вводиться одна. В стоимость заморозки устанавливается сумма, которая будет снята с клиента при установке признака «Заморожен». + После изменения тарифного плана необходимо нажать кнопку «Сохранить» для записи данных. Измененный тарифный план начинает применяться сразу после записи. + + Правка – Администраторы – команда, позволяющая изменять права администраторов и добавлять/удалять их. Дублируется кнопкой + - , при вызове команды будет выдано окно со списком текущих администраторов: - + , при вызове команды будет выдано окно со списком текущих администраторов: + - - Пароль и подтверждение пароля в целях безопасности не отображаются, при записи если оставить незаполненными поля пароля, то он изменен не будет. Для сохранения сделанных изменений необходимо нажать кнопку «Сохранить». В случае успешного сохранения данных администратора будет выведено сообщение: - + + Пароль и подтверждение пароля в целях безопасности не отображаются, при записи если оставить незаполненными поля пароля, то он изменен не будет. Для сохранения сделанных изменений необходимо нажать кнопку «Сохранить». В случае успешного сохранения данных администратора будет выведено сообщение: + - - Если имела место какая-либо ошибка, сервер сообщит об ней. - - Инструменты - Статистика – команда отображает общую статистику по направлениям, с визуальным обзором на диаграмме: - + + Если имела место какая-либо ошибка, сервер сообщит об ней. + + Инструменты - Статистика – команда отображает общую статистику по направлениям, с визуальным обзором на диаграмме: + - - При выборе вариантов внизу соответственно будет перерисована диаграмма. Также можно указать по каким клиентам показывать суммарную статистику: по всем или только по отфильтрованным, и какую собственно на диаграмме прорисовывать статистику. - - Инструменты – Фильтр – команда позволяет отфильтровать текущую таблицу с данными о клиентах по заданному фильтру: - + + При выборе вариантов внизу соответственно будет перерисована диаграмма. Также можно указать по каким клиентам показывать суммарную статистику: по всем или только по отфильтрованным, и какую собственно на диаграмме прорисовывать статистику. + + Инструменты – Фильтр – команда позволяет отфильтровать текущую таблицу с данными о клиентах по заданному фильтру: + - - - Инструменты - Разослать письма... – команда позволяет разослать письма указанным клиентам с сервера: - + + + Инструменты - Разослать письма... – команда позволяет разослать письма указанным клиентам с сервера: + - - В поля From, Subject заносятся электронный адрес отправителя и тема писем соответственно. + + В поля From, Subject заносятся электронный адрес отправителя и тема писем соответственно. Кнопка «Все» позволяет выделить всех клиентов из списка, «Никто» - убирает выделение со всех в списке, «Должники» - выделяет клиентов, у которых баланс меньше нуля и превысил «Кредит», «Инверсия» - позволяет инвертировать выделение, т. е. все кто был помеченными станут непомеченными и наоборот. Кнопки «Загрузить шаблон» и «Сохранить шаблон» позволяют загружать исходный и сохранять текущий шаблоны соответственно. В «Подстановках» можно выбрать спец. Макросы, которые потом при отправке каждому клиенту заменяться на реальные для него цифры или информацию. Пример сохраненного шаблона: - admin@my.net + admin@my.net Состояние счета Уважаемый пользователь %name! @@ -179,82 +179,82 @@ С уважением, администрация сети my.net - Кнопка «Просмотр» позволяет просмотреть итоговое сообщение для выбранного клиента: - + Кнопка «Просмотр» позволяет просмотреть итоговое сообщение для выбранного клиента: + - - Следует помнить что для корректной рассылки писем в настройках необходимо указать SMTP сервер. Рассылка писем предусматривает сохранение и восстановление шаблонов. - - Инструменты – Отправить сообщение – команда предназначена для отправки сообщений клиентам, в данный момент находящимся в OnLine или в OffLine (следует учитывать, что сообщение дойдет моментально только лишь в том случае, если клиент пользуется в данный момент авторизатором, если же клиент в данный момент находится в состоянии OffLine, то сообщение дойдет сразу же после первого подключения): - + + Следует помнить что для корректной рассылки писем в настройках необходимо указать SMTP сервер. Рассылка писем предусматривает сохранение и восстановление шаблонов. + + Инструменты – Отправить сообщение – команда предназначена для отправки сообщений клиентам, в данный момент находящимся в OnLine или в OffLine (следует учитывать, что сообщение дойдет моментально только лишь в том случае, если клиент пользуется в данный момент авторизатором, если же клиент в данный момент находится в состоянии OffLine, то сообщение дойдет сразу же после первого подключения): + - - При отправке сообщения можно задать пользователей, которым уйдет сообщение, интервал повторения сообщения в минутах, количество повторений, а также время в секундах, в течении которого окно с сообщением будет держаться на экране у пользователя. - - Инструменты – Очистить таблицу пользователей – команда позволяет очистить таблицу клиентов и их статистики, однако следует понимать что таблица очищается только в окне конфигуратора, никакие данные на сервере изменены не будут. - Настройки – Настройки... – команда вызывает окно с настройками конфигуратора (дублируется кнопкой - + + При отправке сообщения можно задать пользователей, которым уйдет сообщение, интервал повторения сообщения в минутах, количество повторений, а также время в секундах, в течении которого окно с сообщением будет держаться на экране у пользователя. + + Инструменты – Очистить таблицу пользователей – команда позволяет очистить таблицу клиентов и их статистики, однако следует понимать что таблица очищается только в окне конфигуратора, никакие данные на сервере изменены не будут. + Настройки – Настройки... – команда вызывает окно с настройками конфигуратора (дублируется кнопкой + - ): - - + ): + + - - В данном окне задаются настройки конфигуратора: адрес сервера, порт, адрес почтового сервера и его порт, интервал авто обновления, длина генерируемого пароля и прочие параметры конфигуратора. На закладке «Интерфейс» - + + В данном окне задаются настройки конфигуратора: адрес сервера, порт, адрес почтового сервера и его порт, интервал авто обновления, длина генерируемого пароля и прочие параметры конфигуратора. На закладке «Интерфейс» + - задаются: видимость колонок в окне клиентов, а так же ширина. Признак «Загружать последний шаблон» определяет загружать ли конфигуратору последний шаблон, который был использован при последней отправке писем клиентам. - На закладке «Раскраска» можно задать цвета, шрифт и другие параметры отображения в основной таблице и в панели информации. - + задаются: видимость колонок в окне клиентов, а так же ширина. Признак «Загружать последний шаблон» определяет загружать ли конфигуратору последний шаблон, который был использован при последней отправке писем клиентам. + На закладке «Раскраска» можно задать цвета, шрифт и другие параметры отображения в основной таблице и в панели информации. + - - На закладке «Прочее» можно указать, сохранять ли логин и (или) пароль администратора. Пароль шифруется и привязывается к HDD компьютера, однако, НЕ РЕКОМЕНДУЕТСЯ сохранять пароль администратора !!! Также здесь можно задать имена полей типа UserDataN для отображения в конфигураторе и параметры, которые будут показываться в нижней панели информации. В разделе «Подсети и IP–адреса» можно задать имя и начальный адрес для автоматического поиска свободного IP адреса. - + + На закладке «Прочее» можно указать, сохранять ли логин и (или) пароль администратора. Пароль шифруется и привязывается к HDD компьютера, однако, НЕ РЕКОМЕНДУЕТСЯ сохранять пароль администратора !!! Также здесь можно задать имена полей типа UserDataN для отображения в конфигураторе и параметры, которые будут показываться в нижней панели информации. В разделе «Подсети и IP–адреса» можно задать имя и начальный адрес для автоматического поиска свободного IP адреса. + - - - Настройки – Информация о сервере – команда позволяет узнать некоторую информацию о сервере, о его версии и некоторые другие данные: - + + + Настройки – Информация о сервере – команда позволяет узнать некоторую информацию о сервере, о его версии и некоторые другие данные: + - - Кнопка - + + Кнопка + - позволяет обновить данные о клиентах в таблице. - Кнопка - + позволяет обновить данные о клиентах в таблице. + Кнопка + - позволяет включать или отключать авто обновление данных. В настройках конфигуратора можно задать интервал авто обновления. - - + позволяет включать или отключать авто обновление данных. В настройках конфигуратора можно задать интервал авто обновления. + + diff --git a/doc/help/ch6.xml b/doc/help/ch6.xml index 118704cc..5325f75d 100644 --- a/doc/help/ch6.xml +++ b/doc/help/ch6.xml @@ -1,29 +1,29 @@ - Описание работы с GUI-авторизатором - Клиентский авторизатор предназначен для выдачи клиентам сети. С помощью него возможно узнать состояние счета, а так же состояние перекачанного трафика по направлениям. Сервер системы может работать со старыми версиями авторизаторов, т. е. сохраняется обратная совместимость, однако по мере возможности необходимо обновлять клиентские авторизаторы до последних версий. - Основное окно авторизатора показано ниже: + Описание работы с авторизатором InetAccess. + Клиентский авторизатор предназначен для выдачи клиентам сети. С помощью него возможно узнать состояние счета, а так же состояние перекачанного трафика по направлениям. Сервер системы может работать со старыми версиями авторизаторов, т. е. сохраняется обратная совместимость, однако по мере возможности необходимо обновлять клиентские авторизаторы до последних версий. + Основное окно авторизатора показано ниже: - В поля Имя и Пароль вводятся, выданные администрацией сети, логин и пароль соответственно. - Кнопка «Сообщения» служит для просмотра истории сообщений, отправленных администрацией сети: - + В поля Имя и Пароль вводятся, выданные администрацией сети, логин и пароль соответственно. + Кнопка «Сообщения» служит для просмотра истории сообщений, отправленных администрацией сети: + - - В отключенном состоянии авторизатор имеет следующий вид: + + В отключенном состоянии авторизатор имеет следующий вид: - - Для того чтобы авторизоваться, необходимо заполнить все поля, выбрать при необходимости те направления, к которым следует подключиться и нажать кнопку «Подключиться». Направления необходимо выбрать с помощью кнопки + + Для того чтобы авторизоваться, необходимо заполнить все поля, выбрать при необходимости те направления, к которым следует подключиться и нажать кнопку «Подключиться». Направления необходимо выбрать с помощью кнопки @@ -35,24 +35,24 @@ - - После подключения направления, выбранные для подключения будут отмечены символом «V», а направления к которым подключаться не требуется, будете отмечены символом «Х» в колонке авторизатора «V/X». - При успешном подключении окно авторизатора примет следующий вид: + + После подключения направления, выбранные для подключения будут отмечены символом «V», а направления к которым подключаться не требуется, будете отмечены символом «Х» в колонке авторизатора «V/X». + При успешном подключении окно авторизатора примет следующий вид: - - Если же по каким-то причинам подключение не удастся, то авторизатор сообщит об этом: + + Если же по каким-то причинам подключение не удастся, то авторизатор сообщит об этом: - - При этом будет сообщено именно о той ошибке, которая имеет место в вашей ситуации. - + + При этом будет сообщено именно о той ошибке, которая имеет место в вашей ситуации. + Описание настроек авторизатора. Для вызова диалога настроек авторизатора нажмите кнопку @@ -115,5 +115,5 @@ В конфигурационном файле авторизатора (InetAccess.ini) можно указать параметры, которые не могут быть изменены с помощью окна «Настройка». Параметр IPEditable, если он принимает значение 1, то в окне настроек авторизатора становится недоступным поле IP адрес сервера. Параметр PortEditable, если он принимает значение 1, то в окне настроек авторизатора становится недоступным поле порт сервера. Рекомендуется при выдаче пользователям авторизатора, выдавать и файл настроек с прописанными значениями IP и порта сервера биллинга, а также прописывать IPEditable=1 и PortEditable=1. Параметр NeverSavePassword отвечает за возможность установки флага «Сохранять пароль». Если значение данного параметра равно 1, то авторизатор не позволит установить этот признак, и соответственно не будет сохранять и восстанавливать пароль. Параметр Currency позволяет задать название валюты для отображения в авторизаторе, в которой ведется учет в биллинговой системе. Авторизатор имеет возможность смены иконок, которые будут отображаться в системном трее. Для того, чтобы авторизатор принял пользовательские иконки, следует в том каталоге, где расположен InetAccess.exe создать папку ico и положить туда файлы с иконками. Файлы должны иметь определенные имена: ia_green.bmp, ia_grey.bmp, ia_red.bmp, ia_yellow.bmp. Если пользовательские иконки не будут заданы или будет отсутствовать папка ico, то будут использованы стандартные иконки, встроенные в авторизатор. - + diff --git a/doc/help/ch9.xml b/doc/help/ch9.xml index cdc2ef1a..c83533ab 100644 --- a/doc/help/ch9.xml +++ b/doc/help/ch9.xml @@ -1,9 +1,9 @@ - Лицензия, авторы, копирайты, благодарности. - Система распространяется по лицензии GPL v2. - Авторами системы являются Борис Михайленко aka stg-34 stg34@stargazer.dp.ua, Максим Мороз, Максим Мамонтов aka madf faust@stargazer.dp.ua, Игорь Лысейко и другие. - Авторами файлов справки являются Георгий Филонов aka egor2fsys egor2fsys@gmail.com, Максим Мамонтов aka madf faust@stargazer.dp.ua и Елена Шевелева burmuar@gmail.com. - В системе использована библиотека LibExpat (http://expat.sourceforge.net/). - Модуль БД на основе СУБД Firebird использует библиотеки fbclient (http://www.firebirdsql.org) и IBPP (http://www.ibpp.org). Модуль БД на основе СУБД MySQL использует библиотеку mysqlclient_r (http://dev.mysql.com). Модуль БД на основе СУБД PostgreSQL использует библиотеку pq (http://www.postgresql.org). - Авторы выражают благодарность всем администраторам и пользователям Stargazer за сообщения об ошибках и предложения новых возможностей системы. Также выражаем благодарность форумам «Локальные сети Украины» и «Домашние сети России». + Лицензия, авторы, копирайты, благодарности. + Система распространяется по лицензии GPL v2. + Авторами системы являются Борис ÐœÐ¸Ñ…айленко aka stg-34, Максим ÐœÐ¾Ñ€Ð¾Ð·, Максим ÐœÐ°Ð¼Ð¾Ð½Ñ‚ов aka madf, Игорь Ð›Ñ‹ÑÐµÐ¹ÐºÐ¾ и другие. + Авторами файлов справки являются Георгий Ð¤Ð¸Ð»Ð¾Ð½Ð¾Ð² aka egor2fsys, Максим ÐœÐ°Ð¼Ð¾Ð½Ñ‚ов aka madf и Елена Ð¨ÐµÐ²ÐµÐ»ÐµÐ²Ð°. + В системе использована библиотека LibExpat. + Модуль БД на основе СУБД Firebird использует библиотеки libfbclient и IBPP. Модуль БД на основе СУБД MySQL использует библиотеку libmysqlclient_r. Модуль БД на основе СУБД PostgreSQL использует библиотеку libpq. + Авторы выражают благодарность всем администраторам и пользователям Stargazer за сообщения об ошибках и предложения новых возможностей системы. Также выражаем благодарность форумам «Локальные сети Украины» и «Домашние сети России». diff --git a/doc/help/help.xml b/doc/help/help.xml index c1eef8a8..f9e703a3 100644 --- a/doc/help/help.xml +++ b/doc/help/help.xml @@ -1,30 +1,42 @@ - + + + + + + + + + + + + + + ]> - - - Stargazer - руководство пользователя - - MaximMamontov - - 2011Maxim Mamontov - - - - - - - - - - - - - - + + + + Stargazer — руководство пользователя + + MaximMamontov + + 2016Maxim Mamontov + + &ch1; + &ch2; + &ch3; + &ch4; + &ch5; + &ch6; + &ch7; + &ch8; + &ch9; + &ch10; + &ch11; + &ch12; + &ch13; diff --git a/doc/help/images/administrators.png b/doc/help/images/administrators.png new file mode 100644 index 00000000..b6e6b39f Binary files /dev/null and b/doc/help/images/administrators.png differ diff --git a/doc/help/images/autoupdate.png b/doc/help/images/autoupdate.png new file mode 100644 index 00000000..ef4e976f Binary files /dev/null and b/doc/help/images/autoupdate.png differ diff --git a/doc/help/images/change-in-tariff-user.png b/doc/help/images/change-in-tariff-user.png new file mode 100644 index 00000000..18699023 Binary files /dev/null and b/doc/help/images/change-in-tariff-user.png differ diff --git a/doc/help/images/coloring.png b/doc/help/images/coloring.png new file mode 100644 index 00000000..8813f715 Binary files /dev/null and b/doc/help/images/coloring.png differ diff --git a/doc/help/images/confirm-delete-user.png b/doc/help/images/confirm-delete-user.png new file mode 100644 index 00000000..ccf108a8 Binary files /dev/null and b/doc/help/images/confirm-delete-user.png differ diff --git a/doc/help/images/create-new-user.png b/doc/help/images/create-new-user.png new file mode 100644 index 00000000..65eba711 Binary files /dev/null and b/doc/help/images/create-new-user.png differ diff --git a/doc/help/images/data-editor.png b/doc/help/images/data-editor.png new file mode 100644 index 00000000..7e866005 Binary files /dev/null and b/doc/help/images/data-editor.png differ diff --git a/doc/help/images/delete-user.png b/doc/help/images/delete-user.png new file mode 100644 index 00000000..f526e782 Binary files /dev/null and b/doc/help/images/delete-user.png differ diff --git a/doc/help/images/display-statistics-floating.png b/doc/help/images/display-statistics-floating.png new file mode 100644 index 00000000..aaba6d93 Binary files /dev/null and b/doc/help/images/display-statistics-floating.png differ diff --git a/doc/help/images/dowload.png b/doc/help/images/dowload.png new file mode 100644 index 00000000..2e59cdba Binary files /dev/null and b/doc/help/images/dowload.png differ diff --git a/doc/help/images/editor-rate-plans.png b/doc/help/images/editor-rate-plans.png new file mode 100644 index 00000000..a46bcd63 Binary files /dev/null and b/doc/help/images/editor-rate-plans.png differ diff --git a/doc/help/images/error.png b/doc/help/images/error.png new file mode 100644 index 00000000..548cebdb Binary files /dev/null and b/doc/help/images/error.png differ diff --git a/doc/help/images/filter.png b/doc/help/images/filter.png new file mode 100644 index 00000000..59cadd6d Binary files /dev/null and b/doc/help/images/filter.png differ diff --git a/doc/help/images/firebird-erd.png b/doc/help/images/firebird-erd.png new file mode 100644 index 00000000..b114ec50 Binary files /dev/null and b/doc/help/images/firebird-erd.png differ diff --git a/doc/help/images/inetaccess-main.png b/doc/help/images/inetaccess-main.png new file mode 100644 index 00000000..aba4667a Binary files /dev/null and b/doc/help/images/inetaccess-main.png differ diff --git a/doc/help/images/inform-admin.png b/doc/help/images/inform-admin.png new file mode 100644 index 00000000..35d45f87 Binary files /dev/null and b/doc/help/images/inform-admin.png differ diff --git a/doc/help/images/information.png b/doc/help/images/information.png new file mode 100644 index 00000000..629b9ef7 Binary files /dev/null and b/doc/help/images/information.png differ diff --git a/doc/help/images/informserver.png b/doc/help/images/informserver.png new file mode 100644 index 00000000..570f9ad7 Binary files /dev/null and b/doc/help/images/informserver.png differ diff --git a/doc/help/images/interface.png b/doc/help/images/interface.png new file mode 100644 index 00000000..fb1d2004 Binary files /dev/null and b/doc/help/images/interface.png differ diff --git a/doc/help/images/internet-access.png b/doc/help/images/internet-access.png new file mode 100644 index 00000000..86d02cdf Binary files /dev/null and b/doc/help/images/internet-access.png differ diff --git a/doc/help/images/ip-search.png b/doc/help/images/ip-search.png new file mode 100644 index 00000000..579d2c86 Binary files /dev/null and b/doc/help/images/ip-search.png differ diff --git a/doc/help/images/key-admin.png b/doc/help/images/key-admin.png new file mode 100644 index 00000000..72206232 Binary files /dev/null and b/doc/help/images/key-admin.png differ diff --git a/doc/help/images/key-settingsconfig.png b/doc/help/images/key-settingsconfig.png new file mode 100644 index 00000000..7ec90105 Binary files /dev/null and b/doc/help/images/key-settingsconfig.png differ diff --git a/doc/help/images/key.png b/doc/help/images/key.png new file mode 100644 index 00000000..5a5f3d86 Binary files /dev/null and b/doc/help/images/key.png differ diff --git a/doc/help/images/login.png b/doc/help/images/login.png new file mode 100644 index 00000000..8950f954 Binary files /dev/null and b/doc/help/images/login.png differ diff --git a/doc/help/images/messages.png b/doc/help/images/messages.png new file mode 100644 index 00000000..1b07d881 Binary files /dev/null and b/doc/help/images/messages.png differ diff --git a/doc/help/images/network-settings.png b/doc/help/images/network-settings.png new file mode 100644 index 00000000..66f182ec Binary files /dev/null and b/doc/help/images/network-settings.png differ diff --git a/doc/help/images/new-customer.png b/doc/help/images/new-customer.png new file mode 100644 index 00000000..79e2c6e3 Binary files /dev/null and b/doc/help/images/new-customer.png differ diff --git a/doc/help/images/notification-letters.png b/doc/help/images/notification-letters.png new file mode 100644 index 00000000..51b9ccd2 Binary files /dev/null and b/doc/help/images/notification-letters.png differ diff --git a/doc/help/images/of-authorities.png b/doc/help/images/of-authorities.png new file mode 100644 index 00000000..dcfe756e Binary files /dev/null and b/doc/help/images/of-authorities.png differ diff --git a/doc/help/images/other-settings.png b/doc/help/images/other-settings.png new file mode 100644 index 00000000..391cb8db Binary files /dev/null and b/doc/help/images/other-settings.png differ diff --git a/doc/help/images/send-message.png b/doc/help/images/send-message.png new file mode 100644 index 00000000..575434a7 Binary files /dev/null and b/doc/help/images/send-message.png differ diff --git a/doc/help/images/set-of-authorities.png b/doc/help/images/set-of-authorities.png new file mode 100644 index 00000000..e56029ad Binary files /dev/null and b/doc/help/images/set-of-authorities.png differ diff --git a/doc/help/images/settings-key.png b/doc/help/images/settings-key.png new file mode 100644 index 00000000..5638b9bf Binary files /dev/null and b/doc/help/images/settings-key.png differ diff --git a/doc/help/images/sgconfig-main.png b/doc/help/images/sgconfig-main.png new file mode 100644 index 00000000..e82f3259 Binary files /dev/null and b/doc/help/images/sgconfig-main.png differ diff --git a/doc/help/images/statistics.png b/doc/help/images/statistics.png new file mode 100644 index 00000000..733cd065 Binary files /dev/null and b/doc/help/images/statistics.png differ diff --git a/doc/help/images/tariff-plans.png b/doc/help/images/tariff-plans.png new file mode 100644 index 00000000..5756817a Binary files /dev/null and b/doc/help/images/tariff-plans.png differ diff --git a/doc/help/images/tariff.png b/doc/help/images/tariff.png new file mode 100644 index 00000000..de049e5f Binary files /dev/null and b/doc/help/images/tariff.png differ diff --git a/doc/help/images/up-down-option.png b/doc/help/images/up-down-option.png new file mode 100644 index 00000000..ffa4b9ee Binary files /dev/null and b/doc/help/images/up-down-option.png differ diff --git a/doc/help/images/up-down.png b/doc/help/images/up-down.png new file mode 100644 index 00000000..fba0144c Binary files /dev/null and b/doc/help/images/up-down.png differ diff --git a/doc/help/images/update.png b/doc/help/images/update.png new file mode 100644 index 00000000..dda7bf42 Binary files /dev/null and b/doc/help/images/update.png differ diff --git a/doc/help/images/upload-dowload.png b/doc/help/images/upload-dowload.png new file mode 100644 index 00000000..826d37fa Binary files /dev/null and b/doc/help/images/upload-dowload.png differ diff --git a/doc/help/images/user-button.png b/doc/help/images/user-button.png new file mode 100644 index 00000000..ffbd164c Binary files /dev/null and b/doc/help/images/user-button.png differ diff --git a/doc/help/images/user-key.png b/doc/help/images/user-key.png new file mode 100644 index 00000000..b35b12d2 Binary files /dev/null and b/doc/help/images/user-key.png differ diff --git a/doc/help/images/username.png b/doc/help/images/username.png new file mode 100644 index 00000000..02a4bf79 Binary files /dev/null and b/doc/help/images/username.png differ diff --git a/doc/help/images/view-letter.png b/doc/help/images/view-letter.png new file mode 100644 index 00000000..d37eebad Binary files /dev/null and b/doc/help/images/view-letter.png differ diff --git a/doc/help/images/window-of-authorities.png b/doc/help/images/window-of-authorities.png new file mode 100644 index 00000000..cd2df63a Binary files /dev/null and b/doc/help/images/window-of-authorities.png differ