a70eeedc4c668e948f2601840cacd70e0ecf4d11
[asterisk/asterisk.git] / configs / sip.conf.sample
1 ;
2 ; SIP Configuration 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
23 [general]
24 context=default                 ; Default context for incoming calls
25 ;allowguest=no                  ; Allow or reject guest calls (default is yes, this can also be set to 'osp'
26                                 ; if asterisk was compiled with OSP support.
27 ;recordhistory=yes              ; Record SIP history by default 
28                                 ; (see sip history / sip no history)
29 ;realm=mydomain.tld             ; Realm for digest authentication
30                                 ; defaults to "asterisk"
31                                 ; Realms MUST be globally unique according to RFC 3261
32                                 ; Set this to your host name or domain name
33 port=5060                       ; UDP Port to bind to (SIP standard port is 5060)
34 bindaddr=0.0.0.0                ; IP address to bind to (0.0.0.0 binds to all)
35 srvlookup=yes                   ; Enable DNS SRV lookups on outbound calls
36                                 ; Note: Asterisk only uses the first host 
37                                 ; in SRV records
38                                 ; Disabling DNS SRV lookups disables the 
39                                 ; ability to place SIP calls based on domain 
40                                 ; names to some other SIP users on the Internet
41                                 
42 ;pedantic=yes                   ; Enable slow, pedantic checking for Pingtel
43                                 ; and multiline formatted headers for strict
44                                 ; SIP compatibility (defaults to "no")
45 ;tos=184                        ; Set IP QoS to either a keyword or numeric val
46 ;tos=lowdelay                   ; lowdelay,throughput,reliability,mincost,none
47 ;maxexpirey=3600                ; Max length of incoming registration we allow
48 ;defaultexpirey=120             ; Default length of incoming/outoing registration
49 ;notifymimetype=text/plain      ; Allow overriding of mime type in MWI NOTIFY
50 ;checkmwi=10                    ; Default time between mailbox checks for peers
51 ;videosupport=yes               ; Turn on support for SIP video
52
53 ;disallow=all                   ; First disallow all codecs
54 ;allow=ulaw                     ; Allow codecs in order of preference
55 ;allow=ilbc                     ; Note: codec order is respected only in [general]
56 ;musicclass=default             ; Sets the default music on hold class for all SIP calls
57                                 ; This may also be set for individual users/peers
58 ;language=en                    ; Default language setting for all users/peers
59                                 ; This may also be set for individual users/peers
60 ;relaxdtmf=yes                  ; Relax dtmf handling
61 ;rtptimeout=60                  ; Terminate call if 60 seconds of no RTP activity
62                                 ; when we're not on hold
63 ;rtpholdtimeout=300             ; Terminate call if 300 seconds of no RTP activity
64                                 ; when we're on hold (must be > rtptimeout)
65 ;trustrpid = no                 ; If Remote-Party-ID should be trusted
66 ;progressinband=never           ; If we should generate in-band ringing always
67                                 ; use 'never' to never use in-band signalling, even in cases
68                                 ; where some buggy devices might not render it
69 ;useragent=Asterisk PBX         ; Allows you to change the user agent string
70 ;nat=no                         ; NAT settings 
71                                 ; yes = Always ignore info and assume NAT
72                                 ; no = Use NAT mode only according to RFC3581 
73                                 ; never = Never attempt NAT mode or RFC3581 support
74                                 ; route = Assume NAT, don't send rport 
75                                 ; (work around more UNIDEN bugs)
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 ;usereqphone = no               ; If yes, ";user=phone" is added to uri that contains
80                                 ; a valid phone number
81                                 ; of performing a "hairpin" call.
82 ;dtmfmode = rfc2833             ; Set default dtmfmode for sending DTMF. Default: rfc2833
83                                 ; Other options: 
84                                 ; info : SIP INFO messages
85                                 ; inband : Inband audio
86
87 ;compactheaders = yes           ; send compact sip headers.
88
89 ;
90 ; If regcontext is specified, Asterisk will dynamically 
91 ; create and destroy a NoOp priority 1 extension for a given
92 ; peer who registers or unregisters with us.  The actual extension
93 ; is the 'regexten' parameter of the registering peer or its
94 ; name if 'regexten' is not provided.  More than one regexten may be supplied
95 ; if they are separated by '&'.  Patterns may be used in regexten.
96 ;
97 ;regcontext=sipregistrations
98 ;
99 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
100 ; Format for the register statement is:
101 ;       register => user[:secret[:authuser]]@host[:port][/extension]
102 ;
103 ; If no extension is given, the 's' extension is used. The extension
104 ; needs to be defined in extensions.conf to be able to accept calls
105 ; from this SIP proxy (provider)
106 ;
107 ; host is either a host name defined in DNS or the name of a 
108 ; section defined below.
109 ;
110 ; Examples:
111 ;
112 ;register => 1234:password@mysipprovider.com    
113 ;
114 ;     This will pass incoming calls to the 's' extension
115 ;
116 ;
117 ;register => 2345:password@sip_proxy/1234
118 ;
119 ;    Register 2345 at sip provider 'sip_proxy'.  Calls from this provider connect to local 
120 ;    extension 1234 in extensions.conf default context, unless you define 
121 ;    unless you configure a [sip_proxy] section below, and configure a context.
122 ;        Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
123 ;        Tip 2: Use separate type=peer and type=user sections for SIP providers
124 ;                      (instead of type=friend) if you have calls in both directions
125   
126 ;registertimeout=20             ; retry registration calls every 20 seconds (default)
127
128 ;externip = 200.201.202.203     ; Address that we're going to put in outbound SIP messages
129                                 ; if we're behind a NAT
130
131                                 ; The externip and localnet is used
132                                 ; when registering and communicating with other proxies
133                                 ; that we're registered with
134                                 ; You may add multiple local networks.  A reasonable set of defaults
135                                 ; are:
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                                 ; usedl
143 ;localnet=192.168.0.0/255.255.0.0; All RFC 1918 addresses are local networks
144 ;localnet=10.0.0.0/255.0.0.0    ; Also RFC1918
145 ;localnet=172.16.0.0/12         ; Another RFC1918 with CIDR notation
146 ;localnet=169.254.0.0/255.255.0.0 ;Zero conf local network
147
148 ;-----------------------------------------------------------------------------------
149 ; Users and peers have different settings available. Friends have all settings,
150 ; since a friend is both a peer and a user
151 ;
152 ; User config options:        Peer configuration:
153 ; --------------------        -------------------
154 ; context                     context
155 ; permit                      permit
156 ; deny                        deny
157 ; secret                      secret
158 ; md5secret                   md5secret
159 ; dtmfmode                    dtmfmode
160 ; canreinvite                 canreinvite
161 ; nat                         nat
162 ; callgroup                   callgroup
163 ; pickupgroup                 pickupgroup
164 ; language                    language
165 ; allow                       allow
166 ; disallow                    disallow
167 ; insecure                    insecure
168 ; trustrpid                   trustrpid
169 ; progressinband              progressinband
170 ; promiscredir                promiscredir
171 ; useclientcode               useclientcode
172 ; setvar
173 ; callerid
174 ; accountcode
175 ; amaflags
176 ; incominglimit
177 ; restrictcid
178 ;                             mailbox
179 ;                             username
180 ;                             template
181 ;                             fromdomain
182 ;                             regexten
183 ;                             fromuser
184 ;                             host
185 ;                             mask
186 ;                             port
187 ;                             qualify
188 ;                             defaultip
189 ;                             rtptimeout
190 ;                             rtpholdtimeout
191
192 ;[sip_proxy]
193 ; For incoming calls only. Example: FWD (Free World Dialup)
194 ;type=user
195 ;context=from-fwd
196
197 ;[sip_proxy-out]
198 ;type=peer                      ; we only want to call out, not be called
199 ;secret=guessit
200 ;username=yourusername          ; Authentication user for outbound proxies
201 ;fromuser=yourusername          ; Many SIP providers require this!
202 ;host=box.provider.com
203 ;usereqphone=yes                ; This provider requires ";user=phone" on URI
204
205 ;[grandstream1]
206 ;type=friend                    ; either "friend" (peer+user), "peer" or "user"
207 ;context=from-sip
208 ;fromuser=grandstream1          ; overrides the callerid, e.g. required by FWD
209 ;callerid=John Doe <1234>
210 ;host=192.168.0.23              ; we have a static but private IP address
211 ;nat=no                         ; there is not NAT between phone and Asterisk
212 ;canreinvite=yes                ; allow RTP voice traffic to bypass Asterisk
213 ;dtmfmode=info                  ; either RFC2833 or INFO for the BudgeTone
214 ;incominglimit=1                ; permit only 1 outgoing call at a time
215                                 ; from the phone to asterisk
216 ;mailbox=1234@default  ; mailbox 1234 in voicemail context "default"
217 ;disallow=all                   ; need to disallow=all before we can use allow=
218 ;allow=ulaw                     ; Note: In user sections the order of codecs
219                                 ; listed with allow= does NOT matter!
220 ;allow=alaw
221 ;allow=g723.1                   ; Asterisk only supports g723.1 pass-thru!
222 ;allow=g729                     ; Pass-thru only unless g729 license obtained
223
224
225 ;[xlite1]
226 ;Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
227 ;Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
228 ;type=friend
229 ;regexten=1234                 ; When they register, create extension 1234
230 ;username=xlite1
231 ;callerid="Jane Smith" <5678>
232 ;host=dynamic
233 ;nat=yes                       ; X-Lite is behind a NAT router
234 ;canreinvite=no                ; Typically set to NO if behind NAT
235 ;disallow=all
236 ;allow=gsm                     ; GSM consumes far less bandwidth than ulaw
237 ;allow=ulaw
238 ;allow=alaw
239
240
241 ;[snom]
242 ;type=friend                    ; Friends place calls and receive calls
243 ;context=from-sip               ; Context for incoming calls from this user
244 ;secret=blah
245 ;language=de                    ; Use German prompts for this user 
246 ;host=dynamic                   ; This peer register with us
247 ;dtmfmode=inband                ; Choices are inband, rfc2833, or info
248 ;defaultip=192.168.0.59         ; IP used until peer registers
249 ;username=snom                  ; Username to use in INVITE until peer registers
250 ;mailbox=1234,2345              ; Mailboxes for message waiting indicator
251 ;restrictcid=yes                ; To have the callerid restriced -> sent as ANI
252 ;disallow=all
253 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
254 ;mailbox=1234@context,2345      ; Mailbox(-es) for message waiting indicator
255
256
257 ;[polycom]
258 ;type=friend                    ; Friends place calls and receive calls
259 ;context=from-sip               ; Context for incoming calls from this user
260 ;secret=blahpoly
261 ;host=dynamic                   ; This peer register with us
262 ;dtmfmode=rfc2833               ; Choices are inband, rfc2833, or info
263 ;username=polly                 ; Username to use in INVITE until peer registers
264 ;disallow=all
265 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
266 ;progressinband=no              ; Polycom phones don't work properly with "never"
267
268
269 ;[pingtel]
270 ;type=friend
271 ;username=pingtel
272 ;secret=blah
273 ;host=dynamic
274 ;insecure=yes                   ; To match a peer based by IP address only and not peer
275 ;insecure=very                  ; To allow registered hosts to call without re-authenticating
276 ;qualify=1000                   ; Consider it down if it's 1 second to reply
277                                 ; Helps with NAT session
278                                 ; qualify=yes uses default value
279 ;callgroup=1,3-4                ; We are in caller groups 1,3,4
280 ;pickupgroup=1,3-5              ; We can do call pick-p for call group 1,3,4,5
281 ;defaultip=192.168.0.60         ; IP address to use if peer has not registred
282
283 ;[cisco1]
284 ;type=friend
285 ;username=cisco1
286 ;secret=blah
287 ;qualify=200                    ; Qualify peer is no more than 200ms away
288 ;nat=yes                        ; This phone may be natted
289                                 ; Send SIP and RTP to  IP address that packet is 
290                                 ; received from instead of trusting SIP headers 
291 ;host=dynamic                   ; This device registers with us
292 ;canreinvite=no                 ; Asterisk by default tries to redirect the
293                                 ; RTP media stream (audio) to go directly from
294                                 ; the caller to the callee.  Some devices do not
295                                 ; support this (especially if one of them is 
296                                 ; behind a NAT).
297 ;defaultip=192.168.0.4
298
299 ;[cisco2]
300 ;type=friend
301 ;username=cisco2
302 ;fromuser=markster              ; Specify user to put in "from" instead of callerid
303 ;fromdomain=yourdomain.com      ; Specify domain to put in "from" instead of callerid
304                                 ; fromuser and fromdomain are used when Asterisk
305                                 ; places calls to this account.  It is not used for
306                                 ; calls from this account.
307 ;secret=blah
308 ;host=dynamic
309 ;defaultip=192.168.0.4
310 ;amaflags=default               ; Choices are default, omit, billing, documentation
311 ;accountcode=markster           ; Users may be associated with an accountcode to ease billing