1[general]
2; General settings for the operation of Yate
3
4; modload: boolean: Should a module be loaded by default if there is no
5;  reference to it in the [modules] section
6;modload=enable
7
8; modpath: string: Overrides the runtime module directory path which is
9;  compiled in or specified with the -m command line option. Note that this
10;  setting takes priority over anything else
11; Note that you MUST NOT add a path separator at the end
12;modpath=
13
14; extrapath: string: Absolute or relative path to an extra modules directory,
15;  gets loaded before those added by command line -x parameters
16; Note that you MUST NOT add a path separator at the end
17;extrapath=
18
19; nodename: string: Name of this node in a cluster
20; Defaults to detected machine hostname
21;nodename=
22
23: minworkers: int: Minimum / initial number of engine worker threads
24; Valid range 1 to 100, default 1
25;minworkers=1
26
27; maxworkers: int: Maximum number of worker threads the engine can create
28; This parameter is reloadable
29; Valid range minworkers to 500, default 10
30;maxworkers=10
31
32; addworkers: int: How many workers to create in a batch when needed
33; This parameter is reloadable
34; Valid range 1 to 10, default 1
35;addworkers=1
36
37; semworkers: boolean: Use a timed semaphore to reduce idle CPU usage
38; Default true if the software platform supports timed semaphores efficiently
39;semworkers=
40
41; maxmsgrate: int: Message rate threshold to declare engine congestion
42; This parameter is reloadable
43; Valid range 0 to 50000, default 0 (disable message rate check)
44;maxmsgrate=0
45
46; maxqueued: int: Message queue size threshold to declare engine congestion
47; This parameter is reloadable
48; Valid range 0 to 10000, default 0 (disable queue size check)
49;maxqueued=0
50
51; maxmsgage: int: Queued message age threshold (in msec) to declare engine congestion
52; This parameter is reloadable
53; Valid range 0 to 5000, default 0 (disable message age check)
54;maxmsgage=0
55
56; maxevents: int: Maximum number of events kept per type
57; This parameter is reloadable
58; Valid range 0 to 1000, default 25, 0 disables limit
59;maxevents=25
60
61; startevents: boolean: Capture all debug events at startup
62;startevents=yes
63
64; restarts: int: Time in seconds after startup the engine will try to restart
65;  to clean up any accumulating problems. Restarts are performed only when
66;  started in supervised mode
67; If at restart time at least one of the modules is busy it will try again to
68;  restart every 10 seconds
69;restarts=0
70
71; timejump: int: Forward system time jump in seconds accepted without restart
72; If non-zero and system time jumps backwards or too much forward
73;  an alert will be logged and if supervised the engine will restart
74; Valid range 8 to 120, 0 disables check (default)
75;timejump=0
76
77; warntime: int: Warn time limit for message dispatch in milliseconds, a value
78;  of zero disables such warnings
79;warntime=0
80
81; idlemsec: int: System idle time in milliseconds
82;  Set to zero to use platform default
83;  If not set the platform default is doubled only in client mode
84;idlemsec=
85
86; wintimer: int: Requested timer resolution in milliseconds (Windows only, does
87;  not work on 9x and ME). The default resolution depends on hardware, Windows
88;  version and currently running programs
89;wintimer=0
90
91; trackparam: string: Name of the parameter used to track message through handlers
92;  If empty or boolean true the default "handlers" will be used instead
93;  Set to boolean false to disable tracking only if you are sure what you want
94;trackparam=handlers
95
96; abortinfo: boolean: Display some engine statistics during a process abort
97;abortinfo=enable
98
99; nodeid: int: ID assigned to this node
100;  Range 0 - 2^nodebits-1
101;nodeid=
102
103; nodebits: int: Length in bits of the node ID
104;  Range 0 - 12. 0 means that node ID will be ignored
105;nodebits=0
106
107; msgsniff: bool: Activate message sniffer module (if loaded) at engine init time
108;msgsniff=disable
109
110; filtersniff: regexp: Default filter to apply to message sniffer at initialization
111; If empty it will match all messages except engine.timer which is never displayed
112; Example for a filter matching all chan.Anything messages and engine.halt:
113;  filtersniff=^\(chan\.\|engine\.halt$\)
114;filtersniff=
115
116; agesniff: float: Display only messages whose age or delay is higher than this value
117;agesniff=0
118
119
120[modules]
121; This section should hold one line for each module whose loading behaviour
122;  is to be changed from the default specified by modload= in section [general]
123; Each line has to be of the form:
124;   modulename.yate=boolean
125; Note that modules can be located only in the module directory so no path
126;  information should be specified
127
128
129[localsym]
130; This section is used to force some modules to be loaded without their
131;  symbols being globally available - if the operating system supports.
132; Windows will ignore this section completely.
133; Each line has to be of the form:
134;   modulename.yate=boolean
135
136; pwlib does not clean up properly on Linux so we must disable global symbols
137;  unfortunately preventing all pwlib plugins from loading
138h323chan.yate=yes
139
140
141[nounload]
142; This section is used to prevent some modules from being unloaded from
143;  memory, although finalization will be attempted if possible.
144; Each line has to be of the form:
145;   modulename.yate=boolean
146
147
148[preload]
149; Put a line in this section for each shared library that you want to load
150;  before any Yate module
151; Each line has to be of the form:
152;   /path/to/the/library.so=boolean
153; You should specify the full path to the library. Extension is operating
154;  system specific - usually .so for *NIX systems and .dll for Windows
155
156
157[postload]
158; Put a line in this section for each shared library that you want to load
159;  after all Yate modules
160; Each line has to be of the form:
161;   /path/to/the/library.so=boolean
162; You should specify the full path to the library. Extension is operating
163;  system specific - usually .so for *NIX systems and .dll for Windows
164
165
166[debug]
167; Each line in this section generates an engine.debug message immediately
168;  after the first initialization. This is equivalent of issuing the debug
169;  command in the Remote Manager.
170; Each line has to be of the form:
171;  modulename=parameters to debug
172; Examples:
173;  tone=off
174;  h323=level 9
175;  sip=level 8
176;  sip=filter 127.0.0.1
177
178
179[run_params]
180; Extra runtime parameters to add to the Engine at startup
181; It is not possible to overwrite existing parameters, only add new ones
182; These parameters are only loaded once at startup
183; Use the 'runparam' command to add more later
184; Examples:
185;  temppath=/tmp
186;  remote_ip=10.1.2.3
187
188
189[variables]
190; Each line in this section initializes a variable in the Engine's shared list
191; These variables can be accessed and modified from each module
192; Examples:
193;  index1=5
194;  custom=EXAMPLE
195
196
197[telephony]
198; Default settings for telephony drivers
199
200; timeout: int: Default channel timeout in milliseconds
201;timeout=0
202
203; maxroute: int: Maximum number of calls routed at once by each driver
204;maxroute=0
205
206; maxchans: int: Maximum number of channels running at once in each driver
207;maxchans=0
208
209; dtmfdups: bool: Allow duplicate DTMFs (detected with different methods)
210;dtmfdups=disable
211