source: trunk/Distribution/doc/txt/oscam.conf.txt@ 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: 10.4 KB
Line 
1oscam.conf(5) oscam.conf(5)
2
3
4
5NAME
6 oscam.conf - main configuration file for OSCam
7
8SYNOPSIS
9 The main configuration file for OSCam contains global parameters such
10 as debugging, logging, monitor, protocols and anti-cascading. sections
11 in oscam.conf are nonrecurring. The [global] section is required. All
12 other sections are optional.
13
14DESCRIPTIONS
15 The [global] section
16 serverip = IP address
17 bind service to specified IP address, default:all
18
19 logfile = filename|/dev/null|/dev/tty|syslog
20 logging target, default: /var/log/oscam.log
21
22 pidfile = filename
23 PID file, default:no PID file
24
25 usrfile = filename
26 log file for user logging, default:none
27
28 log file format:
29
30 date
31 time
32 CWs per second
33 username
34 IP address of client
35 TCP/IP port
36 CWs found
37 CWs from cache
38 CWs not found
39 CWs ignored
40 CWs timed out
41 CWs tunneled
42 login time in unix/POSIX format
43 logout time in unix/POSIX format
44 protocol
45
46 cwlogdir = path
47 directory for CW logging, default:none
48
49 clienttimeout = seconds
50 value for client process to wait for key, default:5
51
52 fallbacktimeout = seconds
53 time falling back to fallback reader, default:2
54
55 clientmaxidle = seconds
56 value for client process being idle before disconnect, default:120
57
58 cachedelay = milli-seconds
59 value to delay cached requests , default:0
60
61 bindwait = seconds
62 value to wait for bind request to complete, default:120
63
64 netprio = priority
65 network priority, default:system given
66
67 resolvedelay = seconds
68 delay for DNS resolving, default:30
69
70 sleep = minutes
71 time waiting for inactive users, default:none, can be overwritten
72 per user in oscam.user
73
74 unlockparental = 0|1
75 1 = unlock parental mode option to disable Seca pin code request for
76 adult movie, default:0
77
78 nice = -20..+20
79 system priority, default:99
80
81 serialreadertimeout = milli-seconds
82 timeout for serial reader, default:1500
83
84 maxlogsize = kbytes
85 max log file size, default:10
86
87 waitforcards = 0|1
88 1 = wait for local SCs on startup before opening network ports,
89 default:0
90
91 preferlocalcards = 0|1
92 1 = try decoding on local cards first, default:0
93
94 The [monitor] section
95 port = 0|port
96 UDP port for monitor, port=0 monitor disabled, default:0
97
98 serverip = IP address
99 bind service to specified IP address, default:all
100
101 nocrypt = IP address|IP address range[,IP address|IP address range]...
102 unsecured monitor connection, default:none
103
104 example: nocrypt = 127.0.0.1,192.168.0.0-192.168.255.255
105
106 aulow = minutes
107 time no EMM occurs so that client is set to low, default:30
108
109 monlevel = 0|1|2|3|4
110 monitor level:
111
112 0 = no access to monitor
113 1 = only server and own procs
114 2 = all procs, but viewing only, default
115 3 = all procs, reload of oscam.user possible
116 4 = complete access
117
118 monlevel can be overwritten per user in oscam.user
119
120 hideclient_to = seconds
121 time to hide clients in the monitor if not sending requests, 0 =
122 disabled, default:0
123
124 The [camd33] section
125 port = 0|port
126 TCP/IP port for camd 3.3x clients, 0 = disabled, default:0
127
128 serverip = IP address
129 bind service to specified IP address, default:all
130
131 nocrypt = IP address|IP address range[,IP address|IP address range]...
132 unsecured camd 3.3x client connection, default:none
133
134 example: nocrypt = 127.0.0.1,192.168.0.0-192.168.255.255
135
136 passive = 0|1
137 1=force passive camd 3.3x client, default:0
138
139 key = 128 bit key
140 key for camd 3.3x client encryption, default:none
141
142 example: key = 01020304050607080910111213141516
143
144 The [camd35] section
145 port = 0|port
146 UDP port for camd 3.5x clients, 0 = disabled, default:0
147
148 serverip = IP address
149 bind service to specified IP address, default:all
150
151 The [newcamd] section
152 port = port@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...
153 TCP port/CAID/ident definitions, default:none
154
155 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
156
157 Each CAID requires a separate port.
158
159 serverip = IP address
160 bind service to specified IP address, default:all
161
162 allowed = IP address|IP address range[,IP address|IP address range]...
163 client connections allowed from, default:none
164
165 example: allowed = 127.0.0.1,192.168.0.0-192.168.255.255
166
167 keepalive = 0|1
168 0 = disable keepalive, default:1
169
170 key = DES key
171 key for newcamd client encryption, default:none
172
173 example key = 0102030405060708091011121314
174
175 The [radegast] section
176 port = 0|port
177 TCP/IP port for radegast clients, 0=disabled, default:0
178
179 serverip = IP address
180 bind service to specified IP address, default:all
181
182 allowed = IP address|IP address range[,IP address|IP address range]...
183 client connections allowed from, default:none
184
185 example: allowed = 127.0.0.1,192.168.0.0-192.168.255.255
186
187 user = username
188 user name for radegast client
189
190 The [serial] section
191 device = <user>@<device>[:baud][?option1=value1[&option2=value2]]
192 parameters:
193 user = account
194 device = serial device name
195 option = timeout = milli-seconds, timeout for connection,
196 default:50
197 delay = milli-seconds, additional delay between two
198 characters, default:0
199
200 supported serial devices:
201 HSIC (humax sharing interface client)
202 SSSP (simple serial sharing protocol)
203 bomba (BOMBA firmware)
204 dsr9500 (DSR 9500)
205
206 The [cs357x] section
207 port = 0|port
208 UDP port for camd 3.57x clients, 0 = disabled, default:0
209
210 serverip = IP address
211 bind service to specified IP address, default:all
212
213 suppresscmd08 = 0|1
214 0 = CMD08 enabled, 1 = CMD08 disabled, default:0
215
216 The [cs378x] section
217 port = 0|port@CAID[:ident][,ident]...[;port@CAID[:ident][,ident]...]...
218 TCP port/CAID/ident definitions for camd 3.78x clients,0 = disabled,
219 default:0
220
221 example: port = 10000@0100:100000;20000@0200:200000,300000,400000
222
223 Each CAID requires a separate port.
224
225 serverip = IP address
226 bind service to specified IP address, default:all
227
228 suppresscmd08 = 0|1
229 0 = CMD08 enabled, 1 = CMD08 disabled, default:0
230
231 The [cccam] section
232 port = 0|port
233 TCP/IP port for CCcam clients, 0 = disabled, default:0
234
235 version = <main version>.<version>.<sub version>
236 define CCcam version, default:none
237
238 example: version = 1.2.34
239
240 build = <4-digit number>
241 define CCcam build, default:none
242
243 example: build = 5678
244
245 reshare = level
246 reshare level for CCcam clients, default:none
247
248 0 = no resharing
249 1 = resharing for direct peer only
250 2 = resharing for direct peer and next level
251 x = resharing for direct peer and next x level
252
253 The [gbox] section
254 password = password
255 password for gbox server
256
257 maxdist = distance
258 maximum distance to gbox servers, default:5
259
260 ignorelist = filename
261 listing of providers to be ignored, format: G:{<CAID><provider ID>},
262 default:none
263
264 example: G:{01001234}
265
266 onlineinfos = filename
267 file to store online information, default:none
268
269 cardinfos = filename
270 file to store card information, default:none
271
272 locals = <CAID><provider ID>[,<CAID><provider ID>]...
273 backwards sharing of local cards,default:none
274
275 example: locals = 01001234,02005678
276
277 The [dvbapi] section (only if DVB API module enabled)
278 enabled = 0|1
279 1 = DVB API enabled, default:0
280
281 user = username
282 user name for DVB API client, default:anonymous
283
284 ignore = <CAID>[,<CAID>]...
285 CAIDs to be ignored, default:none
286
287 priority = <CAID>:<provider ID>[,CAID:<provider ID>]...
288 CAIDs and provider IDs to be prioritized, default:CAIDs and provider
289 IDs of local SCs will be prioritized
290
291 au = 0|1
292 1 = enable AU, default:0
293
294 boxtype = dbox2|dreambox|ufs910
295 set boxtype, auto detection of DVB API will be aspired,
296 default:dreambox
297
298 The [anticasc] section (only if anti-cascading enabled)
299 enabled = 0|1
300 1 = enabled anti-cascading, default:0
301
302 numusers = quantity
303 anti-cascading: user per account, 0 = anti-cascading disabled,
304 default:0
305
306 sampletime = minutes
307 duration of sample, default:2
308
309 samples = quantity
310 quantity of samples over limit, default:10
311
312 penalty = 0|1|2
313 level of penalty:
314
315 0 = only logging
316 1 = send fake CWs
317 2 = disbable user temporary
318
319 default:0, penalty can be overwritten per user in oscam.user
320
321 aclogfile = filename
322 file for anti-cascading logging, default:none
323
324 fakedelay = milli-seconds
325 fake delay time, default:1000
326
327 denysamples = quantity
328 How many samples should be penalized?, default:8
329
330MONITOR
331 monitor commands:
332
333 login <user> <password> = login (for unencrypted connections only)
334 exit = exit monitor
335 log <on|onwohist|off> = enable|enable without hitory|disable
336 logging for 2 minutes
337 status = list of current processes and clients
338 shutdown = showdown OSCam
339 reload = reinit user db, clients and anti-cascading,
340 for newcamd connections: after reloading
341 the ident, please restart newcamd client
342 details <PID> = details about selected PID
343 debug <level> = set debug level (monlevel > 3 required)
344 debug level mask:
345 0 = no debugging (default)
346 2 = ATR parsing info, ECM dumps, CW dumps
347 4 = traffic from/to the reader
348 8 = traffic from/to the clients
349 16 = traffic to the reader-device on IFD
350 layer
351 32 = traffic to the reader-device on I/O
352 layer
353 63 = debug all
354 version = show OSCam version
355
356EXAMPLES
357 [global]
358 logfile = /var/log/oscam/oscam.log
359 usrfile = /var/log/oscam/oscamuser.log
360 pidfile = /var/run/oscam.pid
361
362 waitforcards = 1
363
364 [monitor]
365 port = 988
366 monlevel = 1
367 nocrypt = 127.0.0.1
368
369 [newcamd]
370 key = 0102030405060708091011121314
371 port = 10000@0100:100000;20000@0200:200000,300000,400000
372
373 [radegast]
374 port = 30000
375 user = radegastuser
376 allowed = 127.0.0.1,192.168.0.0-192.168.255.255
377
378 [camd33]
379 port = 40000
380 serverip = 192.168.0.1
381 key = 01020304050607080910111213141516
382
383 [cs378x]
384 port = 50000@0300:600000
385
386SEE ALSO
387 list_smargo(1), oscam(1), oscam.user(5), oscam.server(5),
388 oscam.srvid(5), oscam.guess(5), oscam.cert(5), oscam.services(5),
389 oscam.ird(5), oscam.ac(5)
390
391
392
393 oscam.conf(5)
Note: See TracBrowser for help on using the repository browser.