source: trunk/Distribution/doc/man/oscam.conf.5@ 1991

Last change on this file since 1991 was 1991, checked in by landlord, 12 years ago

Documentation: Moved 'ecmcache' parameter to global section.

File size: 15.1 KB
Line 
1.TH oscam.conf 5
2.SH NAME
3\fBoscam.conf\fR - main configuration file for OSCam
4.SH SYNOPSIS
5The main configuration file for OSCam contains global parameters
6such as debugging, logging, monitor, protocols and anti-cascading.
7sections in \fBoscam.conf\fR are \fInonrecurring\fR. The [global]
8section is \fIrequired\fR. All other sections are optional.
9.SH DESCRIPTIONS
10.SS "The [global] section"
11.PP
12\fBserverip\fP = \fBIP address\fP
13.RS 3n
14bind service to specified IP address, default:all
15.RE
16.PP
17\fBlogfile\fP = \fBfilename\fP|\fB/dev/null\fP|\fB/dev/tty\fP|\fBsyslog\fP
18.RS 3n
19logging target, default: /var/log/oscam.log
20.RE
21.PP
22\fBdisablelog\fP = \fB0\fP|\fB1\fP
23.RS 3n
241 = disable log file, default:0
25.RE
26.PP
27\fBdisableuserfile\fP = \fB0\fP|\fB1\fP
28.RS 3n
291 = avoid logging although \fBlogfile\fP is set, default:0
30.RE
31.PP
32\fBpidfile\fP = \fBfilename\fP
33.RS 3n
34PID file, default:no PID file
35.RE
36.PP
37\fBusrfile\fP = \fBfilename\fP
38.RS 3n
39log file for user logging, default:none
40
41log file format:
42
43 date
44 time
45 CWs per second
46 username
47 IP address of client
48 TCP/IP port
49 CWs found
50 CWs from cache
51 CWs not found
52 CWs ignored
53 CWs timed out
54 CWs tunneled
55 login time in unix/POSIX format
56 logout time in unix/POSIX format
57 protocol
58.RE
59.PP
60\fBcwlogdir\fP = \fBpath\fP
61.RS 3n
62directory for CW logging, default:none
63.RE
64.PP
65\fBclienttimeout\fP = \fBseconds\fP
66.RS 3n
67value for client process to wait for key, default:5
68.RE
69.PP
70\fBfallbacktimeout\fP = \fBseconds\fP
71.RS 3n
72time falling back to fallback reader, default:2
73.RE
74.PP
75\fBclientmaxidle\fP = \fBseconds\fP
76.RS 3n
77value for client process being idle before disconnect, default:120
78.RE
79.PP
80\fBcachedelay\fP = \fBmilli-seconds\fP
81.RS 3n
82value to delay cached requests , default:0
83.RE
84.PP
85\fBbindwait\fP = \fBseconds\fP
86.RS 3n
87value to wait for bind request to complete, default:120
88.RE
89.PP
90\fBnetprio\fP = \fBpriority\fP
91.RS 3n
92network priority, default:system given
93.RE
94.PP
95\fBresolvedelay\fP = \fBseconds\fP
96.RS 3n
97delay for DNS resolving, default:30
98.RE
99.PP
100\fBclientdyndns\fP = \fB0\fP|\fB1\fP
101.RS 3n
1021 = enable DNS resolving of clients, if you have already defined a hostname
103for your clients the parameter must be 1, otherwise no authentication will
104be possible for this clients, default:0
105.RE
106.PP
107\fBsleep\fP = \fBminutes\fP
108.RS 3n
109time waiting for inactive users, default:none, can be overwritten per user in \fBoscam.user\fR
110.RE
111.PP
112\fBunlockparental\fP = \fB0\fP|\fB1\fP
113.RS 3n
1141 = unlock parental mode option to disable Seca pin code request for adult movie, default:0
115.RE
116.PP
117\fBnice\fP = \fB-20\fP..\fB+20\fP
118.RS 3n
119system priority, default:99
120.RE
121.PP
122\fBserialreadertimeout\fP = \fBmilli-seconds\fP
123.RS 3n
124timeout for serial reader, default:1500
125.RE
126.PP
127\fBmaxlogsize\fP = \fBkbytes\fP
128.RS 3n
129max log file size, default:10
130.RE
131.PP
132\fBwaitforcards\fP = \fB0\fP|\fB1\fP
133.RS 3n
1341 = wait for local SCs on startup before opening network ports, default:0
135.RE
136.PP
137\fBpreferlocalcards\fP = \fB0\fP|\fB1\fP
138.RS 3n
1391 = try decoding on local cards first, default:0
140.RE
141.PP
142\fBecmcache\fP = \fB0\fP|\fB1\fP
143.RS 3n
1441 = disable ECM cache, default:0
145.RE
146.SS "The [monitor] section"
147.PP
148\fBport\fP = \fB0\fP|\fBport\fP
149.RS 3n
150UDP port for monitor, port=0 monitor disabled, default:0
151.RE
152.PP
153\fBserverip\fP = \fBIP address\fP
154.RS 3n
155bind service to specified IP address, default:all
156.RE
157.PP
158\fBnocrypt\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
159.RS 3n
160unsecured monitor connection, default:none
161
162 example: nocrypt = 127.0.0.1,192.168.0.0-192.168.255.255
163.RE
164.PP
165\fBaulow\fP = \fBminutes\fP
166.RS 3n
167time no EMM occurs so that client is set to low, default:30
168.RE
169.PP
170\fBmonlevel\fP = \fB0\fP|\fB1\fP|\fB2\fP|\fB3\fP|\fB4\fP
171.RS 3n
172monitor level:
173
174 0 = no access to monitor
175 1 = only server and own procs
176 2 = all procs, but viewing only, default
177 3 = all procs, reload of \fBoscam.user\fR possible
178 4 = complete access
179
180monlevel can be overwritten per user in \fBoscam.user\fR
181.RE
182.PP
183\fBhideclient_to\fP = \fBseconds\fP
184.RS 3n
185time to hide clients in the monitor if not sending requests, 0 = disabled, default:0
186.RE
187.PP
188\fBappendchaninfo\fP = \fB0\fP|\fB1\fP
189.RS 3n
1901 = append channel name on log messages, default:0
191.RE
192.SS "The [webif] section" \fI(only if web interface module enabled)\fR
193\fBhttpport\fP = \fBport\fP
194.RS 3n
195port for web interface, 0 = disabled, default:none, \fIrequired\fR
196.RE
197.PP
198\fBhttpuser\fP = \fBusername\fP
199.RS 3n
200username for password protection, default:none
201.RE
202.PP
203\fBhttppwd\fP = \fBpassword\fP
204.RS 3n
205password for password protection, default:none
206.RE
207.PP
208\fBhttpcss\fP = \fBpath\fP
209.RS 3n
210path for external CSS file, default:none
211.RE
212.PP
213\fBhttptpl\fP = \fBpath\fP
214.RS 3n
215path for external templates, default:none
216.RE
217.PP
218\fBhttprefresh\fP = \fBseconds\fP
219.RS 3n
220status refresh in seconds, default:none
221.RE
222.PP
223\fBhttptpl\fP = \fBpath\fP
224.RS 3n
225path for external templates, default:none
226.RE
227.PP
228\fBhttphideidleclients\fP = \fB0\fP|\fB1\fP
229.RS 3n
2301 = enables hiding clients after idle time set in parameter \fBhideclient_to\fP, default:0
231.RE
232.PP
233\fBhttpscript\fP = \fBpath\fP
234.RS 3n
235path to an executable script which you wish to start from web interface, default:none
236.RE
237.PP
238\fBhttpallowed\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
239.RS 3n
240http web interface connections allowed, default:none
241 example: httpallowed = 127.0.0.1,192.168.0.0-192.168.255.255
242.RE
243.SS "The [camd33] section"
244.PP
245\fBport\fP = \fB0\fP|\fBport\fP
246.RS 3n
247TCP/IP port for camd 3.3x clients, 0 = disabled, default:0
248.RE
249.PP
250\fBserverip\fP = \fBIP address\fP
251.RS 3n
252bind service to specified IP address, default:all
253.RE
254.PP
255\fBnocrypt\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
256.RS 3n
257unsecured camd 3.3x client connection, default:none
258
259 example: nocrypt = 127.0.0.1,192.168.0.0-192.168.255.255
260.RE
261.PP
262\fBpassive\fP = \fB0\fP|\fB1\fP
263.RS 3n
2641=force passive camd 3.3x client, default:0
265.RE
266.PP
267\fBkey\fP = \fB128 bit key\fP
268.RS 3n
269key for camd 3.3x client encryption, default:none
270
271 example: key = 01020304050607080910111213141516
272.RE
273.SS "The [camd35] section"
274.PP
275\fBport\fP = \fB0\fP|\fBport\fP
276.RS 3n
277UDP port for camd 3.5x clients, 0 = disabled, default:0
278.RE
279.PP
280\fBserverip\fP = \fBIP address\fP
281.RS 3n
282bind service to specified IP address, default:all
283.RE
284.SS "The [newcamd] section"
285.PP
286\fBmgclient\fP = \fB0\fP|\fB1\fP \fI(for beta testing only)\fR
287.RS 3n
2881 = enable mgcamd extended newcamd protocol, allowing for a single connection to work with mutliple providers, default:0
289.RE
290.PP
291\fBport\fP = \fBport@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...\fP
292.RS 3n
293TCP port/CAID/ident definitions, default:none
294
295 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
296
297Each CAID requires a separate port.
298.RE
299.PP
300\fBserverip\fP = \fBIP address\fP
301.RS 3n
302bind service to specified IP address, default:all
303.RE
304.PP
305\fBallowed\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
306.RS 3n
307client connections allowed from, default:none
308
309 example: allowed = 127.0.0.1,192.168.0.0-192.168.255.255
310.RE
311.PP
312\fBkeepalive\fP = \fB0\fP|\fB1\fP
313.RS 3n
3140 = disable keepalive, default:1
315.RE
316.PP
317\fBkey\fP = \fBDES key\fP
318.RS 3n
319key for newcamd client encryption, default:none
320
321 example key = 0102030405060708091011121314
322.RE
323.SS "The [radegast] section"
324.PP
325\fBport\fP = \fB0\fP|\fBport\fP
326.RS 3n
327TCP/IP port for radegast clients, 0=disabled, default:0
328.RE
329.PP
330\fBserverip\fP = \fBIP address\fP
331.RS 3n
332bind service to specified IP address, default:all
333.RE
334.PP
335\fBallowed\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
336.RS 3n
337client connections allowed from, default:none
338
339 example: allowed = 127.0.0.1,192.168.0.0-192.168.255.255
340.RE
341.PP
342\fBuser\fP = \fBusername\fP
343.RS 3n
344user name for radegast client
345.RE
346.SS "The [serial] section"
347.PP
348\fBdevice\fP = \fB<user>@<device>[:baud][?option1=value1[&option2=value2]]\fP
349.RS 3n
350parameters:
351 \fBuser\fP = \fBaccount\fP
352 \fBdevice\fP = \fBserial device name\fP
353 \fBoption\fP = \fBtimeout\fP = milli-seconds, timeout for connection,
354 default:50
355 \fBdelay\fP = milli-seconds, additional delay between two
356 characters, default:0
357
358supported serial devices:
359 HSIC (humax sharing interface client)
360 SSSP (simple serial sharing protocol)
361 bomba (BOMBA firmware)
362 dsr9500 (DSR 9500)
363.RE
364.SS "The [cs357x] section"
365.PP
366\fBport\fP = \fB0\fP|\fBport\fP
367.RS 3n
368UDP port for camd 3.57x clients, 0 = disabled, default:0
369.RE
370.PP
371\fBserverip\fP = \fBIP address\fP
372.RS 3n
373bind service to specified IP address, default:all
374.RE
375.PP
376\fBsuppresscmd08\fP = \fB0\fP|\fB1\fP
377.RS 3n
3780 = CMD08 enabled, 1 = CMD08 disabled, default:0
379.RE
380.SS "The [cs378x] section"
381.PP
382\fBport\fP = \fB0\fP|\fBport@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...\fP
383.RS 3n
384TCP port/CAID/ident definitions for camd 3.78x clients,0 = disabled, default:0
385
386 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
387
388 Each CAID requires a separate port.
389.RE
390.PP
391\fBserverip\fP = \fBIP address\fP
392.RS 3n
393bind service to specified IP address, default:all
394.RE
395.PP
396\fBsuppresscmd08\fP = \fB0\fP|\fB1\fP
397.RS 3n
3980 = CMD08 enabled, 1 = CMD08 disabled, default:0
399.RE
400.SS "The [cccam] section"
401.PP
402\fBport\fP = \fB0\fP|\fBport\fP
403.RS 3n
404TCP/IP port for CCcam clients, 0 = disabled, default:0
405.RE
406.PP
407\fBversion\fP = \fB<main version>.<version>.<sub version>\fP
408.RS 3n
409define CCcam version, default:none
410
411 example: version = 1.2.34
412.RE
413.PP
414\fBbuild\fP = \fB<4-digit number>\fP
415.RS 3n
416define CCcam build, default:none
417
418 example: build = 5678
419.RE
420.PP
421\fBreshare\fP = \fBlevel\fP
422.RS 3n
423reshare level for CCcam clients, default:none
424
425 0 = no resharing
426 1 = resharing for direct peer only
427 2 = resharing for direct peer and next level
428 x = resharing for direct peer and next x level
429.RE
430.SS "The [gbox] section"
431.PP
432\fBpassword\fP = \fBpassword\fP
433.RS 3n
434password for gbox server
435.RE
436.PP
437\fBmaxdist\fP = \fBdistance\fP
438.RS 3n
439maximum distance to gbox servers, default:5
440.RE
441.PP
442\fBignorelist\fP = \fBfilename\fP
443.RS 3n
444listing of providers to be ignored, format: G:{<CAID><provider ID>}, default:none
445
446 example: G:{01001234}
447.RE
448.PP
449\fBonlineinfos\fP = \fBfilename\fP
450.RS 3n
451file to store online information, default:none
452.RE
453.PP
454\fBcardinfos\fP = \fBfilename\fP
455.RS 3n
456file to store card information, default:none
457.RE
458.PP
459\fBlocals\fP = \fB<CAID><provider ID>[,<CAID><provider ID>]\fP...
460.RS 3n
461backwards sharing of local cards,default:none
462
463 example: locals = 01001234,02005678
464.RE
465.SS "The [dvbapi] section" \fI(only if DVB API module enabled)\fR
466.PP
467\fBenabled\fP = \fB0\fP|\fB1\fP
468.RS 3n
4691 = DVB API enabled, default:0
470.RE
471.PP
472\fBuser\fP = \fBusername\fP
473.RS 3n
474user name for DVB API client, default:anonymous
475.RE
476.PP
477\fBignore\fP = \fB<CAID>[,<CAID>]...\fP
478.RS 3n
479CAIDs to be ignored, default:none
480.RE
481.PP
482\fBpriority\fP = \fB<CAID>:<provider ID>[,CAID:<provider ID>]...\fP
483.RS 3n
484CAIDs and provider IDs to be prioritized, default:CAIDs and provider IDs of local SCs will be prioritized
485.RE
486.PP
487\fBau\fP = \fB0\fP|\fB1\fP
488.RS 3n
4891 = enable AU, default:0
490.RE
491.PP
492\fBboxtype\fP = \fBdbox2\fP|\fBdreambox\fP|\fBufs910\fP
493.RS 3n
494set boxtype, auto detection of DVB API will be aspired, default:dreambox
495.RE
496.SS "The [anticasc] section" \fI(only if anti-cascading enabled)\fR
497.PP
498\fBenabled\fP = \fB0\fP|\fB1\fP
499.RS 3n
5001 = enabled anti-cascading, default:0
501.RE
502.PP
503\fBnumusers\fP = \fBquantity\fP
504.RS 3n
505anti-cascading: user per account, 0 = anti-cascading disabled, default:0
506.RE
507.PP
508\fBsampletime\fP = \fBminutes\fP
509.RS 3n
510duration of sample, default:2
511.RE
512.PP
513\fBsamples\fP = \fBquantity\fP
514.RS 3n
515quantity of samples over limit, default:10
516.RE
517.PP
518\fBpenalty\fP = \fB0\fP|\fB1\fP|\fB2\fP
519.RS 3n
520level of penalty:
521
522 0 = only logging
523 1 = send fake CWs
524 2 = disbable user temporary
525
526default:0, penalty can be overwritten per user in \fBoscam.user\fR
527.RE
528.PP
529\fBaclogfile\fP = \fBfilename\fP
530.RS 3n
531file for anti-cascading logging, default:none
532.RE
533.PP
534\fBfakedelay\fP = \fBmilli-seconds\fP
535.RS 3n
536fake delay time, default:1000
537.RE
538.PP
539\fBdenysamples\fP = \fBquantity\fP
540.RS 3n
541How many samples should be penalized?, default:8
542.RE
543.SH MONITOR
544monitor commands:
545.TP 3n
546\(bu
547\fBlogin <user> <password>\fP
548
549login (for unencrypted connections only)
550
551.TP 3n
552\(bu
553\fBsetuser <user> <parameter>=<value>\fP
554
555set parameter for user
556
557.TP 3n
558\(bu
559\fBexit\fP
560
561exit monitor
562
563.TP 3n
564\(bu
565\fBlog <on|onwohist|off>\fP
566
567enable|enable without hitory|disable logging for 2 minutes
568
569.TP 3n
570\(bu
571\fBstatus\fP
572
573list of current processes and clients
574
575.TP 3n
576\(bu
577\fBshutdown\fP
578
579shutdown OSCam
580
581.TP 3n
582\(bu
583\fBreload\fP
584
585reinit user db, clients and anti-cascading, for newcamd connections: after reloading the ident, please restart newcamd client
586
587.TP 3n
588\(bu
589\fBdetails <PID>\fP
590
591details about selected PID
592
593.TP 3n
594\(bu
595\fBdebug <level>\fP
596
597set debug level (\fBmonlevel\fP > 3 required)
598
599debug level mask:
600 0 = no debugging (default)
601 2 = ATR parsing info, ECM dumps, CW dumps
602 4 = traffic from/to the reader
603 8 = traffic from/to the clients
604 16 = traffic to the reader-device on IFD layer
605 32 = traffic to the reader-device on I/O layer
606 64 = EMM logging
607 255 = debug all
608.TP 3n
609\(bu
610\fBversion\fP
611
612show OSCam version
613
614.TP 3n
615\(bu
616\fBcommands\fP
617
618show all valid monitor commands
619.SH WEB INTERFACE
620.TP 3n
621\(bu
622template system
623
624The web interface allows you to create your own template. For developing your
625own template request the orignal template with the non-linked page
626\fBsavetemplates.html\fP. Store your own template in the directory specified
627by \fBhttptpl\fP.
628.TP 3n
629\(bu
630SSL connection to the web interface
631
632The Apache module \fBmod_proxy\fP can be used to proxy requests to the web
633interface. With this module it's also possible to use a SSL connection to
634the web interface.
635
636 ProxyRequests Off
637 <Proxy *>
638 Order deny,allow
639 Allow from all
640 </Proxy>
641 ProxyPass /oscam/ http://localhost:8080/
642 ProxyPassReverse /oscam/ http://localhost:8080/
643
644For further information please read the Apache documentation.
645.TP 3n
646\(bu
647known issues
648
649Login is not possible by now with the Safari browser because of incorrect
650stale flag handling. Increasing the AUTHNONCEVALIDSECS in oscam-http.h would
651be a workaround, but also a small security risk.
652.SH EXAMPLES
653 [global]
654 logfile = /var/log/oscam/oscam.log
655 usrfile = /var/log/oscam/oscamuser.log
656 pidfile = /var/run/oscam.pid
657
658 waitforcards = 1
659
660 [monitor]
661 port = 988
662 monlevel = 1
663 nocrypt = 127.0.0.1
664
665 [webif]
666 httpport = 8888
667 httpuser = myusername
668 httppwd = mypassword
669
670 [newcamd]
671 key = 0102030405060708091011121314
672 port = 10000@0100:100000;20000@0200:200000,300000,400000
673
674 [radegast]
675 port = 30000
676 user = radegastuser
677 allowed = 127.0.0.1,192.168.0.0-192.168.255.255
678
679 [camd33]
680 port = 40000
681 serverip = 192.168.0.1
682 key = 01020304050607080910111213141516
683
684 [cs378x]
685 port = 50000@0300:600000
686.SH "SEE ALSO"
687\fBlist_smargo\fR(1), \fBoscam\fR(1), \fBoscam.user\fR(5), \fBoscam.server\fR(5), \fBoscam.srvid\fR(5), \fBoscam.guess\fR(5), \fBoscam.cert\fR(5), \fBoscam.services\fR(5), \fBoscam.ird\fR(5), \fBoscam.ac\fR(5)
Note: See TracBrowser for help on using the repository browser.