To satisfy some legal concerns, add an option for chan_sip to include a
[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 list peers              Show all SIP peers (including friends)
17 ;   sip list users              Show all SIP users (including friends)
18 ;   sip list registry           Show status of hosts we register with
19 ;
20 ;   sip debug                   Show all SIP messages
21 ;
22 ;   sip reload                  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)
29 ;match_auth_username=yes        ; if available, match user entry using the
30                                 ; 'username' field from the authentication line
31                                 ; instead of the From: field.
32                                 
33 allowoverlap=no                 ; Disable overlap dialing support. (Default is yes)
34 ;allowtransfer=no               ; Disable all transfers (unless enabled in peers or users)
35                                 ; Default is enabled
36 ;realm=mydomain.tld             ; Realm for digest authentication
37                                 ; defaults to "asterisk". If you set a system name in
38                                 ; asterisk.conf, it defaults to that system name
39                                 ; Realms MUST be globally unique according to RFC 3261
40                                 ; Set this to your host name or domain name
41 bindport=5060                   ; UDP Port to bind to (SIP standard port is 5060)
42                                 ; bindport is the local UDP port that Asterisk will listen on
43 bindaddr=0.0.0.0                ; IP address to bind to (0.0.0.0 binds to all)
44 srvlookup=yes                   ; Enable DNS SRV lookups on outbound calls
45                                 ; Note: Asterisk only uses the first host 
46                                 ; in SRV records
47                                 ; Disabling DNS SRV lookups disables the 
48                                 ; ability to place SIP calls based on domain 
49                                 ; names to some other SIP users on the Internet
50                                 
51 ;domain=mydomain.tld            ; Set default domain for this host
52                                 ; If configured, Asterisk will only allow
53                                 ; INVITE and REFER to non-local domains
54                                 ; Use "sip show domains" to list local domains
55 ;pedantic=yes                   ; Enable checking of tags in headers, 
56                                 ; international character conversions in URIs
57                                 ; and multiline formatted headers for strict
58                                 ; SIP compatibility (defaults to "no")
59
60 ; See doc/qos.tex for a description of these parameters.
61 ;tos_sip=cs3                    ; Sets TOS for SIP packets.
62 ;tos_audio=ef                   ; Sets TOS for RTP audio packets.
63 ;tos_video=af41                 ; Sets TOS for RTP video packets.
64 ;tos_text=af41                  ; Sets TOS for RTP text packets.
65
66 ;cos_sip=4                      ; Sets CoS for SIP packets.
67 ;cos_audio=6                    ; Sets CoS for RTP audio packets.
68 ;cos_video=5                    ; Sets CoS for RTP video packets.
69 ;cos_text=0                     ; Sets CoS for RTP text packets.
70
71 ;maxexpiry=3600                 ; Maximum allowed time of incoming registrations
72                                 ; and subscriptions (seconds)
73 ;minexpiry=60                   ; Minimum length of registrations/subscriptions (default 60)
74 ;defaultexpiry=120              ; Default length of incoming/outgoing registration
75 ;t1min=100                      ; Minimum roundtrip time for messages to monitored hosts
76                                 ; Defaults to 100 ms
77 ;notifymimetype=text/plain      ; Allow overriding of mime type in MWI NOTIFY
78 ;buggymwi=no                    ; Cisco SIP firmware doesn't support the MWI RFC
79                                 ; fully. Enable this option to not get error messages
80                                 ; when sending MWI to phones with this bug.
81 ;vmexten=voicemail              ; dialplan extension to reach mailbox sets the 
82                                 ; Message-Account in the MWI notify message 
83                                 ; defaults to "asterisk"
84 ;disallow=all                   ; First disallow all codecs
85 ;allow=ulaw                     ; Allow codecs in order of preference
86 ;allow=ilbc                     ; see doc/rtp-packetization for framing options
87 ;
88 ; This option specifies a preference for which music on hold class this channel
89 ; should listen to when put on hold if the music class has not been set on the
90 ; channel with Set(CHANNEL(musicclass)=whatever) in the dialplan, and the peer
91 ; channel putting this one on hold did not suggest a music class.
92 ;
93 ; This option may be specified globally, or on a per-user or per-peer basis.
94 ;
95 ;mohinterpret=default
96 ;
97 ; This option specifies which music on hold class to suggest to the peer channel
98 ; when this channel places the peer on hold. It may be specified globally or on
99 ; a per-user or per-peer basis.
100 ;
101 ;mohsuggest=default
102 ;
103 ;language=en                    ; Default language setting for all users/peers
104                                 ; This may also be set for individual users/peers
105 ;relaxdtmf=yes                  ; Relax dtmf handling
106 ;trustrpid = no                 ; If Remote-Party-ID should be trusted
107 ;sendrpid = yes                 ; If Remote-Party-ID should be sent
108 ;progressinband=never           ; If we should generate in-band ringing always
109                                 ; use 'never' to never use in-band signalling, even in cases
110                                 ; where some buggy devices might not render it
111                                 ; Valid values: yes, no, never Default: never
112 ;useragent=Asterisk PBX         ; Allows you to change the user agent string
113                                 ; The default user agent string also contains the Asterisk
114                                 ; version. If you don't want to expose this, change the
115                                 ; useragent string.
116 ;promiscredir = no              ; If yes, allows 302 or REDIR to non-local SIP address
117                                 ; Note that promiscredir when redirects are made to the
118                                 ; local system will cause loops since Asterisk is incapable
119                                 ; of performing a "hairpin" call.
120 ;usereqphone = no               ; If yes, ";user=phone" is added to uri that contains
121                                 ; a valid phone number
122 ;dtmfmode = rfc2833             ; Set default dtmfmode for sending DTMF. Default: rfc2833
123                                 ; Other options: 
124                                 ; info : SIP INFO messages
125                                 ; inband : Inband audio (requires 64 kbit codec -alaw, ulaw)
126                                 ; auto : Use rfc2833 if offered, inband otherwise
127
128 ;compactheaders = yes           ; send compact sip headers.
129 ;
130 ;videosupport=yes               ; Turn on support for SIP video. You need to turn this on
131                                 ; in the this section to get any video support at all.
132                                 ; You can turn it off on a per peer basis if the general
133                                 ; video support is enabled, but you can't enable it for
134                                 ; one peer only without enabling in the general section.
135 ;maxcallbitrate=384             ; Maximum bitrate for video calls (default 384 kb/s)
136                                 ; Videosupport and maxcallbitrate is settable
137                                 ; for peers and users as well
138 ;callevents=no                  ; generate manager events when sip ua 
139                                 ; performs events (e.g. hold)
140 ;limitonpeers=no                ; Apply all call limits ("limit=") only to peers, never
141                                 ; to users. This improves handling of call limits
142                                 ; and device states in certain situations. The user part
143                                 ; of a type=friend will still be affected by the call
144                                 ; limit, but Asterisk will only use one object for
145                                 ; counting the simultaneous calls.
146 ;alwaysauthreject = yes         ; When an incoming INVITE or REGISTER is to be rejected,
147                                 ; for any reason, always reject with '401 Unauthorized'
148                                 ; instead of letting the requester know whether there was
149                                 ; a matching user or peer for their request
150
151 ;g726nonstandard = yes          ; If the peer negotiates G726-32 audio, use AAL2 packing
152                                 ; order instead of RFC3551 packing order (this is required
153                                 ; for Sipura and Grandstream ATAs, among others). This is
154                                 ; contrary to the RFC3551 specification, the peer _should_
155                                 ; be negotiating AAL2-G726-32 instead :-(
156 ;outboundproxy=proxy.provider.domain           ; send outbound signaling to this proxy, not directly to the devices
157 ;outboundproxy=proxy.provider.domain:8080       ; send outbound signaling to this proxy, not directly to the devices
158 ;outboundproxy=proxy.provider.domain,force      ; Send ALL outbound signalling to proxy, ignoring route: headers
159 ;matchexterniplocally = yes     ; Only substitute the externip or externhost setting if it matches
160                                 ; your localnet setting. Unless you have some sort of strange network
161                                 ; setup you will not need to enable this.
162
163 ;
164 ; If regcontext is specified, Asterisk will dynamically create and destroy a
165 ; NoOp priority 1 extension for a given peer who registers or unregisters with
166 ; us and have a "regexten=" configuration item.  
167 ; Multiple contexts may be specified by separating them with '&'. The 
168 ; actual extension is the 'regexten' parameter of the registering peer or its
169 ; name if 'regexten' is not provided.  If more than one context is provided,
170 ; the context must be specified within regexten by appending the desired
171 ; context after '@'.  More than one regexten may be supplied if they are 
172 ; separated by '&'.  Patterns may be used in regexten.
173 ;
174 ;regcontext=sipregistrations
175 ;regextenonqualify=yes          ; Default "no"
176                                 ; If you have qualify on and the peer becomes unreachable
177                                 ; this setting will enforce inactivation of the regexten
178                                 ; extension for the peer
179 ;
180 ;--------------------------- RTP timers ----------------------------------------------------
181 ; These timers are currently used for both audio and video streams. The RTP timeouts
182 ; are only applied to the audio channel.
183 ; The settings are settable in the global section as well as per device
184 ;
185 ;rtptimeout=60                  ; Terminate call if 60 seconds of no RTP or RTCP activity
186                                 ; on the audio channel
187                                 ; when we're not on hold. This is to be able to hangup
188                                 ; a call in the case of a phone disappearing from the net,
189                                 ; like a powerloss or grandma tripping over a cable.
190 ;rtpholdtimeout=300             ; Terminate call if 300 seconds of no RTP or RTCP activity
191                                 ; on the audio channel
192                                 ; when we're on hold (must be > rtptimeout)
193 ;rtpkeepalive=<secs>            ; Send keepalives in the RTP stream to keep NAT open
194                                 ; (default is off - zero)
195 ;--------------------------- SIP DEBUGGING ---------------------------------------------------
196 ;sipdebug = yes                 ; Turn on SIP debugging by default, from
197                                 ; the moment the channel loads this configuration
198 ;recordhistory=yes              ; Record SIP history by default 
199                                 ; (see sip history / sip no history)
200 ;dumphistory=yes                ; Dump SIP history at end of SIP dialogue
201                                 ; SIP history is output to the DEBUG logging channel
202
203
204 ;--------------------------- STATUS NOTIFICATIONS (SUBSCRIPTIONS) ----------------------------
205 ; You can subscribe to the status of extensions with a "hint" priority
206 ; (See extensions.conf.sample for examples)
207 ; chan_sip support two major formats for notifications: dialog-info and SIMPLE 
208 ;
209 ; You will get more detailed reports (busy etc) if you have a call limit set
210 ; for a device. When the call limit is filled, we will indicate busy. Note that
211 ; you need at least 2 in order to be able to do attended transfers.
212 ;
213 ; If you set the busy-level in addition to the call limit, we will indicate busy
214 ; when we have a number of calls that matches busy-level, but still allow calls
215 ; up to the call-limit. This allows for transfers while still having blinking
216 ; lamps and queues understanding that a device is busy.
217 ;
218 ; For queues, you will need this level of detail in status reporting, regardless
219 ; if you use SIP subscriptions. Queues and manager use the same internal interface
220 ; for reading status information.
221 ;
222 ; Note: Subscriptions does not work if you have a realtime dialplan and use the
223 ; realtime switch.
224 ;
225 ;allowsubscribe=no              ; Disable support for subscriptions. (Default is yes)
226 ;subscribecontext = default     ; Set a specific context for SUBSCRIBE requests
227                                 ; Useful to limit subscriptions to local extensions
228                                 ; Settable per peer/user also
229 ;notifyringing = yes            ; Notify subscriptions on RINGING state (default: no)
230 ;notifyhold = yes               ; Notify subscriptions on HOLD state (default: no)
231                                 ; Turning on notifyringing and notifyhold will add a lot
232                                 ; more database transactions if you are using realtime.
233 ;limitonpeer = yes              ; Apply call limits on peers only. This will improve 
234                                 ; status notification when you are using type=friend
235                                 ; Inbound calls, that really apply to the user part
236                                 ; of a friend will now be added to and compared with
237                                 ; the peer limit instead of applying two call limits,
238                                 ; one for the peer and one for the user.
239
240 ;----------------------------------------- T.38 FAX PASSTHROUGH SUPPORT -----------------------
241 ;
242 ; This setting is available in the [general] section as well as in device configurations.
243 ; Setting this to yes, enables T.38 fax (UDPTL) passthrough on SIP to SIP calls, provided
244 ; both parties have T38 support enabled in their Asterisk configuration 
245 ; This has to be enabled in the general section for all devices to work. You can then
246 ; disable it on a per device basis. 
247 ;
248 ; T.38 faxing only works in SIP to SIP calls, with no local or agent channel being used.
249 ;
250 ; t38pt_udptl = yes            ; Default false
251 ;
252 ;----------------------------------------- OUTBOUND SIP REGISTRATIONS  ------------------------
253 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
254 ; Format for the register statement is:
255 ;       register => user[:secret[:authuser]]@host[:port][/extension]
256 ;
257 ; If no extension is given, the 's' extension is used. The extension needs to
258 ; be defined in extensions.conf to be able to accept calls from this SIP proxy
259 ; (provider).
260 ;
261 ; host is either a host name defined in DNS or the name of a section defined
262 ; below.
263 ;
264 ; A similar effect can be achieved by adding a "callbackextension" option in a peer section.
265 ; this is equivalent to having the following line in the general section:
266 ;
267 ;       register => username:secret@host/callbackextension
268 ;
269 ; and more readable because you don't have to write the parameters in two places
270 ; (note that the "port" is ignored - this is a bug that should be fixed).
271 ;
272 ; Examples:
273 ;
274 ;register => 1234:password@mysipprovider.com    
275 ;
276 ;     This will pass incoming calls to the 's' extension
277 ;
278 ;
279 ;register => 2345:password@sip_proxy/1234
280 ;
281 ;    Register 2345 at sip provider 'sip_proxy'.  Calls from this provider
282 ;    connect to local extension 1234 in extensions.conf, default context,
283 ;    unless you configure a [sip_proxy] section below, and configure a
284 ;    context.
285 ;    Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
286 ;    Tip 2: Use separate type=peer and type=user sections for SIP providers
287 ;           (instead of type=friend) if you have calls in both directions
288   
289 ;registertimeout=20             ; retry registration calls every 20 seconds (default)
290 ;registerattempts=10            ; Number of registration attempts before we give up
291                                 ; 0 = continue forever, hammering the other server
292                                 ; until it accepts the registration
293                                 ; Default is 0 tries, continue forever
294
295 ;----------------------------------------- NAT SUPPORT ------------------------
296 ; The externip, externhost and localnet settings are used if you use Asterisk
297 ; behind a NAT device to communicate with services on the outside.
298
299 ;externip = 200.201.202.203     ; Address that we're going to put in outbound SIP
300                                 ; messages if we're behind a NAT
301
302                                 ; The externip and localnet is used
303                                 ; when registering and communicating with other proxies
304                                 ; that we're registered with
305 ;externhost=foo.dyndns.net      ; Alternatively you can specify an 
306                                 ; external host, and Asterisk will 
307                                 ; perform DNS queries periodically.  Not
308                                 ; recommended for production 
309                                 ; environments!  Use externip instead
310 ;externrefresh=10               ; How often to refresh externhost if 
311                                 ; used
312                                 ; You may add multiple local networks.  A reasonable 
313                                 ; set of defaults are:
314 ;localnet=192.168.0.0/255.255.0.0; All RFC 1918 addresses are local networks
315 ;localnet=10.0.0.0/255.0.0.0    ; Also RFC1918
316 ;localnet=172.16.0.0/12         ; Another RFC1918 with CIDR notation
317 ;localnet=169.254.0.0/255.255.0.0 ;Zero conf local network
318
319 ; The nat= setting is used when Asterisk is on a public IP, communicating with
320 ; devices hidden behind a NAT device (broadband router).  If you have one-way
321 ; audio problems, you usually have problems with your NAT configuration or your
322 ; firewall's support of SIP+RTP ports.  You configure Asterisk choice of RTP
323 ; ports for incoming audio in rtp.conf
324 ;
325 ;nat=no                         ; Global NAT settings  (Affects all peers and users)
326                                 ; yes = Always ignore info and assume NAT
327                                 ; no = Use NAT mode only according to RFC3581 (;rport)
328                                 ; never = Never attempt NAT mode or RFC3581 support
329                                 ; route = Assume NAT, don't send rport 
330                                 ; (work around more UNIDEN bugs)
331
332 ;----------------------------------- MEDIA HANDLING --------------------------------
333 ; By default, Asterisk tries to re-invite the audio to an optimal path. If there's
334 ; no reason for Asterisk to stay in the media path, the media will be redirected.
335 ; This does not really work with in the case where Asterisk is outside and have
336 ; clients on the inside of a NAT. In that case, you want to set canreinvite=nonat
337 ;
338 ;canreinvite=yes                ; Asterisk by default tries to redirect the
339                                 ; RTP media stream (audio) to go directly from
340                                 ; the caller to the callee.  Some devices do not
341                                 ; support this (especially if one of them is behind a NAT).
342                                 ; The default setting is YES. If you have all clients
343                                 ; behind a NAT, or for some other reason wants Asterisk to
344                                 ; stay in the audio path, you may want to turn this off.
345
346                                 ; This setting also affect direct RTP
347                                 ; at call setup (a new feature in 1.4 - setting up the
348                                 ; call directly between the endpoints instead of sending
349                                 ; a re-INVITE).
350
351 ;directrtpsetup=yes             ; Enable the new experimental direct RTP setup. This sets up
352                                 ; the call directly with media peer-2-peer without re-invites.
353                                 ; Will not work for video and cases where the callee sends 
354                                 ; RTP payloads and fmtp headers in the 200 OK that does not match the
355                                 ; callers INVITE.
356
357 ;canreinvite=nonat              ; An additional option is to allow media path redirection
358                                 ; (reinvite) but only when the peer where the media is being
359                                 ; sent is known to not be behind a NAT (as the RTP core can
360                                 ; determine it based on the apparent IP address the media
361                                 ; arrives from).
362
363 ;canreinvite=update             ; Yet a third option... use UPDATE for media path redirection,
364                                 ; instead of INVITE. This can be combined with 'nonat', as
365                                 ; 'canreinvite=update,nonat'. It implies 'yes'.
366
367 ;----------------------------------------- REALTIME SUPPORT ------------------------
368 ; For additional information on ARA, the Asterisk Realtime Architecture,
369 ; please read realtime.txt and extconfig.txt in the /doc directory of the
370 ; source code.
371 ;
372 ;rtcachefriends=yes             ; Cache realtime friends by adding them to the internal list
373                                 ; just like friends added from the config file only on a
374                                 ; as-needed basis? (yes|no)
375
376 ;rtsavesysname=yes              ; Save systemname in realtime database at registration
377                                 ; Default= no
378
379 ;rtupdate=yes                   ; Send registry updates to database using realtime? (yes|no)
380                                 ; If set to yes, when a SIP UA registers successfully, the ip address,
381                                 ; the origination port, the registration period, and the username of
382                                 ; the UA will be set to database via realtime. 
383                                 ; If not present, defaults to 'yes'.
384 ;rtautoclear=yes                ; Auto-Expire friends created on the fly on the same schedule
385                                 ; as if it had just registered? (yes|no|<seconds>)
386                                 ; If set to yes, when the registration expires, the friend will
387                                 ; vanish from the configuration until requested again. If set
388                                 ; to an integer, friends expire within this number of seconds
389                                 ; instead of the registration interval.
390
391 ;ignoreregexpire=yes            ; Enabling this setting has two functions:
392                                 ;
393                                 ; For non-realtime peers, when their registration expires, the
394                                 ; information will _not_ be removed from memory or the Asterisk database
395                                 ; if you attempt to place a call to the peer, the existing information
396                                 ; will be used in spite of it having expired
397                                 ;
398                                 ; For realtime peers, when the peer is retrieved from realtime storage,
399                                 ; the registration information will be used regardless of whether
400                                 ; it has expired or not; if it expires while the realtime peer 
401                                 ; is still in memory (due to caching or other reasons), the 
402                                 ; information will not be removed from realtime storage
403
404 ;----------------------------------------- SIP DOMAIN SUPPORT ------------------------
405 ; Incoming INVITE and REFER messages can be matched against a list of 'allowed'
406 ; domains, each of which can direct the call to a specific context if desired.
407 ; By default, all domains are accepted and sent to the default context or the
408 ; context associated with the user/peer placing the call.
409 ; Domains can be specified using:
410 ; domain=<domain>[,<context>]
411 ; Examples:
412 ; domain=myasterisk.dom
413 ; domain=customer.com,customer-context
414 ;
415 ; In addition, all the 'default' domains associated with a server should be
416 ; added if incoming request filtering is desired.
417 ; autodomain=yes
418 ;
419 ; To disallow requests for domains not serviced by this server:
420 ; allowexternaldomains=no
421
422 ;domain=mydomain.tld,mydomain-incoming
423                                 ; Add domain and configure incoming context
424                                 ; for external calls to this domain
425 ;domain=1.2.3.4                 ; Add IP address as local domain
426                                 ; You can have several "domain" settings
427 ;allowexternalinvites=no        ; Disable INVITE and REFER to non-local domains
428                                 ; Default is yes
429 ;autodomain=yes                 ; Turn this on to have Asterisk add local host
430                                 ; name and local IP to domain list.
431
432 ; fromdomain=mydomain.tld       ; When making outbound SIP INVITEs to
433                                 ; non-peers, use your primary domain "identity"
434                                 ; for From: headers instead of just your IP
435                                 ; address. This is to be polite and
436                                 ; it may be a mandatory requirement for some
437                                 ; destinations which do not have a prior
438                                 ; account relationship with your server. 
439
440 ;------------------------------ JITTER BUFFER CONFIGURATION --------------------------
441 ; jbenable = yes              ; Enables the use of a jitterbuffer on the receiving side of a
442                               ; SIP channel. Defaults to "no". An enabled jitterbuffer will
443                               ; be used only if the sending side can create and the receiving
444                               ; side can not accept jitter. The SIP channel can accept jitter,
445                               ; thus a jitterbuffer on the receive SIP side will be used only
446                               ; if it is forced and enabled.
447
448 ; jbforce = no                ; Forces the use of a jitterbuffer on the receive side of a SIP
449                               ; channel. Defaults to "no".
450
451 ; jbmaxsize = 200             ; Max length of the jitterbuffer in milliseconds.
452
453 ; jbresyncthreshold = 1000    ; Jump in the frame timestamps over which the jitterbuffer is
454                               ; resynchronized. Useful to improve the quality of the voice, with
455                               ; big jumps in/broken timestamps, usually sent from exotic devices
456                               ; and programs. Defaults to 1000.
457
458 ; jbimpl = fixed              ; Jitterbuffer implementation, used on the receiving side of a SIP
459                               ; channel. Two implementations are currently available - "fixed"
460                               ; (with size always equals to jbmaxsize) and "adaptive" (with
461                               ; variable size, actually the new jb of IAX2). Defaults to fixed.
462
463 ; jblog = no                  ; Enables jitterbuffer frame logging. Defaults to "no".
464 ;-----------------------------------------------------------------------------------
465
466 ;---- Disclaimer Settings ----------------------------------------------------------
467 ;
468 ;enabledisclaimer = no  ; This option enables sending a disclaimer along with all
469 ;                       ; SIP messages.  Generally, this would be some sort of legal
470 ;                       ; statement.  Note that the legal implications of using this
471 ;                       ; with a SIP proxy are not quite clear if the disclaimer
472 ;                       ; indicates that the message contents can not be used by
473 ;                       ; any party excepted the intended recipient, so it should
474 ;                       ; probably not be used in a network that contains proxies.
475 ;                       ; The default is "no".
476 ;
477 ;dislciamertext = Your custom disclaimer here.  
478 ;                       ; You can configure a custom disclaimer with this option.
479 ;                       ; Note that you must keep the entire disclaimer on one line.
480 ;                       ; The default text is:
481 ;                       ;   "This message and all contents are covered by the Electronic Communications "
482 ;                       ; "Privacy Act, 18 U.S.C. Sections 2510-2521, is confidential and may be legally " 
483 ;                       ; "privileged. It is intended to be conveyed only to the designated recipient(s). " 
484 ;                       ; "If you are not the intended recipient, you are hereby notified that any " 
485 ;                       ; "retention, dissemination, distribution or copying of this communication is " 
486 ;                       ; "strictly prohibited and that use, dissemination, distribution or reproduction " 
487 ;                       ; "of this message by unintended recipients is not authorized and may be unlawful. " 
488 ;                       ; "Please reply to sender that you have received the message in error, " 
489 ;                       ; "then delete it. Thank you."
490 ;
491 ;-----------------------------------------------------------------------------------
492
493 [authentication]
494 ; Global credentials for outbound calls, i.e. when a proxy challenges your
495 ; Asterisk server for authentication. These credentials override
496 ; any credentials in peer/register definition if realm is matched.
497 ;
498 ; This way, Asterisk can authenticate for outbound calls to other
499 ; realms. We match realm on the proxy challenge and pick an set of 
500 ; credentials from this list
501 ; Syntax:
502 ;       auth = <user>:<secret>@<realm>
503 ;       auth = <user>#<md5secret>@<realm>
504 ; Example:
505 ;auth=mark:topsecret@digium.com
506
507 ; You may also add auth= statements to [peer] definitions 
508 ; Peer auth= override all other authentication settings if we match on realm
509
510 ;------------------------------------------------------------------------------
511 ; Users and peers have different settings available. Friends have all settings,
512 ; since a friend is both a peer and a user
513 ;
514 ; User config options:        Peer configuration:
515 ; --------------------        -------------------
516 ; context                     context
517 ; callingpres                 callingpres
518 ; permit                      permit
519 ; deny                        deny
520 ; secret                      secret
521 ; md5secret                   md5secret
522 ; dtmfmode                    dtmfmode
523 ; canreinvite                 canreinvite
524 ; nat                         nat
525 ; callgroup                   callgroup
526 ; pickupgroup                 pickupgroup
527 ; language                    language
528 ; allow                       allow
529 ; disallow                    disallow
530 ; insecure                    insecure
531 ; trustrpid                   trustrpid
532 ; progressinband              progressinband
533 ; promiscredir                promiscredir
534 ; useclientcode               useclientcode
535 ; accountcode                 accountcode
536 ; setvar                      setvar
537 ; callerid                    callerid
538 ; amaflags                    amaflags
539 ; call-limit                  call-limit
540 ; allowoverlap                allowoverlap
541 ; allowsubscribe              allowsubscribe
542 ; allowtransfer               allowtransfer
543 ; subscribecontext            subscribecontext
544 ; videosupport                videosupport
545 ; maxcallbitrate              maxcallbitrate
546 ; rfc2833compensate           mailbox
547 ;                             busy-level
548 ;                             username
549 ;                             template
550 ;                             fromdomain
551 ;                             regexten
552 ;                             fromuser
553 ;                             host
554 ;                             port
555 ;                             qualify
556 ;                             defaultip
557 ;                             rtptimeout
558 ;                             rtpholdtimeout
559 ;                             sendrpid
560 ;                             outboundproxy
561 ;                             rfc2833compensate
562 ;                             callbackextension
563
564 ;[sip_proxy]
565 ; For incoming calls only. Example: FWD (Free World Dialup)
566 ; We match on IP address of the proxy for incoming calls 
567 ; since we can not match on username (caller id)
568 ;type=peer
569 ;context=from-fwd
570 ;host=fwd.pulver.com
571
572 ;[sip_proxy-out]
573 ;type=peer                              ; we only want to call out, not be called
574 ;secret=guessit
575 ;username=yourusername                  ; Authentication user for outbound proxies
576 ;fromuser=yourusername                  ; Many SIP providers require this!
577 ;fromdomain=provider.sip.domain 
578 ;host=box.provider.com
579 ;usereqphone=yes                        ; This provider requires ";user=phone" on URI
580 ;call-limit=5                           ; permit only 5 simultaneous outgoing calls to this peer
581                                         ; Call-limits will not be enforced on real-time peers,
582                                         ; since they are not stored in-memory
583 ;busy-level=2                           ; Signal busy at 2 or more calls
584 ;outboundproxy=proxy.provider.domain    ; send outbound signaling to this proxy, not directly to the peer
585 ;port=80                                ; The port number we want to connect to on the remote side
586                                         ; Also used as "defaultport" in combination with "defaultip" settings
587
588 ;--- sample definition for a provider
589 ;[provider1]
590 ;type=peer
591 ;host=sip.provider1.com
592 ;username=4015552299            ; how your provider knows you
593 ;secret=youwillneverguessit
594 ;callbackextension=123          ; Register with this server and require calls coming back to this extension
595
596 ;------------------------------------------------------------------------------
597 ; Definitions of locally connected SIP devices
598 ;
599 ; type = user   a device that authenticates to us by "from" field to place calls
600 ; type = peer   a device we place calls to or that calls us and we match by host
601 ; type = friend two configurations (peer+user) in one
602 ;
603 ; For device names, we recommend using only a-z, numerics (0-9) and underscore
604
605 ; For local phones, type=friend works most of the time
606 ;
607 ; If you have one-way audio, you probably have NAT problems. 
608 ; If Asterisk is on a public IP, and the phone is inside of a NAT device
609 ; you will need to configure nat option for those phones.
610 ; Also, turn on qualify=yes to keep the nat session open
611 ;
612 ; Because you might have a large number of similar sections, it is generally
613 ; convenient to use templates for the common parameters, and add them
614 ; the the various sections. Examples are below, and we can even leave
615 ; the templates uncommented as they will not harm:
616
617 [basic-options](!)              ; a template
618         dtmfmode=rfc2833
619         context=from-office
620         type=friend
621
622 [natted-phone](!,basic-options) ; another template inheriting basic-options
623         nat=yes
624         canreinvite=no
625         host=dynamic
626
627 [public-phone](!,basic-options) ; another template inheriting basic-options
628         nat=no
629         canreinvite=yes
630
631 [my-codecs](!)          ; a template for my preferred codecs
632         disallow=all
633         allow=ilbc
634         allow=g729
635         allow=gsm
636         allow=g723
637         allow=ulaw
638
639 [ulaw-phone](!)         ; and another one for ulaw-only
640         disallow=all
641         allow=ulaw
642
643 ; and finally instantiate a few phones
644 ;
645 ; [2133](natted-phone,my-codecs)
646 ;       secret = peekaboo
647 ; [2134](natted-phone,ulaw-hone)
648 ;       secret = not_very_secret
649 ; [2136](public-phone,ulaw-hone)
650 ;       secret = not_very_secret_either
651 ; ...
652 ;
653
654 ; Standard configurations not using templates look like this:
655 ;
656 ;[grandstream1]
657 ;type=friend                    
658 ;context=from-sip               ; Where to start in the dialplan when this phone calls
659 ;callerid=John Doe <1234>       ; Full caller ID, to override the phones config
660                                 ; on incoming calls to Asterisk
661 ;host=192.168.0.23              ; we have a static but private IP address
662                                 ; No registration allowed
663 ;nat=no                         ; there is not NAT between phone and Asterisk
664 ;canreinvite=yes                ; allow RTP voice traffic to bypass Asterisk
665 ;dtmfmode=info                  ; either RFC2833 or INFO for the BudgeTone
666 ;call-limit=1                   ; permit only 1 outgoing call and 1 incoming call at a time
667                                 ; from the phone to asterisk
668                                 ; 1 for the explicit peer, 1 for the explicit user,
669                                 ; remember that a friend equals 1 peer and 1 user in
670                                 ; memory
671                                 ; This will affect your subscriptions as well.
672                                 ; There is no combined call counter for a "friend"
673                                 ; so there's currently no way in sip.conf to limit
674                                 ; to one inbound or outbound call per phone. Use
675                                 ; the group counters in the dial plan for that.
676                                 ;
677 ;mailbox=1234@default           ; mailbox 1234 in voicemail context "default"
678 ;disallow=all                   ; need to disallow=all before we can use allow=
679 ;allow=ulaw                     ; Note: In user sections the order of codecs
680                                 ; listed with allow= does NOT matter!
681 ;allow=alaw
682 ;allow=g723.1                   ; Asterisk only supports g723.1 pass-thru!
683 ;allow=g729                     ; Pass-thru only unless g729 license obtained
684 ;callingpres=allowed_passed_screen      ; Set caller ID presentation
685                                 ; See README.callingpres for more information
686
687
688 ;[xlite1]
689 ; Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
690 ; Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
691 ;type=friend
692 ;regexten=1234                  ; When they register, create extension 1234
693 ;callerid="Jane Smith" <5678>
694 ;host=dynamic                   ; This device needs to register
695 ;nat=yes                        ; X-Lite is behind a NAT router
696 ;canreinvite=no                 ; Typically set to NO if behind NAT
697 ;disallow=all
698 ;allow=gsm                      ; GSM consumes far less bandwidth than ulaw
699 ;allow=ulaw
700 ;allow=alaw
701 ;mailbox=1234@default,1233@default      ; Subscribe to status of multiple mailboxes
702
703
704 ;[snom]
705 ;type=friend                    ; Friends place calls and receive calls
706 ;context=from-sip               ; Context for incoming calls from this user
707 ;secret=blah
708 ;subscribecontext=localextensions       ; Only allow SUBSCRIBE for local extensions
709 ;language=de                    ; Use German prompts for this user 
710 ;host=dynamic                   ; This peer register with us
711 ;dtmfmode=inband                ; Choices are inband, rfc2833, or info
712 ;defaultip=192.168.0.59         ; IP used until peer registers
713 ;mailbox=1234@context,2345      ; Mailbox(-es) for message waiting indicator
714 ;subscribemwi=yes               ; Only send notifications if this phone 
715                                 ; subscribes for mailbox notification
716 ;vmexten=voicemail              ; dialplan extension to reach mailbox 
717                                 ; sets the Message-Account in the MWI notify message
718                                 ; defaults to global vmexten which defaults to "asterisk"
719 ;disallow=all
720 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
721
722
723 ;[polycom]
724 ;type=friend                    ; Friends place calls and receive calls
725 ;context=from-sip               ; Context for incoming calls from this user
726 ;secret=blahpoly
727 ;host=dynamic                   ; This peer register with us
728 ;dtmfmode=rfc2833               ; Choices are inband, rfc2833, or info
729 ;username=polly                 ; Username to use in INVITE until peer registers
730                                 ; Normally you do NOT need to set this parameter
731 ;disallow=all
732 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
733 ;progressinband=no              ; Polycom phones don't work properly with "never"
734
735
736 ;[pingtel]
737 ;type=friend
738 ;secret=blah
739 ;host=dynamic
740 ;insecure=port                  ; Allow matching of peer by IP address without 
741                                 ; matching port number
742 ;insecure=invite                ; Do not require authentication of incoming INVITEs
743 ;insecure=port,invite           ; (both)
744 ;qualify=1000                   ; Consider it down if it's 1 second to reply
745                                 ; Helps with NAT session
746                                 ; qualify=yes uses default value
747 ;
748 ; Call group and Pickup group should be in the range from 0 to 63
749 ;
750 ;callgroup=1,3-4                ; We are in caller groups 1,3,4
751 ;pickupgroup=1,3-5              ; We can do call pick-p for call group 1,3,4,5
752 ;defaultip=192.168.0.60         ; IP address to use if peer has not registered
753 ;deny=0.0.0.0/0.0.0.0           ; ACL: Control access to this account based on IP address
754 ;permit=192.168.0.60/255.255.255.0
755
756 ;[cisco1]
757 ;type=friend
758 ;secret=blah
759 ;qualify=200                    ; Qualify peer is no more than 200ms away
760 ;nat=yes                        ; This phone may be natted
761                                 ; Send SIP and RTP to the IP address that packet is 
762                                 ; received from instead of trusting SIP headers 
763 ;host=dynamic                   ; This device registers with us
764 ;canreinvite=no                 ; Asterisk by default tries to redirect the
765                                 ; RTP media stream (audio) to go directly from
766                                 ; the caller to the callee.  Some devices do not
767                                 ; support this (especially if one of them is 
768                                 ; behind a NAT).
769 ;defaultip=192.168.0.4          ; IP address to use until registration
770 ;username=goran                 ; Username to use when calling this device before registration
771                                 ; Normally you do NOT need to set this parameter
772 ;setvar=CUSTID=5678             ; Channel variable to be set for all calls from this device
773
774 ;[pre14-asterisk]
775 ;type=friend
776 ;secret=digium
777 ;host=dynamic
778 ;rfc2833compensate=yes          ; Compensate for pre-1.4 DTMF transmission from another Asterisk machine.
779                                 ; You must have this turned on or DTMF reception will work improperly.