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