BILLmanager 6
Documentation
/
BILLmanager 6
/
BILLmanager settings
/
Fine-tuning
/
Configuration file
en En
es Es
Add to Favorites
Focus mode
Documentation
/
BILLmanager 6
/
BILLmanager settings
/
Fine-tuning
/
Configuration file

Configuration file

The parameters, directory paths, and options used by the platform are written to the configuration file. By default, the configuration file is located in /usr/local/mgr5/etc/billmgr.conf. The article describes the parameters, directory paths, and options that can be changed in the configuration file.

To apply the settings after changing them, restart the platform with the command:

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

Parameters

Syntax: each parameter is specified on a new line in the format Parameter name Value. For example, AuthenLifeTime 3600 is the session lifetime in seconds 3600.

View the list of parameters:

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

BILLmanager parameters

  • AllowedTurnOffClient — a parameter that describes users who are allowed access to BILLmanager 4 while it is stopped for migration to version 5. Used only for migration to BILLmanager 5; 
  • AuthenLifeTime — session lifetime in seconds. Sessions inactive for longer than the specified time are deleted automatically. By default, this parameter is set to one hour. If you set the time to less than one hour, sessions will be closed even if the panel browser window is open; 
  • AvatarFileSize — the size of the file used as an avatar in the web interface; 
  • DBHost — database server address. Usually localhost; 
  • DBName — billing database name (billmgr); 
  • DBPassword — password for connecting to the database server; 
  • DBSocket — socket for connecting to the database server; 
  • DBUser — user for connecting to the database (billmgr);
  • DayBeforePaydateForDebtWarning — how many days before the due date to send the client a notification about the need to pay the invoice. The default value is: 3. Read more in Credit limit management;
  • DayAfterPaydateForDebtExpiredWarning — how many days after the due date to send the client a notification about the need to pay the invoice. 
  • The default value is: 1. Read more in Credit limit management;
  • DayBeforeBlockedForDebtWarning — how many days before blocking to send the client a notification about the need to pay the invoice. The default value is: 5. Read more in Credit limit management;
  • EnableBlockingSince — the date from which blocking for overdue receivables starts working. Read more in Credit limit management;
  • LastLogin — sets the condition for displaying the banner with information about the last login. It can have the following values:
    • info — always show the banner;
    • notify — show the banner only if the address has changed;
    • none — do not show the banner;
  • LongRequest — the time in seconds allowed for a request to complete. A request that takes longer than the specified time is placed in a special long request log var/<panel name>.long.log. Default: 300 seconds; 
  • LowMoneyExpirePeriod — determines:
    • if auto-renewal is disabled, how many days in advance to send a notification that the services need to be renewed. Default: 5 4 3 2 1 0;

    • if auto-renewal is enabled, how many days in advance to send a notification that there are insufficient funds for automatic service renewal. Default: 5 4 3 2 1 0;

      Notifications are not sent for services with a trial period.
  • LowMoneyNoticePeriod — how many days before paying for the service to send a notification or create an automatic payment when the account balance is low. Default: 0 1 2 3 4 5 10, where the values are the days before the service expires;
  • NearDeletePeriod — how many days in advance to send a notification that services without auto-renewal will be deleted. Default: 7 5 3 1; 
  • NumberOfThreadsForPool — the number of requests that can be processed simultaneously. If the number of requests exceeds the specified value, they are queued.
  • PWGenCharacters — characters used to generate passwords. Default: 1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ; 
  • PWGenLen — number of characters in the password; 
  • PWStrength — perform password strength checking. Possible values:
    • 0 — do not check ;
    • 1 — "weak";
    • 2 — "good";
    • 3 — "strong"; 
  • PricelistPerItemtype — the number of tariffs displayed in the storefront. Default value: 3. The recommended value should not exceed 10;
  • PreloaderTimeout — the maximum preloader loading time before the "Loading time exceeded" banner appears; 
  • Problems — settings for the "Notifications" section (left menu section, notifications about issues in the system). It can take the following values:
    • ProblemsAddressFrom;
    • ProblemsAddressTo;
    • ProblemsEmailEnabled; ProblemsKeepOld;
    • ProblemsKeepSolved;
    • ProblemsLang;
    • ProblemsPeriod;
    • ProblemsShowAll;
    • ProblemsSmtpPort;
    • ProblemsSmtpServer;
  • Release — the type of distribution used; 
  • SMTP — mail settings. Values:
    • SMTPPort;
    • SMTPServer;
    • SMTPUser;
  • ServiceProfileDisableNormalizeClone — disables automatic creation of normalized contact clones. It can take the following values:
    • on — enabled. Only contacts of the required type are shown in the lists: unnormalized for regular zones, normalized for zones with normalization;
    • off — disabled. Default value;
  • StartPage — the start page that will be shown first after you log in; 
  • StatNotificationType — send a notification either for each deduction based on statistics or for debt-based deductions (section Global settings → Statistics-based); 
  • RegFormType — simple or extended client registration form (1 or 2); 
  • StatExpensePolicy — if the amount of funds available for deduction is insufficient, do not perform any actions, make the deduction, or stop the service;
  • SSLRestrictedTld — restricted TLDs, specified separated by commas;
  • SSLRestrictedCountry — restricted countries, specified separated by commas in ISO2 format;
  • SSLRestrictedBrand — restricted SSL brands, specified separated by commas.

