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