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