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