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