Merged revisions 337263 via svnmerge from
[asterisk/asterisk.git] / configs / sip.conf.sample
1 ;
2 ; SIP Configuration example for Asterisk
3 ;
4 ; Note: Please read the security documentation for Asterisk in order to
5 ;       understand the risks of installing Asterisk with the sample
6 ;       configuration. If your Asterisk is installed on a public
7 ;       IP address connected to the Internet, you will want to learn
8 ;       about the various security settings BEFORE you start
9 ;       Asterisk. 
10 ;
11 ;       Especially note the following settings:
12 ;               - allowguest (default enabled)
13 ;               - permit/deny - IP address filters
14 ;               - contactpermit/contactdeny - IP address filters for registrations
15 ;               - context - Which set of services you offer various users
16 ;
17 ; SIP dial strings
18 ;-----------------------------------------------------------
19 ; In the dialplan (extensions.conf) you can use several
20 ; syntaxes for dialing SIP devices.
21 ;        SIP/devicename
22 ;        SIP/username@domain   (SIP uri)
23 ;        SIP/username[:password[:md5secret[:authname[:transport]]]]@host[:port]
24 ;        SIP/devicename/extension
25 ;        SIP/devicename/extension/IPorHost
26 ;        SIP/username@domain//IPorHost
27 ;
28 ;
29 ; Devicename
30 ;        devicename is defined as a peer in a section below.
31 ;
32 ; username@domain
33 ;        Call any SIP user on the Internet
34 ;        (Don't forget to enable DNS SRV records if you want to use this)
35 ;
36 ; devicename/extension
37 ;        If you define a SIP proxy as a peer below, you may call
38 ;        SIP/proxyhostname/user or SIP/user@proxyhostname
39 ;        where the proxyhostname is defined in a section below
40 ;        This syntax also works with ATA's with FXO ports
41 ;
42 ; SIP/username[:password[:md5secret[:authname]]]@host[:port]
43 ;        This form allows you to specify password or md5secret and authname
44 ;        without altering any authentication data in config.
45 ;        Examples:
46 ;
47 ;        SIP/*98@mysipproxy
48 ;        SIP/sales:topsecret::account02@domain.com:5062
49 ;        SIP/12345678::bc53f0ba8ceb1ded2b70e05c3f91de4f:myname@192.168.0.1
50 ;
51 ; IPorHost
52 ;        The next server for this call regardless of domain/peer
53 ;
54 ; All of these dial strings specify the SIP request URI.
55 ; In addition, you can specify a specific To: header by adding an
56 ; exclamation mark after the dial string, like
57 ;
58 ;         SIP/sales@mysipproxy!sales@edvina.net
59 ;
60 ; A new feature for 1.8 allows one to specify a host or IP address to use
61 ; when routing the call. This is typically used in tandem with func_srv if
62 ; multiple methods of reaching the same domain exist. The host or IP address
63 ; is specified after the third slash in the dialstring. Examples:
64 ;
65 ; SIP/devicename/extension/IPorHost
66 ; SIP/username@domain//IPorHost
67 ;
68 ; CLI Commands
69 ; -------------------------------------------------------------
70 ; Useful CLI commands to check peers/users:
71 ;   sip show peers               Show all SIP peers (including friends)
72 ;   sip show registry            Show status of hosts we register with
73 ;
74 ;   sip set debug on             Show all SIP messages
75 ;
76 ;   sip reload                   Reload configuration file
77 ;   sip show settings            Show the current channel configuration
78 ;
79 ;------- Naming devices ------------------------------------------------------
80 ;
81 ; When naming devices, make sure you understand how Asterisk matches calls
82 ; that come in.
83 ;       1. Asterisk checks the SIP From: address username and matches against
84 ;          names of devices with type=user
85 ;          The name is the text between square brackets [name]
86 ;       2. Asterisk checks the From: addres and matches the list of devices
87 ;          with a type=peer
88 ;       3. Asterisk checks the IP address (and port number) that the INVITE
89 ;          was sent from and matches against any devices with type=peer
90 ;
91 ; Don't mix extensions with the names of the devices. Devices need a unique
92 ; name. The device name is *not* used as phone numbers. Phone numbers are
93 ; anything you declare as an extension in the dialplan (extensions.conf).
94 ;
95 ; When setting up trunks, make sure there's no risk that any From: username
96 ; (caller ID) will match any of your device names, because then Asterisk
97 ; might match the wrong device.
98 ;
99 ; Note: The parameter "username" is not the username and in most cases is
100 ;       not needed at all. Check below. In later releases, it's renamed
101 ;       to "defaultuser" which is a better name, since it is used in
102 ;       combination with the "defaultip" setting.
103 ;-----------------------------------------------------------------------------
104
105 ; ** Old configuration options **
106 ; The "call-limit" configuation option is considered old is replaced
107 ; by new functionality. To enable callcounters, you use the new 
108 ; "callcounter" setting (for extension states in queue and subscriptions)
109 ; You are encouraged to use the dialplan groupcount functionality
110 ; to enforce call limits instead of using this channel-specific method.
111 ; You can still set limits per device in sip.conf or in a database by using
112 ; "setvar" to set variables that can be used in the dialplan for various limits.
113
114 [general]
115 context=default                 ; Default context for incoming calls
116 ;allowguest=no                  ; Allow or reject guest calls (default is yes)
117                                 ; If your Asterisk is connected to the Internet
118                                 ; and you have allowguest=yes
119                                 ; you want to check which services you offer everyone
120                                 ; out there, by enabling them in the default context (see below).
121 ;match_auth_username=yes        ; if available, match user entry using the
122                                 ; 'username' field from the authentication line
123                                 ; instead of the From: field.
124 allowoverlap=no                 ; Disable overlap dialing support. (Default is yes)
125 ;allowtransfer=no               ; Disable all transfers (unless enabled in peers or users)
126                                 ; Default is enabled. The Dial() options 't' and 'T' are not
127                                 ; related as to whether SIP transfers are allowed or not.
128 ;realm=mydomain.tld             ; Realm for digest authentication
129                                 ; defaults to "asterisk". If you set a system name in
130                                 ; asterisk.conf, it defaults to that system name
131                                 ; Realms MUST be globally unique according to RFC 3261
132                                 ; Set this to your host name or domain name
133 ;domainsasrealm=no              ; Use domains list as realms
134                                 ; You can serve multiple Realms specifying several
135                                 ; 'domain=...' directives (see below). 
136                                 ; In this case Realm will be based on request 'From'/'To' header
137                                 ; and should match one of domain names.
138                                 ; Otherwise default 'realm=...' will be used.
139
140 ; With the current situation, you can do one of four things:
141 ;  a) Listen on a specific IPv4 address.      Example: bindaddr=192.0.2.1
142 ;  b) Listen on a specific IPv6 address.      Example: bindaddr=2001:db8::1
143 ;  c) Listen on the IPv4 wildcard.            Example: bindaddr=0.0.0.0
144 ;  d) Listen on the IPv4 and IPv6 wildcards.  Example: bindaddr=::
145 ; (You can choose independently for UDP, TCP, and TLS, by specifying different values for
146 ; "udpbindaddr", "tcpbindaddr", and "tlsbindaddr".)
147 ; (Note that using bindaddr=:: will show only a single IPv6 socket in netstat.
148 ;  IPv4 is supported at the same time using IPv4-mapped IPv6 addresses.)
149 ;
150 ; You may optionally add a port number. (The default is port 5060 for UDP and TCP, 5061
151 ; for TLS).
152 ;   IPv4 example: bindaddr=0.0.0.0:5062
153 ;   IPv6 example: bindaddr=[::]:5062
154 ;
155 ; The address family of the bound UDP address is used to determine how Asterisk performs
156 ; DNS lookups. In cases a) and c) above, only A records are considered. In case b), only
157 ; AAAA records are considered. In case d), both A and AAAA records are considered. Note,
158 ; however, that Asterisk ignores all records except the first one. In case d), when both A
159 ; and AAAA records are available, either an A or AAAA record will be first, and which one
160 ; depends on the operating system. On systems using glibc, AAAA records are given
161 ; priority.
162
163 udpbindaddr=0.0.0.0             ; IP address to bind UDP listen socket to (0.0.0.0 binds to all)
164                                 ; Optionally add a port number, 192.168.1.1:5062 (default is port 5060)
165
166 ; When a dialog is started with another SIP endpoint, the other endpoint
167 ; should include an Allow header telling us what SIP methods the endpoint
168 ; implements. However, some endpoints either do not include an Allow header
169 ; or lie about what methods they implement. In the former case, Asterisk
170 ; makes the assumption that the endpoint supports all known SIP methods.
171 ; If you know that your SIP endpoint does not provide support for a specific
172 ; method, then you may provide a comma-separated list of methods that your
173 ; endpoint does not implement in the disallowed_methods option. Note that 
174 ; if your endpoint is truthful with its Allow header, then there is no need 
175 ; to set this option. This option may be set in the general section or may
176 ; be set per endpoint. If this option is set both in the general section and
177 ; in a peer section, then the peer setting completely overrides the general
178 ; setting (i.e. the result is *not* the union of the two options).
179 ;
180 ; Note also that while Asterisk currently will parse an Allow header to learn
181 ; what methods an endpoint supports, the only actual use for this currently
182 ; is for determining if Asterisk may send connected line UPDATE requests and
183 ; MESSAGE requests. Its use may be expanded in the future.
184 ;
185 ; disallowed_methods = UPDATE
186
187 ;
188 ; Note that the TCP and TLS support for chan_sip is currently considered
189 ; experimental.  Since it is new, all of the related configuration options are
190 ; subject to change in any release.  If they are changed, the changes will
191 ; be reflected in this sample configuration file, as well as in the UPGRADE.txt file.
192 ;
193 tcpenable=no                    ; Enable server for incoming TCP connections (default is no)
194 tcpbindaddr=0.0.0.0             ; IP address for TCP server to bind to (0.0.0.0 binds to all interfaces)
195                                 ; Optionally add a port number, 192.168.1.1:5062 (default is port 5060)
196
197 ;tlsenable=no                   ; Enable server for incoming TLS (secure) connections (default is no)
198 ;tlsbindaddr=0.0.0.0            ; IP address for TLS server to bind to (0.0.0.0) binds to all interfaces)
199                                 ; Optionally add a port number, 192.168.1.1:5063 (default is port 5061)
200                                 ; Remember that the IP address must match the common name (hostname) in the
201                                 ; certificate, so you don't want to bind a TLS socket to multiple IP addresses.
202                                 ; For details how to construct a certificate for SIP see 
203                                 ; http://tools.ietf.org/html/draft-ietf-sip-domain-certs
204
205 ;tcpauthtimeout = 30            ; tcpauthtimeout specifies the maximum number
206                                 ; of seconds a client has to authenticate.  If
207                                 ; the client does not authenticate beofre this
208                                 ; timeout expires, the client will be
209                                 ; disconnected. (default: 30 seconds)
210
211 ;tcpauthlimit = 100             ; tcpauthlimit specifies the maximum number of
212                                 ; unauthenticated sessions that will be allowed
213                                 ; to connect at any given time. (default: 100)
214
215 srvlookup=yes                   ; Enable DNS SRV lookups on outbound calls
216                                 ; Note: Asterisk only uses the first host
217                                 ; in SRV records
218                                 ; Disabling DNS SRV lookups disables the
219                                 ; ability to place SIP calls based on domain
220                                 ; names to some other SIP users on the Internet
221                                 ; Specifying a port in a SIP peer definition or
222                                 ; when dialing outbound calls will supress SRV
223                                 ; lookups for that peer or call.
224
225 ;pedantic=yes                   ; Enable checking of tags in headers,
226                                 ; international character conversions in URIs
227                                 ; and multiline formatted headers for strict
228                                 ; SIP compatibility (defaults to "yes")
229
230 ; See https://wiki.asterisk.org/wiki/display/AST/IP+Quality+of+Service for a description of these parameters.
231 ;tos_sip=cs3                    ; Sets TOS for SIP packets.
232 ;tos_audio=ef                   ; Sets TOS for RTP audio packets.
233 ;tos_video=af41                 ; Sets TOS for RTP video packets.
234 ;tos_text=af41                  ; Sets TOS for RTP text packets.
235
236 ;cos_sip=3                      ; Sets 802.1p priority for SIP packets.
237 ;cos_audio=5                    ; Sets 802.1p priority for RTP audio packets.
238 ;cos_video=4                    ; Sets 802.1p priority for RTP video packets.
239 ;cos_text=3                     ; Sets 802.1p priority for RTP text packets.
240
241 ;maxexpiry=3600                 ; Maximum allowed time of incoming registrations
242                                 ; and subscriptions (seconds)
243 ;minexpiry=60                   ; Minimum length of registrations/subscriptions (default 60)
244 ;defaultexpiry=120              ; Default length of incoming/outgoing registration
245 ;mwiexpiry=3600                 ; Expiry time for outgoing MWI subscriptions
246 ;maxforwards=70                 ; Setting for the SIP Max-Forwards: header (loop prevention)
247                                 ; Default value is 70
248 ;qualifyfreq=60                 ; Qualification: How often to check for the host to be up in seconds
249                                 ; and reported in milliseconds with sip show settings.
250                                 ; Set to low value if you use low timeout for NAT of UDP sessions
251                                 ; Default: 60
252 ;qualifygap=100                 ; Number of milliseconds between each group of peers being qualified
253                                 ; Default: 100
254 ;qualifypeers=1                 ; Number of peers in a group to be qualified at the same time
255                                 ; Default: 1
256 ;notifymimetype=text/plain      ; Allow overriding of mime type in MWI NOTIFY
257 ;buggymwi=no                    ; Cisco SIP firmware doesn't support the MWI RFC
258                                 ; fully. Enable this option to not get error messages
259                                 ; when sending MWI to phones with this bug.
260 ;mwi_from=asterisk              ; When sending MWI NOTIFY requests, use this setting in
261                                 ; the From: header as the "name" portion. Also fill the
262                                 ; "user" portion of the URI in the From: header with this
263                                 ; value if no fromuser is set
264                                 ; Default: empty
265 ;vmexten=voicemail              ; dialplan extension to reach mailbox sets the
266                                 ; Message-Account in the MWI notify message
267                                 ; defaults to "asterisk"
268
269 ; Codec negotiation
270 ;
271 ; When Asterisk is receiving a call, the codec will initially be set to the
272 ; first codec in the allowed codecs defined for the user receiving the call
273 ; that the caller also indicates that it supports. But, after the caller
274 ; starts sending RTP, Asterisk will switch to using whatever codec the caller
275 ; is sending.
276 ;
277 ; When Asterisk is placing a call, the codec used will be the first codec in
278 ; the allowed codecs that the callee indicates that it supports. Asterisk will
279 ; *not* switch to whatever codec the callee is sending.
280 ;
281 ;preferred_codec_only=yes       ; Respond to a SIP invite with the single most preferred codec
282                                 ; rather than advertising all joint codec capabilities. This
283                                 ; limits the other side's codec choice to exactly what we prefer.
284
285 ;disallow=all                   ; First disallow all codecs
286 ;allow=ulaw                     ; Allow codecs in order of preference
287 ;allow=ilbc                     ; see https://wiki.asterisk.org/wiki/display/AST/RTP+Packetization
288                                 ; for framing options
289 ;
290 ; This option specifies a preference for which music on hold class this channel
291 ; should listen to when put on hold if the music class has not been set on the
292 ; channel with Set(CHANNEL(musicclass)=whatever) in the dialplan, and the peer
293 ; channel putting this one on hold did not suggest a music class.
294 ;
295 ; This option may be specified globally, or on a per-user or per-peer basis.
296 ;
297 ;mohinterpret=default
298 ;
299 ; This option specifies which music on hold class to suggest to the peer channel
300 ; when this channel places the peer on hold. It may be specified globally or on
301 ; a per-user or per-peer basis.
302 ;
303 ;mohsuggest=default
304 ;
305 ;parkinglot=plaza               ; Sets the default parking lot for call parking
306                                 ; This may also be set for individual users/peers
307                                 ; Parkinglots are configured in features.conf
308 ;language=en                    ; Default language setting for all users/peers
309                                 ; This may also be set for individual users/peers
310 ;tonezone=se                    ; Default tonezone for all users/peers
311                                 ; This may also be set for individual users/peers
312
313 ;relaxdtmf=yes                  ; Relax dtmf handling
314 ;trustrpid = no                 ; If Remote-Party-ID should be trusted
315 ;sendrpid = yes                 ; If Remote-Party-ID should be sent (defaults to no)
316 ;sendrpid = rpid                ; Use the "Remote-Party-ID" header
317                                 ; to send the identity of the remote party
318                                 ; This is identical to sendrpid=yes
319 ;sendrpid = pai                 ; Use the "P-Asserted-Identity" header
320                                 ; to send the identity of the remote party
321 ;rpid_update = no               ; In certain cases, the only method by which a connected line
322                                 ; change may be immediately transmitted is with a SIP UPDATE request.
323                                 ; If communicating with another Asterisk server, and you wish to be able
324                                 ; transmit such UPDATE messages to it, then you must enable this option.
325                                 ; Otherwise, we will have to wait until we can send a reinvite to
326                                 ; transmit the information.
327 ;prematuremedia=no              ; Some ISDN links send empty media frames before 
328                                 ; the call is in ringing or progress state. The SIP 
329                                 ; channel will then send 183 indicating early media
330                                 ; which will be empty - thus users get no ring signal.
331                                 ; Setting this to "yes" will stop any media before we have
332                                 ; call progress (meaning the SIP channel will not send 183 Session
333                                 ; Progress for early media). Default is "yes". Also make sure that
334                                 ; the SIP peer is configured with progressinband=never. 
335                                 ;
336                                 ; In order for "noanswer" applications to work, you need to run
337                                 ; the progress() application in the priority before the app.
338
339 ;progressinband=never           ; If we should generate in-band ringing always
340                                 ; use 'never' to never use in-band signalling, even in cases
341                                 ; where some buggy devices might not render it
342                                 ; Valid values: yes, no, never Default: never
343 ;useragent=Asterisk PBX         ; Allows you to change the user agent string
344                                 ; The default user agent string also contains the Asterisk
345                                 ; version. If you don't want to expose this, change the
346                                 ; useragent string.
347 ;promiscredir = no              ; If yes, allows 302 or REDIR to non-local SIP address
348                                 ; Note that promiscredir when redirects are made to the
349                                 ; local system will cause loops since Asterisk is incapable
350                                 ; of performing a "hairpin" call.
351 ;usereqphone = no               ; If yes, ";user=phone" is added to uri that contains
352                                 ; a valid phone number
353 ;dtmfmode = rfc2833             ; Set default dtmfmode for sending DTMF. Default: rfc2833
354                                 ; Other options:
355                                 ; info : SIP INFO messages (application/dtmf-relay)
356                                 ; shortinfo : SIP INFO messages (application/dtmf)
357                                 ; inband : Inband audio (requires 64 kbit codec -alaw, ulaw)
358                                 ; auto : Use rfc2833 if offered, inband otherwise
359
360 ;compactheaders = yes           ; send compact sip headers.
361 ;
362 ;videosupport=yes               ; Turn on support for SIP video. You need to turn this
363                                 ; on in this section to get any video support at all.
364                                 ; You can turn it off on a per peer basis if the general
365                                 ; video support is enabled, but you can't enable it for
366                                 ; one peer only without enabling in the general section.
367                                 ; If you set videosupport to "always", then RTP ports will
368                                 ; always be set up for video, even on clients that don't
369                                 ; support it.  This assists callfile-derived calls and
370                                 ; certain transferred calls to use always use video when
371                                 ; available. [yes|NO|always]
372
373 ;maxcallbitrate=384             ; Maximum bitrate for video calls (default 384 kb/s)
374                                 ; Videosupport and maxcallbitrate is settable
375                                 ; for peers and users as well
376 ;callevents=no                  ; generate manager events when sip ua
377                                 ; performs events (e.g. hold)
378 ;authfailureevents=no           ; generate manager "peerstatus" events when peer can't
379                                 ; authenticate with Asterisk. Peerstatus will be "rejected".
380 ;alwaysauthreject = yes         ; When an incoming INVITE or REGISTER is to be rejected,
381                                 ; for any reason, always reject with an identical response
382                                 ; equivalent to valid username and invalid password/hash
383                                 ; instead of letting the requester know whether there was
384                                 ; a matching user or peer for their request.  This reduces
385                                 ; the ability of an attacker to scan for valid SIP usernames.
386                                 ; This option is set to "yes" by default.
387
388 ;auth_options_requests = yes    ; Enabling this option will authenticate OPTIONS requests just like
389                                 ; INVITE requests are.  By default this option is disabled.
390
391 ;accept_outofcall_message = no  ; Disable this option to reject all MESSAGE requests outside of a
392                                 ; call.  By default, this option is enabled.  When enabled, MESSAGE
393                                 ; requests are passed in to the dialplan.
394
395 ;outofcall_message_context = messages ; Context all out of dialog msgs are sent to. When this
396                                       ; option is not set, the context used during peer matching
397                                       ; is used. This option can be defined at both the peer and
398                                       ; global level.
399
400 ;auth_message_requests = yes    ; Enabling this option will authenticate MESSAGE requests.
401                                 ; By default this option is enabled.  However, it can be disabled
402                                 ; should an application desire to not load the Asterisk server with
403                                 ; doing authentication and implement end to end security in the
404                                 ; message body.
405
406 ;g726nonstandard = yes          ; If the peer negotiates G726-32 audio, use AAL2 packing
407                                 ; order instead of RFC3551 packing order (this is required
408                                 ; for Sipura and Grandstream ATAs, among others). This is
409                                 ; contrary to the RFC3551 specification, the peer _should_
410                                 ; be negotiating AAL2-G726-32 instead :-(
411 ;outboundproxy=proxy.provider.domain            ; send outbound signaling to this proxy, not directly to the devices
412 ;outboundproxy=proxy.provider.domain:8080       ; send outbound signaling to this proxy, not directly to the devices
413 ;outboundproxy=proxy.provider.domain,force      ; Send ALL outbound signalling to proxy, ignoring route: headers
414 ;outboundproxy=tls://proxy.provider.domain      ; same as '=proxy.provider.domain' except we try to connect with tls
415 ;outboundproxy=192.0.2.1                        ; IPv4 address literal (default port is 5060)
416 ;outboundproxy=2001:db8::1                      ; IPv6 address literal (default port is 5060)
417 ;outboundproxy=192.168.0.2.1:5062               ; IPv4 address literal with explicit port
418 ;outboundproxy=[2001:db8::1]:5062               ; IPv6 address literal with explicit port
419 ;                                               ; (could also be tcp,udp) - defining transports on the proxy line only
420 ;                                               ; applies for the global proxy, otherwise use the transport= option
421 ;matchexternaddrlocally = yes     ; Only substitute the externaddr or externhost setting if it matches
422                                 ; your localnet setting. Unless you have some sort of strange network
423                                 ; setup you will not need to enable this.
424
425 ;dynamic_exclude_static = yes   ; Disallow all dynamic hosts from registering
426                                 ; as any IP address used for staticly defined
427                                 ; hosts.  This helps avoid the configuration
428                                 ; error of allowing your users to register at
429                                 ; the same address as a SIP provider.
430
431 ;contactdeny=0.0.0.0/0.0.0.0           ; Use contactpermit and contactdeny to
432 ;contactpermit=172.16.0.0/255.255.0.0  ; restrict at what IPs your users may
433                                        ; register their phones.
434
435 ;engine=asterisk                ; RTP engine to use when communicating with the device
436
437 ;
438 ; If regcontext is specified, Asterisk will dynamically create and destroy a
439 ; NoOp priority 1 extension for a given peer who registers or unregisters with
440 ; us and have a "regexten=" configuration item.
441 ; Multiple contexts may be specified by separating them with '&'. The
442 ; actual extension is the 'regexten' parameter of the registering peer or its
443 ; name if 'regexten' is not provided.  If more than one context is provided,
444 ; the context must be specified within regexten by appending the desired
445 ; context after '@'.  More than one regexten may be supplied if they are
446 ; separated by '&'.  Patterns may be used in regexten.
447 ;
448 ;regcontext=sipregistrations
449 ;regextenonqualify=yes          ; Default "no"
450                                 ; If you have qualify on and the peer becomes unreachable
451                                 ; this setting will enforce inactivation of the regexten
452                                 ; extension for the peer
453 ;legacy_useroption_parsing=yes  ; Default "no"      ; If you have this option enabled and there are semicolons
454                                                     ; in the user field of a sip URI, the field be truncated
455                                                     ; at the first semicolon seen. This effectively makes
456                                                     ; semicolon a non-usable character for peer names, extensions,
457                                                     ; and maybe other, less tested things.  This can be useful
458                                                     ; for improving compatability with devices that like to use
459                                                     ; user options for whatever reason.  The behavior is similar to
460                                                     ; how SIP URI's were typically handled in 1.6.2, hence the name.
461
462 ; The shrinkcallerid function removes '(', ' ', ')', non-trailing '.', and '-' not
463 ; in square brackets.  For example, the caller id value 555.5555 becomes 5555555
464 ; when this option is enabled.  Disabling this option results in no modification
465 ; of the caller id value, which is necessary when the caller id represents something
466 ; that must be preserved.  This option can only be used in the [general] section.
467 ; By default this option is on.
468 ;
469 ;shrinkcallerid=yes     ; on by default
470
471
472 ;use_q850_reason = no ; Default "no"
473                       ; Set to yes add Reason header and use Reason header if it is available.
474 ;
475 ;------------------------ TLS settings ------------------------------------------------------------
476 ;tlscertfile=</path/to/certificate.pem> ; Certificate file (*.pem format only) to use for TLS connections
477                                         ; default is to look for "asterisk.pem" in current directory
478
479 ;tlsprivatekey=</path/to/private.pem> ; Private key file (*.pem format only) for TLS connections.
480                                       ; If no tlsprivatekey is specified, tlscertfile is searched for
481                                       ; for both public and private key.
482
483 ;tlscafile=</path/to/certificate>
484 ;        If the server your connecting to uses a self signed certificate
485 ;        you should have their certificate installed here so the code can
486 ;        verify the authenticity of their certificate.
487
488 ;tlscapath=</path/to/ca/dir>
489 ;        A directory full of CA certificates.  The files must be named with
490 ;        the CA subject name hash value.
491 ;        (see man SSL_CTX_load_verify_locations for more info)
492
493 ;tlsdontverifyserver=[yes|no]
494 ;        If set to yes, don't verify the servers certificate when acting as
495 ;        a client.  If you don't have the server's CA certificate you can
496 ;        set this and it will connect without requiring tlscafile to be set.
497 ;        Default is no.
498
499 ;tlscipher=<SSL cipher string>
500 ;        A string specifying which SSL ciphers to use or not use
501 ;        A list of valid SSL cipher strings can be found at:
502 ;                http://www.openssl.org/docs/apps/ciphers.html#CIPHER_STRINGS
503 ;
504 ;tlsclientmethod=tlsv1     ; values include tlsv1, sslv3, sslv2.
505                            ; Specify protocol for outbound client connections.
506                            ; If left unspecified, the default is sslv2.
507 ;
508 ;--------------------------- SIP timers ----------------------------------------------------
509 ; These timers are used primarily in INVITE transactions.
510 ; The default for Timer T1 is 500 ms or the measured run-trip time between
511 ; Asterisk and the device if you have qualify=yes for the device.
512 ;
513 ;t1min=100                      ; Minimum roundtrip time for messages to monitored hosts
514                                 ; Defaults to 100 ms
515 ;timert1=500                    ; Default T1 timer
516                                 ; Defaults to 500 ms or the measured round-trip
517                                 ; time to a peer (qualify=yes).
518 ;timerb=32000                   ; Call setup timer. If a provisional response is not received
519                                 ; in this amount of time, the call will autocongest
520                                 ; Defaults to 64*timert1
521
522 ;--------------------------- RTP timers ----------------------------------------------------
523 ; These timers are currently used for both audio and video streams. The RTP timeouts
524 ; are only applied to the audio channel.
525 ; The settings are settable in the global section as well as per device
526 ;
527 ;rtptimeout=60                  ; Terminate call if 60 seconds of no RTP or RTCP activity
528                                 ; on the audio channel
529                                 ; when we're not on hold. This is to be able to hangup
530                                 ; a call in the case of a phone disappearing from the net,
531                                 ; like a powerloss or grandma tripping over a cable.
532 ;rtpholdtimeout=300             ; Terminate call if 300 seconds of no RTP or RTCP activity
533                                 ; on the audio channel
534                                 ; when we're on hold (must be > rtptimeout)
535 ;rtpkeepalive=<secs>            ; Send keepalives in the RTP stream to keep NAT open
536                                 ; (default is off - zero)
537
538 ;--------------------------- SIP Session-Timers (RFC 4028)------------------------------------
539 ; SIP Session-Timers provide an end-to-end keep-alive mechanism for active SIP sessions.
540 ; This mechanism can detect and reclaim SIP channels that do not terminate through normal
541 ; signaling procedures. Session-Timers can be configured globally or at a user/peer level.
542 ; The operation of Session-Timers is driven by the following configuration parameters:
543 ;
544 ; * session-timers    - Session-Timers feature operates in the following three modes:
545 ;                            originate : Request and run session-timers always
546 ;                            accept    : Run session-timers only when requested by other UA
547 ;                            refuse    : Do not run session timers in any case
548 ;                       The default mode of operation is 'accept'.
549 ; * session-expires   - Maximum session refresh interval in seconds. Defaults to 1800 secs.
550 ; * session-minse     - Minimum session refresh interval in seconds. Defualts to 90 secs.
551 ; * session-refresher - The session refresher (uac|uas). Defaults to 'uas'.
552 ;
553 ;session-timers=originate
554 ;session-expires=600
555 ;session-minse=90
556 ;session-refresher=uas
557 ;
558 ;--------------------------- SIP DEBUGGING ---------------------------------------------------
559 ;sipdebug = yes                 ; Turn on SIP debugging by default, from
560                                 ; the moment the channel loads this configuration
561 ;recordhistory=yes              ; Record SIP history by default
562                                 ; (see sip history / sip no history)
563 ;dumphistory=yes                ; Dump SIP history at end of SIP dialogue
564                                 ; SIP history is output to the DEBUG logging channel
565
566
567 ;--------------------------- STATUS NOTIFICATIONS (SUBSCRIPTIONS) ----------------------------
568 ; You can subscribe to the status of extensions with a "hint" priority
569 ; (See extensions.conf.sample for examples)
570 ; chan_sip support two major formats for notifications: dialog-info and SIMPLE
571 ;
572 ; You will get more detailed reports (busy etc) if you have a call counter enabled
573 ; for a device.
574 ;
575 ; If you set the busylevel, we will indicate busy when we have a number of calls that
576 ; matches the busylevel treshold.
577 ;
578 ; For queues, you will need this level of detail in status reporting, regardless
579 ; if you use SIP subscriptions. Queues and manager use the same internal interface
580 ; for reading status information.
581 ;
582 ; Note: Subscriptions does not work if you have a realtime dialplan and use the
583 ; realtime switch.
584 ;
585 ;allowsubscribe=no              ; Disable support for subscriptions. (Default is yes)
586 ;subscribecontext = default     ; Set a specific context for SUBSCRIBE requests
587                                 ; Useful to limit subscriptions to local extensions
588                                 ; Settable per peer/user also
589 ;notifyringing = no             ; Control whether subscriptions already INUSE get sent
590                                 ; RINGING when another call is sent (default: yes)
591 ;notifyhold = yes               ; Notify subscriptions on HOLD state (default: no)
592                                 ; Turning on notifyringing and notifyhold will add a lot
593                                 ; more database transactions if you are using realtime.
594 ;notifycid = yes                ; Control whether caller ID information is sent along with
595                                 ; dialog-info+xml notifications (supported by snom phones).
596                                 ; Note that this feature will only work properly when the
597                                 ; incoming call is using the same extension and context that
598                                 ; is being used as the hint for the called extension.  This means
599                                 ; that it won't work when using subscribecontext for your sip
600                                 ; user or peer (if subscribecontext is different than context).
601                                 ; This is also limited to a single caller, meaning that if an
602                                 ; extension is ringing because multiple calls are incoming,
603                                 ; only one will be used as the source of caller ID.  Specify
604                                 ; 'ignore-context' to ignore the called context when looking
605                                 ; for the caller's channel.  The default value is 'no.' Setting
606                                 ; notifycid to 'ignore-context' also causes call-pickups attempted
607                                 ; via SNOM's NOTIFY mechanism to set the context for the call pickup
608                                 ; to PICKUPMARK.
609 ;callcounter = yes              ; Enable call counters on devices. This can be set per
610                                 ; device too.
611
612 ;----------------------------------------- T.38 FAX SUPPORT ----------------------------------
613 ;
614 ; This setting is available in the [general] section as well as in device configurations.
615 ; Setting this to yes enables T.38 FAX (UDPTL) on SIP calls; it defaults to off.
616 ;
617 ; t38pt_udptl = yes            ; Enables T.38 with FEC error correction.
618 ; t38pt_udptl = yes,fec        ; Enables T.38 with FEC error correction.
619 ; t38pt_udptl = yes,redundancy ; Enables T.38 with redundancy error correction.
620 ; t38pt_udptl = yes,none       ; Enables T.38 with no error correction.
621 ;
622 ; In some cases, T.38 endpoints will provide a T38FaxMaxDatagram value (during T.38 setup) that
623 ; is based on an incorrect interpretation of the T.38 recommendation, and results in failures
624 ; because Asterisk does not believe it can send T.38 packets of a reasonable size to that
625 ; endpoint (Cisco media gateways are one example of this situation). In these cases, during a
626 ; T.38 call you will see warning messages on the console/in the logs from the Asterisk UDPTL
627 ; stack complaining about lack of buffer space to send T.38 FAX packets. If this occurs, you
628 ; can set an override (globally, or on a per-device basis) to make Asterisk ignore the
629 ; T38FaxMaxDatagram value specified by the other endpoint, and use a configured value instead.
630 ; This can be done by appending 'maxdatagram=<value>' to the t38pt_udptl configuration option,
631 ; like this:
632 ;
633 ; t38pt_udptl = yes,fec,maxdatagram=400 ; Enables T.38 with FEC error correction and overrides
634 ;                                       ; the other endpoint's provided value to assume we can
635 ;                                       ; send 400 byte T.38 FAX packets to it.
636 ;
637 ; FAX detection will cause the SIP channel to jump to the 'fax' extension (if it exists)
638 ; based one or more events being detected. The events that can be detected are an incoming
639 ; CNG tone or an incoming T.38 re-INVITE request.
640 ;
641 ; faxdetect = yes               ; Default 'no', 'yes' enables both CNG and T.38 detection
642 ; faxdetect = cng               ; Enables only CNG detection
643 ; faxdetect = t38               ; Enables only T.38 detection
644 ;
645 ;----------------------------------------- OUTBOUND SIP REGISTRATIONS  ------------------------
646 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
647 ; Format for the register statement is:
648 ;       register => [peer?][transport://]user[@domain][:secret[:authuser]]@host[:port][/extension][~expiry]
649 ;
650 ;
651 ;
652 ; domain is either
653 ;       - domain in DNS
654 ;       - host name in DNS
655 ;       - the name of a peer defined below or in realtime
656 ; The domain is where you register your username, so your SIP uri you are registering to
657 ; is username@domain
658 ;
659 ; If no extension is given, the 's' extension is used. The extension needs to
660 ; be defined in extensions.conf to be able to accept calls from this SIP proxy
661 ; (provider).
662 ;
663 ; A similar effect can be achieved by adding a "callbackextension" option in a peer section.
664 ; this is equivalent to having the following line in the general section:
665 ;
666 ;        register => username:secret@host/callbackextension
667 ;
668 ; and more readable because you don't have to write the parameters in two places
669 ; (note that the "port" is ignored - this is a bug that should be fixed).
670 ;
671 ; Note that a register= line doesn't mean that we will match the incoming call in any
672 ; other way than described above. If you want to control where the call enters your
673 ; dialplan, which context, you want to define a peer with the hostname of the provider's
674 ; server. If the provider has multiple servers to place calls to your system, you need
675 ; a peer for each server.
676 ;
677 ; Beginning with Asterisk version 1.6.2, the "user" portion of the register line may
678 ; contain a port number. Since the logical separator between a host and port number is a
679 ; ':' character, and this character is already used to separate between the optional "secret"
680 ; and "authuser" portions of the line, there is a bit of a hoop to jump through if you wish
681 ; to use a port here. That is, you must explicitly provide a "secret" and "authuser" even if
682 ; they are blank. See the third example below for an illustration.
683 ;
684 ;
685 ; Examples:
686 ;
687 ;register => 1234:password@mysipprovider.com
688 ;
689 ;     This will pass incoming calls to the 's' extension
690 ;
691 ;
692 ;register => 2345:password@sip_proxy/1234
693 ;
694 ;    Register 2345 at sip provider 'sip_proxy'.  Calls from this provider
695 ;    connect to local extension 1234 in extensions.conf, default context,
696 ;    unless you configure a [sip_proxy] section below, and configure a
697 ;    context.
698 ;    Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
699 ;    Tip 2: Use separate inbound and outbound sections for SIP providers
700 ;           (instead of type=friend) if you have calls in both directions
701 ;
702 ;register => 3456@mydomain:5082::@mysipprovider.com
703 ;
704 ;    Note that in this example, the optional authuser and secret portions have
705 ;    been left blank because we have specified a port in the user section
706 ;
707 ;register => tls://username:xxxxxx@sip-tls-proxy.example.org
708 ;
709 ;    The 'transport' part defaults to 'udp' but may also be 'tcp' or 'tls'.
710 ;    Using 'udp://' explicitly is also useful in case the username part
711 ;    contains a '/' ('user/name').
712
713 ;registertimeout=20             ; retry registration calls every 20 seconds (default)
714 ;registerattempts=10            ; Number of registration attempts before we give up
715                                 ; 0 = continue forever, hammering the other server
716                                 ; until it accepts the registration
717                                 ; Default is 0 tries, continue forever
718
719 ;----------------------------------------- OUTBOUND MWI SUBSCRIPTIONS -------------------------
720 ; Asterisk can subscribe to receive the MWI from another SIP server and store it locally for retrieval
721 ; by other phones. At this time, you can only subscribe using UDP as the transport.
722 ; Format for the mwi register statement is:
723 ;       mwi => user[:secret[:authuser]]@host[:port]/mailbox
724 ;
725 ; Examples:
726 ;mwi => 1234:password@mysipprovider.com/1234
727 ;mwi => 1234:password@myportprovider.com:6969/1234
728 ;mwi => 1234:password:authuser@myauthprovider.com/1234
729 ;mwi => 1234:password:authuser@myauthportprovider.com:6969/1234
730 ;
731 ; MWI received will be stored in the 1234 mailbox of the SIP_Remote context. It can be used by other phones by following the below:
732 ; mailbox=1234@SIP_Remote
733 ;----------------------------------------- NAT SUPPORT ------------------------
734 ;
735 ; WARNING: SIP operation behind a NAT is tricky and you really need
736 ; to read and understand well the following section.
737 ;
738 ; When Asterisk is behind a NAT device, the "local" address (and port) that
739 ; a socket is bound to has different values when seen from the inside or
740 ; from the outside of the NATted network. Unfortunately this address must
741 ; be communicated to the outside (e.g. in SIP and SDP messages), and in
742 ; order to determine the correct value Asterisk needs to know:
743 ;
744 ; + whether it is talking to someone "inside" or "outside" of the NATted network.
745 ;   This is configured by assigning the "localnet" parameter with a list
746 ;   of network addresses that are considered "inside" of the NATted network.
747 ;   IF LOCALNET IS NOT SET, THE EXTERNAL ADDRESS WILL NOT BE SET CORRECTLY.
748 ;   Multiple entries are allowed, e.g. a reasonable set is the following:
749 ;
750 ;      localnet=192.168.0.0/255.255.0.0 ; RFC 1918 addresses
751 ;      localnet=10.0.0.0/255.0.0.0      ; Also RFC1918
752 ;      localnet=172.16.0.0/12           ; Another RFC1918 with CIDR notation
753 ;      localnet=169.254.0.0/255.255.0.0 ; Zero conf local network
754 ;
755 ; + the "externally visible" address and port number to be used when talking
756 ;   to a host outside the NAT. This information is derived by one of the
757 ;   following (mutually exclusive) config file parameters:
758 ;
759 ;   a. "externaddr = hostname[:port]" specifies a static address[:port] to
760 ;      be used in SIP and SDP messages.
761 ;      The hostname is looked up only once, when [re]loading sip.conf .
762 ;      If a port number is not present, use the port specified in the "udpbindaddr"
763 ;      (which is not guaranteed to work correctly, because a NAT box might remap the
764 ;      port number as well as the address).
765 ;      This approach can be useful if you have a NAT device where you can
766 ;      configure the mapping statically. Examples:
767 ;
768 ;        externaddr = 12.34.56.78          ; use this address.
769 ;        externaddr = 12.34.56.78:9900     ; use this address and port.
770 ;        externaddr = mynat.my.org:12600   ; Public address of my nat box.
771 ;        externtcpport = 9900   ; The externally mapped tcp port, when Asterisk is behind a static NAT or PAT. 
772 ;                               ; externtcpport will default to the externaddr or externhost port if either one is set. 
773 ;        externtlsport = 12600  ; The externally mapped tls port, when Asterisk is behind a static NAT or PAT.
774 ;                               ; externtlsport port will default to the RFC designated port of 5061.   
775 ;
776 ;   b. "externhost = hostname[:port]" is similar to "externaddr" except
777 ;      that the hostname is looked up every "externrefresh" seconds
778 ;      (default 10s). This can be useful when your NAT device lets you choose
779 ;      the port mapping, but the IP address is dynamic.
780 ;      Beware, you might suffer from service disruption when the name server
781 ;      resolution fails. Examples:
782 ;
783 ;        externhost=foo.dyndns.net       ; refreshed periodically
784 ;        externrefresh=180               ; change the refresh interval
785 ;
786 ;   Note that at the moment all these mechanism work only for the SIP socket.
787 ;   The IP address discovered with externaddr/externhost is reused for
788 ;   media sessions as well, but the port numbers are not remapped so you
789 ;   may still experience problems.
790 ;
791 ; NOTE 1: in some cases, NAT boxes will use different port numbers in
792 ; the internal<->external mapping. In these cases, the "externaddr" and
793 ; "externhost" might not help you configure addresses properly.
794 ;
795 ; NOTE 2: when using "externaddr" or "externhost", the address part is
796 ; also used as the external address for media sessions. Thus, the port
797 ; information in the SDP may be wrong!
798 ;
799 ; In addition to the above, Asterisk has an additional "nat" parameter to
800 ; address NAT-related issues in incoming SIP or media sessions.
801 ; In particular, depending on the 'nat= ' settings described below, Asterisk
802 ; may override the address/port information specified in the SIP/SDP messages,
803 ; and use the information (sender address) supplied by the network stack instead.
804 ; However, this is only useful if the external traffic can reach us.
805 ; The following settings are allowed (both globally and in individual sections):
806 ;
807 ;        nat = no                ; Default. Use rport if the remote side says to use it.
808 ;        nat = force_rport       ; Force rport to always be on.
809 ;        nat = yes               ; Force rport to always be on and perform comedia RTP handling.
810 ;        nat = comedia           ; Use rport if the remote side says to use it and perform comedia RTP handling.
811 ;
812 ; 'comedia RTP handling' refers to the technique of sending RTP to the port that the
813 ; the other endpoint's RTP arrived from, and means 'connection-oriented media'. This is
814 ; only partially related to RFC 4145 which was referred to as COMEDIA while it was in
815 ; draft form. This method is used to accomodate endpoints that may be located behind
816 ; NAT devices, and as such the port number they tell Asterisk to send RTP packets to
817 ; for their media streams is not actual port number that will be used on the nearer
818 ; side of the NAT.
819 ;
820 ; In addition to these settings, Asterisk *always* uses 'symmetric RTP' mode as defined by
821 ; RFC 4961; Asterisk will always send RTP packets from the same port number it expects
822 ; to receive them on.
823 ;
824 ; The IP address used for media (audio, video, and text) in the SDP can also be overridden by using
825 ; the media_address configuration option. This is only applicable to the general section and
826 ; can not be set per-user or per-peer.
827 ;
828 ; media_address = 172.16.42.1
829 ;
830 ; Through the use of the res_stun_monitor module, Asterisk has the ability to detect when the
831 ; perceived external network address has changed.  When the stun_monitor is installed and
832 ; configured, chan_sip will renew all outbound registrations when the monitor detects any sort
833 ; of network change has occurred. By default this option is enabled, but only takes effect once
834 ; res_stun_monitor is configured.  If res_stun_monitor is enabled and you wish to not
835 ; generate all outbound registrations on a network change, use the option below to disable
836 ; this feature.
837 ;
838 ; subscribe_network_change_event = yes ; on by default
839
840 ;----------------------------------- MEDIA HANDLING --------------------------------
841 ; By default, Asterisk tries to re-invite media streams to an optimal path. If there's
842 ; no reason for Asterisk to stay in the media path, the media will be redirected.
843 ; This does not really work well in the case where Asterisk is outside and the
844 ; clients are on the inside of a NAT. In that case, you want to set directmedia=nonat.
845 ;
846 ;directmedia=yes                ; Asterisk by default tries to redirect the
847                                 ; RTP media stream to go directly from
848                                 ; the caller to the callee.  Some devices do not
849                                 ; support this (especially if one of them is behind a NAT).
850                                 ; The default setting is YES. If you have all clients
851                                 ; behind a NAT, or for some other reason want Asterisk to
852                                 ; stay in the audio path, you may want to turn this off.
853
854                                 ; This setting also affect direct RTP
855                                 ; at call setup (a new feature in 1.4 - setting up the
856                                 ; call directly between the endpoints instead of sending
857                                 ; a re-INVITE).
858
859                                 ; Additionally this option does not disable all reINVITE operations.
860                                 ; It only controls Asterisk generating reINVITEs for the specific
861                                 ; purpose of setting up a direct media path. If a reINVITE is
862                                 ; needed to switch a media stream to inactive (when placed on
863                                 ; hold) or to T.38, it will still be done, regardless of this 
864                                 ; setting. Note that direct T.38 is not supported.
865
866 ;directmedia=nonat              ; An additional option is to allow media path redirection
867                                 ; (reinvite) but only when the peer where the media is being
868                                 ; sent is known to not be behind a NAT (as the RTP core can
869                                 ; determine it based on the apparent IP address the media
870                                 ; arrives from).
871
872 ;directmedia=update             ; Yet a third option... use UPDATE for media path redirection,
873                                 ; instead of INVITE. This can be combined with 'nonat', as
874                                 ; 'directmedia=update,nonat'. It implies 'yes'.
875
876 ;directrtpsetup=yes             ; Enable the new experimental direct RTP setup. This sets up
877                                 ; the call directly with media peer-2-peer without re-invites.
878                                 ; Will not work for video and cases where the callee sends
879                                 ; RTP payloads and fmtp headers in the 200 OK that does not match the
880                                 ; callers INVITE. This will also fail if directmedia is enabled when
881                                 ; the device is actually behind NAT.
882
883 ;directmediadeny=0.0.0.0/0      ; Use directmediapermit and directmediadeny to restrict 
884 ;directmediapermit=172.16.0.0/16; which peers should be able to pass directmedia to each other
885                                 ; (There is no default setting, this is just an example)
886                                 ; Use this if some of your phones are on IP addresses that
887                                 ; can not reach each other directly. This way you can force 
888                                 ; RTP to always flow through asterisk in such cases.
889
890 ;ignoresdpversion=yes           ; By default, Asterisk will honor the session version
891                                 ; number in SDP packets and will only modify the SDP
892                                 ; session if the version number changes. This option will
893                                 ; force asterisk to ignore the SDP session version number
894                                 ; and treat all SDP data as new data.  This is required
895                                 ; for devices that send us non standard SDP packets
896                                 ; (observed with Microsoft OCS). By default this option is
897                                 ; off.
898
899 ;sdpsession=Asterisk PBX        ; Allows you to change the SDP session name string, (s=)
900                                 ; Like the useragent parameter, the default user agent string
901                                 ; also contains the Asterisk version.
902 ;sdpowner=root                  ; Allows you to change the username field in the SDP owner string, (o=)
903                                 ; This field MUST NOT contain spaces
904 ;encryption=no                  ; Whether to offer SRTP encrypted media (and only SRTP encrypted media)
905                                 ; on outgoing calls to a peer. Calls will fail with HANGUPCAUSE=58 if
906                                 ; the peer does not support SRTP. Defaults to no.
907 ;encryption_taglen=80           ; Set the auth tag length offered in the INVITE either 32/80 default 80
908
909 ;----------------------------------------- REALTIME SUPPORT ------------------------
910 ; For additional information on ARA, the Asterisk Realtime Architecture,
911 ; please read https://wiki.asterisk.org/wiki/display/AST/Realtime+Database+Configuration
912 ;
913 ;rtcachefriends=yes             ; Cache realtime friends by adding them to the internal list
914                                 ; just like friends added from the config file only on a
915                                 ; as-needed basis? (yes|no)
916
917 ;rtsavesysname=yes              ; Save systemname in realtime database at registration
918                                 ; Default= no
919
920 ;rtupdate=yes                   ; Send registry updates to database using realtime? (yes|no)
921                                 ; If set to yes, when a SIP UA registers successfully, the ip address,
922                                 ; the origination port, the registration period, and the username of
923                                 ; the UA will be set to database via realtime.
924                                 ; If not present, defaults to 'yes'. Note: realtime peers will
925                                 ; probably not function across reloads in the way that you expect, if
926                                 ; you turn this option off.
927 ;rtautoclear=yes                ; Auto-Expire friends created on the fly on the same schedule
928                                 ; as if it had just registered? (yes|no|<seconds>)
929                                 ; If set to yes, when the registration expires, the friend will
930                                 ; vanish from the configuration until requested again. If set
931                                 ; to an integer, friends expire within this number of seconds
932                                 ; instead of the registration interval.
933
934 ;ignoreregexpire=yes            ; Enabling this setting has two functions:
935                                 ;
936                                 ; For non-realtime peers, when their registration expires, the
937                                 ; information will _not_ be removed from memory or the Asterisk database
938                                 ; if you attempt to place a call to the peer, the existing information
939                                 ; will be used in spite of it having expired
940                                 ;
941                                 ; For realtime peers, when the peer is retrieved from realtime storage,
942                                 ; the registration information will be used regardless of whether
943                                 ; it has expired or not; if it expires while the realtime peer
944                                 ; is still in memory (due to caching or other reasons), the
945                                 ; information will not be removed from realtime storage
946
947 ;----------------------------------------- SIP DOMAIN SUPPORT ------------------------
948 ; Incoming INVITE and REFER messages can be matched against a list of 'allowed'
949 ; domains, each of which can direct the call to a specific context if desired.
950 ; By default, all domains are accepted and sent to the default context or the
951 ; context associated with the user/peer placing the call.
952 ; REGISTER to non-local domains will be automatically denied if a domain
953 ; list is configured.
954 ;
955 ; Domains can be specified using:
956 ; domain=<domain>[,<context>]
957 ; Examples:
958 ; domain=myasterisk.dom
959 ; domain=customer.com,customer-context
960 ;
961 ; In addition, all the 'default' domains associated with a server should be
962 ; added if incoming request filtering is desired.
963 ; autodomain=yes
964 ;
965 ; To disallow requests for domains not serviced by this server:
966 ; allowexternaldomains=no
967
968 ;domain=mydomain.tld,mydomain-incoming
969                                 ; Add domain and configure incoming context
970                                 ; for external calls to this domain
971 ;domain=1.2.3.4                 ; Add IP address as local domain
972                                 ; You can have several "domain" settings
973 ;allowexternaldomains=no        ; Disable INVITE and REFER to non-local domains
974                                 ; Default is yes
975 ;autodomain=yes                 ; Turn this on to have Asterisk add local host
976                                 ; name and local IP to domain list.
977
978 ; fromdomain=mydomain.tld       ; When making outbound SIP INVITEs to
979                                 ; non-peers, use your primary domain "identity"
980                                 ; for From: headers instead of just your IP
981                                 ; address. This is to be polite and
982                                 ; it may be a mandatory requirement for some
983                                 ; destinations which do not have a prior
984                                 ; account relationship with your server.
985
986 ;------------------------------ Advice of Charge CONFIGURATION --------------------------
987 ; snom_aoc_enabled = yes;     ; This options turns on and off support for sending AOC-D and
988                               ; AOC-E to snom endpoints.  This option can be used both in the
989                               ; peer and global scope.  The default for this option is off.
990
991
992 ;------------------------------ JITTER BUFFER CONFIGURATION --------------------------
993 ; jbenable = yes              ; Enables the use of a jitterbuffer on the receiving side of a
994                               ; SIP channel. Defaults to "no". An enabled jitterbuffer will
995                               ; be used only if the sending side can create and the receiving
996                               ; side can not accept jitter. The SIP channel can accept jitter,
997                               ; thus a jitterbuffer on the receive SIP side will be used only
998                               ; if it is forced and enabled.
999
1000 ; jbforce = no                ; Forces the use of a jitterbuffer on the receive side of a SIP
1001                               ; channel. Defaults to "no".
1002
1003 ; jbmaxsize = 200             ; Max length of the jitterbuffer in milliseconds.
1004
1005 ; jbresyncthreshold = 1000    ; Jump in the frame timestamps over which the jitterbuffer is
1006                               ; resynchronized. Useful to improve the quality of the voice, with
1007                               ; big jumps in/broken timestamps, usually sent from exotic devices
1008                               ; and programs. Defaults to 1000.
1009
1010 ; jbimpl = fixed              ; Jitterbuffer implementation, used on the receiving side of a SIP
1011                               ; channel. Two implementations are currently available - "fixed"
1012                               ; (with size always equals to jbmaxsize) and "adaptive" (with
1013                               ; variable size, actually the new jb of IAX2). Defaults to fixed.
1014
1015 ; jbtargetextra = 40          ; This option only affects the jb when 'jbimpl = adaptive' is set.
1016                               ; The option represents the number of milliseconds by which the new jitter buffer
1017                               ; will pad its size. the default is 40, so without modification, the new
1018                               ; jitter buffer will set its size to the jitter value plus 40 milliseconds.
1019                               ; increasing this value may help if your network normally has low jitter,
1020                               ; but occasionally has spikes.
1021
1022 ; jblog = no                  ; Enables jitterbuffer frame logging. Defaults to "no".
1023
1024 ;----------------------------- SIP_CAUSE reporting ---------------------------------
1025 ; storesipcause = no          ; This option causes chan_sip to set the
1026                               ; HASH(SIP_CAUSE,<channel name>) channel variable
1027                               ; to the value of the last sip response.
1028                               ; WARNING: enabling this option carries a
1029                               ; significant performance burden. It should only
1030                               ; be used in low call volume situations. This
1031                               ; option defaults to "no".
1032
1033 ;-----------------------------------------------------------------------------------
1034
1035 [authentication]
1036 ; Global credentials for outbound calls, i.e. when a proxy challenges your
1037 ; Asterisk server for authentication. These credentials override
1038 ; any credentials in peer/register definition if realm is matched.
1039 ;
1040 ; This way, Asterisk can authenticate for outbound calls to other
1041 ; realms. We match realm on the proxy challenge and pick an set of
1042 ; credentials from this list
1043 ; Syntax:
1044 ;        auth = <user>:<secret>@<realm>
1045 ;        auth = <user>#<md5secret>@<realm>
1046 ; Example:
1047 ;auth=mark:topsecret@digium.com
1048 ;
1049 ; You may also add auth= statements to [peer] definitions
1050 ; Peer auth= override all other authentication settings if we match on realm
1051
1052 ;------------------------------------------------------------------------------
1053 ; DEVICE CONFIGURATION
1054 ;
1055 ; The SIP channel has two types of devices, the friend and the peer.
1056 ; * The type=friend is a device type that accepts both incoming and outbound calls,
1057 ;   where Asterisk match on the From: username on incoming calls.
1058 ;   (A synonym for friend is "user"). This is a type you use for your local
1059 ;   SIP phones.
1060 ; * The type=peer also handles both incoming and outbound calls. On inbound calls,
1061 ;   Asterisk only matches on IP/port, not on names. This is mostly used for SIP
1062 ;   trunks.
1063 ;
1064 ; Use remotesecret for outbound authentication, and secret for authenticating
1065 ; inbound requests. For historical reasons, if no remotesecret is supplied for an
1066 ; outbound registration or call, the secret will be used. 
1067 ;
1068 ; For device names, we recommend using only a-z, numerics (0-9) and underscore
1069 ;
1070 ; For local phones, type=friend works most of the time
1071 ;
1072 ; If you have one-way audio, you probably have NAT problems.
1073 ; If Asterisk is on a public IP, and the phone is inside of a NAT device
1074 ; you will need to configure nat option for those phones.
1075 ; Also, turn on qualify=yes to keep the nat session open
1076 ;
1077 ; Configuration options available
1078 ; --------------------
1079 ; context
1080 ; callingpres
1081 ; permit
1082 ; deny
1083 ; secret
1084 ; md5secret
1085 ; remotesecret
1086 ; transport
1087 ; dtmfmode
1088 ; directmedia
1089 ; nat
1090 ; callgroup
1091 ; pickupgroup
1092 ; language
1093 ; allow
1094 ; disallow
1095 ; insecure
1096 ; trustrpid
1097 ; progressinband
1098 ; promiscredir
1099 ; useclientcode
1100 ; accountcode
1101 ; setvar
1102 ; callerid
1103 ; amaflags
1104 ; callcounter
1105 ; busylevel
1106 ; allowoverlap
1107 ; allowsubscribe
1108 ; allowtransfer
1109 ; ignoresdpversion
1110 ; subscribecontext
1111 ; template
1112 ; videosupport
1113 ; maxcallbitrate
1114 ; rfc2833compensate
1115 ; mailbox
1116 ; session-timers
1117 ; session-expires
1118 ; session-minse
1119 ; session-refresher
1120 ; t38pt_usertpsource
1121 ; regexten
1122 ; fromdomain
1123 ; fromuser
1124 ; host
1125 ; port
1126 ; qualify
1127 ; defaultip
1128 ; defaultuser
1129 ; rtptimeout
1130 ; rtpholdtimeout
1131 ; sendrpid
1132 ; outboundproxy
1133 ; rfc2833compensate
1134 ; callbackextension
1135 ; registertrying
1136 ; timert1
1137 ; timerb
1138 ; qualifyfreq
1139 ; t38pt_usertpsource
1140 ; contactpermit         ; Limit what a host may register as (a neat trick
1141 ; contactdeny           ; is to register at the same IP as a SIP provider,
1142 ;                       ; then call oneself, and get redirected to that
1143 ;                       ; same location).
1144 ; directmediapermit
1145 ; directmediadeny
1146 ; unsolicited_mailbox
1147 ; use_q850_reason
1148 ; maxforwards
1149 ; encryption
1150 ; description           ; Used to provide a description of the peer in console output
1151
1152 ;[sip_proxy]
1153 ; For incoming calls only. Example: FWD (Free World Dialup)
1154 ; We match on IP address of the proxy for incoming calls
1155 ; since we can not match on username (caller id)
1156 ;type=peer
1157 ;context=from-fwd
1158 ;host=fwd.pulver.com
1159
1160 ;[sip_proxy-out]
1161 ;type=peer                        ; we only want to call out, not be called
1162 ;remotesecret=guessit             ; Our password to their service
1163 ;defaultuser=yourusername         ; Authentication user for outbound proxies
1164 ;fromuser=yourusername            ; Many SIP providers require this!
1165 ;fromdomain=provider.sip.domain
1166 ;host=box.provider.com
1167 ;transport=udp,tcp                ; This sets the default transport type to udp for outgoing, and will
1168 ;                                 ; accept both tcp and udp. The default transport type is only used for
1169 ;                                 ; outbound messages until a Registration takes place.  During the
1170 ;                                 ; peer Registration the transport type may change to another supported
1171 ;                                 ; type if the peer requests so.
1172
1173 ;usereqphone=yes                  ; This provider requires ";user=phone" on URI
1174 ;callcounter=yes                  ; Enable call counter
1175 ;busylevel=2                      ; Signal busy at 2 or more calls
1176 ;outboundproxy=proxy.provider.domain  ; send outbound signaling to this proxy, not directly to the peer
1177 ;port=80                          ; The port number we want to connect to on the remote side
1178                                   ; Also used as "defaultport" in combination with "defaultip" settings
1179
1180 ;--- sample definition for a provider
1181 ;[provider1]
1182 ;type=peer
1183 ;host=sip.provider1.com
1184 ;fromuser=4015552299              ; how your provider knows you
1185 ;remotesecret=youwillneverguessit ; The password we use to authenticate to them
1186 ;secret=gissadetdu                ; The password they use to contact us
1187 ;callbackextension=123            ; Register with this server and require calls coming back to this extension
1188 ;transport=udp,tcp                ; This sets the transport type to udp for outgoing, and will
1189 ;                                 ;   accept both tcp and udp. Default is udp. The first transport
1190 ;                                 ;   listed will always be used for outgoing connections.
1191 ;unsolicited_mailbox=4015552299   ; If the remote SIP server sends an unsolicited MWI NOTIFY message the new/old
1192 ;                                 ;   message count will be stored in the configured virtual mailbox. It can be used
1193 ;                                 ;   by any device supporting MWI by specifying <configured value>@SIP_Remote as the
1194 ;                                 ;   mailbox.
1195
1196 ;
1197 ; Because you might have a large number of similar sections, it is generally
1198 ; convenient to use templates for the common parameters, and add them
1199 ; the the various sections. Examples are below, and we can even leave
1200 ; the templates uncommented as they will not harm:
1201
1202 [basic-options](!)                ; a template
1203         dtmfmode=rfc2833
1204         context=from-office
1205         type=friend
1206
1207 [natted-phone](!,basic-options)   ; another template inheriting basic-options
1208         nat=yes
1209         directmedia=no
1210         host=dynamic
1211
1212 [public-phone](!,basic-options)   ; another template inheriting basic-options
1213         nat=no
1214         directmedia=yes
1215
1216 [my-codecs](!)                    ; a template for my preferred codecs
1217         disallow=all
1218         allow=ilbc
1219         allow=g729
1220         allow=gsm
1221         allow=g723
1222         allow=ulaw
1223         ; Or, more simply:
1224         ;allow=!all,ilbc,g729,gsm,g723,ulaw
1225
1226 [ulaw-phone](!)                   ; and another one for ulaw-only
1227         disallow=all
1228         allow=ulaw
1229         ; Again, more simply:
1230         ;allow=!all,ulaw
1231
1232 ; and finally instantiate a few phones
1233 ;
1234 ; [2133](natted-phone,my-codecs)
1235 ;        secret = peekaboo
1236 ; [2134](natted-phone,ulaw-phone)
1237 ;        secret = not_very_secret
1238 ; [2136](public-phone,ulaw-phone)
1239 ;        secret = not_very_secret_either
1240 ; ...
1241 ;
1242
1243 ; Standard configurations not using templates look like this:
1244 ;
1245 ;[grandstream1]
1246 ;type=friend
1247 ;context=from-sip                ; Where to start in the dialplan when this phone calls
1248 ;callerid=John Doe <1234>        ; Full caller ID, to override the phones config
1249                                  ; on incoming calls to Asterisk
1250 ;description=Courtesy Phone      ; Description of the peer. Shown when doing 'sip show peers'.
1251 ;host=192.168.0.23               ; we have a static but private IP address
1252                                  ; No registration allowed
1253 ;nat=no                          ; there is not NAT between phone and Asterisk
1254 ;directmedia=yes                 ; allow RTP voice traffic to bypass Asterisk
1255 ;dtmfmode=info                   ; either RFC2833 or INFO for the BudgeTone
1256 ;call-limit=1                    ; permit only 1 outgoing call and 1 incoming call at a time
1257                                  ; from the phone to asterisk (deprecated)
1258                                  ; 1 for the explicit peer, 1 for the explicit user,
1259                                  ; remember that a friend equals 1 peer and 1 user in
1260                                  ; memory
1261                                  ; There is no combined call counter for a "friend"
1262                                  ; so there's currently no way in sip.conf to limit
1263                                  ; to one inbound or outbound call per phone. Use
1264                                  ; the group counters in the dial plan for that.
1265                                  ;
1266 ;mailbox=1234@default            ; mailbox 1234 in voicemail context "default"
1267 ;disallow=all                    ; need to disallow=all before we can use allow=
1268 ;allow=ulaw                      ; Note: In user sections the order of codecs
1269                                  ; listed with allow= does NOT matter!
1270 ;allow=alaw
1271 ;allow=g723.1                    ; Asterisk only supports g723.1 pass-thru!
1272 ;allow=g729                      ; Pass-thru only unless g729 license obtained
1273 ;callingpres=allowed_passed_screen ; Set caller ID presentation
1274                                  ; See README.callingpres for more information
1275
1276 ;[xlite1]
1277 ; Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
1278 ; Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
1279 ;type=friend
1280 ;regexten=1234                   ; When they register, create extension 1234
1281 ;callerid="Jane Smith" <5678>
1282 ;host=dynamic                    ; This device needs to register
1283 ;nat=yes                         ; X-Lite is behind a NAT router
1284 ;directmedia=no                  ; Typically set to NO if behind NAT
1285 ;disallow=all
1286 ;allow=gsm                       ; GSM consumes far less bandwidth than ulaw
1287 ;allow=ulaw
1288 ;allow=alaw
1289 ;mailbox=1234@default,1233@default ; Subscribe to status of multiple mailboxes
1290 ;registertrying=yes              ; Send a 100 Trying when the device registers.
1291
1292 ;[snom]
1293 ;type=friend                     ; Friends place calls and receive calls
1294 ;context=from-sip                ; Context for incoming calls from this user
1295 ;secret=blah
1296 ;subscribecontext=localextensions ; Only allow SUBSCRIBE for local extensions
1297 ;language=de                     ; Use German prompts for this user
1298 ;host=dynamic                    ; This peer register with us
1299 ;dtmfmode=inband                 ; Choices are inband, rfc2833, or info
1300 ;defaultip=192.168.0.59          ; IP used until peer registers
1301 ;mailbox=1234@context,2345       ; Mailbox(-es) for message waiting indicator
1302 ;subscribemwi=yes                ; Only send notifications if this phone
1303                                  ; subscribes for mailbox notification
1304 ;vmexten=voicemail               ; dialplan extension to reach mailbox
1305                                  ; sets the Message-Account in the MWI notify message
1306                                  ; defaults to global vmexten which defaults to "asterisk"
1307 ;disallow=all
1308 ;allow=ulaw                      ; dtmfmode=inband only works with ulaw or alaw!
1309
1310
1311 ;[polycom]
1312 ;type=friend                     ; Friends place calls and receive calls
1313 ;context=from-sip                ; Context for incoming calls from this user
1314 ;secret=blahpoly
1315 ;host=dynamic                    ; This peer register with us
1316 ;dtmfmode=rfc2833                ; Choices are inband, rfc2833, or info
1317 ;defaultuser=polly               ; Username to use in INVITE until peer registers
1318 ;defaultip=192.168.40.123
1319                                  ; Normally you do NOT need to set this parameter
1320 ;disallow=all
1321 ;allow=ulaw                      ; dtmfmode=inband only works with ulaw or alaw!
1322 ;progressinband=no               ; Polycom phones don't work properly with "never"
1323
1324
1325 ;[pingtel]
1326 ;type=friend
1327 ;secret=blah
1328 ;host=dynamic
1329 ;insecure=port                   ; Allow matching of peer by IP address without
1330                                  ; matching port number
1331 ;insecure=invite                 ; Do not require authentication of incoming INVITEs
1332 ;insecure=port,invite            ; (both)
1333 ;qualify=1000                    ; Consider it down if it's 1 second to reply
1334                                  ; Helps with NAT session
1335                                  ; qualify=yes uses default value
1336 ;qualifyfreq=60                  ; Qualification: How often to check for the
1337                                  ; host to be up in seconds
1338                                  ; Set to low value if you use low timeout for
1339                                  ; NAT of UDP sessions
1340 ;
1341 ; Call group and Pickup group should be in the range from 0 to 63
1342 ;
1343 ;callgroup=1,3-4                 ; We are in caller groups 1,3,4
1344 ;pickupgroup=1,3-5               ; We can do call pick-p for call group 1,3,4,5
1345 ;defaultip=192.168.0.60          ; IP address to use if peer has not registered
1346 ;deny=0.0.0.0/0.0.0.0            ; ACL: Control access to this account based on IP address
1347 ;permit=192.168.0.60/255.255.255.0
1348 ;permit=192.168.0.60/24          ; we can also use CIDR notation for subnet masks
1349 ;permit=2001:db8::/32            ; IPv6 ACLs can be specified if desired. IPv6 ACLs
1350                                  ; apply only to IPv6 addresses, and IPv4 ACLs apply
1351                                  ; only to IPv4 addresses.
1352
1353 ;[cisco1]
1354 ;type=friend
1355 ;secret=blah
1356 ;qualify=200                     ; Qualify peer is no more than 200ms away
1357 ;nat=yes                         ; This phone may be natted
1358                                  ; Send SIP and RTP to the IP address that packet is
1359                                  ; received from instead of trusting SIP headers
1360 ;host=dynamic                    ; This device registers with us
1361 ;directmedia=no                  ; Asterisk by default tries to redirect the
1362                                  ; RTP media stream (audio) to go directly from
1363                                  ; the caller to the callee.  Some devices do not
1364                                  ; support this (especially if one of them is
1365                                  ; behind a NAT).
1366 ;defaultip=192.168.0.4           ; IP address to use until registration
1367 ;defaultuser=goran               ; Username to use when calling this device before registration
1368                                  ; Normally you do NOT need to set this parameter
1369 ;setvar=CUSTID=5678              ; Channel variable to be set for all calls from or to this device
1370 ;setvar=ATTENDED_TRANSFER_COMPLETE_SOUND=beep   ; This channel variable will
1371                                                 ; cause the given audio file to
1372                                                 ; be played upon completion of
1373                                                 ; an attended transfer.
1374
1375 ;[pre14-asterisk]
1376 ;type=friend
1377 ;secret=digium
1378 ;host=dynamic
1379 ;rfc2833compensate=yes          ; Compensate for pre-1.4 DTMF transmission from another Asterisk machine.
1380                                 ; You must have this turned on or DTMF reception will work improperly.
1381 ;t38pt_usertpsource=yes         ; Use the source IP address of RTP as the destination IP address for UDPTL packets
1382                                 ; if the nat option is enabled. If a single RTP packet is received Asterisk will know the
1383                                 ; external IP address of the remote device. If port forwarding is done at the client side
1384                                 ; then UDPTL will flow to the remote device.