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