source: branches/monitor-improvement/Distribution/doc/man/oscam.conf.5@ 1189

Last change on this file since 1189 was 1189, checked in by alno, 12 years ago

WebIf:

  • Merging revisions 1180-1185 of trunk
File size: 10.9 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 login time in unix/POSIX format
43 logout time in unix/POSIX format
44 protocol
45.RE
46.PP
47\fBcwlogdir\fP = \fBpath\fP
48.RS 3n
49directory for CW logging, default:none
50.RE
51.PP
52\fBclienttimeout\fP = \fBseconds\fP
53.RS 3n
54value for client process to wait for key, default:5
55.RE
56.PP
57\fBfallbacktimeout\fP = \fBseconds\fP
58.RS 3n
59time falling back to fallback reader, default:2
60.RE
61.PP
62\fBclientmaxidle\fP = \fBseconds\fP
63.RS 3n
64value for client process being idle before disconnect, default:120
65.RE
66.PP
67\fBcachedelay\fP = \fBmilli-seconds\fP
68.RS 3n
69value to delay cached requests , default:0
70.RE
71.PP
72\fBbindwait\fP = \fBseconds\fP
73.RS 3n
74value to wait for bind request to complete, default:120
75.RE
76.PP
77\fBnetprio\fP = \fBpriority\fP
78.RS 3n
79network priority, default:system given
80.RE
81.PP
82\fBresolvedelay\fP = \fBseconds\fP
83.RS 3n
84delay for DNS resolving, default:30
85.RE
86.PP
87\fBsleep\fP = \fBminutes\fP
88.RS 3n
89time waiting for inactive users, default:none, can be overwritten per user in \fBoscam.user\fR
90.RE
91.PP
92\fBunlockparental\fP = \fB0\fP|\fB1\fP
93.RS 3n
941 = unlock parental mode option to disable Seca pin code request for adult movie, default:0
95.RE
96.PP
97\fBnice\fP = \fB-20\fP..\fB+20\fP
98.RS 3n
99system priority, default:99
100.RE
101.PP
102\fBserialreadertimeout\fP = \fBmilli-seconds\fP
103.RS 3n
104timeout for serial reader, default:1500
105.RE
106.PP
107\fBmaxlogsize\fP = \fBkbytes\fP
108.RS 3n
109max log file size, default:10
110.RE
111.PP
112\fBshowecmdw\fP = \fB0\fP|\fB1\fP
113.RS 3n
1141 = show DW in log file, default:0
115.RE
116.PP
117\fBwaitforcards\fP = \fB0\fP|\fB1\fP
118.RS 3n
1191 = wait for local SCs on startup before opening network ports, default:0
120.RE
121.PP
122\fBpreferlocalcards\fP = \fB0\fP|\fB1\fP
123.RS 3n
1241 = try decoding on local cards first, default:0
125.RE
126.SS "The [monitor] section"
127.PP
128\fBport\fP = \fB0\fP|\fBport\fP
129.RS 3n
130UDP port for monitor, port=0 monitor disabled, default:0
131.RE
132.PP
133\fBserverip\fP = \fBIP address\fP
134.RS 3n
135bind service to specified IP address, default:all
136.RE
137.PP
138\fBnocrypt\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
139.RS 3n
140unsecured monitor connection, default:none
141
142 example: nocrypt = 127.0.0.1,192.168.0.0-192.168.255.255
143.RE
144.PP
145\fBaulow\fP = \fBminutes\fP
146.RS 3n
147time no EMM occurs so that client is set to low, default:30
148.RE
149.PP
150\fBmonlevel\fP = \fB0\fP|\fB1\fP|\fB2\fP|\fB3\fP|\fB4\fP
151.RS 3n
152monitor level:
153
154 0 = no access to monitor
155 1 = only server and own procs
156 2 = all procs, but viewing only, default
157 3 = all procs, reload of \fBoscam.user\fR possible
158 4 = complete access
159
160monlevel can be overwritten per user in \fBoscam.user\fR
161.RE
162.PP
163\fBhideclient_to\fP = \fBminutes\fP
164.RS 3n
165time to hide clients in the monitor if not sending requests, 0 = disabled, default:0
166.RE
167.SS "The [camd33] section"
168.PP
169\fBport\fP = \fB0\fP|\fBport\fP
170.RS 3n
171TCP/IP port for camd 3.3x clients, 0 = disabled, default:0
172.RE
173.PP
174\fBserverip\fP = \fBIP address\fP
175.RS 3n
176bind service to specified IP address, default:all
177.RE
178.PP
179\fBnocrypt\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
180.RS 3n
181unsecured camd 3.3x client connection, default:none
182
183 example: nocrypt = 127.0.0.1,192.168.0.0-192.168.255.255
184.RE
185.PP
186\fBpassive\fP = \fB0\fP|\fB1\fP
187.RS 3n
1881=force passive camd 3.3x client, default:0
189.RE
190.PP
191\fBkey\fP = \fB128 bit key\fP
192.RS 3n
193key for camd 3.3x client encryption, default:none
194
195 example: key = 01020304050607080910111213141516
196.RE
197.SS "The [camd35] section"
198.PP
199\fBport\fP = \fB0\fP|\fBport\fP
200.RS 3n
201UDP port for camd 3.5x clients, 0 = disabled, default:0
202.RE
203.PP
204\fBserverip\fP = \fBIP address\fP
205.RS 3n
206bind service to specified IP address, default:all
207.RE
208.SS "The [newcamd] section"
209.PP
210\fBport\fP = \fBport@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...\fP
211.RS 3n
212TCP port/CAID/ident definitions, default:none
213
214 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
215
216Each CAID requires a separate port.
217.RE
218.PP
219\fBserverip\fP = \fBIP address\fP
220.RS 3n
221bind service to specified IP address, default:all
222.RE
223.PP
224\fBkey\fP = \fBDES key\fP
225.RS 3n
226key for newcamd client encryption, default:none
227
228 example key = 0102030405060708091011121314
229.RE
230.SS "The [radegast] section"
231.PP
232\fBport\fP = \fB0\fP|\fBport\fP
233.RS 3n
234TCP/IP port for radegast clients, 0=disabled, default:0
235.RE
236.PP
237\fBserverip\fP = \fBIP address\fP
238.RS 3n
239bind service to specified IP address, default:all
240.RE
241.PP
242\fBallowed\fP = \fBIP address\fP|\fBIP address range\fP[,\fBIP address\fP|\fBIP address range]\fP...
243.RS 3n
244client connections allowed from, default:none
245
246 example: allowed = 127.0.0.1,192.168.0.0-192.168.255.255
247.RE
248.PP
249\fBuser\fP = \fBusername\fP
250.RS 3n
251user name for radegast client
252.RE
253.SS "The [serial] section"
254.PP
255\fBdevice\fP = \fB<user>@<device>[:baud][?option1=value1[&option2=value2]]\fP
256.RS 3n
257parameters:
258 \fBuser\fP = \fBaccount\fP
259 \fBdevice\fP = \fBserial device name\fP
260 \fBoption\fP = \fBtimeout\fP = milli-seconds, timeout for connection,
261 default:50
262 \fBdelay\fP = milli-seconds, additional delay between two
263 characters, default:0
264
265supported serial devices:
266 HSIC (humax sharing interface client)
267 SSSP (simple serial sharing protocol)
268 bomba (BOMBA firmware)
269 dsr9500 (DSR 9500)
270.RE
271.SS "The [cs357x] section"
272.PP
273\fBport\fP = \fB0\fP|\fBport\fP
274.RS 3n
275UDP port for camd 3.57x clients, 0 = disabled, default:0
276.RE
277.PP
278\fBserverip\fP = \fBIP address\fP
279.RS 3n
280bind service to specified IP address, default:all
281.RE
282.SS "The [cs378x] section"
283.PP
284\fBport\fP = \fB0\fP|\fBport@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...\fP
285.RS 3n
286TCP port/CAID/ident definitions for camd 3.78x clients,0 = disabled, default:0
287
288 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
289
290 Each CAID requires a separate port.
291.RE
292.PP
293\fBserverip\fP = \fBIP address\fP
294.RS 3n
295bind service to specified IP address, default:all
296.RE
297.SS "The [gbox] section"
298.PP
299\fBpassword\fP = \fBpassword\fP
300.RS 3n
301password for gbox server
302.RE
303.PP
304\fBmaxdist\fP = \fBdistance\fP
305.RS 3n
306maximum distance to gbox servers, default:5
307.RE
308.PP
309\fBignorelist\fP = \fBfilename\fP
310.RS 3n
311listing of providers to be ignored, format: G:{<CAID><provider ID>}, default:none
312
313 example: G:{01001234}
314.RE
315.PP
316\fBonlineinfos\fP = \fBfilename\fP
317.RS 3n
318file to store online information, default:none
319.RE
320.PP
321\fBcardinfos\fP = \fBfilename\fP
322.RS 3n
323file to store card information, default:none
324.RE
325.PP
326\fBlocals\fP = \fB<CAID><provider ID>[,<CAID><provider ID>]\fP...
327.RS 3n
328backwards sharing of local cards,default:none
329
330 example: locals = 01001234,02005678
331.RE
332.SS "The [dvbapi] section" \fI(only if DVB API module enabled)\fR
333.PP
334\fBenabled\fP = \fB0\fP|\fB1\fP
335.RS 3n
3361 = DVB API enabled, default:0
337.RE
338.PP
339\fBuser\fP = \fBusername\fP
340.RS 3n
341user name for DVB API client, default:anonymous
342.RE
343.PP
344\fBignore\fP = \fBCAID[,CAID]...\fP
345.RS 3n
346CAIDs to be ignored, default:none
347.RE
348.PP
349\fBpriority\fP = \fBCAID[,CAID]...\fP
350.RS 3n
351CAIDs to be prioritized, default:CAIDs of local SCs will be prioritized
352.RE
353.PP
354\fBau\fP = \fB0\fP|\fB1\fP
355.RS 3n
3561 = enable AU, default:0
357.RE
358.PP
359\fBboxtype\fP = \fBdbox2\fP|\fBdreambox\fP|\fBufs910\fP
360.RS 3n
361set boxtype, auto detection of DVB API will be aspired, default:dreambox
362.RE
363.SS "The [anticasc] section" \fI(only if anti-cascading enabled)\fR
364.PP
365\fBenabled\fP = \fB0\fP|\fB1\fP
366.RS 3n
3671 = enabled anti-cascading, default:0
368.RE
369.PP
370\fBnumusers\fP = \fBquantity\fP
371.RS 3n
372anti-cascading: user per account, 0 = anti-cascading not permitted, default:0
373.RE
374.PP
375\fBsampletime\fP = \fBminutes\fP
376.RS 3n
377duration of sample, default:2
378.RE
379.PP
380\fBsamples\fP = \fBquantity\fP
381.RS 3n
382quantity of samples over limit, default:10
383.RE
384.PP
385\fBpenalty\fP = \fB0\fP|\fB1\fP|\fB2\fP
386.RS 3n
387level of penalty:
388
389 0 = only logging
390 1 = send fake CWs
391 2 = disbable user temporary
392
393default:0, penalty can be overwritten per user in \fBoscam.user\fR
394.RE
395.PP
396\fBaclogfile\fP = \fBfilename\fP
397.RS 3n
398file for anti-cascading logging, default:none
399.RE
400.PP
401\fBfakedelay\fP = \fBmilli-seconds\fP
402.RS 3n
403fake delay time, default:1000
404.RE
405.PP
406\fBdenysamples\fP = \fBquantity\fP
407.RS 3n
408How many samples should be penalized?, default:8
409.RE
410.SH MONITOR
411monitor commands:
412
413 login <user> <password> = login (for unencrypted connections only)
414 exit = exit monitor
415 log <on|onwohist|off> = enable|enable without hitory|disable
416 logging for 2 minutes
417 status = list of current processes and clients
418 shutdown = showdown OSCam
419 reload = reinit user db, clients and anti-cascading,
420 for newcamd connections: after reloading
421 the ident, please restart newcamd client
422 details <PID> = details about selected PID
423 debug <level> = set debug level (\fBmonlevel\fP > 3 required)
424 debug level mask:
425 0 = no debugging (default)
426 1 = debug dumps
427 2 = debug master process
428 4 = debug reader/proxy process
429 8 = debug client process
430 16 = debug reader I/O
431 32 = debug watchdog
432 63 = debug all
433 version = show OSCam version
434.SH EXAMPLES
435 [global]
436 logfile = /var/log/oscam/oscam.log
437 usrfile = /var/log/oscam/oscamuser.log
438 pidfile = /var/run/oscam.pid
439
440 waitforcards = 1
441
442 [monitor]
443 port = 988
444 monlevel = 1
445 nocrypt = 127.0.0.1
446
447 [newcamd]
448 key = 0102030405060708091011121314
449 port = 10000@0100:100000;20000@0200:200000,300000,400000
450
451 [radegast]
452 port = 30000
453 user = radegastuser
454 allowed = 127.0.0.1,192.168.0.0-192.168.255.255
455
456 [camd33]
457 port = 40000
458 serverip = 192.168.0.1
459 key = 01020304050607080910111213141516
460
461 [cs378x]
462 port = 50000@0300:600000
463.SH "SEE ALSO"
464\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.