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