]> git.stg.codes - stg.git/blobdiff - projects/stargazer/inst/linux/etc/stargazer/stargazer.conf
Fix trailing whitespaces.
[stg.git] / projects / stargazer / inst / linux / etc / stargazer / stargazer.conf
index 5c0693c44e5eb39cfeeecdc3caac8f9b0ce59b1a..769196099622de3a21de4af14916b4431e2ca450 100644 (file)
-################################################################################\r
-#                        Stargazer Configuration file                          #\r
-################################################################################\r
-\r
-# LOG file name\r
-# Parameter: required\r
-# Value: file path\r
-# Default: /var/log/stargazer.log\r
-LogFile = /var/log/stargazer.log\r
-\r
-# PID file name\r
-# Parameter: optional\r
-# Value: file path\r
-# Default: /var/run/stargazer.pid\r
-PIDFile = /var/run/stargazer.pid\r
-\r
-# Traffic classification rules\r
-# Parameter: required\r
-# Value: file path\r
-# Default: /etc/stargazer/rules\r
-Rules = /etc/stargazer/rules\r
-\r
-# The time interval between writing detailed user's statistics into the database\r
-# Note: With a large number of users this value should be increased,\r
-# since writting into the database can take a long time.\r
-# Parameter: required\r
-# Values: 1 (hourly), 1/2 (every half hour), 1/4 (every 15 m), 1/6 (every 10 m)\r
-# Default: 1/2\r
-DetailStatWritePeriod = 1/2\r
-\r
-# The time interval between writing summary user's statistics into the database\r
-# Parameter: optional\r
-# Value: 1 ... 1440 (minutes)\r
-# Default: 10\r
-StatWritePeriod = 10\r
-\r
-# Day of charging fee\r
-# Note: 0 - The last day of the month\r
-# Parameter: required\r
-# Value: 0 ... 31\r
-# Default: 1\r
-DayFee = 1\r
-\r
-# Fee charged at the last (yes) or first (no) day of tariffication period.\r
-# Defines how the fee will be charged in the transition to the new tariff.\r
-# User has tariff A with fee 100. Changing it to tariff B with fee 200\r
-# will result in charging user's account at 100 if DayFeeIsLastDay = yes \r
-# and at 200, if DayFeeIsLastDay = no\r
-# Parameter: required\r
-# Values: yes, no\r
-# Default: no\r
-DayFeeIsLastDay = no\r
-\r
-# Day of changing delayed tariffs and resetting summary user's statistics.\r
-# Defines the edge of the tariffication period.\r
-# Parameter: required\r
-# Value: 0 ... 31. 0 - The last day of the month\r
-# Default: 1\r
-DayResetTraff = 1\r
-\r
-# Defines whether to charge fee daily (yes) or monthly (no)\r
-# Parameter: required\r
-# Values: yes, no\r
-# Default: no\r
-SpreadFee = no\r
-\r
-# Defines whether the user can access the internet if it has no cash,\r
-# but remained prepaid traffic\r
-# Parameter: required\r
-# Values: yes, no\r
-# Default: no\r
-FreeMbAllowInet = no\r
-\r
-# Defines what will be written in the traffic cost in detail_stat.\r
-# If user still has the prepaid traffic and WriteFreeMbTraffCost = no,\r
-# then the traffic cost willn't be written in detail_stat.\r
-# If user doestn't have prepaid traffic and WriteFreeMbTraffCost = no, \r
-# then the traffic cost will be written in detail_stat.\r
-# When WriteFreeMbTraffCost = yes the traffic cost will be recorded in any case.\r
-# Parameter: required\r
-# Values: yes, no\r
-# Default: yes\r
-WriteFreeMbTraffCost = yes\r
-\r
-# Charge a full monthly fee even if user was "frozen" a part \r
-# of the tariffication period\r
-# Parameter: optional\r
-# Values: yes, no\r
-# Default: no\r
-FullFee = yes\r
-\r
-# Allow user to see and use a full cash (yes) or hide a part of it (no) \r
-# for the next fee charge\r
-# Parameter: optional\r
-# Values: yes, no\r
-# Default: yes\r
-# ShowFeeInCash=yes\r
-\r
-# The names of directions. Direction without names will not appear in\r
-# authorizer and configurator.\r
-# Note: Names consisting of several words should be quoted\r
-# Parameter: optional\r
-# Values:\r
-<DirNames>\r
-    DirName0 = Internet\r
-    DirName1 =\r
-    DirName2 =\r
-    DirName3 =\r
-    DirName4 =\r
-    DirName5 =\r
-    DirName6 =\r
-    DirName7 =\r
-    DirName8 =\r
-    DirName9 =\r
-</DirNames>\r
-\r
-# Amount of stg-exec processes.\r
-# These processes are responsible for the execution of scripts OnConnect, \r
-# OnDisconnect, etc. \r
-# Amount of processes means how many scripts can be executed simultaneously.\r
-# Recommend to leave 1 to avoid errors when executing scripts\r
-# Parameter: optional\r
-# Value: 1 ... 1024\r
-# Default: 1\r
-ExecutersNum = 1\r
-\r
-# Message queue identifier for the script executer.\r
-# It may be changed if there're a needs to run multiple copies of stargazer.\r
-# Warning: If you do not understand it, do not touch this setting!\r
-# Parameter: optional\r
-# Value: 0 ... 2 ^ 32\r
-# Default: 5555\r
-# ExecMsgKey = 5555\r
-\r
-# The path to directory with server modules\r
-# Parameter: required\r
-# Value: directory path\r
-# Default: /usr/lib/stg\r
-ModulesPath = /usr/lib/stg\r
-\r
-# Directory where the "monitor" files are located.\r
-# A blank files will be created in this directory. The modification time of such\r
-# files will be changed about once a minute. If server crashes or some of server \r
-# component hang, the files will stop refreshing, and on this basis we can define\r
-# the failure of the server and if necessary restart. \r
-# If option is omitted or blank, the monitoring is not performed.\r
-# Parameter: optional\r
-# Value: file path\r
-# Default: /var/stargazer/monitor\r
-#MonitorDir=/var/stargazer/monitor\r
-\r
-################################################################################\r
-# Store module\r
-# Configure the module that works with the database server\r
-\r
-# Warning: Only one store module could be used at the same time!\r
-\r
-<IncludeFile "conf-enabled.d/store_*.conf">\r
-</IncludeFile>\r
-\r
-\r
-################################################################################\r
-# Other modules\r
-\r
-<Modules>\r
-\r
-    <IncludeFile "conf-enabled.d/mod_*.conf">\r
-    </IncludeFile>\r
-\r
-</Modules>\r
-################################################################################\r
+################################################################################
+#                        Stargazer Configuration file                          #
+################################################################################
+
+# LOG file name
+# Parameter: required
+# Value: file path
+# Default: /var/log/stargazer.log
+LogFile = /var/log/stargazer.log
+
+# PID file name
+# Parameter: optional
+# Value: file path
+# Default: /var/run/stargazer.pid
+PIDFile = /var/run/stargazer.pid
+
+# Traffic classification rules
+# Parameter: required
+# Value: file path
+# Default: /etc/stargazer/rules
+Rules = /etc/stargazer/rules
+
+# The time interval between writing detailed user's statistics into the database
+# Note: With a large number of users this value should be increased,
+# since writting into the database can take a long time.
+# Parameter: required
+# Values: 1 (hourly), 1/2 (every half hour), 1/4 (every 15 m), 1/6 (every 10 m)
+# Default: 1/2
+DetailStatWritePeriod = 1/2
+
+# The time interval between writing summary user's statistics into the database
+# Parameter: optional
+# Value: 1 ... 1440 (minutes)
+# Default: 10
+StatWritePeriod = 10
+
+# Day of charging fee
+# Note: 0 - The last day of the month
+# Parameter: required
+# Value: 0 ... 31
+# Default: 1
+DayFee = 1
+
+# Fee charged at the last (yes) or first (no) day of tariffication period.
+# Defines how the fee will be charged in the transition to the new tariff.
+# User has tariff A with fee 100. Changing it to tariff B with fee 200
+# will result in charging user's account at 100 if DayFeeIsLastDay = yes
+# and at 200, if DayFeeIsLastDay = no
+# Parameter: required
+# Values: yes, no
+# Default: no
+DayFeeIsLastDay = no
+
+# Day of changing delayed tariffs and resetting summary user's statistics.
+# Defines the edge of the tariffication period.
+# Parameter: required
+# Value: 0 ... 31. 0 - The last day of the month
+# Default: 1
+DayResetTraff = 1
+
+# Defines whether to charge fee daily (yes) or monthly (no)
+# Parameter: required
+# Values: yes, no
+# Default: no
+SpreadFee = no
+
+# Defines whether the user can access the internet if it has no cash,
+# but remained prepaid traffic
+# Parameter: required
+# Values: yes, no
+# Default: no
+FreeMbAllowInet = no
+
+# Defines what will be written in the traffic cost in detail_stat.
+# If user still has the prepaid traffic and WriteFreeMbTraffCost = no,
+# then the traffic cost willn't be written in detail_stat.
+# If user doestn't have prepaid traffic and WriteFreeMbTraffCost = no,
+# then the traffic cost will be written in detail_stat.
+# When WriteFreeMbTraffCost = yes the traffic cost will be recorded in any case.
+# Parameter: required
+# Values: yes, no
+# Default: yes
+WriteFreeMbTraffCost = yes
+
+# Charge a full monthly fee even if user was "frozen" a part
+# of the tariffication period
+# Parameter: optional
+# Values: yes, no
+# Default: no
+FullFee = no
+
+# Allow user to see and use a full cash (yes) or hide a part of it (no)
+# for the next fee charge
+# Parameter: optional
+# Values: yes, no
+# Default: yes
+# ShowFeeInCash=yes
+
+# The names of directions. Direction without names will not appear in
+# authorizer and configurator.
+# Note: Names consisting of several words should be quoted
+# Parameter: optional
+# Values:
+<DirNames>
+    DirName0 = Internet
+    DirName1 =
+    DirName2 =
+    DirName3 =
+    DirName4 =
+    DirName5 =
+    DirName6 =
+    DirName7 =
+    DirName8 =
+    DirName9 =
+</DirNames>
+
+# Amount of stg-exec processes.
+# These processes are responsible for the execution of scripts OnConnect,
+# OnDisconnect, etc.
+# Amount of processes means how many scripts can be executed simultaneously.
+# Recommend to leave 1 to avoid errors when executing scripts
+# Parameter: optional
+# Value: 1 ... 1024
+# Default: 1
+ExecutersNum = 1
+
+# Message queue identifier for the script executer.
+# It may be changed if there're a needs to run multiple copies of stargazer.
+# Warning: If you do not understand it, do not touch this setting!
+# Parameter: optional
+# Value: 0 ... 2 ^ 32
+# Default: 5555
+# ExecMsgKey = 5555
+
+# The path to directory with server modules
+# Parameter: required
+# Value: directory path
+# Default: /usr/lib/stg
+ModulesPath = /usr/lib/stg
+
+# Directory where the "monitor" files are located.
+# A blank files will be created in this directory. The modification time of such
+# files will be changed about once a minute. If server crashes or some of server
+# component hang, the files will stop refreshing, and on this basis we can define
+# the failure of the server and if necessary restart.
+# If option is omitted or blank, the monitoring is not performed.
+# Parameter: optional
+# Value: file path
+# Default: /var/stargazer/monitor
+#MonitorDir=/var/stargazer/monitor
+
+# Defines message maximum lifetime
+# Note: 0 - unlimited
+# Parameter: optional
+# Value: any numeric
+# Default: 0 (day)
+# MessagesTimeout = 0
+
+# Defines fee charging rules.
+# 0 - classic rules, allow fee charge even cash is negative;
+# 1 - disallow fee charge if cash value is negative;
+# 2 - disallow fee charge if there is not enought cash (cash < fee).
+# Parameter: optional
+# Value: 0 ... 2
+# Default: 0 (classic)
+# FeeChargeType = 0
+
+# Enable or disable reconnect on tariff change
+# Parameter: optional
+# Values: yes, no
+# Default: no
+# ReconnectOnTariffChange = no
+
+# Definest set of parameters passed to OnConnect and OnDisconnect scripts
+# This set is added to the end of the default param list, which are, respectively:
+# login, ip, cash, id, dirs
+# Valid parameter names: "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".
+# Parameter: optional
+# Values: parameter names, case insensitive
+# Default:
+# ScriptParams =
+
+# Enable or disable writing session log
+# Parameter: optional
+# Values: yes, no
+# Default: no (session log is enabled)
+# DisableSessionLog = no
+
+# Filter for logging parameter changes
+# Defines which parameters will be logged to parameter log in database. Allows
+# to specify multiuple parameter names or asterisk (*), which means "log all params".
+# Valid parameter names: "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".
+# Parameter: optional
+# Values: parameter names, case insensitive, or "*"
+# Default: *
+# FilterParamsLog = *
+
+################################################################################
+# Store module
+# Configure the module that works with the database server
+
+# Warning: Only one store module could be used at the same time!
+
+<IncludeFile "conf-enabled.d/store_*.conf">
+</IncludeFile>
+
+
+################################################################################
+# Other modules
+
+<Modules>
+
+    <IncludeFile "conf-enabled.d/mod_*.conf">
+    </IncludeFile>
+
+</Modules>
+################################################################################