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