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