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