Fix for formats so they give better output on failure conditions. (#6141)
[asterisk/asterisk.git] / configs / sip.conf.sample
1 ;
2 ; SIP Configuration example for Asterisk
3 ;
4 ; Syntax for specifying a SIP device in extensions.conf is
5 ; SIP/devicename where devicename is defined in a section below.
6 ;
7 ; You may also use 
8 ; SIP/username@domain to call any SIP user on the Internet
9 ; (Don't forget to enable DNS SRV records if you want to use this)
10
11 ; If you define a SIP proxy as a peer below, you may call
12 ; SIP/proxyhostname/user or SIP/user@proxyhostname 
13 ; where the proxyhostname is defined in a section below 
14
15 ; Useful CLI commands to check peers/users:
16 ;   sip show peers              Show all SIP peers (including friends)
17 ;   sip show users              Show all SIP users (including friends)
18 ;   sip show registry           Show status of hosts we register with
19 ;
20 ;   sip debug                   Show all SIP messages
21 ;
22 ;   reload chan_sip.so          Reload configuration file
23 ;                               Active SIP peers will not be reconfigured
24 ;
25
26 [general]
27 context=default                 ; Default context for incoming calls
28 ;allowguest=no                  ; Allow or reject guest calls (default is yes, this can also be set to 'osp'
29                                 ; if asterisk was compiled with OSP support.
30 ;realm=mydomain.tld             ; Realm for digest authentication
31                                 ; defaults to "asterisk"
32                                 ; Realms MUST be globally unique according to RFC 3261
33                                 ; Set this to your host name or domain name
34 bindport=5060                   ; UDP Port to bind to (SIP standard port is 5060)
35 bindaddr=0.0.0.0                ; IP address to bind to (0.0.0.0 binds to all)
36 srvlookup=yes                   ; Enable DNS SRV lookups on outbound calls
37                                 ; Note: Asterisk only uses the first host 
38                                 ; in SRV records
39                                 ; Disabling DNS SRV lookups disables the 
40                                 ; ability to place SIP calls based on domain 
41                                 ; names to some other SIP users on the Internet
42                                 
43 ;domain=mydomain.tld            ; Set default domain for this host
44                                 ; If configured, Asterisk will only allow
45                                 ; INVITE and REFER to non-local domains
46                                 ; Use "sip show domains" to list local domains
47 ;domain=mydomain.tld,mydomain-incoming
48                                 ; Add domain and configure incoming context
49                                 ; for external calls to this domain
50 ;domain=1.2.3.4                 ; Add IP address as local domain
51                                 ; You can have several "domain" settings
52 ;allowexternalinvites=no        ; Disable INVITE and REFER to non-local domains
53                                 ; Default is yes
54 ;autodomain=yes                 ; Turn this on to have Asterisk add local host
55                                 ; name and local IP to domain list.
56 ;pedantic=yes                   ; Enable slow, pedantic checking for Pingtel
57                                 ; and multiline formatted headers for strict
58                                 ; SIP compatibility (defaults to "no")
59 ;tos=184                        ; Set IP QoS to either a keyword or numeric val
60 ;tos=lowdelay                   ; lowdelay,throughput,reliability,mincost,none
61 ;maxexpiry=3600                 ; Max length of incoming registration we allow
62 ;minexpiry=60                   ; Minimum length of registration (default 60)
63 ;defaultexpiry=120              ; Default length of incoming/outoing registration
64 ;notifymimetype=text/plain      ; Allow overriding of mime type in MWI NOTIFY
65 ;checkmwi=10                    ; Default time between mailbox checks for peers
66 ;vmexten=voicemail      ; dialplan extension to reach mailbox sets the 
67                                                 ; Message-Account in the MWI notify message 
68                                                 ; defaults to "asterisk"
69 ;videosupport=yes               ; Turn on support for SIP video
70 ;recordhistory=yes              ; Record SIP history by default 
71                                 ; (see sip history / sip no history)
72
73 ;disallow=all                   ; First disallow all codecs
74 ;allow=ulaw                     ; Allow codecs in order of preference
75 ;allow=ilbc                     ; 
76 ;musicclass=default             ; Sets the default music on hold class for all SIP calls
77                                 ; This may also be set for individual users/peers
78 ;language=en                    ; Default language setting for all users/peers
79                                 ; This may also be set for individual users/peers
80 ;relaxdtmf=yes                  ; Relax dtmf handling
81 ;rtptimeout=60                  ; Terminate call if 60 seconds of no RTP activity
82                                 ; when we're not on hold
83 ;rtpholdtimeout=300             ; Terminate call if 300 seconds of no RTP activity
84                                 ; when we're on hold (must be > rtptimeout)
85 ;trustrpid = no                 ; If Remote-Party-ID should be trusted
86 ;sendrpid = yes                 ; If Remote-Party-ID should be sent
87 ;progressinband=never           ; If we should generate in-band ringing always
88                                 ; use 'never' to never use in-band signalling, even in cases
89                                 ; where some buggy devices might not render it
90 ;useragent=Asterisk PBX         ; Allows you to change the user agent string
91 ;promiscredir = no              ; If yes, allows 302 or REDIR to non-local SIP address
92                                 ; Note that promiscredir when redirects are made to the
93                                 ; local system will cause loops since SIP is incapable
94                                 ; of performing a "hairpin" call.
95 ;usereqphone = no               ; If yes, ";user=phone" is added to uri that contains
96                                 ; a valid phone number
97 ;dtmfmode = rfc2833             ; Set default dtmfmode for sending DTMF. Default: rfc2833
98                                 ; Other options: 
99                                 ; info : SIP INFO messages
100                                 ; inband : Inband audio (requires 64 kbit codec -alaw, ulaw)
101                                 ; auto : Use rfc2833 if offered, inband otherwise
102
103 ;compactheaders = yes           ; send compact sip headers.
104 ;sipdebug = yes                 ; Turn on SIP debugging by default, from
105                                 ; the moment the channel loads this configuration
106 ;subscribecontext = default     ; Set a specific context for SUBSCRIBE requests
107                                 ; Useful to limit subscriptions to local extensions
108                                 ; Settable per peer/user also
109 ;notifyringing = yes            ; Notify subscriptions on RINGING state
110
111 ;
112 ; If regcontext is specified, Asterisk will dynamically create and destroy a
113 ; NoOp priority 1 extension for a given peer who registers or unregisters with
114 ; us.  The actual extension is the 'regexten' parameter of the registering
115 ; peer or its name if 'regexten' is not provided.  More than one regexten may
116 ; be supplied if they are separated by '&'.  Patterns may be used in regexten.
117 ;
118 ;regcontext=sipregistrations
119 ;
120 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
121 ; Format for the register statement is:
122 ;       register => user[:secret[:authuser]]@host[:port][/extension]
123 ;
124 ; If no extension is given, the 's' extension is used. The extension needs to
125 ; be defined in extensions.conf to be able to accept calls from this SIP proxy
126 ; (provider).
127 ;
128 ; host is either a host name defined in DNS or the name of a section defined
129 ; below.
130 ;
131 ; Examples:
132 ;
133 ;register => 1234:password@mysipprovider.com    
134 ;
135 ;     This will pass incoming calls to the 's' extension
136 ;
137 ;
138 ;register => 2345:password@sip_proxy/1234
139 ;
140 ;    Register 2345 at sip provider 'sip_proxy'.  Calls from this provider
141 ;    connect to local extension 1234 in extensions.conf, default context,
142 ;    unless you configure a [sip_proxy] section below, and configure a
143 ;    context.
144 ;    Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
145 ;    Tip 2: Use separate type=peer and type=user sections for SIP providers
146 ;           (instead of type=friend) if you have calls in both directions
147   
148 ;registertimeout=20             ; retry registration calls every 20 seconds (default)
149 ;registerattempts=10            ; Number of registration attempts before we give up
150                                 ; 0 = continue forever, hammering the other server until it 
151                                 ; accepts the registration
152                                 ; Default is 0 tries, continue forever
153 ;callevents=no                  ; generate manager events when sip ua performs events (e.g. hold)
154
155 ;----------------------------------------- NAT SUPPORT ------------------------
156 ; The externip, externhost and localnet settings are used if you use Asterisk
157 ; behind a NAT device to communicate with services on the outside.
158
159 ;externip = 200.201.202.203     ; Address that we're going to put in outbound SIP messages
160                                 ; if we're behind a NAT
161
162                                 ; The externip and localnet is used
163                                 ; when registering and communicating with other proxies
164                                 ; that we're registered with
165 ;externhost=foo.dyndns.net      ; Alternatively you can specify an 
166                                 ; external host, and Asterisk will 
167                                 ; perform DNS queries periodically.  Not
168                                 ; recommended for production 
169                                 ; environments!  Use externip instead
170 ;externrefresh=10               ; How often to refresh externhost if 
171                                 ; used
172                                 ; You may add multiple local networks.  A reasonable set of defaults
173                                 ; are:
174 ;localnet=192.168.0.0/255.255.0.0; All RFC 1918 addresses are local networks
175 ;localnet=10.0.0.0/255.0.0.0    ; Also RFC1918
176 ;localnet=172.16.0.0/12         ; Another RFC1918 with CIDR notation
177 ;localnet=169.254.0.0/255.255.0.0 ;Zero conf local network
178
179 ; The nat= setting is used when Asterisk is on a public IP, communicating with
180 ; devices hidden behind a NAT device (broadband router).  If you have one-way
181 ; audio problems, you usually have problems with your NAT configuration or your
182 ; firewall's support of SIP+RTP ports.  You configure Asterisk choice of RTP
183 ; ports for incoming audio in rtp.conf
184 ;
185 ;nat=no                         ; Global NAT settings  (Affects all peers and users)
186                                 ; yes = Always ignore info and assume NAT
187                                 ; no = Use NAT mode only according to RFC3581 
188                                 ; never = Never attempt NAT mode or RFC3581 support
189                                 ; route = Assume NAT, don't send rport 
190                                 ; (work around more UNIDEN bugs)
191
192 ;rtcachefriends=yes             ; Cache realtime friends by adding them to the internal list
193                                 ; just like friends added from the config file only on a
194                                 ; as-needed basis? (yes|no)
195
196 ;rtupdate=yes                   ; Send registry updates to database using realtime? (yes|no)
197                                 ; If set to yes, when a SIP UA registers successfully, the ip address,
198                                 ; the origination port, the registration period, and the username of
199                                 ; the UA will be set to database via realtime. If not present, defaults to 'yes'.
200
201 ;rtautoclear=yes                ; Auto-Expire friends created on the fly on the same schedule
202                                 ; as if it had just registered? (yes|no|<seconds>)
203                                 ; If set to yes, when the registration expires, the friend will vanish from
204                                 ; the configuration until requested again. If set to an integer,
205                                 ; friends expire within this number of seconds instead of the
206                                 ; registration interval.
207
208 ;ignoreregexpire=yes            ; Enabling this setting has two functions:
209                                 ;
210                                 ; For non-realtime peers, when their registration expires, the information
211                                 ; will _not_ be removed from memory or the Asterisk database; if you attempt
212                                 ; to place a call to the peer, the existing information will be used in spite
213                                 ; of it having expired
214                                 ;
215                                 ; For realtime peers, when the peer is retrieved from realtime storage,
216                                 ; the registration information will be used regardless of whether
217                                 ; it has expired or not; if it expires while the realtime peer is still in
218                                 ; memory (due to caching or other reasons), the information will not be
219                                 ; removed from realtime storage
220
221 ; Incoming INVITE and REFER messages can be matched against a list of 'allowed'
222 ; domains, each of which can direct the call to a specific context if desired.
223 ; By default, all domains are accepted and sent to the default context or the
224 ; context associated with the user/peer placing the call.
225 ; Domains can be specified using:
226 ; domain=<domain>[,<context>]
227 ; Examples:
228 ; domain=myasterisk.dom
229 ; domain=customer.com,customer-context
230 ;
231 ; In addition, all the 'default' domains associated with a server should be
232 ; added if incoming request filtering is desired.
233 ; autodomain=yes
234 ;
235 ; To disallow requests for domains not serviced by this server:
236 ; allowexternaldomains=no
237
238 ; fromdomain=mydomain.tld ; When making outbound SIP INVITEs to
239                           ; non-peers, use your primary domain "identity"
240                           ; for From: headers instead of just your IP
241                           ; address. This is to be polite and
242                           ; it may be a mandatory requirement for some
243                           ; destinations which do not have a prior
244                           ; account relationship with your server. 
245
246 [authentication]
247 ; Global credentials for outbound calls, i.e. when a proxy challenges your
248 ; Asterisk server for authentication. These credentials override
249 ; any credentials in peer/register definition if realm is matched.
250 ;
251 ; This way, Asterisk can authenticate for outbound calls to other
252 ; realms. We match realm on the proxy challenge and pick an set of 
253 ; credentials from this list
254 ; Syntax:
255 ;       auth = <user>:<secret>@<realm>
256 ;       auth = <user>#<md5secret>@<realm>
257 ; Example:
258 ;auth=mark:topsecret@digium.com
259
260 ; You may also add auth= statements to [peer] definitions 
261 ; Peer auth= override all other authentication settings if we match on realm
262
263 ;------------------------------------------------------------------------------
264 ; Users and peers have different settings available. Friends have all settings,
265 ; since a friend is both a peer and a user
266 ;
267 ; User config options:        Peer configuration:
268 ; --------------------        -------------------
269 ; context                     context
270 ; callingpres                 callingpres
271 ; permit                      permit
272 ; deny                        deny
273 ; secret                      secret
274 ; md5secret                   md5secret
275 ; dtmfmode                    dtmfmode
276 ; canreinvite                 canreinvite
277 ; nat                         nat
278 ; callgroup                   callgroup
279 ; pickupgroup                 pickupgroup
280 ; language                    language
281 ; allow                       allow
282 ; disallow                    disallow
283 ; insecure                    insecure
284 ; trustrpid                   trustrpid
285 ; progressinband              progressinband
286 ; promiscredir                promiscredir
287 ; useclientcode               useclientcode
288 ; accountcode                 accountcode
289 ; setvar                      setvar
290 ; callerid                    callerid
291 ; amaflags                    amaflags
292 ; call-limit                  call-limit
293 ; restrictcid                 restrictcid
294 ; subscribecontext            subscribecontext
295 ;                             mailbox
296 ;                             username
297 ;                             template
298 ;                             fromdomain
299 ;                             regexten
300 ;                             fromuser
301 ;                             host
302 ;                             port
303 ;                             qualify
304 ;                             defaultip
305 ;                             rtptimeout
306 ;                             rtpholdtimeout
307 ;                             sendrpid
308
309 ;[sip_proxy]
310 ; For incoming calls only. Example: FWD (Free World Dialup)
311 ; We match on IP address of the proxy for incoming calls 
312 ; since we can not match on username (caller id)
313 ;type=peer
314 ;context=from-fwd
315 ;host=fwd.pulver.com
316
317 ;[sip_proxy-out]
318 ;type=peer                      ; we only want to call out, not be called
319 ;secret=guessit
320 ;username=yourusername          ; Authentication user for outbound proxies
321 ;fromuser=yourusername          ; Many SIP providers require this!
322 ;fromdomain=provider.sip.domain 
323 ;host=box.provider.com
324 ;usereqphone=yes                ; This provider requires ";user=phone" on URI
325 ;call-limit=5                   ; permit only 5 simultaneous outgoing calls to this peer
326
327 ;------------------------------------------------------------------------------
328 ; Definitions of locally connected SIP phones
329 ;
330 ; type = user   a device that authenticates to us by "from" field to place calls
331 ; type = peer   a device we place calls to or that calls us and we match by host
332 ; type = friend two configurations (peer+user) in one
333 ;
334 ; For local phones, type=friend works most of the time
335 ;
336 ; If you have one-way audio, you propably have NAT problems. 
337 ; If Asterisk is on a public IP, and the phone is inside of a NAT device
338 ; you will need to configure nat option for those phones.
339 ; Also, turn on qualify=yes to keep the nat session open
340
341 ;[grandstream1]
342 ;type=friend                    
343 ;context=from-sip               ; Where to start in the dialplan when this phone calls
344 ;callerid=John Doe <1234>       ; Full caller ID, to override the phones config
345 ;host=192.168.0.23              ; we have a static but private IP address
346                                 ; No registration allowed
347 ;nat=no                         ; there is not NAT between phone and Asterisk
348 ;canreinvite=yes                ; allow RTP voice traffic to bypass Asterisk
349 ;dtmfmode=info                  ; either RFC2833 or INFO for the BudgeTone
350 ;call-limit=1                   ; permit only 1 outgoing call and 1 incoming call at a time
351                                 ; from the phone to asterisk
352                                 ; 1 for the explicit peer, 1 for the explicit user,
353                                 ; remember that a friend equals 1 peer and 1 user in
354                                 ; memory
355                                 ; This will affect your subscriptions as well.
356                                 ; There is no combined call counter for a "friend"
357                                 ; so there's currently no way in sip.conf to limit
358                                 ; to one inbound or outbound call per phone. Use
359                                 ; the group counters in the dial plan for that.
360                                 ;
361 ;mailbox=1234@default           ; mailbox 1234 in voicemail context "default"
362 ;disallow=all                   ; need to disallow=all before we can use allow=
363 ;allow=ulaw                     ; Note: In user sections the order of codecs
364                                 ; listed with allow= does NOT matter!
365 ;allow=alaw
366 ;allow=g723.1                   ; Asterisk only supports g723.1 pass-thru!
367 ;allow=g729                     ; Pass-thru only unless g729 license obtained
368 ;astdb=chan2ext/SIP/grandstream1=1234   ; ensures an astDB entry exists
369 ;callingpres=allowed_passed_screen      ; Set caller ID presentation
370                                 ; See README.callingpres for more information
371
372
373 ;[xlite1]
374 ; Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
375 ; Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
376 ;type=friend
377 ;regexten=1234                  ; When they register, create extension 1234
378 ;callerid="Jane Smith" <5678>
379 ;host=dynamic                   ; This device needs to register
380 ;nat=yes                        ; X-Lite is behind a NAT router
381 ;canreinvite=no                 ; Typically set to NO if behind NAT
382 ;disallow=all
383 ;allow=gsm                      ; GSM consumes far less bandwidth than ulaw
384 ;allow=ulaw
385 ;allow=alaw
386 ;mailbox=1234@default,1233@default      ; Subscribe to status of multiple mailboxes
387
388
389 ;[snom]
390 ;type=friend                    ; Friends place calls and receive calls
391 ;context=from-sip               ; Context for incoming calls from this user
392 ;secret=blah
393 ;subscribecontext=localextensions       ; Only allow SUBSCRIBE for local extensions
394 ;language=de                    ; Use German prompts for this user 
395 ;host=dynamic                   ; This peer register with us
396 ;dtmfmode=inband                ; Choices are inband, rfc2833, or info
397 ;defaultip=192.168.0.59         ; IP used until peer registers
398 ;mailbox=1234@context,2345      ; Mailbox(-es) for message waiting indicator
399 ;vmexten=voicemail      ; dialplan extension to reach mailbox 
400                         ; sets the Message-Account in the MWI notify message
401                         ; defaults to global vmexten which defaults to "asterisk"
402 ;restrictcid=yes                ; To have the callerid restriced -> sent as ANI
403 ;disallow=all
404 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
405
406
407 ;[polycom]
408 ;type=friend                    ; Friends place calls and receive calls
409 ;context=from-sip               ; Context for incoming calls from this user
410 ;secret=blahpoly
411 ;host=dynamic                   ; This peer register with us
412 ;dtmfmode=rfc2833               ; Choices are inband, rfc2833, or info
413 ;username=polly                 ; Username to use in INVITE until peer registers
414                                 ; Normally you do NOT need to set this parameter
415 ;disallow=all
416 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
417 ;progressinband=no              ; Polycom phones don't work properly with "never"
418
419
420 ;[pingtel]
421 ;type=friend
422 ;secret=blah
423 ;host=dynamic
424 ;insecure=port                  ; Allow matching of peer by IP address without matching port number
425 ;insecure=invite                ; Do not require authentication of incoming INVITEs
426 ;insecure=port,invite           ; (both)
427 ;qualify=1000                   ; Consider it down if it's 1 second to reply
428                                 ; Helps with NAT session
429                                 ; qualify=yes uses default value
430 ;callgroup=1,3-4                ; We are in caller groups 1,3,4
431 ;pickupgroup=1,3-5              ; We can do call pick-p for call group 1,3,4,5
432 ;defaultip=192.168.0.60         ; IP address to use if peer has not registred
433
434 ;[cisco1]
435 ;type=friend
436 ;secret=blah
437 ;qualify=200                    ; Qualify peer is no more than 200ms away
438 ;nat=yes                        ; This phone may be natted
439                                 ; Send SIP and RTP to the IP address that packet is 
440                                 ; received from instead of trusting SIP headers 
441 ;host=dynamic                   ; This device registers with us
442 ;canreinvite=no                 ; Asterisk by default tries to redirect the
443                                 ; RTP media stream (audio) to go directly from
444                                 ; the caller to the callee.  Some devices do not
445                                 ; support this (especially if one of them is 
446                                 ; behind a NAT).
447 ;defaultip=192.168.0.4          ; IP address to use until registration
448 ;username=goran                 ; Username to use when calling this device before registration
449                                 ; Normally you do NOT need to set this parameter
450 ;setvar=CUSTID=5678             ; Channel variable to be set for all calls from this device
451