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

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

Documentation update for web interface

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