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

Last change on this file since 1746 was 1746, checked in by landlord, 10 years ago

Documentation for 'setuser' command in monitor module

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