1085be999eaf17a81eaeadae2f80cf176952cbb9
[asterisk/asterisk.git] / configs / sip.conf.sample
1 ;
2 ; SIP Configuration example for Asterisk
3 ;
4 ; SIP dial strings
5 ;-----------------------------------------------------------
6 ; In the dialplan (extensions.conf) you can use several 
7 ; syntaxes for dialing SIP devices.
8 ;       SIP/devicename
9 ;       SIP/username@domain   (SIP uri)
10 ;       SIP/username@host:port
11 ;       SIP/devicename/extension
12 ;
13 ;
14 ; Devicename
15 ;      devicename is defined as a peer in a section below.
16 ;
17 ; username@domain
18 ;       Call any SIP user on the Internet
19 ;       (Don't forget to enable DNS SRV records if you want to use this)
20
21 ; devicename/extension
22 ;       If you define a SIP proxy as a peer below, you may call
23 ;       SIP/proxyhostname/user or SIP/user@proxyhostname 
24 ;       where the proxyhostname is defined in a section below 
25 ;       This syntax also works with ATA's with FXO ports
26 ;
27 ; All of these dial strings specify the SIP request URI.
28 ; In addition, you can specify a specific To: header by adding an
29 ; exclamation mark after the dial string, like
30 ;
31 ;       SIP/sales@mysipproxy!sales@edvina.net
32 ;
33 ; CLI Commands
34 ; -------------------------------------------------------------
35 ; Useful CLI commands to check peers/users:
36 ;   sip show peers              Show all SIP peers (including friends)
37 ;   sip show users              Show all SIP users (including friends)
38 ;   sip show registry           Show status of hosts we register with
39 ;
40 ;   sip set debug               Show all SIP messages
41 ;
42 ;   sip reload                  Reload configuration file
43 ;                               Active SIP peers will not be reconfigured
44 ;
45
46 ; ** Deprecated configuration options **
47 ; The "call-limit" configuation option is deprecated. It still works in
48 ; this version of Asterisk, but will disappear in the next version.
49 ; You are encouraged to use the dialplan groupcount functionality
50 ; to enforce call limits instead of using this channel-specific method.
51 ;
52 ; You can still set limits per device in sip.conf or in a database by using 
53 ; "setvar" to set variables that can be used in the dialplan for various limits.
54
55 [general]
56 context=default                 ; Default context for incoming calls
57 ;allowguest=no                  ; Allow or reject guest calls (default is yes)
58 ;match_auth_username=yes        ; if available, match user entry using the
59                                 ; 'username' field from the authentication line
60                                 ; instead of the From: field.
61                                 
62 allowoverlap=no                 ; Disable overlap dialing support. (Default is yes)
63 ;allowtransfer=no               ; Disable all transfers (unless enabled in peers or users)
64                                 ; Default is enabled
65 ;realm=mydomain.tld             ; Realm for digest authentication
66                                 ; defaults to "asterisk". If you set a system name in
67                                 ; asterisk.conf, it defaults to that system name
68                                 ; Realms MUST be globally unique according to RFC 3261
69                                 ; Set this to your host name or domain name
70 bindport=5060                   ; UDP Port to bind to (SIP standard port is 5060)
71                                 ; bindport is the local UDP port that Asterisk will listen on
72 bindaddr=0.0.0.0                ; IP address to bind to (0.0.0.0 binds to all)
73
74 tcpenable=yes                   ; Enable server for incoming TCP connections (default is yes)
75 tcpbindaddr=0.0.0.0             ; IP address for TCP server to bind to (0.0.0.0 binds to all interfaces)
76                                 ; Optionally add a port number, 192.168.1.1:5062 (default is port 5060)
77
78 ;tlsenable=no                   ; Enable server for incoming TLS (secure) connections (default is no)
79 ;tlsbindaddr=0.0.0.0            ; IP address for TLS server to bind to (0.0.0.0) binds to all interfaces)
80                                 ; Optionally add a port number, 192.168.1.1:5063 (default is port 5061)
81                                 ; Remember that the IP address must match the common name (hostname) in the
82                                 ; certificate, so you don't want to bind a TLS socket to multiple IP addresses.
83
84 ;tlscertfile=asterisk.pem       ; Certificate file (*.pem only) to use for TLS connections 
85                                 ; default is to look for "asterisk.pem" in current directory
86
87 srvlookup=yes                   ; Enable DNS SRV lookups on outbound calls
88                                 ; Note: Asterisk only uses the first host 
89                                 ; in SRV records
90                                 ; Disabling DNS SRV lookups disables the 
91                                 ; ability to place SIP calls based on domain 
92                                 ; names to some other SIP users on the Internet
93                                 
94 ;domain=mydomain.tld            ; Set default domain for this host
95                                 ; If configured, Asterisk will only allow
96                                 ; INVITE and REFER to non-local domains
97                                 ; Use "sip show domains" to list local domains
98 ;pedantic=yes                   ; Enable checking of tags in headers, 
99                                 ; international character conversions in URIs
100                                 ; and multiline formatted headers for strict
101                                 ; SIP compatibility (defaults to "no")
102
103 ; See qos.tex or Quality of Service section of asterisk.pdf for a description of these parameters.
104 ;tos_sip=cs3                    ; Sets TOS for SIP packets.
105 ;tos_audio=ef                   ; Sets TOS for RTP audio packets.
106 ;tos_video=af41                 ; Sets TOS for RTP video packets.
107 ;tos_text=af41                  ; Sets TOS for RTP text packets.
108
109 ;cos_sip=3                      ; Sets 802.1p priority for SIP packets.
110 ;cos_audio=5                    ; Sets 802.1p priority for RTP audio packets.
111 ;cos_video=4                    ; Sets 802.1p priority for RTP video packets.
112 ;cos_text=3                     ; Sets 802.1p priority for RTP text packets.
113
114 ;maxexpiry=3600                 ; Maximum allowed time of incoming registrations
115                                 ; and subscriptions (seconds)
116 ;minexpiry=60                   ; Minimum length of registrations/subscriptions (default 60)
117 ;defaultexpiry=120              ; Default length of incoming/outgoing registration
118 ;qualifyfreq=60                 ; Qualification: How often to check for the 
119                                 ; host to be up in seconds
120                                 ; Set to low value if you use low timeout for
121                                 ; NAT of UDP sessions
122 ;notifymimetype=text/plain      ; Allow overriding of mime type in MWI NOTIFY
123 ;buggymwi=no                    ; Cisco SIP firmware doesn't support the MWI RFC
124                                 ; fully. Enable this option to not get error messages
125                                 ; when sending MWI to phones with this bug.
126 ;vmexten=voicemail              ; dialplan extension to reach mailbox sets the 
127                                 ; Message-Account in the MWI notify message 
128                                 ; defaults to "asterisk"
129 ;disallow=all                   ; First disallow all codecs
130 ;allow=ulaw                     ; Allow codecs in order of preference
131 ;allow=ilbc                     ; see doc/rtp-packetization for framing options
132 ;
133 ; This option specifies a preference for which music on hold class this channel
134 ; should listen to when put on hold if the music class has not been set on the
135 ; channel with Set(CHANNEL(musicclass)=whatever) in the dialplan, and the peer
136 ; channel putting this one on hold did not suggest a music class.
137 ;
138 ; This option may be specified globally, or on a per-user or per-peer basis.
139 ;
140 ;mohinterpret=default
141 ;
142 ; This option specifies which music on hold class to suggest to the peer channel
143 ; when this channel places the peer on hold. It may be specified globally or on
144 ; a per-user or per-peer basis.
145 ;
146 ;mohsuggest=default
147 ;
148 ;language=en                    ; Default language setting for all users/peers
149                                 ; This may also be set for individual users/peers
150 ;relaxdtmf=yes                  ; Relax dtmf handling
151 ;trustrpid = no                 ; If Remote-Party-ID should be trusted
152 ;sendrpid = yes                 ; If Remote-Party-ID should be sent
153 ;progressinband=never           ; If we should generate in-band ringing always
154                                 ; use 'never' to never use in-band signalling, even in cases
155                                 ; where some buggy devices might not render it
156                                 ; Valid values: yes, no, never Default: never
157 ;useragent=Asterisk PBX         ; Allows you to change the user agent string
158                                 ; The default user agent string also contains the Asterisk
159                                 ; version. If you don't want to expose this, change the
160                                 ; useragent string.
161 ;sdpsession=Asterisk PBX        ; Allows you to change the SDP session name string, (s=)
162                                 ; Like the useragent parameter, the default user agent string
163                                 ; also contains the Asterisk version.
164 ;sdpowner=root                  ; Allows you to change the username field in the SDP owner string, (o=)
165                                 ; This field MUST NOT contain spaces
166 ;promiscredir = no              ; If yes, allows 302 or REDIR to non-local SIP address
167                                 ; Note that promiscredir when redirects are made to the
168                                 ; local system will cause loops since Asterisk is incapable
169                                 ; of performing a "hairpin" call.
170 ;usereqphone = no               ; If yes, ";user=phone" is added to uri that contains
171                                 ; a valid phone number
172 ;dtmfmode = rfc2833             ; Set default dtmfmode for sending DTMF. Default: rfc2833
173                                 ; Other options: 
174                                 ; info : SIP INFO messages (application/dtmf-relay)
175                                 ; shortinfo : SIP INFO messages (application/dtmf)
176                                 ; inband : Inband audio (requires 64 kbit codec -alaw, ulaw)
177                                 ; auto : Use rfc2833 if offered, inband otherwise
178
179 ;compactheaders = yes           ; send compact sip headers.
180 ;
181 ;videosupport=yes               ; Turn on support for SIP video. You need to turn this on
182                                 ; in the this section to get any video support at all.
183                                 ; You can turn it off on a per peer basis if the general
184                                 ; video support is enabled, but you can't enable it for
185                                 ; one peer only without enabling in the general section.
186 ;maxcallbitrate=384             ; Maximum bitrate for video calls (default 384 kb/s)
187                                 ; Videosupport and maxcallbitrate is settable
188                                 ; for peers and users as well
189 ;callevents=no                  ; generate manager events when sip ua 
190                                 ; performs events (e.g. hold)
191 ;alwaysauthreject = yes         ; When an incoming INVITE or REGISTER is to be rejected,
192                                 ; for any reason, always reject with '401 Unauthorized'
193                                 ; instead of letting the requester know whether there was
194                                 ; a matching user or peer for their request
195
196 ;g726nonstandard = yes          ; If the peer negotiates G726-32 audio, use AAL2 packing
197                                 ; order instead of RFC3551 packing order (this is required
198                                 ; for Sipura and Grandstream ATAs, among others). This is
199                                 ; contrary to the RFC3551 specification, the peer _should_
200                                 ; be negotiating AAL2-G726-32 instead :-(
201 ;outboundproxy=proxy.provider.domain           ; send outbound signaling to this proxy, not directly to the devices
202 ;outboundproxy=proxy.provider.domain:8080       ; send outbound signaling to this proxy, not directly to the devices
203 ;outboundproxy=proxy.provider.domain,force      ; Send ALL outbound signalling to proxy, ignoring route: headers
204 ;matchexterniplocally = yes     ; Only substitute the externip or externhost setting if it matches
205                                 ; your localnet setting. Unless you have some sort of strange network
206                                 ; setup you will not need to enable this.
207
208 ;
209 ; If regcontext is specified, Asterisk will dynamically create and destroy a
210 ; NoOp priority 1 extension for a given peer who registers or unregisters with
211 ; us and have a "regexten=" configuration item.  
212 ; Multiple contexts may be specified by separating them with '&'. The 
213 ; actual extension is the 'regexten' parameter of the registering peer or its
214 ; name if 'regexten' is not provided.  If more than one context is provided,
215 ; the context must be specified within regexten by appending the desired
216 ; context after '@'.  More than one regexten may be supplied if they are 
217 ; separated by '&'.  Patterns may be used in regexten.
218 ;
219 ;regcontext=sipregistrations
220 ;regextenonqualify=yes          ; Default "no"
221                                 ; If you have qualify on and the peer becomes unreachable
222                                 ; this setting will enforce inactivation of the regexten
223                                 ; extension for the peer
224 ;
225 ;--------------------------- SIP timers ----------------------------------------------------
226 ; These timers are used primarily in INVITE transactions. 
227 ; The default for Timer T1 is 500 ms or the measured run-trip time between
228 ; Asterisk and the device if you have qualify=yes for the device.
229 ;
230 ;t1min=100                      ; Minimum roundtrip time for messages to monitored hosts
231                                 ; Defaults to 100 ms
232 ;timert1=500                    ; Default T1 timer
233                                 ; Defaults to 500 ms or the measured round-trip
234                                 ; time to a peer (qualify=yes).
235 ;timerb=32000                   ; Call setup timer. If a provisional response is not received
236                                 ; in this amount of time, the call will autocongest
237                                 ; Defaults to 64*timert1
238
239 ;--------------------------- RTP timers ----------------------------------------------------
240 ; These timers are currently used for both audio and video streams. The RTP timeouts
241 ; are only applied to the audio channel.
242 ; The settings are settable in the global section as well as per device
243 ;
244 ;rtptimeout=60                  ; Terminate call if 60 seconds of no RTP or RTCP activity
245                                 ; on the audio channel
246                                 ; when we're not on hold. This is to be able to hangup
247                                 ; a call in the case of a phone disappearing from the net,
248                                 ; like a powerloss or grandma tripping over a cable.
249 ;rtpholdtimeout=300             ; Terminate call if 300 seconds of no RTP or RTCP activity
250                                 ; on the audio channel
251                                 ; when we're on hold (must be > rtptimeout)
252 ;rtpkeepalive=<secs>            ; Send keepalives in the RTP stream to keep NAT open
253                                 ; (default is off - zero)
254
255 ;--------------------------- SIP Session-Timers (RFC 4028)------------------------------------
256 ; SIP Session-Timers provide an end-to-end keep-alive mechanism for active SIP sessions.
257 ; This mechanism can detect and reclaim SIP channels that do not terminate through normal
258 ; signaling procedures. Session-Timers can be configured globally or at a user/peer level.
259 ; The operation of Session-Timers is driven by the following configuration parameters:
260 ;
261 ; * session-timers    - Session-Timers feature operates in the following three modes:
262 ;                            originate : Request and run session-timers always
263 ;                            accept    : Run session-timers only when requested by other UA
264 ;                            refuse    : Do not run session timers in any case
265 ;                       The default mode of operation is 'accept'.
266 ; * session-expires   - Maximum session refresh interval in seconds. Defaults to 1800 secs.
267 ; * session-minse     - Minimum session refresh interval in seconds. Defualts to 90 secs.
268 ; * session-refresher - The session refresher (uac|uas). Defaults to 'uas'.
269 ;
270 ;session-timers=originate
271 ;session-expires=600
272 ;session-minse=90
273 ;session-refresher=uas
274
275
276 ;--------------------------- SIP DEBUGGING ---------------------------------------------------
277 ;sipdebug = yes                 ; Turn on SIP debugging by default, from
278                                 ; the moment the channel loads this configuration
279 ;recordhistory=yes              ; Record SIP history by default 
280                                 ; (see sip history / sip no history)
281 ;dumphistory=yes                ; Dump SIP history at end of SIP dialogue
282                                 ; SIP history is output to the DEBUG logging channel
283
284
285 ;--------------------------- STATUS NOTIFICATIONS (SUBSCRIPTIONS) ----------------------------
286 ; You can subscribe to the status of extensions with a "hint" priority
287 ; (See extensions.conf.sample for examples)
288 ; chan_sip support two major formats for notifications: dialog-info and SIMPLE 
289 ;
290 ; You will get more detailed reports (busy etc) if you have a call counter enabled
291 ; for a device. 
292 ;
293 ; If you set the busylevel, we will indicate busy when we have a number of calls that 
294 ; matches the busylevel treshold.
295 ;
296 ; For queues, you will need this level of detail in status reporting, regardless
297 ; if you use SIP subscriptions. Queues and manager use the same internal interface
298 ; for reading status information.
299 ;
300 ; Note: Subscriptions does not work if you have a realtime dialplan and use the
301 ; realtime switch.
302 ;
303 ;allowsubscribe=no              ; Disable support for subscriptions. (Default is yes)
304 ;subscribecontext = default     ; Set a specific context for SUBSCRIBE requests
305                                 ; Useful to limit subscriptions to local extensions
306                                 ; Settable per peer/user also
307 ;notifyringing = yes            ; Notify subscriptions on RINGING state (default: no)
308 ;notifyhold = yes               ; Notify subscriptions on HOLD state (default: no)
309                                 ; Turning on notifyringing and notifyhold will add a lot
310                                 ; more database transactions if you are using realtime.
311 ;callcounter = yes              ; Enable call counters on devices. This can be set per
312                                 ; device too.
313 ;counteronpeer = yes            ; Apply call counting on peers only. This will improve 
314                                 ; status notification when you are using type=friend
315                                 ; Inbound calls, that really apply to the user part
316                                 ; of a friend will now be added to and compared with
317                                 ; the peer counter instead of applying two call counters,
318                                 ; one for the peer and one for the user.
319                                 ; "sip show inuse" will only show active calls on 
320                                 ; the peer side of a "type=friend" object if this
321                                 ; setting is turned on.
322
323 ;----------------------------------------- T.38 FAX PASSTHROUGH SUPPORT -----------------------
324 ;
325 ; This setting is available in the [general] section as well as in device configurations.
326 ; Setting this to yes, enables T.38 fax (UDPTL) passthrough on SIP to SIP calls, provided
327 ; both parties have T38 support enabled in their Asterisk configuration 
328 ; This has to be enabled in the general section for all devices to work. You can then
329 ; disable it on a per device basis. 
330 ;
331 ; T.38 faxing only works in SIP to SIP calls, with no local or agent channel being used.
332 ;
333 ; t38pt_udptl = yes            ; Default false
334 ;
335 ;----------------------------------------- OUTBOUND SIP REGISTRATIONS  ------------------------
336 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
337 ; Format for the register statement is:
338 ;       register => [transport://]user[:secret[:authuser]]@host[:port][/extension]
339 ;
340
341 ;
342 ; If no extension is given, the 's' extension is used. The extension needs to
343 ; be defined in extensions.conf to be able to accept calls from this SIP proxy
344 ; (provider).
345 ;
346 ; host is either a host name defined in DNS or the name of a section defined
347 ; below.
348 ;
349 ; A similar effect can be achieved by adding a "callbackextension" option in a peer section.
350 ; this is equivalent to having the following line in the general section:
351 ;
352 ;       register => username:secret@host/callbackextension
353 ;
354 ; and more readable because you don't have to write the parameters in two places
355 ; (note that the "port" is ignored - this is a bug that should be fixed).
356 ;
357 ; Examples:
358 ;
359 ;register => 1234:password@mysipprovider.com    
360 ;
361 ;     This will pass incoming calls to the 's' extension
362 ;
363 ;
364 ;register => 2345:password@sip_proxy/1234
365 ;
366 ;    Register 2345 at sip provider 'sip_proxy'.  Calls from this provider
367 ;    connect to local extension 1234 in extensions.conf, default context,
368 ;    unless you configure a [sip_proxy] section below, and configure a
369 ;    context.
370 ;    Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
371 ;    Tip 2: Use separate type=peer and type=user sections for SIP providers
372 ;           (instead of type=friend) if you have calls in both directions
373   
374 ;registertimeout=20             ; retry registration calls every 20 seconds (default)
375 ;registerattempts=10            ; Number of registration attempts before we give up
376                                 ; 0 = continue forever, hammering the other server
377                                 ; until it accepts the registration
378                                 ; Default is 0 tries, continue forever
379
380 ;----------------------------------------- NAT SUPPORT ------------------------
381 ;
382 ; WARNING: SIP operation behind a NAT is tricky and you really need
383 ; to read and understand well the following section.
384 ;
385 ; When Asterisk is behind a NAT device, the "local" address (and port) that
386 ; a socket is bound to has different values when seen from the inside or
387 ; from the outside of the NATted network. Unfortunately this address must
388 ; be communicated to the outside (e.g. in SIP and SDP messages), and in
389 ; order to determine the correct value Asterisk needs to know:
390 ;
391 ; + whether it is talking to someone "inside" or "outside" of the NATted network.
392 ;   This is configured by assigning the "localnet" parameter with a list
393 ;   of network addresses that are considered "inside" of the NATted network.
394 ;   IF LOCALNET IS NOT SET, THE EXTERNAL ADDRESS WILL NOT BE SET CORRECTLY.
395 ;   Multiple entries are allowed, e.g. a reasonable set is the following:
396 ;
397 ;      localnet=192.168.0.0/255.255.0.0 ; RFC 1918 addresses
398 ;      localnet=10.0.0.0/255.0.0.0      ; Also RFC1918
399 ;      localnet=172.16.0.0/12           ; Another RFC1918 with CIDR notation
400 ;      localnet=169.254.0.0/255.255.0.0 ; Zero conf local network
401 ;
402 ; + the "externally visible" address and port number to be used when talking
403 ;   to a host outside the NAT. This information is derived by one of the
404 ;   following (mutually exclusive) config file parameters:
405 ;
406 ;   a. "externip = hostname[:port]" specifies a static address[:port] to
407 ;      be used in SIP and SDP messages.
408 ;      The hostname is looked up only once, when [re]loading sip.conf .
409 ;      If a port number is not present, use the "bindport" value (which is
410 ;      not guaranteed to work correctly, because a NAT box might remap the
411 ;      port number as well as the address).
412 ;      This approach can be useful if you have a NAT device where you can
413 ;      configure the mapping statically. Examples:
414 ;
415 ;       externip = 12.34.56.78          ; use this address.
416 ;       externip = 12.34.56.78:9900     ; use this address and port.
417 ;       externip = mynat.my.org:12600   ; Public address of my nat box.
418 ;
419 ;   b. "externhost = hostname[:port]" is similar to "externip" except
420 ;      that the hostname is looked up every "externrefresh" seconds
421 ;      (default 10s). This can be useful when your NAT device lets you choose
422 ;      the port mapping, but the IP address is dynamic.
423 ;      Beware, you might suffer from service disruption when the name server
424 ;      resolution fails. Examples:
425 ;
426 ;       externhost=foo.dyndns.net       ; refreshed periodically
427 ;       externrefresh=180               ; change the refresh interval
428 ;
429 ;   c. "stunaddr = stun.server[:port]" queries the STUN server specified
430 ;      as an argument to obtain the external address/port.
431 ;      Queries are also sent periodically every "externrefresh" seconds
432 ;      (as a side effect, sending the query also acts as a keepalive for
433 ;      the state entry on the nat box):
434 ;
435 ;       stunaddr = foo.stun.com:3478
436 ;       externrefresh = 15
437 ;
438 ;   Note that at the moment all these mechanism work only for the SIP socket.
439 ;   The IP address discovered with externip/externhost/STUN is reused for
440 ;   media sessions as well, but the port numbers are not remapped so you
441 ;   may still experience problems.
442 ;
443 ; NOTE 1: in some cases, NAT boxes will use different port numbers in
444 ; the internal<->external mapping. In these cases, the "externip" and
445 ; "externhost" might not help you configure addresses properly, and you
446 ; really need to use STUN.
447 ;
448 ; NOTE 2: when using "externip" or "externhost", the address part is
449 ; also used as the external address for media sessions.
450 ; If you use "stunaddr", STUN queries will be sent to the same server
451 ; also from media sockets, and this should permit a correct mapping of
452 ; the port numbers as well.
453 ;
454 ; In addition to the above, Asterisk has an additional "nat" parameter to
455 ; address NAT-related issues in incoming SIP or media sessions.
456 ; In particular, depending on the 'nat= ' settings described below, Asterisk
457 ; may override the address/port information specified in the SIP/SDP messages,
458 ; and use the information (sender address) supplied by the network stack instead.
459 ; However, this is only useful if the external traffic can reach us.
460 ; The following settings are allowed (both globally and in individual sections):
461 ;
462 ;       nat = no                ; default. Use NAT mode only according to RFC3581 (;rport)
463 ;       nat = yes               ; Always ignore info and assume NAT
464 ;       nat = never             ; Never attempt NAT mode or RFC3581 support
465 ;       nat = route             ; route = Assume NAT, don't send rport 
466 ;                               ; (work around more UNIDEN bugs)
467
468 ;----------------------------------- MEDIA HANDLING --------------------------------
469 ; By default, Asterisk tries to re-invite the audio to an optimal path. If there's
470 ; no reason for Asterisk to stay in the media path, the media will be redirected.
471 ; This does not really work with in the case where Asterisk is outside and have
472 ; clients on the inside of a NAT. In that case, you want to set canreinvite=nonat
473 ;
474 ;canreinvite=yes                ; Asterisk by default tries to redirect the
475                                 ; RTP media stream (audio) to go directly from
476                                 ; the caller to the callee.  Some devices do not
477                                 ; support this (especially if one of them is behind a NAT).
478                                 ; The default setting is YES. If you have all clients
479                                 ; behind a NAT, or for some other reason wants Asterisk to
480                                 ; stay in the audio path, you may want to turn this off.
481
482                                 ; This setting also affect direct RTP
483                                 ; at call setup (a new feature in 1.4 - setting up the
484                                 ; call directly between the endpoints instead of sending
485                                 ; a re-INVITE).
486
487 ;directrtpsetup=yes             ; Enable the new experimental direct RTP setup. This sets up
488                                 ; the call directly with media peer-2-peer without re-invites.
489                                 ; Will not work for video and cases where the callee sends 
490                                 ; RTP payloads and fmtp headers in the 200 OK that does not match the
491                                 ; callers INVITE. This will also fail if canreinvite is enabled when
492                                 ; the device is actually behind NAT.
493
494 ;canreinvite=nonat              ; An additional option is to allow media path redirection
495                                 ; (reinvite) but only when the peer where the media is being
496                                 ; sent is known to not be behind a NAT (as the RTP core can
497                                 ; determine it based on the apparent IP address the media
498                                 ; arrives from).
499
500 ;canreinvite=update             ; Yet a third option... use UPDATE for media path redirection,
501                                 ; instead of INVITE. This can be combined with 'nonat', as
502                                 ; 'canreinvite=update,nonat'. It implies 'yes'.
503
504 ;----------------------------------------- REALTIME SUPPORT ------------------------
505 ; For additional information on ARA, the Asterisk Realtime Architecture,
506 ; please read realtime.txt and extconfig.txt in the /doc directory of the
507 ; source code.
508 ;
509 ;rtcachefriends=yes             ; Cache realtime friends by adding them to the internal list
510                                 ; just like friends added from the config file only on a
511                                 ; as-needed basis? (yes|no)
512
513 ;rtsavesysname=yes              ; Save systemname in realtime database at registration
514                                 ; Default= no
515
516 ;rtupdate=yes                   ; Send registry updates to database using realtime? (yes|no)
517                                 ; If set to yes, when a SIP UA registers successfully, the ip address,
518                                 ; the origination port, the registration period, and the username of
519                                 ; the UA will be set to database via realtime. 
520                                 ; If not present, defaults to 'yes'.
521 ;rtautoclear=yes                ; Auto-Expire friends created on the fly on the same schedule
522                                 ; as if it had just registered? (yes|no|<seconds>)
523                                 ; If set to yes, when the registration expires, the friend will
524                                 ; vanish from the configuration until requested again. If set
525                                 ; to an integer, friends expire within this number of seconds
526                                 ; instead of the registration interval.
527
528 ;ignoreregexpire=yes            ; Enabling this setting has two functions:
529                                 ;
530                                 ; For non-realtime peers, when their registration expires, the
531                                 ; information will _not_ be removed from memory or the Asterisk database
532                                 ; if you attempt to place a call to the peer, the existing information
533                                 ; will be used in spite of it having expired
534                                 ;
535                                 ; For realtime peers, when the peer is retrieved from realtime storage,
536                                 ; the registration information will be used regardless of whether
537                                 ; it has expired or not; if it expires while the realtime peer 
538                                 ; is still in memory (due to caching or other reasons), the 
539                                 ; information will not be removed from realtime storage
540
541 ;----------------------------------------- SIP DOMAIN SUPPORT ------------------------
542 ; Incoming INVITE and REFER messages can be matched against a list of 'allowed'
543 ; domains, each of which can direct the call to a specific context if desired.
544 ; By default, all domains are accepted and sent to the default context or the
545 ; context associated with the user/peer placing the call.
546 ; Domains can be specified using:
547 ; domain=<domain>[,<context>]
548 ; Examples:
549 ; domain=myasterisk.dom
550 ; domain=customer.com,customer-context
551 ;
552 ; In addition, all the 'default' domains associated with a server should be
553 ; added if incoming request filtering is desired.
554 ; autodomain=yes
555 ;
556 ; To disallow requests for domains not serviced by this server:
557 ; allowexternaldomains=no
558
559 ;domain=mydomain.tld,mydomain-incoming
560                                 ; Add domain and configure incoming context
561                                 ; for external calls to this domain
562 ;domain=1.2.3.4                 ; Add IP address as local domain
563                                 ; You can have several "domain" settings
564 ;allowexternaldomains=no        ; Disable INVITE and REFER to non-local domains
565                                 ; Default is yes
566 ;autodomain=yes                 ; Turn this on to have Asterisk add local host
567                                 ; name and local IP to domain list.
568
569 ; fromdomain=mydomain.tld       ; When making outbound SIP INVITEs to
570                                 ; non-peers, use your primary domain "identity"
571                                 ; for From: headers instead of just your IP
572                                 ; address. This is to be polite and
573                                 ; it may be a mandatory requirement for some
574                                 ; destinations which do not have a prior
575                                 ; account relationship with your server. 
576
577 ;------------------------------ JITTER BUFFER CONFIGURATION --------------------------
578 ; jbenable = yes              ; Enables the use of a jitterbuffer on the receiving side of a
579                               ; SIP channel. Defaults to "no". An enabled jitterbuffer will
580                               ; be used only if the sending side can create and the receiving
581                               ; side can not accept jitter. The SIP channel can accept jitter,
582                               ; thus a jitterbuffer on the receive SIP side will be used only
583                               ; if it is forced and enabled.
584
585 ; jbforce = no                ; Forces the use of a jitterbuffer on the receive side of a SIP
586                               ; channel. Defaults to "no".
587
588 ; jbmaxsize = 200             ; Max length of the jitterbuffer in milliseconds.
589
590 ; jbresyncthreshold = 1000    ; Jump in the frame timestamps over which the jitterbuffer is
591                               ; resynchronized. Useful to improve the quality of the voice, with
592                               ; big jumps in/broken timestamps, usually sent from exotic devices
593                               ; and programs. Defaults to 1000.
594
595 ; jbimpl = fixed              ; Jitterbuffer implementation, used on the receiving side of a SIP
596                               ; channel. Two implementations are currently available - "fixed"
597                               ; (with size always equals to jbmaxsize) and "adaptive" (with
598                               ; variable size, actually the new jb of IAX2). Defaults to fixed.
599
600 ; jblog = no                  ; Enables jitterbuffer frame logging. Defaults to "no".
601 ;-----------------------------------------------------------------------------------
602
603 [authentication]
604 ; Global credentials for outbound calls, i.e. when a proxy challenges your
605 ; Asterisk server for authentication. These credentials override
606 ; any credentials in peer/register definition if realm is matched.
607 ;
608 ; This way, Asterisk can authenticate for outbound calls to other
609 ; realms. We match realm on the proxy challenge and pick an set of 
610 ; credentials from this list
611 ; Syntax:
612 ;       auth = <user>:<secret>@<realm>
613 ;       auth = <user>#<md5secret>@<realm>
614 ; Example:
615 ;auth=mark:topsecret@digium.com
616
617 ; You may also add auth= statements to [peer] definitions 
618 ; Peer auth= override all other authentication settings if we match on realm
619
620 ;------------------------------------------------------------------------------
621 ; Users and peers have different settings available. Friends have all settings,
622 ; since a friend is both a peer and a user
623 ;
624 ; User config options:        Peer configuration:
625 ; --------------------        -------------------
626 ; context                     context
627 ; callingpres                 callingpres
628 ; permit                      permit
629 ; deny                        deny
630 ; secret                      secret
631 ; md5secret                   md5secret
632 ; dtmfmode                    dtmfmode
633 ; canreinvite                 canreinvite
634 ; nat                         nat
635 ; callgroup                   callgroup
636 ; pickupgroup                 pickupgroup
637 ; language                    language
638 ; allow                       allow
639 ; disallow                    disallow
640 ; insecure                    insecure
641 ; trustrpid                   trustrpid
642 ; progressinband              progressinband
643 ; promiscredir                promiscredir
644 ; useclientcode               useclientcode
645 ; accountcode                 accountcode
646 ; setvar                      setvar
647 ; callerid                    callerid
648 ; amaflags                    amaflags
649 ; call-limit                  call-limit        (deprecated)
650 ; callcounter                 callcounter
651 ; allowoverlap                allowoverlap
652 ; allowsubscribe              allowsubscribe
653 ; allowtransfer               allowtransfer
654 ; subscribecontext            subscribecontext
655 ; videosupport                videosupport
656 ; maxcallbitrate              maxcallbitrate
657 ; rfc2833compensate           mailbox
658 ; session-timers             busylevel
659 ; session-expires            
660 ; session-minse              template
661 ; session-refresher          fromdomain
662 ;                            regexten
663 ;                            fromuser
664 ;                            host
665 ;                            port
666 ;                             qualify
667 ;                             defaultip
668 ;                             defaultuser
669 ;                             rtptimeout
670 ;                             rtpholdtimeout
671 ;                             sendrpid
672 ;                             outboundproxy
673 ;                             rfc2833compensate
674 ;                             callbackextension
675 ;                             registertrying
676 ;                             session-timers
677 ;                             session-expires
678 ;                             session-minse
679 ;                             session-refresher
680 ;                             timert1
681 ;                             timerb
682 ;                             qualifyfreq
683
684
685 ;[sip_proxy]
686 ; For incoming calls only. Example: FWD (Free World Dialup)
687 ; We match on IP address of the proxy for incoming calls 
688 ; since we can not match on username (caller id)
689 ;type=peer
690 ;context=from-fwd
691 ;host=fwd.pulver.com
692
693 ;[sip_proxy-out]
694 ;type=peer                              ; we only want to call out, not be called
695 ;secret=guessit
696 ;defaultuser=yourusername               ; Authentication user for outbound proxies
697 ;fromuser=yourusername                  ; Many SIP providers require this!
698 ;fromdomain=provider.sip.domain 
699 ;host=box.provider.com
700 ;usereqphone=yes                        ; This provider requires ";user=phone" on URI
701 ;callcounter=yes                        ; Enable call counter
702 ;busylevel=2                            ; Signal busy at 2 or more calls
703 ;outboundproxy=proxy.provider.domain    ; send outbound signaling to this proxy, not directly to the peer
704 ;port=80                                ; The port number we want to connect to on the remote side
705                                         ; Also used as "defaultport" in combination with "defaultip" settings
706
707 ;--- sample definition for a provider
708 ;[provider1]
709 ;type=peer
710 ;host=sip.provider1.com
711 ;fromuser=4015552299            ; how your provider knows you
712 ;secret=youwillneverguessit
713 ;callbackextension=123          ; Register with this server and require calls coming back to this extension
714
715 ;------------------------------------------------------------------------------
716 ; Definitions of locally connected SIP devices
717 ;
718 ; type = user   a device that authenticates to us by "from" field to place calls
719 ; type = peer   a device we place calls to or that calls us and we match by host
720 ; type = friend two configurations (peer+user) in one
721 ;
722 ; For device names, we recommend using only a-z, numerics (0-9) and underscore
723
724 ; For local phones, type=friend works most of the time
725 ;
726 ; If you have one-way audio, you probably have NAT problems. 
727 ; If Asterisk is on a public IP, and the phone is inside of a NAT device
728 ; you will need to configure nat option for those phones.
729 ; Also, turn on qualify=yes to keep the nat session open
730 ;
731 ; Because you might have a large number of similar sections, it is generally
732 ; convenient to use templates for the common parameters, and add them
733 ; the the various sections. Examples are below, and we can even leave
734 ; the templates uncommented as they will not harm:
735
736 [basic-options](!)              ; a template
737         dtmfmode=rfc2833
738         context=from-office
739         type=friend
740
741 [natted-phone](!,basic-options) ; another template inheriting basic-options
742         nat=yes
743         canreinvite=no
744         host=dynamic
745
746 [public-phone](!,basic-options) ; another template inheriting basic-options
747         nat=no
748         canreinvite=yes
749
750 [my-codecs](!)          ; a template for my preferred codecs
751         disallow=all
752         allow=ilbc
753         allow=g729
754         allow=gsm
755         allow=g723
756         allow=ulaw
757
758 [ulaw-phone](!)         ; and another one for ulaw-only
759         disallow=all
760         allow=ulaw
761
762 ; and finally instantiate a few phones
763 ;
764 ; [2133](natted-phone,my-codecs)
765 ;       secret = peekaboo
766 ; [2134](natted-phone,ulaw-phone)
767 ;       secret = not_very_secret
768 ; [2136](public-phone,ulaw-phone)
769 ;       secret = not_very_secret_either
770 ; ...
771 ;
772
773 ; Standard configurations not using templates look like this:
774 ;
775 ;[grandstream1]
776 ;type=friend                    
777 ;context=from-sip               ; Where to start in the dialplan when this phone calls
778 ;callerid=John Doe <1234>       ; Full caller ID, to override the phones config
779                                 ; on incoming calls to Asterisk
780 ;host=192.168.0.23              ; we have a static but private IP address
781                                 ; No registration allowed
782 ;nat=no                         ; there is not NAT between phone and Asterisk
783 ;canreinvite=yes                ; allow RTP voice traffic to bypass Asterisk
784 ;dtmfmode=info                  ; either RFC2833 or INFO for the BudgeTone
785 ;call-limit=1                   ; permit only 1 outgoing call and 1 incoming call at a time
786                                 ; from the phone to asterisk (deprecated)
787                                 ; 1 for the explicit peer, 1 for the explicit user,
788                                 ; remember that a friend equals 1 peer and 1 user in
789                                 ; memory
790                                 ; There is no combined call counter for a "friend"
791                                 ; so there's currently no way in sip.conf to limit
792                                 ; to one inbound or outbound call per phone. Use
793                                 ; the group counters in the dial plan for that.
794                                 ;
795 ;mailbox=1234@default           ; mailbox 1234 in voicemail context "default"
796 ;disallow=all                   ; need to disallow=all before we can use allow=
797 ;allow=ulaw                     ; Note: In user sections the order of codecs
798                                 ; listed with allow= does NOT matter!
799 ;allow=alaw
800 ;allow=g723.1                   ; Asterisk only supports g723.1 pass-thru!
801 ;allow=g729                     ; Pass-thru only unless g729 license obtained
802 ;callingpres=allowed_passed_screen      ; Set caller ID presentation
803                                 ; See README.callingpres for more information
804
805 ;[xlite1]
806 ; Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
807 ; Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
808 ;type=friend
809 ;regexten=1234                  ; When they register, create extension 1234
810 ;callerid="Jane Smith" <5678>
811 ;host=dynamic                   ; This device needs to register
812 ;nat=yes                        ; X-Lite is behind a NAT router
813 ;canreinvite=no                 ; Typically set to NO if behind NAT
814 ;disallow=all
815 ;allow=gsm                      ; GSM consumes far less bandwidth than ulaw
816 ;allow=ulaw
817 ;allow=alaw
818 ;mailbox=1234@default,1233@default      ; Subscribe to status of multiple mailboxes
819 ;registertrying=yes             ; Send a 100 Trying when the device registers.
820
821 ;[snom]
822 ;type=friend                    ; Friends place calls and receive calls
823 ;context=from-sip               ; Context for incoming calls from this user
824 ;secret=blah
825 ;subscribecontext=localextensions       ; Only allow SUBSCRIBE for local extensions
826 ;language=de                    ; Use German prompts for this user 
827 ;host=dynamic                   ; This peer register with us
828 ;dtmfmode=inband                ; Choices are inband, rfc2833, or info
829 ;defaultip=192.168.0.59         ; IP used until peer registers
830 ;mailbox=1234@context,2345      ; Mailbox(-es) for message waiting indicator
831 ;subscribemwi=yes               ; Only send notifications if this phone 
832                                 ; subscribes for mailbox notification
833 ;vmexten=voicemail              ; dialplan extension to reach mailbox 
834                                 ; sets the Message-Account in the MWI notify message
835                                 ; defaults to global vmexten which defaults to "asterisk"
836 ;disallow=all
837 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
838
839
840 ;[polycom]
841 ;type=friend                    ; Friends place calls and receive calls
842 ;context=from-sip               ; Context for incoming calls from this user
843 ;secret=blahpoly
844 ;host=dynamic                   ; This peer register with us
845 ;dtmfmode=rfc2833               ; Choices are inband, rfc2833, or info
846 ;defaultuser=polly              ; Username to use in INVITE until peer registers
847 ;defaultip=192.168.40.123
848                                 ; Normally you do NOT need to set this parameter
849 ;disallow=all
850 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
851 ;progressinband=no              ; Polycom phones don't work properly with "never"
852
853
854 ;[pingtel]
855 ;type=friend
856 ;secret=blah
857 ;host=dynamic
858 ;insecure=port                  ; Allow matching of peer by IP address without 
859                                 ; matching port number
860 ;insecure=invite                ; Do not require authentication of incoming INVITEs
861 ;insecure=port,invite           ; (both)
862 ;qualify=1000                   ; Consider it down if it's 1 second to reply
863                                 ; Helps with NAT session
864                                 ; qualify=yes uses default value
865 ;qualifyfreq=60 ; Qualification: How often to check for the 
866                                 ; host to be up in seconds
867                                 ; Set to low value if you use low timeout for
868                                 ; NAT of UDP sessions
869 ;
870 ; Call group and Pickup group should be in the range from 0 to 63
871 ;
872 ;callgroup=1,3-4                ; We are in caller groups 1,3,4
873 ;pickupgroup=1,3-5              ; We can do call pick-p for call group 1,3,4,5
874 ;defaultip=192.168.0.60         ; IP address to use if peer has not registered
875 ;deny=0.0.0.0/0.0.0.0           ; ACL: Control access to this account based on IP address
876 ;permit=192.168.0.60/255.255.255.0
877
878 ;[cisco1]
879 ;type=friend
880 ;secret=blah
881 ;qualify=200                    ; Qualify peer is no more than 200ms away
882 ;nat=yes                        ; This phone may be natted
883                                 ; Send SIP and RTP to the IP address that packet is 
884                                 ; received from instead of trusting SIP headers 
885 ;host=dynamic                   ; This device registers with us
886 ;canreinvite=no                 ; Asterisk by default tries to redirect the
887                                 ; RTP media stream (audio) to go directly from
888                                 ; the caller to the callee.  Some devices do not
889                                 ; support this (especially if one of them is 
890                                 ; behind a NAT).
891 ;defaultip=192.168.0.4          ; IP address to use until registration
892 ;defaultuser=goran              ; Username to use when calling this device before registration
893                                 ; Normally you do NOT need to set this parameter
894 ;setvar=CUSTID=5678             ; Channel variable to be set for all calls from this device
895
896 ;[pre14-asterisk]
897 ;type=friend
898 ;secret=digium
899 ;host=dynamic
900 ;rfc2833compensate=yes          ; Compensate for pre-1.4 DTMF transmission from another Asterisk machine.
901                                 ; You must have this turned on or DTMF reception will work improperly.