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