Документация BILLmanager 5

Конфигурационный файл

ISPSystem

Параметры, пути директорий и опции, используемые панелью управления, записываются в конфигурационный файл. Конфигурационный файл по умолчанию расположен в /usr/local/mgr5/etc/billmgr.conf. В статье описаны параметры, пути директорий и опции, которые могут быть изменены в конфигурационном файле.

Обратите внимание!

Для применения настроек после их изменения перезапустите панель управления с помощью команды:

/usr/local/mgr5/sbin/mgrctl -m billmgr exit

Параметры


Синтаксис: каждый параметр указывается с новой строки в формате "Название параметра Значение". Например, AuthenLifeTime 3600 — время жизни сессии 3600 секунд.

Просмотр списка параметров:

/usr/local/mgr5/sbin/mgrctl -m billmgr paramlist

Параметры BILLmanager

  • AllowedTurnOffClient — параметр, описывающий пользователей, которым разрешен доступ в BILLmanager 4-ой версии, на время его остановки для переноса на 5 версию. Используется только для миграции на BILLmanager 5; 
  • AuthenLifeTime — время жизни сессии в секундах. Сессии, неактивные дольше указанного времени, будут автоматически удалены. По умолчанию значение этого параметра равно одному часу. Если вы установите время меньше часа, сессии будут закрываться (даже если окно браузера с панелью открыто); 
  • AvatarFileSize — размер файла, используемого в качестве аватара в веб-интерфейсе; 
  • DBHost — адрес сервера баз данных. Обычно localhost; 
  • DBName — имя базы данных биллинга (billmgr); 
  • DBPassword — пароль для подключения к серверу БД; 
  • DBSocket — сокет для подключения к серверу БД; 
  • DBUser — пользователь для подключения к базе (billmgr); 
  • LastLogin — устанавливает условие отображения баннера с информацией о последнем входе в систему. Может иметь следующие значения:
    • info — всегда показывать баннер;
    • notify — показывать баннер, только если адрес изменился;
    • none — не показывать баннер;
  • LongRequest — время в секундах на выполнение запроса. Запрос, выполняющийся дольше заданного времени, попадает в специальный журнал долгих запросов var/<имя панели>.long.log. По умолчанию 300 секунд; 
  • LowMoneyExpirePeriod — определяет:
    • если не включено автопродление, то за сколько дней отправлять уведомление о том, что нужно продлить услуги. По умолчанию 5 4 3 2 1 0;
    • если автопродление включено, то за сколько дней отправлять уведомление о том, что недостаточно средств для автоматического продления услуг. По умолчанию 5 4 3 2 1 0;

      Обратите внимание!

      Отправка уведомлений для услуг с триальным периодом не предусмотрена.

  • LowMoneyNoticePeriod — за сколько дней до оплаты услуги отправлять уведомление или создавать автоплатёж при малом количестве средств на счету. По умолчанию 10 5 4 3 2 1 0; 
  • NearDeletePeriod — за сколько дней отправлять уведомление о том, что услуги, для которых не включено автопродление, будут удалены. По умолчанию 7 5 3 1; 
  • PWGenCharacters — символы, используемые для генерации паролей. По умолчанию 1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ; 
  • PWGenLen — количество символов в пароле; 
  • PWStrength — выполнять проверку сложности пароля. Возможные значения: 0 — не выполнять проверку / 1 — "слабый" / 2 — "хороший" / 3 — "сложный"; 
  • PreloaderTimeout — максимальное время загрузки прелоадера до появления баннера "Превышено время загрузки"; 
  • Problems — настройка раздела "Уведомления" (левый раздел меню, уведомления о проблемах в системе). Может принимать значения:
    • ProblemsAddressFrom;

    • ProblemsAddressTo;

    • ProblemsEmailEnabled; ProblemsKeepOld;

    • ProblemsKeepSolved;

    • ProblemsLang;

    • ProblemsPeriod;

    • ProblemsShowAll;

    • ProblemsSmtpPort;

    • ProblemsSmtpServer;

  • Release — тип используемого дистрибутива; 
  • SMTP — настройки почты. Значения:
    • SMTPPort;

    • SMTPServer;

    • SMTPUser;

  • StartPage — стартовая страница, которая будет отображаться первой после того, как вы войдете в систему; 
  • StatNotificationType — отправлять уведомление либо при каждом списании по статистике, либо при списании в долг (раздел Глобальные настройки → Учет по статистике); 
  • RegFormType — простая или расширенная форма регистрации клиента (1 или 2); 
  • StatExpensePolicy — при недостаточном количестве средств для списания не выполнять действий, производить списание или же останавливать услугу;
  • SSLRestrictedTld — ограниченные tld, задаются через запятую;
  • SSLRestrictedCountry — ограниченные страны, задаются через запятую в формате iso2;
  • SSLRestrictedBrand — ограниченные SSL бренды, задаются через запятую.

