60dc8730533f119355475b60783868551d94ca7f
[asterisk/asterisk.git] / configs / skinny.conf.sample
1 ;
2 ; Skinny Configuration for Asterisk
3 ;
4 [general]
5 bindaddr=0.0.0.0        ; Address to bind to
6 bindport=2000           ; Port to bind to, default tcp/2000
7 dateformat=M-D-Y        ; M,D,Y in any order (6 chars max)
8                         ; "A" may also be used, but it must be at the end.
9                         ; Use M for month, D for day, Y for year, A for 12-hour time.
10 keepalive=120
11
12 ;authtimeout = 30       ; authtimeout specifies the maximum number of seconds a
13                         ; client has to authenticate.  If the client does not
14                         ; authenticate beofre this timeout expires, the client
15                         ; will be disconnected.  (default: 30 seconds)
16
17 ;authlimit = 50         ; authlimit specifies the maximum number of
18                         ; unauthenticated sessions that will be allowed to
19                         ; connect at any given time. (default: 50)
20
21 ;vmexten=8500           ; Systemwide voicemailmain pilot number
22                         ; It must be in the same context as the calling
23                         ; device/line
24
25 ; If regcontext is specified, Asterisk will dynamically create and destroy a
26 ; NoOp priority 1 extension for a given line which registers or unregisters with
27 ; us and have a "regexten=" configuration item.
28 ; Multiple contexts may be specified by separating them with '&'. The
29 ; actual extension is the 'regexten' parameter of the registering line or its
30 ; name if 'regexten' is not provided.  If more than one context is provided,
31 ; the context must be specified within regexten by appending the desired
32 ; context after '@'.  More than one regexten may be supplied if they are
33 ; separated by '&'.  Patterns may be used in regexten.
34 ;
35 ;regcontext=skinnyregistrations
36
37 ;allow=all              ; see https://wiki.asterisk.org/wiki/display/AST/RTP+Packetization
38                         ; for framing options
39 ;disallow=
40
41 ; The imeddialkey option allows for a key to be used to immediately dial the already
42 ; entered number. This is useful where the dialplan includes variable length pattern
43 ; matching. Valid options are '#' and '*'. On devices with soft buttons, a button will
44 ; be available to immediately dial when a pattern than can be dialed has been entered.
45 ; Default is unset, that is no immediated dial key (softbutton still exists).
46 ;
47 ;immeddialkey=#
48
49 ; See https://wiki.asterisk.org/wiki/display/AST/IP+Quality+of+Service for a description of these parameters.
50 ;tos=cs3                ; Sets TOS for signaling packets.
51 ;tos_audio=ef           ; Sets TOS for RTP audio packets.
52 ;tos_video=af41         ; Sets TOS for RTP video packets.
53 ;cos=3                  ; Sets 802.1p priority for signaling packets.
54 ;cos_audio=5            ; Sets 802.1p priority for RTP audio packets.
55 ;cos_video=4            ; Sets 802.1p priority for RTP video packets.
56
57 ;------------------------------ JITTER BUFFER CONFIGURATION --------------------------
58 ;jbenable = yes              ; Enables the use of a jitterbuffer on the receiving side of a
59                              ; skinny channel. Defaults to "no". An enabled jitterbuffer will
60                              ; be used only if the sending side can create and the receiving
61                              ; side can not accept jitter. The skinny channel can accept
62                              ; jitter, thus a jitterbuffer on the receive skinny side will be
63                              ; used only if it is forced and enabled.
64
65 ;jbforce = no                ; Forces the use of a jitterbuffer on the receive side of a skinny
66                              ; channel. Defaults to "no".
67
68 ;jbmaxsize = 200             ; Max length of the jitterbuffer in milliseconds.
69
70 ;jbresyncthreshold = 1000    ; Jump in the frame timestamps over which the jitterbuffer is
71                              ; resynchronized. Useful to improve the quality of the voice, with
72                              ; big jumps in/broken timestamps, usually sent from exotic devices
73                              ; and programs. Defaults to 1000.
74
75 ;jbimpl = fixed              ; Jitterbuffer implementation, used on the receiving side of a
76                              ; skinny channel. Two implementations are currently available
77                              ; - "fixed" (with size always equals to jbmaxsize)
78                              ; - "adaptive" (with variable size, actually the new jb of IAX2).
79                              ; Defaults to fixed.
80
81 ;jblog = no                  ; Enables jitterbuffer frame logging. Defaults to "no".
82 ;-----------------------------------------------------------------------------------
83
84 [lines]
85 ;----------------------------------- LINES SECTION --------------------------------
86 ; Options set under [lines] apply to all lines unless explicitly set for a particular
87 ; device. The options that can be set under lines are specified in GENERAL LINE OPTIONS.
88 ; These options can also be set for each individual device as well as those under SPECIFIC
89 ; LINE OPTIONS.
90 ;
91 ; Each label below [lines] in [] is a new line with the specific options specified below
92 ; it. Config stops reading new lines when one of the following is found: [general], [devices]
93 ; or the end of skinny.conf.
94 ;
95 ; Where options are common to both lines and devices, the results typically take that of
96 ; the least permission. ie if a no is set for either line or device, the call will not be
97 ; able to use that permission
98 ;-------------------------------- GENERAL LINE OPTIONS -----------------------------
99 ;earlyrtp=1                  ; whether audio signalling should be provided by asterisk
100 ;                            ; (earlyrtp=1) or device generated (earlyrtp=0). default=yes
101 ;transfer=1                  ; whether the device is allowed to transfer. default=yes
102 ;context=default             ; context to use for this line.
103 ;callfwdtimeout=20000        ; ms before cfwd_noans occurs (default 20 secs)
104 ;------------------------------- SPECIFIC LINE OPTIONS -----------------------------
105 ;setvar=                     ; allows for the setting of chanvars.
106 ;-----------------------------------------------------------------------------------
107
108 ;[100]
109 ;nat=yes
110 ;callerid="Customer Support" <810-234-1212>
111 ;mailbox=100
112 ;vmexten=8500                   ; Device level voicemailmain pilot number
113 ;regexten=100
114 ;context=inbound
115 ;linelabel="Support Line"       ; Displays next to the line
116                                 ; button on 7940's and 7960s
117 ;[110]
118 ;callerid="John Chambers" <408-526-4000>
119 ;context=did
120 ;regexten=110
121 ;linelabel="John"
122 ;mailbox=110
123
124 ;[120]
125 ;Nothing set, so all the defaults are used
126
127 ;[500]
128 ;nat=yes
129 ;callerid="George W. Bush" <202-456-1414>
130 ;setvar=CUSTID=5678     ; Channel variable to be set for all calls from this device
131 ;setvar=ATTENDED_TRANSFER_COMPLETE_SOUND=beep   ; This channel variable will
132                                                 ; cause the given audio file to
133                                                 ; be played upon completion of
134                                                 ; an attended transfer to the
135                                                 ; target of the transfer.
136 ;mailbox=500
137 ;callwaiting=yes
138 ;transfer=yes
139 ;threewaycalling=yes
140 ;context=default
141 ;mohinterpret=default   ; This option specifies a default music on hold class to
142                         ; use when put on hold if the channel's moh class was not
143                         ; explicitly set with Set(CHANNEL(musicclass)=whatever) and
144                         ; the peer channel did not suggest a class to use.
145 ;mohsuggest=default     ; This option specifies which music on hold class to suggest to the peer channel
146                         ; when this channel places the peer on hold. It may be specified globally or on
147                         ; a per-user or per-peer basis.
148
149
150 [devices]
151 ;---------------------------------- DEVICES SECTION -------------------------------
152 ; Options set under [devices] apply to all devices unless explicitly set for a particular
153 ; device. The options that can be set under devices are specified in GENERAL DEVICE OPTIONS.
154 ; These options can also be set for each individual device as well as those under SPECIFIC
155 ; DEVICE OPTIONS.
156 ;
157 ; Each label below [devices] in [] is a new device with the specific options specified below
158 ; it. Config stop reading new devices when one of the following is found: [general], [lines]
159 ; or the end of skinny.conf.
160 ;
161 ; Where options are common to both lines and devices, the results typically take that of
162 ; the least permission. ie if a no is set for either line or device, the call will not be
163 ; able to use that permission
164 ;------------------------------- GENERAL DEVICE OPTIONS ----------------------------
165 ;earlyrtp=1                  ; whether audio signalling should be provided by asterisk
166 ;                            ; (earlyrtp=1) or device generated (earlyrtp=0). default=yes
167 ;transfer=1                  ; whether the device is allowed to transfer. default=yes
168 ;------------------------------ SPECIFIC DEVICE OPTIONS ----------------------------
169 ;device="SEPxxxxxxxxxxxx     ; id of the device. Must be set.
170 ;version=P002G204            ; firmware version to be loaded. If this version is different
171 ;                            ; to the one on the device, the device will try to load this
172 ;                            ; version from the tftp server. Set to device firmware version.
173 ;-----------------------------------------------------------------------------------
174
175 ; Typical config for 12SP+
176 ;[florian]
177 ;device=SEP00D0BA847E6B
178 ;version=P002G204       ; Thanks critch
179 ;context=did
180 ;directmedia=yes        ; Allow media to go directly between two RTP endpoints.
181 ;line=120               ; Dial(Skinny/120@florian)
182
183 ; Service URLs attached to line buttons (eg phone directory)
184 ; See http://www.voip-info.org/wiki/view/Asterisk+Cisco+79XX+XML+Services
185 ; for intro to xml structure.
186 ;serviceurl=Directory,http://host/file.xml
187
188
189 ; Typical config for a 7910
190 ;[duba]                 ; Device name
191 ;device=SEP0007EB463101 ; Official identifier
192 ;version=P002F202       ; Firmware version identifier
193 ;host=192.168.1.144
194 ;permit=192.168.0/24    ; Optional, used for authentication
195 ;line=500
196
197
198 ; Typical config for a 7940 with dual 7914s
199 ;[support]
200 ;device=SEP0007EB463121
201 ;line=100
202 ;line=110
203 ;speeddial => 111,Jack Smith         ; Adds a speeddial button to a device.
204 ;speeddial => 112@hints,Bob Peterson ; When a context is specified, the speeddial watches a dialplan hint.
205 ;addon => 7914
206 ;addon => 7914
207