Parameters inherited from COREmanager

  • AuthenLifeTime — session lifetime in seconds. Sessions that remain idle for more than the period specified, will be removed automatically. The default value is "3600";
  • BuilderOnUpdateXml — path to the script that starts when changing the XML-files of the control panel. It is used in the developer mode;
  • ConnectionLimit — the number of simultaneous connections processed by CORE. The default value is "100";
  • DefaultAccessIp — allow access from the selected IP addresses regardless user settings;
  • DefaultButtonView — default button types in the control panels. The default value is "buttontext":
    • buttontext — icons and text.
  • DefaultHintView — show hints to form fields. The default value is "hintactive":
    • hintactive — the hint will be shown when focusing on the hint;
    • hintpassive — the hint will be shown when moving the mouse cursor on the hint;
  • DefaultInterface — name of the interface to which alias IP addresses are added by default;
  • DefaultLang — default language that will be used. if the browser language cannot be identified or the control panel doesn't support that language;
  • DefaultTheme dragon — the default interface theme;
  • ExpireLogsDays — period in days to store the operation log of the control panel. Indicated in days. The default value is "365";
  • ExceedEmailCount — the number of mail notifications that can be sent to one mailbox per day;
    • 0 — no mail notifications will be sent;

    • 1 — one mail notification of the specified type will be sent to one mailbox per day:

      Types of mail notifications
  • FileMaxEditSize — maximum file size (in KiB) that a user can open in the file manager. The default value is 1024;
  • ForwardedSecret — a key that is used for setting a real IP address is proxy is configured. For more information please refer to the article Control panel address;
  • FsEncoding — file system encoding for the file manager. UTF-8 is used by default;
  • InternalAdminName — administrator who sends internal requests;
  • LastLogin — show the banner informing when you accessed the system for the last time. Possible values:
    • info - always show the banner,
    • warning- show the banner only if the IP address was changed,
    • none - do not show the banner,
  • LicIp — license IP address;
  • LongRequest — time in seconds. If the request is executed for a longer time, it will be registered in the long requests log var/<panel name>.long.log. The default value is 300;
  • MailMode — mail server type to send email notifications;
  • MakefileDir — path to the assembly directory. It is used in the developer mode. The default value is"src/builder";
  • OneTimeExpire — limits the validity period of the temporary key for authorization. The key is created using the session.newkey function. By default, the parameter has a value of 3600 seconds and can take any integer value. For example, to change the validity period of a key from 1 hour to 10 minutes, set OneTimeExpire 600;
  • PWGenCharacters — symbols that are used for randomly generated password. The default value is "1234567890abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ". To make the control panel use special characters (#, $, & etc.) when generating a password, add the required characters to the parameter value;
  • PWGenLen — length of the randomly generated password. The default value is "8";
  • PWStrength — check password strength. The default value is "2":
    • 0 - do not check;
    • 1 - week passwords can be used (K = 3..6);
    • 2 - week passwords cannot be used (K = 6..9);
    • 3 - only strong passwords can be used (K = 9..∞).

    • The password is checked against the dictionary words, and the coefficient of the password strength (K)is calculated as follows: . N — total number of symbols. Nu — number of unique symbols (case-sensitive). Ns — number of special symbols. Nr — number of letters with a different case. Nc — number of consecutive symbols of the same type (letters, digits, special symbols).

  • ProblemsAddressFrom — email from which the mail issue notifications are sent;
  • ProblemsAddressTo — email that receives the mail issue notifications;

  • ProblemsEmailEnabled — this option allows sending the mail issue notifications. The default value is "off":

    • on — enabled;
    • off — disabled.
  • ProblemsKeepOld — period to store notifications in the control panel. The default value is "30";
  • ProblemsKeepSolved — period to store unsolved issues in the control panel. The default value is "7";
  • ProblemsLang — language that is used to describe issues in the email notifications;
  • ProblemsPeriod — period in minutes that will pass before the next attempt to resolve the issue will be made. The default value is "60";
  • ProblemsShowAll — show notifications about user issues. The default value is "off":
    • on — enabled;
    • off — disabled.
  • ProblemsSmtpPort — SMTP-server port to send issue notifications;
  • ProblemsSmtpServer — SMTP-server address to send issue notifications;
  • RestrictAuthinfoRange — authinfo “whitelist” settings. For more information please refer to the article Guide to ISPsystem software API;
  • SMTPPass — user password of the SMTP-server to send issue notifications;
  • SMTPPort — SMTP-server port to send email notifications;
  • SMTPServer — SMTP-server address to send email notifications;
  • SMTPUser — username of the SMTP-server port to send email notifications;
  • SenderName — notification sender name;
  • StartPage — default start page;
  • SOARefreshTime — refresh parameter for SOA record. Determines by default the time interval in seconds after which the system checks whether it needs to update a domain zone in seconds for secondary DNS servers. If the serial number has changed since its last check, then the domain zone on the secondary DNS server will be updated;
  • XSLFOProc — parameters to call the external FO-processor.

Paths

Syntax: each parameter is specified on a new line in the format "path Value".

View the list of paths:

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

Paths inherited from COREmanager

  • ifconfig — the ifconfig utility. The default value is "/sbin/ifconfig".

Options

An option is active if it is specified in the configuration file.

View the list of options:

Syntax: each option is specified on a new line in the format "Option Value"
/usr/local/mgr5/sbin/mgrctl -m billmgr optionlist

BILLmanager options

  • Option EULA — the user selected "I agree" to the terms of the ISPsystem software license agreement. If you delete the option, you will be able to see the agreement text again the next time the panel web interface starts;
  • Option EnableGlobalDiscountQueryCache — enables caching of tariff price calculation with discounts for each client. The option makes it faster to build the list of tariffs and calculate the final price when there are many personal discounts and promotions. When the option is enabled, RAM usage can increase to 4 GB;
  • Option EnableUserConfDb — allows writing user settings from configuration files /usr/local/mgr5/var/userconf to the BILLmanager database;
  • Option ExtendValueItemparam — increase the value field size in the itemparam database table. Affects the length of the string in the itemparam.value field:
    • without the option — 256 characters;
    • with the option — 512 characters;
  • Option EmailUseLibrary — the option allows sending emails in multiple threads using the built-in library. When the option is enabled, emails are processed inside the platform's main process, without starting a separate service;
  • Option ntemail_use_thread — allows using a preconfigured pool of worker processes for sending emails. The number of threads is determined by the formula:
A = max(2, B / 3)

Where:

    • A — number of threads;
    • B — number of logical CPU cores. If B/3 is a fractional number, the fractional part is discarded. For example, the CPU has 16 logical cores. In this case, B = 16/3 = 5;
    • max(2u, ...) — the minimum guaranteed number of threads. Using the option guarantees that the number of threads will never be less than two: if the formula gives 1 or 0, the system automatically uses 2 threads.
  • Option DeleteManualSuspend — enable automatic deletion for services manually stopped by the provider (Global settings section); 
  • Option AllowDeleteNotification — allow clients to delete notifications; 
  • Option OneDedicatedIp — assign no more than one IP address when opening a service; 
  • Option CheckIpInUse — delete only free IP addresses; 
  • Option RequireAccountActivation — require email confirmation during registration; 
  • Option AllocatePricelistLimitIp — automatically recreate the IP addresses included in the tariff; 
  • Option HideClosedItem — do not show services with the "Deleted" status; 
  • Option AllowAnyCountryForProfile — allow payers to specify a country different from the one specified for the client;
  • Option ExplicitTicketDepartmentSelection — make department selection mandatory when a client creates a support request; 
  • Option ProhibitDifferentProfileTypes — prohibit different payer types on one account; 
  • Option AutoPayment — enable automatic invoicing;
  • Option ReserveWithoutExpense — reserve funds without creating expenses; 
  • Option ShowAnnualTurnover — display annual turnover by payments (enabled by default); 
  • Option ShowAnnualExpense — display annual turnover by expenses (mutually exclusive with ShowAnnualTurnover);
  • Option SupportToCc — enable sending notifications to email addresses specified in the CC field of the message received from the client;
  • Option InstructionHidePassword — hide passwords in service instructions. Enabling this option helps protect client servers from unauthorized access. When you open the instruction in email, the password will be visible, and when you open the instruction in BILLmanager, it will be hidden;
  • Option SSLRestrictByCountry — enable country-based restriction;
  • Option SSLRestrictByTld — enable TLD-based restriction;
  • Option SSLRestrictContactPhoneByCountry — enable country-based restriction for the contact's phone number;
  • Option SSLRestrictOrgByCountry — enable country-based restriction for the organization;
  • Option SSLRestrictOrgPhoneByCountry — enable country-based restriction for the organization's phone number;

  • Option SSLSubscriptionPolicy — configure the certificate handling policy within a subscription. Values:

    • auto — certificate reissue starts automatically;
    • manual — the client receives a notification about the certificate expiration date;
    • none — no actions are performed;
  • Option SSLSubscriptionBefore — the value determines how many days before the certificate expires the Option SSLSubscriptionPolicy policy should be started. Default value is 10, maximum value is 200.

Options inherited from COREmanager

  • DisableAutoUpdate — disable auto updates of a control panel;
  • DisableCookieSecure — disable the Secure attribute for cookies. Add this option to access a control panel through HTTP. By default, the option is not specified in the configuration file;
  • DoNotRestoreTasks — do not recover cron jobs. After you have added this option, a control panel will try to create the required cron jobs upon each start;
  • EULA — a user has pressed the "I agree" button to accept ISPsystem License agreement. Deleting this option will show the License agreement when starting the control panel the next time;

  • EnableAcmeshDebug — in the file /usr/local/mgr5/var/<panel_name>_acme_sh.log the log of issuing and updating LE certificates is written. By default, the option is disabled;

    Comments

  • EnableDbAuthlog — if this option is enabled and the type of MySQL database is used, the authorization log will be written to the database. Logging stops. By default, the option is disabled;

    Details
  • FirstStart — the first start of a control panel. The Setup Wizard will open when an administrator logs in to a panel for the first time;

  • HtmlToTextConverter — Specifies which converter to use to convert html to text. Can take the following values:

    • internal;
    • w3m — used by default;
    • lynx;
  • IgnorePluginError — ignore the errors that occur when using a plug-in (if you couldn't start the plug-in or it returned invalid XML). After you have added this option the function will be executed but the corresponding error notification will be registered;
  • RestrictAuthinfo — enable restrictions for authinfo.For more information please refer to the article Guide to ISPsystem software API;
  • SocialDisableFacebook — disable authorization of users through the Facebook social network;
  • SocialDisableGoogle — disable user authorization through a Google account;
  • SocialDisableVkontakte — disable authorization of users through the VK social network;
  • UsageStatAgree — send anonymous information about the use of the control panel. We collect information to improve the quality of our services. We don't collect any form or table values.