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