stargazer/inst/freebsd/etc/stargazer/stargazer.conf

   1 ################################################################################
   2 #                        Stargazer Configuration file                          #
   3 ################################################################################
   4
   5 # LOG file name
   6 # Parameter: required
   7 # Value: file path
   8 # Default: /var/log/stargazer.log
   9 LogFile = /var/log/stargazer.log
  10
  11 # PID file name
  12 # Parameter: optional
  13 # Value: file path
  14 # Default: /var/run/stargazer.pid
  15 PIDFile = /var/run/stargazer.pid
  16
  17 # Traffic classification rules
  18 # Parameter: required
  19 # Value: file path
  20 # Default: /etc/stargazer/rules
  21 Rules = /etc/stargazer/rules
  22
  23 # The time interval between writing detailed user's statistics into the database
  24 # Note: With a large number of users this value should be increased,
  25 # since writting into the database can take a long time.
  26 # Parameter: required
  27 # Values: 1 (hourly), 1/2 (every half hour), 1/4 (every 15 m), 1/6 (every 10 m)
  28 # Default: 1/2
  29 DetailStatWritePeriod = 1/2
  30
  31 # The time interval between writing summary user's statistics into the database
  32 # Parameter: optional
  33 # Value: 1 ... 1440 (minutes)
  34 # Default: 10
  35 StatWritePeriod = 10
  36
  37 # Day of charging fee
  38 # Note: 0 - The last day of the month
  39 # Parameter: required
  40 # Value: 0 ... 31
  41 # Default: 1
  42 DayFee = 1
  43
  44 # When set to 'no' Stargazer will continue reading database after error and show all of them.
  45 # Parameter: optional
  46 # Values: yes, no
  47 # Default: yes
  48 # StopOnError = yes
  49
  50 # Fee charged at the last (yes) or first (no) day of tariffication period.
  51 # Defines how the fee will be charged in the transition to the new tariff.
  52 # User has tariff A with fee 100. Changing it to tariff B with fee 200
  53 # will result in charging user's account at 100 if DayFeeIsLastDay = yes
  54 # and at 200, if DayFeeIsLastDay = no
  55 # Parameter: required
  56 # Values: yes, no
  57 # Default: no
  58 DayFeeIsLastDay = no
  59
  60 # Day of changing delayed tariffs and resetting summary user's statistics.
  61 # Defines the edge of the tariffication period.
  62 # Parameter: required
  63 # Value: 0 ... 31. 0 - The last day of the month
  64 # Default: 1
  65 DayResetTraff = 1
  66
  67 # Defines whether to charge fee daily (yes) or monthly (no)
  68 # Parameter: required
  69 # Values: yes, no
  70 # Default: no
  71 SpreadFee = no
  72
  73 # Defines whether the user can access the internet if it has no cash,
  74 # but remained prepaid traffic
  75 # Parameter: required
  76 # Values: yes, no
  77 # Default: no
  78 FreeMbAllowInet = no
  79
  80 # Defines what will be written in the traffic cost in detail_stat.
  81 # If user still has the prepaid traffic and WriteFreeMbTraffCost = no,
  82 # then the traffic cost willn't be written in detail_stat.
  83 # If user doestn't have prepaid traffic and WriteFreeMbTraffCost = no,
  84 # then the traffic cost will be written in detail_stat.
  85 # When WriteFreeMbTraffCost = yes the traffic cost will be recorded in any case.
  86 # Parameter: required
  87 # Values: yes, no
  88 # Default: yes
  89 WriteFreeMbTraffCost = yes
  90
  91 # Charge a full monthly fee even if user was "frozen" a part
  92 # of the tariffication period
  93 # Parameter: optional
  94 # Values: yes, no
  95 # Default: no
  96 FullFee = no
  97
  98 # Allow user to see and use a full cash (yes) or hide a part of it (no)
  99 # for the next fee charge
 100 # Parameter: optional
 101 # Values: yes, no
 102 # Default: yes
 103 # ShowFeeInCash=yes
 104
 105 # The names of directions. Direction without names will not appear in
 106 # authorizer and configurator.
 107 # Note: Names consisting of several words should be quoted
 108 # Parameter: optional
 109 # Values:
 110 <DirNames>
 111     DirName0 = Internet
 112     DirName1 =
 113     DirName2 =
 114     DirName3 =
 115     DirName4 =
 116     DirName5 =
 117     DirName6 =
 118     DirName7 =
 119     DirName8 =
 120     DirName9 =
 121 </DirNames>
 122
 123 # Amount of stg-exec processes.
 124 # These processes are responsible for the execution of scripts OnConnect,
 125 # OnDisconnect, etc.
 126 # Amount of processes means how many scripts can be executed simultaneously.
 127 # Recommend to leave 1 to avoid errors when executing scripts
 128 # Parameter: optional
 129 # Value: 1 ... 1024
 130 # Default: 1
 131 ExecutersNum = 1
 132
 133 # Message queue identifier for the script executer.
 134 # It may be changed if there're a needs to run multiple copies of stargazer.
 135 # Warning: If you do not understand it, do not touch this setting!
 136 # Parameter: optional
 137 # Value: 0 ... 2 ^ 32
 138 # Default: 5555
 139 # ExecMsgKey = 5555
 140
 141 # The path to directory with server modules
 142 # Parameter: required
 143 # Value: directory path
 144 # Default: /usr/lib/stg
 145 ModulesPath = /usr/lib/stg
 146
 147 # Directory where the "monitor" files are located.
 148 # A blank files will be created in this directory. The modification time of such
 149 # files will be changed about once a minute. If server crashes or some of server
 150 # component hang, the files will stop refreshing, and on this basis we can define
 151 # the failure of the server and if necessary restart.
 152 # If option is omitted or blank, the monitoring is not performed.
 153 # Parameter: optional
 154 # Value: file path
 155 # Default: /var/stargazer/monitor
 156 #MonitorDir=/var/stargazer/monitor
 157
 158 # Defines message maximum lifetime
 159 # Note: 0 - unlimited
 160 # Parameter: optional
 161 # Value: any numeric
 162 # Default: 0 (day)
 163 # MessagesTimeout = 0
 164
 165 # Defines fee charging rules.
 166 # 0 - classic rules, allow fee charge even cash is negative;
 167 # 1 - disallow fee charge if cash value is negative;
 168 # 2 - disallow fee charge if there is not enought cash (cash < fee).
 169 # Parameter: optional
 170 # Value: 0 ... 2
 171 # Default: 0 (classic)
 172 # FeeChargeType = 0
 173
 174 # Enable or disable reconnect on tariff change
 175 # Parameter: optional
 176 # Values: yes, no
 177 # Default: no
 178 # ReconnectOnTariffChange = no
 179
 180 # Definest set of parameters passed to OnConnect and OnDisconnect scripts
 181 # This set is added to the end of the default param list, which are, respectively:
 182 # login, ip, cash, id, dirs
 183 # Valid parameter names: "cash", "upload", "download", "lastCashAdd", "passiveTime",
 184 # "lastCashAddTime", "freeMb", "lastActivityTime", "password", "passive", "disabled",
 185 # "disabledDetailStat", "alwaysOnline", "tariffName", "nextTariff", "address",
 186 # "note", "group", "email", "phone", "realName", "credit", "creditExpire", "ips",
 187 # "userdata0" ... "userdata9".
 188 # Parameter: optional
 189 # Values: parameter names, case insensitive
 190 # Default:
 191 # ScriptParams =
 192
 193 # Enable or disable writing session log
 194 # Parameter: optional
 195 # Values: yes, no
 196 # Default: no (session log is enabled)
 197 # DisableSessionLog = no
 198
 199 # Filter for logging parameter changes
 200 # Defines which parameters will be logged to parameter log in database. Allows
 201 # to specify multiuple parameter names or asterisk (*), which means "log all params".
 202 # Valid parameter names: "cash", "upload", "download", "lastCashAdd", "passiveTime",
 203 # "lastCashAddTime", "freeMb", "lastActivityTime", "password", "passive", "disabled",
 204 # "disabledDetailStat", "alwaysOnline", "tariffName", "nextTariff", "address",
 205 # "note", "group", "email", "phone", "realName", "credit", "creditExpire", "ips",
 206 # "userdata0" ... "userdata9".
 207 # Parameter: optional
 208 # Values: parameter names, case insensitive, or "*"
 209 # Default: *
 210 # FilterParamsLog = *
 211
 212 ################################################################################
 213 # Store module
 214 # Configure the module that works with the database server
 215
 216 # Warning: Only one store module could be used at the same time!
 217
 218 <IncludeFile "conf-enabled.d/store_*.conf">
 219 </IncludeFile>
 220
 221
 222 ################################################################################
 223 # Other modules
 224
 225 <Modules>
 226
 227     <IncludeFile "conf-enabled.d/mod_*.conf">
 228     </IncludeFile>
 229
 230 </Modules>
 231 ################################################################################