source: trunk/Distribution/doc/txt/oscam.conf.txt@ 1703

Last change on this file since 1703 was 1703, checked in by landlord, 11 years ago

Documentation update for web interface

File size: 12.4 KB
Line 
1oscam.conf(5) oscam.conf(5)
2
3
4
5NAME
6 oscam.conf - main configuration file for OSCam
7
8SYNOPSIS
9 The main configuration file for OSCam contains global parameters such
10 as debugging, logging, monitor, protocols and anti-cascading. sections
11 in oscam.conf are nonrecurring. The [global] section is required. All
12 other sections are optional.
13
14DESCRIPTIONS
15 The [global] section
16 serverip = IP address
17 bind service to specified IP address, default:all
18
19 logfile = filename|/dev/null|/dev/tty|syslog
20 logging target, default: /var/log/oscam.log
21
22 pidfile = filename
23 PID file, default:no PID file
24
25 usrfile = filename
26 log file for user logging, default:none
27
28 log file format:
29
30 date
31 time
32 CWs per second
33 username
34 IP address of client
35 TCP/IP port
36 CWs found
37 CWs from cache
38 CWs not found
39 CWs ignored
40 CWs timed out
41 CWs tunneled
42 login time in unix/POSIX format
43 logout time in unix/POSIX format
44 protocol
45
46 cwlogdir = path
47 directory for CW logging, default:none
48
49 clienttimeout = seconds
50 value for client process to wait for key, default:5
51
52 fallbacktimeout = seconds
53 time falling back to fallback reader, default:2
54
55 clientmaxidle = seconds
56 value for client process being idle before disconnect, default:120
57
58 cachedelay = milli-seconds
59 value to delay cached requests , default:0
60
61 bindwait = seconds
62 value to wait for bind request to complete, default:120
63
64 netprio = priority
65 network priority, default:system given
66
67 resolvedelay = seconds
68 delay for DNS resolving, default:30
69
70 sleep = minutes
71 time waiting for inactive users, default:none, can be overwritten
72 per user in oscam.user
73
74 unlockparental = 0|1
75 1 = unlock parental mode option to disable Seca pin code request for
76 adult movie, default:0
77
78 nice = -20..+20
79 system priority, default:99
80
81 serialreadertimeout = milli-seconds
82 timeout for serial reader, default:1500
83
84 maxlogsize = kbytes
85 max log file size, default:10
86
87 waitforcards = 0|1
88 1 = wait for local SCs on startup before opening network ports,
89 default:0
90
91 preferlocalcards = 0|1
92 1 = try decoding on local cards first, default:0
93
94 The [monitor] section
95 port = 0|port
96 UDP port for monitor, port=0 monitor disabled, default:0
97
98 serverip = IP address
99 bind service to specified IP address, default:all
100
101 nocrypt = IP address|IP address range[,IP address|IP address range]...
102 unsecured monitor connection, default:none
103
104 example: nocrypt = 127.0.0.1,192.168.0.0-192.168.255.255
105
106 aulow = minutes
107 time no EMM occurs so that client is set to low, default:30
108
109 monlevel = 0|1|2|3|4
110 monitor level:
111
112 0 = no access to monitor
113 1 = only server and own procs
114 2 = all procs, but viewing only, default
115 3 = all procs, reload of oscam.user possible
116 4 = complete access
117
118 monlevel can be overwritten per user in oscam.user
119
120 hideclient_to = seconds
121 time to hide clients in the monitor if not sending requests, 0 =
122 disabled, default:0
123
124
125 The [webif] section (only if web interface module enabled)
126 httpport = port
127 port for web interface, 0 = disabled, default:none, required
128
129 httpuser = username
130 username for password protection, default:none
131
132 httppwd = password
133 password for password protection, default:none
134
135 httpcss = path
136 path for external CSS file, default:none
137
138 httptpl = path
139 path for external templates, default:none
140
141 httprefresh = seconds
142 status refresh in seconds, default:none
143
144 httptpl = path
145 path for external templates, default:none
146
147 httphideidleclients = 0|1
148 1 = enables hiding clients after idle time set in parameter hide
149 client_to, default:0
150
151 httpscript = path
152 path to an executable script which you wish to start from web inter
153 face, default:none
154
155 httpallowed = IP address|IP address range[,IP address|IP address
156 range]...
157 http web interface connections allowed, default:none
158 example: httpallowed = 127.0.0.1,192.168.0.0-192.168.255.255
159
160 The [camd33] section
161 port = 0|port
162 TCP/IP port for camd 3.3x clients, 0 = disabled, default:0
163
164 serverip = IP address
165 bind service to specified IP address, default:all
166
167 nocrypt = IP address|IP address range[,IP address|IP address range]...
168 unsecured camd 3.3x client connection, default:none
169
170 example: nocrypt = 127.0.0.1,192.168.0.0-192.168.255.255
171
172 passive = 0|1
173 1=force passive camd 3.3x client, default:0
174
175 key = 128 bit key
176 key for camd 3.3x client encryption, default:none
177
178 example: key = 01020304050607080910111213141516
179
180 The [camd35] section
181 port = 0|port
182 UDP port for camd 3.5x clients, 0 = disabled, default:0
183
184 serverip = IP address
185 bind service to specified IP address, default:all
186
187 The [newcamd] section
188 port = port@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...
189 TCP port/CAID/ident definitions, default:none
190
191 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
192
193 Each CAID requires a separate port.
194
195 serverip = IP address
196 bind service to specified IP address, default:all
197
198 allowed = IP address|IP address range[,IP address|IP address range]...
199 client connections allowed from, default:none
200
201 example: allowed = 127.0.0.1,192.168.0.0-192.168.255.255
202
203 keepalive = 0|1
204 0 = disable keepalive, default:1
205
206 key = DES key
207 key for newcamd client encryption, default:none
208
209 example key = 0102030405060708091011121314
210
211 The [radegast] section
212 port = 0|port
213 TCP/IP port for radegast clients, 0=disabled, default:0
214
215 serverip = IP address
216 bind service to specified IP address, default:all
217
218 allowed = IP address|IP address range[,IP address|IP address range]...
219 client connections allowed from, default:none
220
221 example: allowed = 127.0.0.1,192.168.0.0-192.168.255.255
222
223 user = username
224 user name for radegast client
225
226 The [serial] section
227 device = <user>@<device>[:baud][?option1=value1[&option2=value2]]
228 parameters:
229 user = account
230 device = serial device name
231 option = timeout = milli-seconds, timeout for connection,
232 default:50
233 delay = milli-seconds, additional delay between two
234 characters, default:0
235
236 supported serial devices:
237 HSIC (humax sharing interface client)
238 SSSP (simple serial sharing protocol)
239 bomba (BOMBA firmware)
240 dsr9500 (DSR 9500)
241
242 The [cs357x] section
243 port = 0|port
244 UDP port for camd 3.57x clients, 0 = disabled, default:0
245
246 serverip = IP address
247 bind service to specified IP address, default:all
248
249 suppresscmd08 = 0|1
250 0 = CMD08 enabled, 1 = CMD08 disabled, default:0
251
252 The [cs378x] section
253 port = 0|port@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...
254 TCP port/CAID/ident definitions for camd 3.78x clients,0 = disabled,
255 default:0
256
257 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
258
259 Each CAID requires a separate port.
260
261 serverip = IP address
262 bind service to specified IP address, default:all
263
264 suppresscmd08 = 0|1
265 0 = CMD08 enabled, 1 = CMD08 disabled, default:0
266
267 The [cccam] section
268 port = 0|port
269 TCP/IP port for CCcam clients, 0 = disabled, default:0
270
271 version = <main version>.<version>.<sub version>
272 define CCcam version, default:none
273
274 example: version = 1.2.34
275
276 build = <4-digit number>
277 define CCcam build, default:none
278
279 example: build = 5678
280
281 reshare = level
282 reshare level for CCcam clients, default:none
283
284 0 = no resharing
285 1 = resharing for direct peer only
286 2 = resharing for direct peer and next level
287 x = resharing for direct peer and next x level
288
289 The [gbox] section
290 password = password
291 password for gbox server
292
293 maxdist = distance
294 maximum distance to gbox servers, default:5
295
296 ignorelist = filename
297 listing of providers to be ignored, format: G:{<CAID><provider ID>},
298 default:none
299
300 example: G:{01001234}
301
302 onlineinfos = filename
303 file to store online information, default:none
304
305 cardinfos = filename
306 file to store card information, default:none
307
308 locals = <CAID><provider ID>[,<CAID><provider ID>]...
309 backwards sharing of local cards,default:none
310
311 example: locals = 01001234,02005678
312
313 The [dvbapi] section (only if DVB API module enabled)
314 enabled = 0|1
315 1 = DVB API enabled, default:0
316
317 user = username
318 user name for DVB API client, default:anonymous
319
320 ignore = <CAID>[,<CAID>]...
321 CAIDs to be ignored, default:none
322
323 priority = <CAID>:<provider ID>[,CAID:<provider ID>]...
324 CAIDs and provider IDs to be prioritized, default:CAIDs and provider
325 IDs of local SCs will be prioritized
326
327 au = 0|1
328 1 = enable AU, default:0
329
330 boxtype = dbox2|dreambox|ufs910
331 set boxtype, auto detection of DVB API will be aspired,
332 default:dreambox
333
334 The [anticasc] section (only if anti-cascading enabled)
335 enabled = 0|1
336 1 = enabled anti-cascading, default:0
337
338 numusers = quantity
339 anti-cascading: user per account, 0 = anti-cascading disabled,
340 default:0
341
342 sampletime = minutes
343 duration of sample, default:2
344
345 samples = quantity
346 quantity of samples over limit, default:10
347
348 penalty = 0|1|2
349 level of penalty:
350
351 0 = only logging
352 1 = send fake CWs
353 2 = disbable user temporary
354
355 default:0, penalty can be overwritten per user in oscam.user
356
357 aclogfile = filename
358 file for anti-cascading logging, default:none
359
360 fakedelay = milli-seconds
361 fake delay time, default:1000
362
363 denysamples = quantity
364 How many samples should be penalized?, default:8
365
366MONITOR
367 monitor commands:
368
369 login <user> <password> = login (for unencrypted connections only)
370 exit = exit monitor
371 log <on|onwohist|off> = enable|enable without hitory|disable
372 logging for 2 minutes
373 status = list of current processes and clients
374 shutdown = showdown OSCam
375 reload = reinit user db, clients and anti-cascading,
376 for newcamd connections: after reloading
377 the ident, please restart newcamd client
378 details <PID> = details about selected PID
379 debug <level> = set debug level (monlevel > 3 required)
380 debug level mask:
381 0 = no debugging (default)
382 2 = ATR parsing info, ECM dumps, CW dumps
383 4 = traffic from/to the reader
384 8 = traffic from/to the clients
385 16 = traffic to the reader-device on IFD
386 layer
387 32 = traffic to the reader-device on I/O
388 layer
389 63 = debug all
390 version = show OSCam version
391
392WEB INTERFACE
393 template system
394
395 The web interface allows you to create your own template. For devel
396 oping your own template request the orignal template with the non-
397 linked page savetemplates.html. Store your own template in the
398 directory specified by httptpl.
399
400 SSL connection to the web interface
401
402 The Apache module mod_proxy can be used to proxy requests to the web
403 interface. With this module its also possible to use a SSL connec
404 tion to the web interface.
405
406 ProxyRequests Off
407 <Proxy *>
408 Order deny,allow
409 Allow from all
410 </Proxy>
411 ProxyPass /oscam/ http://localhost:8080/
412 ProxyPassReverse /oscam/ http://localhost:8080/
413
414 For further information please read the Apache documentation.
415
416 known issues
417
418 Login is not possible by now with the Safari browser because of
419 incorrect stale flag handling. Increasing the AUTHNONCEVALIDSECS in
420 oscam-http.h would be a workaround, but also a small security risk.
421
422EXAMPLES
423 [global]
424 logfile = /var/log/oscam/oscam.log
425 usrfile = /var/log/oscam/oscamuser.log
426 pidfile = /var/run/oscam.pid
427
428 waitforcards = 1
429
430 [monitor]
431 port = 988
432 monlevel = 1
433 nocrypt = 127.0.0.1
434
435 [newcamd]
436 key = 0102030405060708091011121314
437 port = 10000@0100:100000;20000@0200:200000,300000,400000
438
439 [radegast]
440 port = 30000
441 user = radegastuser
442 allowed = 127.0.0.1,192.168.0.0-192.168.255.255
443
444 [camd33]
445 port = 40000
446 serverip = 192.168.0.1
447 key = 01020304050607080910111213141516
448
449 [cs378x]
450 port = 50000@0300:600000
451
452SEE ALSO
453 list_smargo(1), oscam(1), oscam.user(5), oscam.server(5),
454 oscam.srvid(5), oscam.guess(5), oscam.cert(5), oscam.services(5),
455 oscam.ird(5), oscam.ac(5)
456
457
458
459 oscam.conf(5)
Note: See TracBrowser for help on using the repository browser.