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 ;
 176 ;--------------------------- RTP timers ----------------------------------------------------
 177 ; These timers are currently used for both audio and video streams. The RTP timeouts
 178 ; are only applied to the audio channel.
 179 ; The settings are settable in the global section as well as per device
 180 ;
 181 ;rtptimeout=60                  ; Terminate call if 60 seconds of no RTP or RTCP activity
 182                                 ; on the audio channel
 183                                 ; when we're not on hold. This is to be able to hangup
 184                                 ; a call in the case of a phone disappearing from the net,
 185                                 ; like a powerloss or grandma tripping over a cable.
 186 ;rtpholdtimeout=300             ; Terminate call if 300 seconds of no RTP or RTCP activity
 187                                 ; on the audio channel
 188                                 ; when we're on hold (must be > rtptimeout)
 189 ;rtpkeepalive=<secs>            ; Send keepalives in the RTP stream to keep NAT open
 190                                 ; (default is off - zero)
 191 ;--------------------------- SIP DEBUGGING ---------------------------------------------------
 192 ;sipdebug = yes                 ; Turn on SIP debugging by default, from
 193                                 ; the moment the channel loads this configuration
 194 ;recordhistory=yes              ; Record SIP history by default
 195                                 ; (see sip history / sip no history)
 196 ;dumphistory=yes                ; Dump SIP history at end of SIP dialogue
 197                                 ; SIP history is output to the DEBUG logging channel
 198
 199
 200 ;--------------------------- STATUS NOTIFICATIONS (SUBSCRIPTIONS) ----------------------------
 201 ; You can subscribe to the status of extensions with a "hint" priority
 202 ; (See extensions.conf.sample for examples)
 203 ; chan_sip support two major formats for notifications: dialog-info and SIMPLE
 204 ;
 205 ; You will get more detailed reports (busy etc) if you have a call limit set
 206 ; for a device. When the call limit is filled, we will indicate busy. Note that
 207 ; you need at least 2 in order to be able to do attended transfers.
 208 ;
 209 ; If you set the busy-level in addition to the call limit, we will indicate busy
 210 ; when we have a number of calls that matches busy-level, but still allow calls
 211 ; up to the call-limit. This allows for transfers while still having blinking
 212 ; lamps and queues understanding that a device is busy.
 213 ;
 214 ; For queues, you will need this level of detail in status reporting, regardless
 215 ; if you use SIP subscriptions. Queues and manager use the same internal interface
 216 ; for reading status information.
 217 ;
 218 ; Note: Subscriptions does not work if you have a realtime dialplan and use the
 219 ; realtime switch.
 220 ;
 221 ;allowsubscribe=no              ; Disable support for subscriptions. (Default is yes)
 222 ;subscribecontext = default     ; Set a specific context for SUBSCRIBE requests
 223                                 ; Useful to limit subscriptions to local extensions
 224                                 ; Settable per peer/user also
 225 ;notifyringing = yes            ; Notify subscriptions on RINGING state (default: no)
 226 ;notifyhold = yes               ; Notify subscriptions on HOLD state (default: no)
 227                                 ; Turning on notifyringing and notifyhold will add a lot
 228                                 ; more database transactions if you are using realtime.
 229 ;limitonpeer = yes              ; Apply call limits on peers only. This will improve
 230                                 ; status notification when you are using type=friend
 231                                 ; Inbound calls, that really apply to the user part
 232                                 ; of a friend will now be added to and compared with
 233                                 ; the peer limit instead of applying two call limits,
 234                                 ; one for the peer and one for the user.
 235
 236 ;----------------------------------------- T.38 FAX PASSTHROUGH SUPPORT -----------------------
 237 ;
 238 ; This setting is available in the [general] section as well as in device configurations.
 239 ; Setting this to yes, enables T.38 fax (UDPTL) passthrough on SIP to SIP calls, provided
 240 ; both parties have T38 support enabled in their Asterisk configuration
 241 ; This has to be enabled in the general section for all devices to work. You can then
 242 ; disable it on a per device basis.
 243 ;
 244 ; T.38 faxing only works in SIP to SIP calls, with no local or agent channel being used.
 245 ;
 246 ; t38pt_udptl = yes            ; Default false
 247 ;
 248 ;----------------------------------------- OUTBOUND SIP REGISTRATIONS  ------------------------
 249 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
 250 ; Format for the register statement is:
 251 ;       register => user[:secret[:authuser]]@host[:port][/extension]
 252 ;
 253 ; If no extension is given, the 's' extension is used. The extension needs to
 254 ; be defined in extensions.conf to be able to accept calls from this SIP proxy
 255 ; (provider).
 256 ;
 257 ; host is either a host name defined in DNS or the name of a section defined
 258 ; below.
 259 ;
 260 ; A similar effect can be achieved by adding a "callbackextension" option in a peer section.
 261 ; this is equivalent to having the following line in the general section:
 262 ;
 263 ;       register => username:secret@host/callbackextension
 264 ;
 265 ; and more readable because you don't have to write the parameters in two places
 266 ; (note that the "port" is ignored - this is a bug that should be fixed).
 267 ;
 268 ; Examples:
 269 ;
 270 ;register => 1234:password@mysipprovider.com
 271 ;
 272 ;     This will pass incoming calls to the 's' extension
 273 ;
 274 ;
 275 ;register => 2345:password@sip_proxy/1234
 276 ;
 277 ;    Register 2345 at sip provider 'sip_proxy'.  Calls from this provider
 278 ;    connect to local extension 1234 in extensions.conf, default context,
 279 ;    unless you configure a [sip_proxy] section below, and configure a
 280 ;    context.
 281 ;    Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
 282 ;    Tip 2: Use separate type=peer and type=user sections for SIP providers
 283 ;           (instead of type=friend) if you have calls in both directions
 284
 285 ;registertimeout=20             ; retry registration calls every 20 seconds (default)
 286 ;registerattempts=10            ; Number of registration attempts before we give up
 287                                 ; 0 = continue forever, hammering the other server
 288                                 ; until it accepts the registration
 289                                 ; Default is 0 tries, continue forever
 290
 291 ;----------------------------------------- NAT SUPPORT ------------------------
 292 ; The externip, externhost and localnet settings are used if you use Asterisk
 293 ; behind a NAT device to communicate with services on the outside.
 294
 295 ;externip = 200.201.202.203     ; Address that we're going to put in outbound SIP
 296                                 ; messages if we're behind a NAT
 297
 298                                 ; The externip and localnet is used
 299                                 ; when registering and communicating with other proxies
 300                                 ; that we're registered with
 301 ;externhost=foo.dyndns.net      ; Alternatively you can specify an
 302                                 ; external host, and Asterisk will
 303                                 ; perform DNS queries periodically.  Not
 304                                 ; recommended for production
 305                                 ; environments!  Use externip instead
 306 ;externrefresh=10               ; How often to refresh externhost if
 307                                 ; used
 308                                 ; You may add multiple local networks.  A reasonable
 309                                 ; set of defaults are:
 310 ;localnet=192.168.0.0/255.255.0.0; All RFC 1918 addresses are local networks
 311 ;localnet=10.0.0.0/255.0.0.0    ; Also RFC1918
 312 ;localnet=172.16.0.0/12         ; Another RFC1918 with CIDR notation
 313 ;localnet=169.254.0.0/255.255.0.0 ;Zero conf local network
 314
 315 ; The nat= setting is used when Asterisk is on a public IP, communicating with
 316 ; devices hidden behind a NAT device (broadband router).  If you have one-way
 317 ; audio problems, you usually have problems with your NAT configuration or your
 318 ; firewall's support of SIP+RTP ports.  You configure Asterisk choice of RTP
 319 ; ports for incoming audio in rtp.conf
 320 ;
 321 ;nat=no                         ; Global NAT settings  (Affects all peers and users)
 322                                 ; yes = Always ignore info and assume NAT
 323                                 ; no = Use NAT mode only according to RFC3581 (;rport)
 324                                 ; never = Never attempt NAT mode or RFC3581 support
 325                                 ; route = Assume NAT, don't send rport
 326                                 ; (work around more UNIDEN bugs)
 327
 328 ;----------------------------------- MEDIA HANDLING --------------------------------
 329 ; By default, Asterisk tries to re-invite the audio to an optimal path. If there's
 330 ; no reason for Asterisk to stay in the media path, the media will be redirected.
 331 ; This does not really work with in the case where Asterisk is outside and have
 332 ; clients on the inside of a NAT. In that case, you want to set canreinvite=nonat
 333 ;
 334 ;canreinvite=yes                ; Asterisk by default tries to redirect the
 335                                 ; RTP media stream (audio) to go directly from
 336                                 ; the caller to the callee.  Some devices do not
 337                                 ; support this (especially if one of them is behind a NAT).
 338                                 ; The default setting is YES. If you have all clients
 339                                 ; behind a NAT, or for some other reason wants Asterisk to
 340                                 ; stay in the audio path, you may want to turn this off.
 341
 342                                 ; This setting also affect direct RTP
 343                                 ; at call setup (a new feature in 1.4 - setting up the
 344                                 ; call directly between the endpoints instead of sending
 345                                 ; a re-INVITE).
 346
 347 ;directrtpsetup=yes             ; Enable the new experimental direct RTP setup. This sets up
 348                                 ; the call directly with media peer-2-peer without re-invites.
 349                                 ; Will not work for video and cases where the callee sends
 350                                 ; RTP payloads and fmtp headers in the 200 OK that does not match the
 351                                 ; callers INVITE.
 352
 353 ;canreinvite=nonat              ; An additional option is to allow media path redirection
 354                                 ; (reinvite) but only when the peer where the media is being
 355                                 ; sent is known to not be behind a NAT (as the RTP core can
 356                                 ; determine it based on the apparent IP address the media
 357                                 ; arrives from).
 358
 359 ;canreinvite=update             ; Yet a third option... use UPDATE for media path redirection,
 360                                 ; instead of INVITE. This can be combined with 'nonat', as
 361                                 ; 'canreinvite=update,nonat'. It implies 'yes'.
 362
 363 ;----------------------------------------- REALTIME SUPPORT ------------------------
 364 ; For additional information on ARA, the Asterisk Realtime Architecture,
 365 ; please read realtime.txt and extconfig.txt in the /doc directory of the
 366 ; source code.
 367 ;
 368 ;rtcachefriends=yes             ; Cache realtime friends by adding them to the internal list
 369                                 ; just like friends added from the config file only on a
 370                                 ; as-needed basis? (yes|no)
 371
 372 ;rtsavesysname=yes              ; Save systemname in realtime database at registration
 373                                 ; Default= no
 374
 375 ;rtupdate=yes                   ; Send registry updates to database using realtime? (yes|no)
 376                                 ; If set to yes, when a SIP UA registers successfully, the ip address,
 377                                 ; the origination port, the registration period, and the username of
 378                                 ; the UA will be set to database via realtime.
 379                                 ; If not present, defaults to 'yes'.
 380 ;rtautoclear=yes                ; Auto-Expire friends created on the fly on the same schedule
 381                                 ; as if it had just registered? (yes|no|<seconds>)
 382                                 ; If set to yes, when the registration expires, the friend will
 383                                 ; vanish from the configuration until requested again. If set
 384                                 ; to an integer, friends expire within this number of seconds
 385                                 ; instead of the registration interval.
 386
 387 ;ignoreregexpire=yes            ; Enabling this setting has two functions:
 388                                 ;
 389                                 ; For non-realtime peers, when their registration expires, the
 390                                 ; information will _not_ be removed from memory or the Asterisk database
 391                                 ; if you attempt to place a call to the peer, the existing information
 392                                 ; will be used in spite of it having expired
 393                                 ;
 394                                 ; For realtime peers, when the peer is retrieved from realtime storage,
 395                                 ; the registration information will be used regardless of whether
 396                                 ; it has expired or not; if it expires while the realtime peer
 397                                 ; is still in memory (due to caching or other reasons), the
 398                                 ; information will not be removed from realtime storage
 399
 400 ;----------------------------------------- SIP DOMAIN SUPPORT ------------------------
 401 ; Incoming INVITE and REFER messages can be matched against a list of 'allowed'
 402 ; domains, each of which can direct the call to a specific context if desired.
 403 ; By default, all domains are accepted and sent to the default context or the
 404 ; context associated with the user/peer placing the call.
 405 ; Domains can be specified using:
 406 ; domain=<domain>[,<context>]
 407 ; Examples:
 408 ; domain=myasterisk.dom
 409 ; domain=customer.com,customer-context
 410 ;
 411 ; In addition, all the 'default' domains associated with a server should be
 412 ; added if incoming request filtering is desired.
 413 ; autodomain=yes
 414 ;
 415 ; To disallow requests for domains not serviced by this server:
 416 ; allowexternaldomains=no
 417
 418 ;domain=mydomain.tld,mydomain-incoming
 419                                 ; Add domain and configure incoming context
 420                                 ; for external calls to this domain
 421 ;domain=1.2.3.4                 ; Add IP address as local domain
 422                                 ; You can have several "domain" settings
 423 ;allowexternalinvites=no        ; Disable INVITE and REFER to non-local domains
 424                                 ; Default is yes
 425 ;autodomain=yes                 ; Turn this on to have Asterisk add local host
 426                                 ; name and local IP to domain list.
 427
 428 ; fromdomain=mydomain.tld       ; When making outbound SIP INVITEs to
 429                                 ; non-peers, use your primary domain "identity"
 430                                 ; for From: headers instead of just your IP
 431                                 ; address. This is to be polite and
 432                                 ; it may be a mandatory requirement for some
 433                                 ; destinations which do not have a prior
 434                                 ; account relationship with your server.
 435
 436 ;------------------------------ JITTER BUFFER CONFIGURATION --------------------------
 437 ; jbenable = yes              ; Enables the use of a jitterbuffer on the receiving side of a
 438                               ; SIP channel. Defaults to "no". An enabled jitterbuffer will
 439                               ; be used only if the sending side can create and the receiving
 440                               ; side can not accept jitter. The SIP channel can accept jitter,
 441                               ; thus a jitterbuffer on the receive SIP side will be used only
 442                               ; if it is forced and enabled.
 443
 444 ; jbforce = no                ; Forces the use of a jitterbuffer on the receive side of a SIP
 445                               ; channel. Defaults to "no".
 446
 447 ; jbmaxsize = 200             ; Max length of the jitterbuffer in milliseconds.
 448
 449 ; jbresyncthreshold = 1000    ; Jump in the frame timestamps over which the jitterbuffer is
 450                               ; resynchronized. Useful to improve the quality of the voice, with
 451                               ; big jumps in/broken timestamps, usually sent from exotic devices
 452                               ; and programs. Defaults to 1000.
 453
 454 ; jbimpl = fixed              ; Jitterbuffer implementation, used on the receiving side of a SIP
 455                               ; channel. Two implementations are currently available - "fixed"
 456                               ; (with size always equals to jbmaxsize) and "adaptive" (with
 457                               ; variable size, actually the new jb of IAX2). Defaults to fixed.
 458
 459 ; jblog = no                  ; Enables jitterbuffer frame logging. Defaults to "no".
 460 ;-----------------------------------------------------------------------------------
 461
 462 [authentication]
 463 ; Global credentials for outbound calls, i.e. when a proxy challenges your
 464 ; Asterisk server for authentication. These credentials override
 465 ; any credentials in peer/register definition if realm is matched.
 466 ;
 467 ; This way, Asterisk can authenticate for outbound calls to other
 468 ; realms. We match realm on the proxy challenge and pick an set of
 469 ; credentials from this list
 470 ; Syntax:
 471 ;       auth = <user>:<secret>@<realm>
 472 ;       auth = <user>#<md5secret>@<realm>
 473 ; Example:
 474 ;auth=mark:topsecret@digium.com
 475 ;
 476 ; You may also add auth= statements to [peer] definitions
 477 ; Peer auth= override all other authentication settings if we match on realm
 478
 479 ;------------------------------------------------------------------------------
 480 ; Users and peers have different settings available. Friends have all settings,
 481 ; since a friend is both a peer and a user
 482 ;
 483 ; User config options:        Peer configuration:
 484 ; --------------------        -------------------
 485 ; context                     context
 486 ; callingpres                 callingpres
 487 ; permit                      permit
 488 ; deny                        deny
 489 ; secret                      secret
 490 ; md5secret                   md5secret
 491 ; dtmfmode                    dtmfmode
 492 ; canreinvite                 canreinvite
 493 ; nat                         nat
 494 ; callgroup                   callgroup
 495 ; pickupgroup                 pickupgroup
 496 ; language                    language
 497 ; allow                       allow
 498 ; disallow                    disallow
 499 ; insecure                    insecure
 500 ; trustrpid                   trustrpid
 501 ; progressinband              progressinband
 502 ; promiscredir                promiscredir
 503 ; useclientcode               useclientcode
 504 ; accountcode                 accountcode
 505 ; setvar                      setvar
 506 ; callerid                    callerid
 507 ; amaflags                    amaflags
 508 ; call-limit                  call-limit
 509 ; allowoverlap                allowoverlap
 510 ; allowsubscribe              allowsubscribe
 511 ; allowtransfer               allowtransfer
 512 ; subscribecontext            subscribecontext
 513 ; videosupport                videosupport
 514 ; maxcallbitrate              maxcallbitrate
 515 ; rfc2833compensate           mailbox
 516 ;                             busy-level
 517 ;                             username
 518 ;                             template
 519 ;                             fromdomain
 520 ;                             regexten
 521 ;                             fromuser
 522 ;                             host
 523 ;                             port
 524 ;                             qualify
 525 ;                             defaultip
 526 ;                             rtptimeout
 527 ;                             rtpholdtimeout
 528 ;                             sendrpid
 529 ;                             outboundproxy
 530 ;                             rfc2833compensate
 531 ;                             callbackextension
 532
 533 ;[sip_proxy]
 534 ; For incoming calls only. Example: FWD (Free World Dialup)
 535 ; We match on IP address of the proxy for incoming calls
 536 ; since we can not match on username (caller id)
 537 ;type=peer
 538 ;context=from-fwd
 539 ;host=fwd.pulver.com
 540
 541 ;[sip_proxy-out]
 542 ;type=peer                              ; we only want to call out, not be called
 543 ;secret=guessit
 544 ;username=yourusername                  ; Authentication user for outbound proxies
 545 ;fromuser=yourusername                  ; Many SIP providers require this!
 546 ;fromdomain=provider.sip.domain
 547 ;host=box.provider.com
 548 ;usereqphone=yes                        ; This provider requires ";user=phone" on URI
 549 ;call-limit=5                           ; permit only 5 simultaneous outgoing calls to this peer
 550                                         ; Call-limits will not be enforced on real-time peers,
 551                                         ; since they are not stored in-memory
 552 ;busy-level=2                           ; Signal busy at 2 or more calls
 553 ;outboundproxy=proxy.provider.domain    ; send outbound signaling to this proxy, not directly to the peer
 554 ;port=80                                ; The port number we want to connect to on the remote side
 555                                         ; Also used as "defaultport" in combination with "defaultip" settings
 556
 557 ;--- sample definition for a provider
 558 ;[provider1]
 559 ;type=peer
 560 ;host=sip.provider1.com
 561 ;username=4015552299            ; how your provider knows you
 562 ;secret=youwillneverguessit
 563 ;callbackextension=123          ; Register with this server and require calls coming back to this extension
 564
 565 ;------------------------------------------------------------------------------
 566 ; Definitions of locally connected SIP devices
 567 ;
 568 ; type = user   a device that authenticates to us by "from" field to place calls
 569 ; type = peer   a device we place calls to or that calls us and we match by host
 570 ; type = friend two configurations (peer+user) in one
 571 ;
 572 ; For device names, we recommend using only a-z, numerics (0-9) and underscore
 573 ;
 574 ; For local phones, type=friend works most of the time
 575 ;
 576 ; If you have one-way audio, you probably have NAT problems.
 577 ; If Asterisk is on a public IP, and the phone is inside of a NAT device
 578 ; you will need to configure nat option for those phones.
 579 ; Also, turn on qualify=yes to keep the nat session open
 580 ;
 581 ; Because you might have a large number of similar sections, it is generally
 582 ; convenient to use templates for the common parameters, and add them
 583 ; the the various sections. Examples are below, and we can even leave
 584 ; the templates uncommented as they will not harm:
 585
 586 [basic-options](!)              ; a template
 587         dtmfmode=rfc2833
 588         context=from-office
 589         type=friend
 590
 591 [natted-phone](!,basic-options) ; another template inheriting basic-options
 592         nat=yes
 593         canreinvite=no
 594         host=dynamic
 595
 596 [public-phone](!,basic-options) ; another template inheriting basic-options
 597         nat=no
 598         canreinvite=yes
 599
 600 [my-codecs](!)          ; a template for my preferred codecs
 601         disallow=all
 602         allow=ilbc
 603         allow=g729
 604         allow=gsm
 605         allow=g723
 606         allow=ulaw
 607
 608 [ulaw-phone](!)         ; and another one for ulaw-only
 609         disallow=all
 610         allow=ulaw
 611
 612 ; and finally instantiate a few phones
 613 ;
 614 ; [2133](natted-phone,my-codecs)
 615 ;       secret = peekaboo
 616 ; [2134](natted-phone,ulaw-hone)
 617 ;       secret = not_very_secret
 618 ; [2136](public-phone,ulaw-hone)
 619 ;       secret = not_very_secret_either
 620 ; ...
 621 ;
 622
 623 ; Standard configurations not using templates look like this:
 624 ;
 625 ;[grandstream1]
 626 ;type=friend
 627 ;context=from-sip               ; Where to start in the dialplan when this phone calls
 628 ;callerid=John Doe <1234>       ; Full caller ID, to override the phones config
 629                                 ; on incoming calls to Asterisk
 630 ;host=192.168.0.23              ; we have a static but private IP address
 631                                 ; No registration allowed
 632 ;nat=no                         ; there is not NAT between phone and Asterisk
 633 ;canreinvite=yes                ; allow RTP voice traffic to bypass Asterisk
 634 ;dtmfmode=info                  ; either RFC2833 or INFO for the BudgeTone
 635 ;call-limit=1                   ; permit only 1 outgoing call and 1 incoming call at a time
 636                                 ; from the phone to asterisk
 637                                 ; 1 for the explicit peer, 1 for the explicit user,
 638                                 ; remember that a friend equals 1 peer and 1 user in
 639                                 ; memory
 640                                 ; This will affect your subscriptions as well.
 641                                 ; There is no combined call counter for a "friend"
 642                                 ; so there's currently no way in sip.conf to limit
 643                                 ; to one inbound or outbound call per phone. Use
 644                                 ; the group counters in the dial plan for that.
 645                                 ;
 646 ;mailbox=1234@default           ; mailbox 1234 in voicemail context "default"
 647 ;disallow=all                   ; need to disallow=all before we can use allow=
 648 ;allow=ulaw                     ; Note: In user sections the order of codecs
 649                                 ; listed with allow= does NOT matter!
 650 ;allow=alaw
 651 ;allow=g723.1                   ; Asterisk only supports g723.1 pass-thru!
 652 ;allow=g729                     ; Pass-thru only unless g729 license obtained
 653 ;callingpres=allowed_passed_screen      ; Set caller ID presentation
 654                                 ; See README.callingpres for more information
 655
 656
 657 ;[xlite1]
 658 ; Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
 659 ; Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
 660 ;type=friend
 661 ;regexten=1234                  ; When they register, create extension 1234
 662 ;callerid="Jane Smith" <5678>
 663 ;host=dynamic                   ; This device needs to register
 664 ;nat=yes                        ; X-Lite is behind a NAT router
 665 ;canreinvite=no                 ; Typically set to NO if behind NAT
 666 ;disallow=all
 667 ;allow=gsm                      ; GSM consumes far less bandwidth than ulaw
 668 ;allow=ulaw
 669 ;allow=alaw
 670 ;mailbox=1234@default,1233@default      ; Subscribe to status of multiple mailboxes
 671
 672
 673 ;[snom]
 674 ;type=friend                    ; Friends place calls and receive calls
 675 ;context=from-sip               ; Context for incoming calls from this user
 676 ;secret=blah
 677 ;subscribecontext=localextensions       ; Only allow SUBSCRIBE for local extensions
 678 ;language=de                    ; Use German prompts for this user
 679 ;host=dynamic                   ; This peer register with us
 680 ;dtmfmode=inband                ; Choices are inband, rfc2833, or info
 681 ;defaultip=192.168.0.59         ; IP used until peer registers
 682 ;mailbox=1234@context,2345      ; Mailbox(-es) for message waiting indicator
 683 ;subscribemwi=yes               ; Only send notifications if this phone
 684                                 ; subscribes for mailbox notification
 685 ;vmexten=voicemail              ; dialplan extension to reach mailbox
 686                                 ; sets the Message-Account in the MWI notify message
 687                                 ; defaults to global vmexten which defaults to "asterisk"
 688 ;disallow=all
 689 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
 690
 691
 692 ;[polycom]
 693 ;type=friend                    ; Friends place calls and receive calls
 694 ;context=from-sip               ; Context for incoming calls from this user
 695 ;secret=blahpoly
 696 ;host=dynamic                   ; This peer register with us
 697 ;dtmfmode=rfc2833               ; Choices are inband, rfc2833, or info
 698 ;username=polly                 ; Username to use in INVITE until peer registers
 699                                 ; Normally you do NOT need to set this parameter
 700 ;disallow=all
 701 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
 702 ;progressinband=no              ; Polycom phones don't work properly with "never"
 703
 704
 705 ;[pingtel]
 706 ;type=friend
 707 ;secret=blah
 708 ;host=dynamic
 709 ;insecure=port                  ; Allow matching of peer by IP address without
 710                                 ; matching port number
 711 ;insecure=invite                ; Do not require authentication of incoming INVITEs
 712 ;insecure=port,invite           ; (both)
 713 ;qualify=1000                   ; Consider it down if it's 1 second to reply
 714                                 ; Helps with NAT session
 715                                 ; qualify=yes uses default value
 716 ;
 717 ; Call group and Pickup group should be in the range from 0 to 63
 718 ;
 719 ;callgroup=1,3-4                ; We are in caller groups 1,3,4
 720 ;pickupgroup=1,3-5              ; We can do call pick-p for call group 1,3,4,5
 721 ;defaultip=192.168.0.60         ; IP address to use if peer has not registered
 722 ;deny=0.0.0.0/0.0.0.0           ; ACL: Control access to this account based on IP address
 723 ;permit=192.168.0.60/255.255.255.0
 724
 725 ;[cisco1]
 726 ;type=friend
 727 ;secret=blah
 728 ;qualify=200                    ; Qualify peer is no more than 200ms away
 729 ;nat=yes                        ; This phone may be natted
 730                                 ; Send SIP and RTP to the IP address that packet is
 731                                 ; received from instead of trusting SIP headers
 732 ;host=dynamic                   ; This device registers with us
 733 ;canreinvite=no                 ; Asterisk by default tries to redirect the
 734                                 ; RTP media stream (audio) to go directly from
 735                                 ; the caller to the callee.  Some devices do not
 736                                 ; support this (especially if one of them is
 737                                 ; behind a NAT).
 738 ;defaultip=192.168.0.4          ; IP address to use until registration
 739 ;username=goran                 ; Username to use when calling this device before registration
 740                                 ; Normally you do NOT need to set this parameter
 741 ;setvar=CUSTID=5678             ; Channel variable to be set for all calls from this device
 742
 743 ;[pre14-asterisk]
 744 ;type=friend
 745 ;secret=digium
 746 ;host=dynamic
 747 ;rfc2833compensate=yes          ; Compensate for pre-1.4 DTMF transmission from another Asterisk machine.
 748                                 ; You must have this turned on or DTMF reception will work improperly.