Параметры, наследуемые от COREmanager

  • AuthenLifeTime — время жизни сессии. Сессия, в которой нет активности дольше, чем значение параметра, автоматически удаляется. Указывается в секундах. По умолчанию — "3600";
  • BuilderOnUpdateXml — путь к скрипту, который запускается при изменении XML файлов панели управления. Используется в режиме разработчика;
  • ConnectionLimit — количество одновременно обрабатываемых соединений. По умолчанию — "100";
  • DefaultAccessIp — ограничение IP-адресов для доступа к панели управления по умолчанию;
  • DefaultButtonView — вид кнопок в панели управления по умолчанию. По умолчанию — "buttontext":
    • buttontext — значки и текст.
  • DefaultHintView — способ отображения подсказок в панели управления по умолчанию. По умолчанию — "hintactive":
    • hintactive — отображение при фокусировке на подсказке;
    • hintpassive — отображение при наведении курсора на подсказку.
  • DefaultInterface — имя интерфейса, на который добавляются дополнительные IP-адреса по умолчанию;
  • DefaultLang — язык по умолчанию. Используется, если не удалось определить язык браузера или такой язык не поддерживается;
  • ExpireLogsDays — период хранения записей в журнале операций панели управления. Указывается в днях. По умолчанию — "365";
  • ExceedEmailCount — количество почтовых уведомлений, которые могут быть отправлены на один почтовый ящик, в день;

    • 0 — почтовые уведомления не будут отправляться;

    • 1 — на одну почту в день будет отправлено одно почтовое уведомление указанного типа:

      • уведомление о неуникальности почты: "Шлюзы. Уведомление о невозможности однозначно идентифицировать клиента по Email адресу";
      • уведомление об отсутствии данных о такой почте: "Шлюзы. Уведомление о необходимости подтверждения адреса электронной почты";
      • уведомление об успешном подтверждении почты: "Шлюзы. Уведомление об успешном подтверждении адреса электронной почты";
      • уведомление о создании тикета из письма: "Техническая поддержка. Уведомление о создании запроса на основе письма".
  • FileMaxEditSize — максимальный размер файла, который можно открыть в редакторе менеджера файлов. Указывается в КиБ. По умолчанию — "1024";
  • ForwardedSecret — ключ, который нужен для подстановки реального IP-адреса клиента при использовании проксирования. Подробнее см. в статье Настройка адреса панели управления;
  • FsEncoding — кодировка файловой системы для менеджера файлов. По умолчанию — "UTF-8";
  • InternalAdminName — логин администратора, от имени которого выполняются внутренние запросы панели управления;
  • LastLogin — условие отображения баннера с информацией о последнем входе в систему:
    • info — всегда показывать баннер;
    • warning — показывать баннер, только если адрес изменился;
    • none — не показывать баннер.
  • LicIp — IP-адрес лицензии;
  • LongRequest — предел времени выполнения запроса, после которого он записывается в специальный журнал долгих запросов var/<имя панели управления>.long.log. Указывается в секундах. По умолчанию — "300";
  • MailMode — тип почтового сервера для отправки почтовых уведомлений;
  • MakefileDir — путь к сборочной директории. Используется в режиме разработчика. По умолчанию — "src/builder";
  • OneTimeExpire — параметр ограничивает время действия временного ключа для авторизации. Ключ создаётся при помощи функции session.newkey. По умолчанию параметр имеет значение 3600 секунд и может принимать любое целочисленное значение. Например, чтобы уменьшить время действия ключа с 1 часа до 10 минут, установите значение параметра OneTimeExpire 600;
  • PWGenCharacters — набор символов, которые используются при автоматической генерации пароля. По умолчанию — "1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". Чтобы панель управления при генерации пароля использовала специальные символы (#, $, & и т.д.), добавьте нужные символы в значение параметра;
  • PWGenLen — длина пароля, который создаётся при автоматической генерации. По умолчанию — "8";
  • PWStrength — сложность проверки пароля. По умолчанию — "2":
    • 0 — не выполнять проверку;
    • 1 — разрешает использование слабых паролей (K = 3..6);
    • 2 — запрещает использование слабых паролей (K = 6..9);
    • 3 — разрешает только сложные пароли (K = 9..∞).
      Проверяется наличие пароля в словаре запрещённых паролей и вычисляется коэффициент его сложности (K) по формуле . N — общее количество символов. Nu — количество уникальных символов (с учётом регистра). Ns — количество специальных символов. Nr — количество букв, регистр которых отличается от предыдущей. Nc — количество идущих подряд символов одного типа (буквы, цифры, спецсимволы).

  • ProblemsAddressFrom — email отправителя уведомлений о проблемах по почте;

  • ProblemsAddressTo — email получателя уведомлений о проблемах по почте;

  • ProblemsEmailEnabled — опция отправления уведомлений о проблемах по почте. По умолчанию — "off":

    • on — включена;
    • off — выключена.
  • ProblemsKeepOld — период хранения уведомлений в панели управления. По умолчанию — "30";
  • ProblemsKeepSolved — период хранения решённых проблем в панели управления. По умолчанию — "7";
  • ProblemsLang — язык описания уведомлений о проблемах для отправки по почте;
  • ProblemsPeriod — период, через который осуществляются попытки решения проблемы в панели управления. Указывается в минутах. По умолчанию — "60";
  • ProblemsShowAll — опция отображения уведомлений о проблемах пользователей. По умолчанию — "off":
    • on — включена;
    • off — выключена.
  • ProblemsSmtpPort — порт SMTP-сервера для отправки уведомлений о проблемах по почте;
  • ProblemsSmtpServer — адрес SMTP-сервера для отправки уведомлений о проблемах по почте;
  • RestrictAuthinfoRange — настройки "белого списка" authinfo. Подробнее см. в статье Взаимодействие через API;
  • SMTPPass — пароль учётной записи пользователя SMTP-сервера для отправки почтовых уведомлений;
  • SMTPPort — порт SMTP-сервера для отправки почтовых уведомлений;
  • SMTPServer — адрес SMTP-сервера для отправки почтовых уведомлений;
  • SMTPUser — учётная запись пользователя SMTP-сервера для отправки почтовых уведомлений;
  • SenderName — имя отправителя, которое указывается в почтовых уведомлениях;
  • StartPage — стартовая страница по умолчанию;
  • SOARefreshTime — параметр refresh для SOA-записи. Определяет по умолчанию интервал времени в секундах, по истечении которого выполняется проверка необходимости обновления доменной зоны для вторичных DNS-серверов. Если серийный номер изменился с момента последней проверки, то доменная зона на вторичном DNS-сервере будет обновлена;
  • XSLFOProc — параметры вызова внешнего FO-процессора.

Пути


Синтаксис: каждый параметр указывается с новой строки в формате "path Значение".

Просмотр списка путей:

/usr/local/mgr5/sbin/mgrctl -m billmgr pathlist

Пути, наследуемые от COREmanager

  • ifconfig — утилита ifconfig. По умолчанию — "/sbin/ifconfig".

Опции


Синтаксис: каждая опция указывается с новой строки в формате "Option Значение".

Просмотр списка опций:

/usr/local/mgr5/sbin/mgrctl -m billmgr optionlist

Опции BILLmanager

  • Option EULA — пользователь выбрал "Согласен" с условиями Лицензионного соглашения на использование программного обеспечения ISPsystem. При удалении опции вы сможете снова увидеть текст соглашения при следующем старте веб-интерфейса панели; 
  • Option DeleteManualSuspend —включить автоматическое удаление для услуг, остановленных провайдером вручную (раздел Глобальные настройки); 
  • Option AllowDeleteNotification — разрешить клиентам удалять уведомления; 
  • Option OneDedicatedIp — выделять при открытии услуги не более одного IP адреса; 
  • Option CheckIpInUse — удалять только свободные IP-адреса; 
  • Option RequireAccountActivation — требовать подтверждение Email-адресов при регистрации; 
  • Option AllocatePricelistLimitIp — автоматически пересоздать включенные в тариф IP-адреса; 
  • Option HideClosedItem — не показывать услуги со статусом "Удалена"; 
  • Option AllowAnyCountryForProfile — разрешить плательщикам указывать страну отличную от указанной у клиента; 
  • Option ProhibitDifferentProfileTypes — запретить разные типы плательщиков на одном аккаунте; 
  • Option AutoPayment — включить автоматическое выставление счетов; 
  • Option ReserveWithoutExpense — резервировать средства не создавая расходы; 
  • Option ShowAnnualTurnover — отображать годовой оборот по платежам (включена по умолчанию); 
  • Option ShowAnnualExpense — отображать годовой оборот по расходам (взаимоисключающая для ShowAnnualTurnover);
  • Option SupportToCc — включить отправку уведомлений на email-адреса, указанные в копии письма, полученного от клиента;
  • Option InstructionHidePassword — скрывать пароли в инструкциях к услугам. Включение данной опции позволяет обезопасить серверы клиентов от несанкционированного доступа. При открытии инструкции на почте пароль будет виден, а при открытии инструкции в BILLmanager скрыт;
  • Option SSLRestrictByCountry — включить ограничение по стране;
  • Option SSLRestrictByTld — включить ограничение по tld;
  • Option SSLRestrictContactPhoneByCountry — включить ограничение по стране номера телефона у контакта;
  • Option SSLRestrictOrgByCountry — включить ограничение по стране организации;
  • Option SSLRestrictOrgPhoneByCountry — включить ограничение по стране номера телефона у организации.

Опции, наследуемые от COREmanager

  • DisableAutoUpdate — опция отключения автоматического обновления панели управления;
  • DisableCookieSecure — отключить для cookies атрибут Secure. Чтобы получить доступ к панели управления по протоколу HTTP, добавьте эту опцию. По умолчанию её нет в конфигурационном файле;
  • DoNotRestoreTasks — опция отключения восстановления заданий планировщика cron. При включении опции панель управления не будет восстанавливать в планировщике необходимые задания при каждом её запуске;
  • EnableAcmeshDebug — при включении опции в файл /usr/local/mgr5/var/<имя_панели>_acme_sh.log пишется лог выпуска и обновления LE сертификатов. По умолчанию, опция отключена;

    <имя_панели> — название панели управления:

    • ispmgr — ISPmanager;
    • billmgr — BILLmanager;
    • vmmgr — VMmanager KVM или Cloud;
    • vemgr — VMmanager OVZ;
    • dcimgr — DCImanager;
    • ipmgr — IPmanager;
    • dnsmgr — DNSmanager.
  • EnableDbAuthlog — при включении опции и используемом типе базы данных MySQL включается запись журнала авторизации в базу данных. Запись в лог-файл прекращается. По умолчанию, опция отключена;

    Будут созданы таблицы, хранящие:

    • core_auth_log — записи авторизации пользователей;
    • core_auth_log_last — записи последней авторизации пользователя;
    • core_auth_log_banner — записи о том, что последняя авторизация произведена с другого IP-адреса.
  • EULA — наличие опции подтверждает согласие пользователя с условиями Лицензионного соглашения на использование программного обеспечения ISPsystem;

  • FirstStart — наличие опции подтверждает, что первый вход в панель управления ещё не был выполнен. При первом входе пользователю предлагается пройти мастер начальной настройки;

  • IgnorePluginError — опция игнорирования ошибок при выполнении плагинов (если плагин не получилось запустить или он вернул неверный XML-документ). При наличии опции продолжится выполнение функции и в будет зарегистрировано уведомление об ошибке при работе плагина;

  • RestrictAuthinfo — включить ограничения для authinfo. Подробнее см. в статье Взаимодействие через API;
  • SocialDisableFacebook — запретить авторизацию пользователей через соцсеть Facebook*;
  • SocialDisableGoogle — запретить авторизацию пользователей через аккаунт Google;

  • SocialDisableVkontakte — запретить авторизацию пользователей через соцсеть "ВКонтакте";
  • UsageStatAgree — опция отправки анонимных сведений об использовании функций панели и ошибок, которые при этом возникают. Значения полей форм или таблиц не относятся к таким сведениям. Полученная информация используется для улучшения продуктов ISPsystem.

*Деятельность Meta Platforms Inc. по реализации продуктов-социальных сетей Facebook и Instagram на территории РФ запрещена.

Спасибо за ваш отзыв!
Была ли полезна статья?
Уточните, почему:

статья не соответствует названию

статью сложно понять

в статье нет ответа на мой вопрос

рекомендации из статьи не помогли

другая причина

Расскажите, что вам не понравилось в статье: