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