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

Last change on this file since 1577 was 1577, checked in by merek, 11 years ago

Merge documentation updates from UMP r1680, thanks to landlord

File size: 12.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\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.SS "The [camd33] section"
166.PP
167\fBport\fP = \fB0\fP|\fBport\fP
168.RS 3n
169TCP/IP port for camd 3.3x clients, 0 = disabled, default:0
170.RE
171.PP
172\fBserverip\fP = \fBIP address\fP
173.RS 3n
174bind service to specified IP address, default:all
175.RE
176.PP
177\fBnocrypt\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
178.RS 3n
179unsecured camd 3.3x client connection, default:none
180
181 example: nocrypt = 127.0.0.1,192.168.0.0-192.168.255.255
182.RE
183.PP
184\fBpassive\fP = \fB0\fP|\fB1\fP
185.RS 3n
1861=force passive camd 3.3x client, default:0
187.RE
188.PP
189\fBkey\fP = \fB128 bit key\fP
190.RS 3n
191key for camd 3.3x client encryption, default:none
192
193 example: key = 01020304050607080910111213141516
194.RE
195.SS "The [camd35] section"
196.PP
197\fBport\fP = \fB0\fP|\fBport\fP
198.RS 3n
199UDP port for camd 3.5x clients, 0 = disabled, default:0
200.RE
201.PP
202\fBserverip\fP = \fBIP address\fP
203.RS 3n
204bind service to specified IP address, default:all
205.RE
206.SS "The [newcamd] section"
207.PP
208\fBport\fP = \fBport@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...\fP
209.RS 3n
210TCP port/CAID/ident definitions, default:none
211
212 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
213
214Each CAID requires a separate port.
215.RE
216.PP
217\fBserverip\fP = \fBIP address\fP
218.RS 3n
219bind service to specified IP address, default:all
220.RE
221.PP
222\fBallowed\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
223.RS 3n
224client connections allowed from, default:none
225
226 example: allowed = 127.0.0.1,192.168.0.0-192.168.255.255
227.RE
228.PP
229\fBkeepalive\fP = \fB0\fP|\fB1\fP
230.RS 3n
2310 = disable keepalive, default:1
232.RE
233.PP
234\fBkey\fP = \fBDES key\fP
235.RS 3n
236key for newcamd client encryption, default:none
237
238 example key = 0102030405060708091011121314
239.RE
240.SS "The [radegast] section"
241.PP
242\fBport\fP = \fB0\fP|\fBport\fP
243.RS 3n
244TCP/IP port for radegast clients, 0=disabled, default:0
245.RE
246.PP
247\fBserverip\fP = \fBIP address\fP
248.RS 3n
249bind service to specified IP address, default:all
250.RE
251.PP
252\fBallowed\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
253.RS 3n
254client connections allowed from, default:none
255
256 example: allowed = 127.0.0.1,192.168.0.0-192.168.255.255
257.RE
258.PP
259\fBuser\fP = \fBusername\fP
260.RS 3n
261user name for radegast client
262.RE
263.SS "The [serial] section"
264.PP
265\fBdevice\fP = \fB<user>@<device>[:baud][?option1=value1[&option2=value2]]\fP
266.RS 3n
267parameters:
268 \fBuser\fP = \fBaccount\fP
269 \fBdevice\fP = \fBserial device name\fP
270 \fBoption\fP = \fBtimeout\fP = milli-seconds, timeout for connection,
271 default:50
272 \fBdelay\fP = milli-seconds, additional delay between two
273 characters, default:0
274
275supported serial devices:
276 HSIC (humax sharing interface client)
277 SSSP (simple serial sharing protocol)
278 bomba (BOMBA firmware)
279 dsr9500 (DSR 9500)
280.RE
281.SS "The [cs357x] section"
282.PP
283\fBport\fP = \fB0\fP|\fBport\fP
284.RS 3n
285UDP port for camd 3.57x clients, 0 = disabled, default:0
286.RE
287.PP
288\fBserverip\fP = \fBIP address\fP
289.RS 3n
290bind service to specified IP address, default:all
291.RE
292.PP
293\fBsuppresscmd08\fP = \fB0\fP|\fB1\fP
294.RS 3n
2950 = CMD08 enabled, 1 = CMD08 disabled, default:0
296.RE
297.SS "The [cs378x] section"
298.PP
299\fBport\fP = \fB0\fP|\fBport@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...\fP
300.RS 3n
301TCP port/CAID/ident definitions for camd 3.78x clients,0 = disabled, default:0
302
303 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
304
305 Each CAID requires a separate port.
306.RE
307.PP
308\fBserverip\fP = \fBIP address\fP
309.RS 3n
310bind service to specified IP address, default:all
311.RE
312.PP
313\fBsuppresscmd08\fP = \fB0\fP|\fB1\fP
314.RS 3n
3150 = CMD08 enabled, 1 = CMD08 disabled, default:0
316.RE
317.SS "The [cccam] section"
318.PP
319\fBport\fP = \fB0\fP|\fBport\fP
320.RS 3n
321TCP/IP port for CCcam clients, 0 = disabled, default:0
322.RE
323.PP
324\fBversion\fP = \fB<main version>.<version>.<sub version>\fP
325.RS 3n
326define CCcam version, default:none
327
328 example: version = 1.2.34
329.RE
330.PP
331\fBbuild\fP = \fB<4-digit number>\fP
332.RS 3n
333define CCcam build, default:none
334
335 example: build = 5678
336.RE
337.PP
338\fBreshare\fP = \fBlevel\fP
339.RS 3n
340reshare level for CCcam clients, default:none
341
342 0 = no resharing
343 1 = resharing for direct peer only
344 2 = resharing for direct peer and next level
345 x = resharing for direct peer and next x level
346.RE
347.SS "The [gbox] section"
348.PP
349\fBpassword\fP = \fBpassword\fP
350.RS 3n
351password for gbox server
352.RE
353.PP
354\fBmaxdist\fP = \fBdistance\fP
355.RS 3n
356maximum distance to gbox servers, default:5
357.RE
358.PP
359\fBignorelist\fP = \fBfilename\fP
360.RS 3n
361listing of providers to be ignored, format: G:{<CAID><provider ID>}, default:none
362
363 example: G:{01001234}
364.RE
365.PP
366\fBonlineinfos\fP = \fBfilename\fP
367.RS 3n
368file to store online information, default:none
369.RE
370.PP
371\fBcardinfos\fP = \fBfilename\fP
372.RS 3n
373file to store card information, default:none
374.RE
375.PP
376\fBlocals\fP = \fB<CAID><provider ID>[,<CAID><provider ID>]\fP...
377.RS 3n
378backwards sharing of local cards,default:none
379
380 example: locals = 01001234,02005678
381.RE
382.SS "The [dvbapi] section" \fI(only if DVB API module enabled)\fR
383.PP
384\fBenabled\fP = \fB0\fP|\fB1\fP
385.RS 3n
3861 = DVB API enabled, default:0
387.RE
388.PP
389\fBuser\fP = \fBusername\fP
390.RS 3n
391user name for DVB API client, default:anonymous
392.RE
393.PP
394\fBignore\fP = \fB<CAID>[,<CAID>]...\fP
395.RS 3n
396CAIDs to be ignored, default:none
397.RE
398.PP
399\fBpriority\fP = \fB<CAID>:<provider ID>[,CAID:<provider ID>]...\fP
400.RS 3n
401CAIDs and provider IDs to be prioritized, default:CAIDs and provider IDs of local SCs will be prioritized
402.RE
403.PP
404\fBau\fP = \fB0\fP|\fB1\fP
405.RS 3n
4061 = enable AU, default:0
407.RE
408.PP
409\fBboxtype\fP = \fBdbox2\fP|\fBdreambox\fP|\fBufs910\fP
410.RS 3n
411set boxtype, auto detection of DVB API will be aspired, default:dreambox
412.RE
413.SS "The [anticasc] section" \fI(only if anti-cascading enabled)\fR
414.PP
415\fBenabled\fP = \fB0\fP|\fB1\fP
416.RS 3n
4171 = enabled anti-cascading, default:0
418.RE
419.PP
420\fBnumusers\fP = \fBquantity\fP
421.RS 3n
422anti-cascading: user per account, 0 = anti-cascading disabled, default:0
423.RE
424.PP
425\fBsampletime\fP = \fBminutes\fP
426.RS 3n
427duration of sample, default:2
428.RE
429.PP
430\fBsamples\fP = \fBquantity\fP
431.RS 3n
432quantity of samples over limit, default:10
433.RE
434.PP
435\fBpenalty\fP = \fB0\fP|\fB1\fP|\fB2\fP
436.RS 3n
437level of penalty:
438
439 0 = only logging
440 1 = send fake CWs
441 2 = disbable user temporary
442
443default:0, penalty can be overwritten per user in \fBoscam.user\fR
444.RE
445.PP
446\fBaclogfile\fP = \fBfilename\fP
447.RS 3n
448file for anti-cascading logging, default:none
449.RE
450.PP
451\fBfakedelay\fP = \fBmilli-seconds\fP
452.RS 3n
453fake delay time, default:1000
454.RE
455.PP
456\fBdenysamples\fP = \fBquantity\fP
457.RS 3n
458How many samples should be penalized?, default:8
459.RE
460.SH MONITOR
461monitor commands:
462
463 login <user> <password> = login (for unencrypted connections only)
464 exit = exit monitor
465 log <on|onwohist|off> = enable|enable without hitory|disable
466 logging for 2 minutes
467 status = list of current processes and clients
468 shutdown = showdown OSCam
469 reload = reinit user db, clients and anti-cascading,
470 for newcamd connections: after reloading
471 the ident, please restart newcamd client
472 details <PID> = details about selected PID
473 debug <level> = set debug level (\fBmonlevel\fP > 3 required)
474 debug level mask:
475 0 = no debugging (default)
476 2 = ATR parsing info, ECM dumps, CW dumps
477 4 = traffic from/to the reader
478 8 = traffic from/to the clients
479 16 = traffic to the reader-device on IFD layer
480 32 = traffic to the reader-device on I/O layer
481 63 = debug all
482 version = show OSCam version
483.SH EXAMPLES
484 [global]
485 logfile = /var/log/oscam/oscam.log
486 usrfile = /var/log/oscam/oscamuser.log
487 pidfile = /var/run/oscam.pid
488
489 waitforcards = 1
490
491 [monitor]
492 port = 988
493 monlevel = 1
494 nocrypt = 127.0.0.1
495
496 [newcamd]
497 key = 0102030405060708091011121314
498 port = 10000@0100:100000;20000@0200:200000,300000,400000
499
500 [radegast]
501 port = 30000
502 user = radegastuser
503 allowed = 127.0.0.1,192.168.0.0-192.168.255.255
504
505 [camd33]
506 port = 40000
507 serverip = 192.168.0.1
508 key = 01020304050607080910111213141516
509
510 [cs378x]
511 port = 50000@0300:600000
512.SH "SEE ALSO"
513\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.