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