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