res_pjsip_session: Enable RFC3578 overlap dialing support.
[asterisk/asterisk.git] / configs / samples / pjsip.conf.sample
1 ; PJSIP Configuration Samples and Quick Reference
2 ;
3 ; This file has several very basic configuration examples, to serve as a quick
4 ; reference to jog your memory when you need to write up a new configuration.
5 ; It is not intended to teach PJSIP configuration or serve as an exhaustive
6 ; reference of options and potential scenarios.
7 ;
8 ; This file has two main sections.
9 ; First, manually written examples to serve as a handy reference.
10 ; Second, a list of all possible PJSIP config options by section. This is
11 ; pulled from the XML config help. It only shows the synopsis for every item.
12 ; If you want to see more detail please check the documentation sources
13 ; mentioned at the top of this file.
14
15 ; ============================================================================
16 ; NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE NOTICE
17 ;
18 ; This file does not maintain the complete option documentation.
19 ; ============================================================================
20
21 ; Documentation
22 ;
23 ; The official documentation is at http://wiki.asterisk.org
24 ; You can read the XML configuration help via Asterisk command line with
25 ; "config show help res_pjsip", then you can drill down through the various
26 ; sections and their options.
27 ;
28
29 ;========!!!!!!!!!!!!!!!!!!!  SECURITY NOTICE  !!!!!!!!!!!!!!!!!!!!===========
30 ;
31 ; At a minimum please read the file "README-SERIOUSLY.bestpractices.txt",
32 ; located in the Asterisk source directory before starting Asterisk.
33 ; Otherwise you risk allowing the security of the Asterisk system to be
34 ; compromised. Beyond that please visit and read the security information on
35 ; the wiki at: https://wiki.asterisk.org/wiki/x/EwFB
36 ;
37 ; A few basics to pay attention to:
38 ;
39 ; Anonymous Calls
40 ;
41 ; By default anonymous inbound calls via PJSIP are not allowed. If you want to
42 ; route anonymous calls you'll need to define an endpoint named "anonymous".
43 ; res_pjsip_endpoint_identifier_anonymous.so handles that functionality so it
44 ; must be loaded. It is not recommended to accept anonymous calls.
45 ;
46 ; Access Control Lists
47 ;
48 ; See the example ACL configuration in this file. Read the configuration help
49 ; for the section and all of its options. Look over the samples in acl.conf
50 ; and documentation at https://wiki.asterisk.org/wiki/x/uA80AQ
51 ; If possible, restrict access to only networks and addresses you trust.
52 ;
53 ; Dialplan Contexts
54 ;
55 ; When defining configuration (such as an endpoint) that links into
56 ; dialplan configuration, be aware of what that dialplan does. It's easy to
57 ; accidentally provide access to internal or outbound dialing extensions which
58 ; could cost you severely. The "context=" line in endpoint configuration
59 ; determines which dialplan context inbound calls will enter into.
60 ;
61 ;=============================================================================
62
63 ; Overview of Configuration Section Types Used in the Examples
64 ;
65 ; * Transport "transport"
66 ;   * Configures res_pjsip transport layer interaction.
67 ; * Endpoint "endpoint"
68 ;   * Configures core SIP functionality related to SIP endpoints.
69 ; * Authentication "auth"
70 ;   * Stores inbound or outbound authentication credentials for use by trunks,
71 ;     endpoints, registrations.
72 ; * Address of Record "aor"
73 ;   * Stores contact information for use by endpoints.
74 ; * Endpoint Identification "identify"
75 ;   * Maps a host directly to an endpoint
76 ; * Access Control List "acl"
77 ;   * Defines a permission list or references one stored in acl.conf
78 ; * Registration "registration"
79 ;   * Contains information about an outbound SIP registration
80 ; * Phone Provisioning "phoneprov"
81 ;   * Contains information needed by res_phoneprov for autoprovisioning
82
83 ; The following sections show example configurations for various scenarios.
84 ; Most require a couple or more configuration types configured in concert.
85
86 ;=============================================================================
87
88 ; Naming of Configuration Sections
89 ;
90 ; Configuration section names are denoted with enclosing brackets,
91 ; e.g. [6001]
92 ; In most cases, you can name a section whatever makes sense to you. For example
93 ; you might name a transport [transport-udp-nat] to help you remember how that
94 ; section is being used. However, in some cases, ("endpoint" and "aor" types)
95 ; the section name has a relationship to its function.
96 ;
97 ; Depending on the modules loaded, Asterisk can match SIP requests to an
98 ; endpoint or aor in a few ways:
99 ;
100 ; 1) Match a section name for endpoint type sections to the username in the
101 ;    "From" header of inbound SIP requests.
102 ; 2) Match a section name for aor type sections to the username in the "To"
103 ;    header of inbound SIP REGISTER requests.
104 ; 3) With an identify type section configured, match an inbound SIP request of
105 ;    any type to an endpoint or aor based on the IP source address of the
106 ;    request.
107 ;
108 ; Note that sections can have the same name as long as their "type" options are
109 ; set to different values. In most cases it makes sense to have associated
110 ; configuration sections use the same name, as you'll see in the examples within
111 ; this file.
112
113 ;===============EXAMPLE TRANSPORTS============================================
114 ;
115 ; A few examples for potential transport options.
116 ;
117 ; For the NAT transport example, be aware that the options starting with
118 ; the prefix "external_" will only apply to communication with addresses
119 ; outside the range set with "local_net=".
120 ;
121 ; You can have more than one of any type of transport, as long as it doesn't
122 ; use the same resources (bind address, port, etc) as the others.
123
124 ; Basic UDP transport
125 ;
126 ;[transport-udp]
127 ;type=transport
128 ;protocol=udp    ;udp,tcp,tls,ws,wss
129 ;bind=0.0.0.0
130
131 ; UDP transport behind NAT
132 ;
133 ;[transport-udp-nat]
134 ;type=transport
135 ;protocol=udp
136 ;bind=0.0.0.0
137 ;local_net=192.0.2.0/24
138 ;external_media_address=203.0.113.1
139 ;external_signaling_address=203.0.113.1
140
141 ; Basic IPv6 UDP transport
142 ;
143 ;[transport-udp-ipv6]
144 ;type=transport
145 ;protocol=udp
146 ;bind=::
147
148 ; Example IPv4 TLS transport
149 ;
150 ;[transport-tls]
151 ;type=transport
152 ;protocol=tls
153 ;bind=0.0.0.0
154 ;cert_file=/path/mycert.crt
155 ;priv_key_file=/path/mykey.key
156 ;cipher=ADH-AES256-SHA,ADH-AES128-SHA
157 ;method=tlsv1
158
159
160 ;===============OUTBOUND REGISTRATION WITH OUTBOUND AUTHENTICATION============
161 ;
162 ; This is a simple registration that works with some SIP trunking providers.
163 ; You'll need to set up the auth example "mytrunk_auth" below to enable outbound
164 ; authentication. Note that we "outbound_auth=" use for outbound authentication
165 ; instead of "auth=", which is for inbound authentication.
166 ;
167 ; If you are registering to a server from behind NAT, be sure you assign a transport
168 ; that is appropriately configured with NAT related settings. See the NAT transport example.
169 ;
170 ; "contact_user=" sets the SIP contact header's user portion of the SIP URI
171 ; this will affect the extension reached in dialplan when the far end calls you at this
172 ; registration. The default is 's'.
173 ;
174 ; If you would like to enable line support and have incoming calls related to this
175 ; registration go to an endpoint automatically the "line" and "endpoint" options must
176 ; be set. The "endpoint" option specifies what endpoint the incoming call should be
177 ; associated with.
178
179 ;[mytrunk]
180 ;type=registration
181 ;transport=transport-udp
182 ;outbound_auth=mytrunk_auth
183 ;server_uri=sip:sip.example.com
184 ;client_uri=sip:1234567890@sip.example.com
185 ;contact_user=1234567890
186 ;retry_interval=60
187 ;forbidden_retry_interval=600
188 ;expiration=3600
189 ;line=yes
190 ;endpoint=mytrunk
191
192 ;[mytrunk_auth]
193 ;type=auth
194 ;auth_type=userpass
195 ;password=1234567890
196 ;username=1234567890
197 ;realm=sip.example.com
198
199 ;===============ENDPOINT CONFIGURED AS A TRUNK, OUTBOUND AUTHENTICATION=======
200 ;
201 ; This is one way to configure an endpoint as a trunk. It is set up with
202 ; "outbound_auth=" to enable authentication when dialing out through this
203 ; endpoint. There is no inbound authentication set up since a provider will
204 ; not normally authenticate when calling you.
205 ;
206 ; The identify configuration enables IP address matching against this endpoint.
207 ; For calls from a trunking provider, the From user may be different every time,
208 ; so we want to match against IP address instead of From user.
209 ;
210 ; If you want the provider of your trunk to know where to send your calls
211 ; you'll need to use an outbound registration as in the example above this
212 ; section.
213 ;
214 ; NAT
215 ;
216 ; At a basic level configure the endpoint with a transport that is set up
217 ; with the appropriate NAT settings. There may be some additional settings you
218 ; need here based on your NAT/Firewall scenario. Look to the CLI config help
219 ; "config show help res_pjsip endpoint" or on the wiki for other NAT related
220 ; options and configuration. We've included a few below.
221 ;
222 ; AOR
223 ;
224 ; Endpoints use one or more AOR sections to store their contact details.
225 ; You can define multiple contact addresses in SIP URI format in multiple
226 ; "contact=" entries.
227 ;
228
229 ;[mytrunk]
230 ;type=endpoint
231 ;transport=transport-udp
232 ;context=from-external
233 ;disallow=all
234 ;allow=ulaw
235 ;outbound_auth=mytrunk_auth
236 ;aors=mytrunk
237 ;                   ;A few NAT relevant options that may come in handy.
238 ;force_rport=yes    ;It's a good idea to read the configuration help for each
239 ;direct_media=no    ;of these options.
240 ;ice_support=yes
241
242 ;[mytrunk]
243 ;type=aor
244 ;contact=sip:198.51.100.1:5060
245 ;contact=sip:198.51.100.2:5060
246
247 ;[mytrunk]
248 ;type=identify
249 ;endpoint=mytrunk
250 ;match=198.51.100.1
251 ;match=198.51.100.2
252
253
254 ;=============ENDPOINT CONFIGURED AS A TRUNK, INBOUND AUTH AND REGISTRATION===
255 ;
256 ; Here we are allowing a remote device to register to Asterisk and requiring
257 ; that they authenticate for registration and calls.
258 ; You'll note that this configuration is essentially the same as configuring
259 ; an endpoint for use with a SIP phone.
260
261
262 ;[7000]
263 ;type=endpoint
264 ;context=from-external
265 ;disallow=all
266 ;allow=ulaw
267 ;transport=transport-udp
268 ;auth=7000
269 ;aors=7000
270
271 ;[7000]
272 ;type=auth
273 ;auth_type=userpass
274 ;password=7000
275 ;username=7000
276
277 ;[7000]
278 ;type=aor
279 ;max_contacts=1
280
281
282 ;===============ENDPOINT CONFIGURED FOR USE WITH A SIP PHONE==================
283 ;
284 ; This example includes the endpoint, auth and aor configurations. It
285 ; requires inbound authentication and allows registration, as well as references
286 ; a transport that you'll need to uncomment from the previous examples.
287 ;
288 ; Uncomment one of the transport lines to choose which transport you want. If
289 ; not specified then the default transport chosen is the first defined transport
290 ; in the configuration file.
291 ;
292 ; Modify the "max_contacts=" line to change how many unique registrations to allow.
293 ;
294 ; Use the "contact=" line instead of max_contacts= if you want to statically
295 ; define the location of the device.
296 ;
297 ; If using the TLS enabled transport, you may want the "media_encryption=sdes"
298 ; option to additionally enable SRTP, though they are not mutually inclusive.
299 ;
300 ; If this endpoint were remote, and it was using a transport configured for NAT
301 ; then you likely want to use "direct_media=no" to prevent audio issues.
302
303
304 ;[6001]
305 ;type=endpoint
306 ;transport=transport-udp
307 ;context=from-internal
308 ;disallow=all
309 ;allow=ulaw
310 ;allow=gsm
311 ;auth=6001
312 ;aors=6001
313 ;
314 ; A few more transports to pick from, and some related options below them.
315 ;
316 ;transport=transport-tls
317 ;media_encryption=sdes
318 ;transport=transport-udp-ipv6
319 ;transport=transport-udp-nat
320 ;direct_media=no
321 ;
322 ; MWI related options
323
324 ;aggregate_mwi=yes
325 ;mailboxes=6001@default,7001@default
326 ;mwi_from_user=6001
327 ;
328 ; Extension and Device state options
329 ;
330 ;device_state_busy_at=1
331 ;allow_subscribe=yes
332 ;sub_min_expiry=30
333
334 ;[6001]
335 ;type=auth
336 ;auth_type=userpass
337 ;password=6001
338 ;username=6001
339
340 ;[6001]
341 ;type=aor
342 ;max_contacts=1
343 ;contact=sip:6001@192.0.2.1:5060
344
345 ;===============ENDPOINT BEHIND NAT OR FIREWALL===============================
346 ;
347 ; This example assumes your transport is configured with a public IP and the
348 ; endpoint itself is behind NAT and maybe a firewall, rather than having
349 ; Asterisk behind NAT. For the sake of simplicity, we'll assume a typical
350 ; VOIP phone. The most important settings to configure are:
351 ;
352 ;  * direct_media, to ensure Asterisk stays in the media path
353 ;  * rtp_symmetric and force_rport options to help the far-end NAT/firewall
354 ;
355 ; Depending on the settings of your remote SIP device or NAT/firewall device
356 ; you may have to experiment with a combination of these settings.
357 ;
358 ; If both Asterisk and the remote phones are a behind NAT/firewall then you'll
359 ; have to make sure to use a transport with appropriate settings (as in the
360 ; transport-udp-nat example).
361 ;
362 ;[6002]
363 ;type=endpoint
364 ;transport=transport-udp
365 ;context=from-internal
366 ;disallow=all
367 ;allow=ulaw
368 ;auth=6002
369 ;aors=6002
370 ;direct_media=no
371 ;rtp_symmetric=yes
372 ;force_rport=yes
373 ;rewrite_contact=yes  ; necessary if endpoint does not know/register public ip:port
374 ;ice_support=yes   ;This is specific to clients that support NAT traversal
375                    ;for media via ICE,STUN,TURN. See the wiki at:
376                    ;https://wiki.asterisk.org/wiki/x/D4FHAQ
377                    ;for a deeper explanation of this topic.
378
379 ;[6002]
380 ;type=auth
381 ;auth_type=userpass
382 ;password=6002
383 ;username=6002
384
385 ;[6002]
386 ;type=aor
387 ;max_contacts=2
388
389
390 ;============EXAMPLE ACL CONFIGURATION==========================================
391 ;
392 ; The ACL or Access Control List section defines a set of permissions to permit
393 ; or deny access to various address or addresses. Alternatively it references an
394 ; ACL configuration already set in acl.conf.
395 ;
396 ; The ACL configuration is independent of individual endpoint configuration and
397 ; operates on all inbound SIP communication using res_pjsip.
398
399 ; Reference an ACL defined in acl.conf.
400 ;
401 ;[acl]
402 ;type=acl
403 ;acl=example_named_acl1
404
405 ; Reference a contactacl specifically.
406 ;
407 ;[acl]
408 ;type=acl
409 ;contact_acl=example_contact_acl1
410
411 ; Define your own ACL here in pjsip.conf and
412 ; permit or deny by IP address or range.
413 ;
414 ;[acl]
415 ;type=acl
416 ;deny=0.0.0.0/0.0.0.0
417 ;permit=209.16.236.0/24
418 ;deny=209.16.236.1
419
420 ; Restrict based on Contact Headers rather than IP.
421 ; Define options multiple times for various addresses or use a comma-delimited string.
422 ;
423 ;[acl]
424 ;type=acl
425 ;contact_deny=0.0.0.0/0.0.0.0
426 ;contact_permit=209.16.236.0/24
427 ;contact_permit=209.16.236.1
428 ;contact_permit=209.16.236.2,209.16.236.3
429
430 ; Restrict based on Contact Headers rather than IP and use
431 ; advanced syntax. Note the bang symbol used for "NOT", so we can deny
432 ; 209.16.236.12/32 within the permit= statement.
433 ;
434 ;[acl]
435 ;type=acl
436 ;contact_deny=0.0.0.0/0.0.0.0
437 ;contact_permit=209.16.236.0
438 ;permit=209.16.236.0/24, !209.16.236.12/32
439
440
441 ;============EXAMPLE RLS CONFIGURATION==========================================
442 ;
443 ;Asterisk provides support for RFC 4662 Resource List Subscriptions. This allows
444 ;for an endpoint to, through a single subscription, subscribe to the states of
445 ;multiple resources. Resource lists are configured in pjsip.conf using the
446 ;resource_list configuration object. Below is an example of a resource list that
447 ;allows an endpoint to subscribe to the presence of alice, bob, and carol.
448
449 ;[my_list]
450 ;type=resource_list
451 ;list_item=alice
452 ;list_item=bob
453 ;list_item=carol
454 ;event=presence
455
456 ;The "event" option in the resource list corresponds to the SIP event-package
457 ;that the subscribed resources belong to. A resource list can only provide states
458 ;for resources that belong to the same event-package. This means that you cannot
459 ;create a list that is a combination of presence and message-summary resources,
460 ;for instance. Any event-package that Asterisk supports can be used in a resource
461 ;list (presence, dialog, and message-summary). Whenever support for a new event-
462 ;package is added to Asterisk, support for that event-package in resource lists
463 ;will automatically be supported.
464
465 ;The "list_item" options indicate the names of resources to subscribe to. The
466 ;way these are interpreted is event-package specific. For instance, with presence
467 ;list_items, hints in the dialplan are looked up. With message-summary list_items,
468 ;mailboxes are looked up using your installed voicemail provider (app_voicemail
469 ;by default). Note that in the above example, the list_item options were given
470 ;one per line. However, it is also permissible to provide multiple list_item
471 ;options on a single line (e.g. list_item = alice,bob,carol).
472
473 ;In addition to the options presented in the above configuration, there are two
474 ;more configuration options that can be set.
475 ; * full_state: dictates whether Asterisk should always send the states of
476 ;   all resources in the list at once. Defaults to "no". You should only set
477 ;   this to "yes" if you are interoperating with an endpoint that does not
478 ;   behave correctly when partial state notifications are sent to it.
479 ; * notification_batch_interval: By default, Asterisk will send a NOTIFY request
480 ;   immediately when a resource changes state. This option causes Asterisk to
481 ;   start batching resource state changes for the specified number of milliseconds
482 ;   after a resource changes states. This way, if multiple resources change state
483 ;   within a brief interval, Asterisk can send a single NOTIFY request with all
484 ;   of the state changes reflected in it.
485
486 ;There is a limitation to the size of resource lists in Asterisk. If a constructed
487 ;notification from Asterisk will exceed 64000 bytes, then the message is deemed
488 ;too large to send. If you find that you are seeing error messages about SIP
489 ;NOTIFY requests being too large to send, consider breaking your lists into
490 ;sub-lists.
491
492 ;============EXAMPLE PHONEPROV CONFIGURATION================================
493
494 ; Before configuring provisioning here, see the documentation for res_phoneprov
495 ; and configure phoneprov.conf appropriately.
496
497 ; For each user to be autoprovisioned, a [phoneprov] configuration section
498 ; must be created.  At a minimum, the 'type', 'PROFILE' and 'MAC' variables must
499 ; be set.  All other variables are optional.
500 ; Example:
501
502 ;[1000]
503 ;type=phoneprov               ; must be specified as 'phoneprov'
504 ;endpoint=1000                ; Required only if automatic setting of
505                               ; USERNAME, SECRET, DISPLAY_NAME and CALLERID
506                               ; are needed.
507 ;PROFILE=digium               ; required
508 ;MAC=deadbeef4dad             ; required
509 ;SERVER=myserver.example.com  ; A standard variable
510 ;TIMEZONE=America/Denver      ; A standard variable
511 ;MYVAR=somevalue              ; A user confdigured variable
512
513 ; If the phoneprov sections have common variables, it is best to create a
514 ; phoneprov template.  The example below will produce the same configuration
515 ; as the one specified above except that MYVAR will be overridden for
516 ; the specific user.
517 ; Example:
518
519 ;[phoneprov_defaults](!)
520 ;type=phoneprov               ; must be specified as 'phoneprov'
521 ;PROFILE=digium               ; required
522 ;SERVER=myserver.example.com  ; A standard variable
523 ;TIMEZONE=America/Denver      ; A standard variable
524 ;MYVAR=somevalue              ; A user configured variable
525
526 ;[1000](phoneprov_defaults)
527 ;endpoint=1000                ; Required only if automatic setting of
528                               ; USERNAME, SECRET, DISPLAY_NAME and CALLERID
529                               ; are needed.
530 ;MAC=deadbeef4dad             ; required
531 ;MYVAR=someOTHERvalue         ; A user confdigured variable
532
533 ; To have USERNAME and SECRET automatically set, the endpoint
534 ; specified here must in turn have an outbound_auth section defined.
535
536 ; Fuller example:
537
538 ;[1000]
539 ;type=endpoint
540 ;outbound_auth=1000-auth
541 ;callerid=My Name <8005551212>
542 ;transport=transport-udp-nat
543
544 ;[1000-auth]
545 ;type=auth
546 ;auth_type=userpass
547 ;username=myname
548 ;password=mysecret
549
550 ;[phoneprov_defaults](!)
551 ;type=phoneprov               ; must be specified as 'phoneprov'
552 ;PROFILE=someprofile          ; required
553 ;SERVER=myserver.example.com  ; A standard variable
554 ;TIMEZONE=America/Denver      ; A standard variable
555 ;MYVAR=somevalue              ; A user configured variable
556
557 ;[1000](phoneprov_defaults)
558 ;endpoint=1000                ; Required only if automatic setting of
559                               ; USERNAME, SECRET, DISPLAY_NAME and CALLERID
560                               ; are needed.
561 ;MAC=deadbeef4dad             ; required
562 ;MYVAR=someUSERvalue          ; A user confdigured variable
563 ;LABEL=1000                   ; A standard variable
564
565 ; The previous sections would produce a template substitution map as follows:
566
567 ;MAC=deadbeef4dad               ;added by pp1000
568 ;USERNAME=myname                ;automatically added by 1000-auth username
569 ;SECRET=mysecret                ;automatically added by 1000-auth password
570 ;PROFILE=someprofile            ;added by defaults
571 ;SERVER=myserver.example.com    ;added by defaults
572 ;SERVER_PORT=5060               ;added by defaults
573 ;MYVAR=someUSERvalue            ;added by defaults but overdidden by user
574 ;CALLERID=8005551212            ;automatically added by 1000 callerid
575 ;DISPLAY_NAME=My Name           ;automatically added by 1000 callerid
576 ;TIMEZONE=America/Denver        ;added by defaults
577 ;TZOFFSET=252100                ;automatically calculated by res_phoneprov
578 ;DST_ENABLE=1                   ;automatically calculated by res_phoneprov
579 ;DST_START_MONTH=3              ;automatically calculated by res_phoneprov
580 ;DST_START_MDAY=9               ;automatically calculated by res_phoneprov
581 ;DST_START_HOUR=3               ;automatically calculated by res_phoneprov
582 ;DST_END_MONTH=11               ;automatically calculated by res_phoneprov
583 ;DST_END_MDAY=2                 ;automatically calculated by res_phoneprov
584 ;DST_END_HOUR=1                 ;automatically calculated by res_phoneprov
585 ;ENDPOINT_ID=1000               ;automatically added by this module
586 ;AUTH_ID=1000-auth              ;automatically added by this module
587 ;TRANSPORT_ID=transport-udp-nat ;automatically added by this module
588 ;LABEL=1000                     ;added by user
589
590 ; MODULE PROVIDING BELOW SECTION(S): res_pjsip
591 ;==========================ENDPOINT SECTION OPTIONS=========================
592 ;[endpoint]
593 ;  SYNOPSIS: Endpoint
594 ;100rel=yes     ; Allow support for RFC3262 provisional ACK tags (default:
595                 ; "yes")
596 ;aggregate_mwi=yes      ;  (default: "yes")
597 ;allow= ; Media Codec s to allow (default: "")
598 ;allow_overlap=yes ; Enable RFC3578 overlap dialing support. (default: "yes")
599 ;aors=  ; AoR s to be used with the endpoint (default: "")
600 ;auth=  ; Authentication Object s associated with the endpoint (default: "")
601 ;callerid=      ; CallerID information for the endpoint (default: "")
602 ;callerid_privacy=allowed_not_screened      ; Default privacy level (default: "allowed_not_screened")
603 ;callerid_tag=  ; Internal id_tag for the endpoint (default: "")
604 ;context=default        ; Dialplan context for inbound sessions (default:
605                         ; "default")
606 ;direct_media_glare_mitigation=none     ; Mitigation of direct media re INVITE
607                                         ; glare (default: "none")
608 ;direct_media_method=invite     ; Direct Media method type (default: "invite")
609 ;connected_line_method=invite   ; Connected line method type (default:
610                                 ; "invite")
611 ;direct_media=yes       ; Determines whether media may flow directly between
612                         ; endpoints (default: "yes")
613 ;disable_direct_media_on_nat=no ; Disable direct media session refreshes when
614                                 ; NAT obstructs the media session (default:
615                                 ; "no")
616 ;disallow=      ; Media Codec s to disallow (default: "")
617 ;dtmf_mode=rfc4733      ; DTMF mode (default: "rfc4733")
618 ;media_address=         ; IP address used in SDP for media handling (default: "")
619 ;bind_rtp_to_media_address=     ; Bind the RTP session to the media_address.
620                                 ; This causes all RTP packets to be sent from
621                                 ; the specified address. (default: "no")
622 ;force_rport=yes        ; Force use of return port (default: "yes")
623 ;ice_support=no ; Enable the ICE mechanism to help traverse NAT (default: "no")
624 ;identify_by=username   ; A comma-separated list of ways the Endpoint or AoR can be
625                         ; identified.
626                         ; "username": Identify by the From or To username and domain
627                         ; "auth_username": Identify by the Authorization username and realm
628                         ; In all cases, if an exact match on username and domain/realm fails,
629                         ; the match will be retried with just the username.
630                         ; (default: "username")
631 ;redirect_method=user   ; How redirects received from an endpoint are handled
632                         ; (default: "user")
633 ;mailboxes=     ; NOTIFY the endpoint when state changes for any of the specified mailboxes.
634                 ; Asterisk will send unsolicited MWI NOTIFY messages to the endpoint when state
635                 ; changes happen for any of the specified mailboxes. (default: "")
636 ;voicemail_extension= ; The voicemail extension to send in the NOTIFY Message-Account header
637                       ; (default: global/default_voicemail_extension)
638 ;mwi_subscribe_replaces_unsolicited=no
639                       ; An MWI subscribe will replace unsoliticed NOTIFYs
640                       ; (default: "no")
641 ;moh_suggest=default    ; Default Music On Hold class (default: "default")
642 ;moh_passthrough=yes    ; Pass Music On Hold through using SIP re-invites with sendonly
643                         ; when placing on hold and sendrecv when taking off hold
644 ;outbound_auth= ; Authentication object used for outbound requests (default:
645                 ; "")
646 ;outbound_proxy=        ; Proxy through which to send requests, a full SIP URI
647                         ; must be provided (default: "")
648 ;rewrite_contact=no     ; Allow Contact header to be rewritten with the source
649                         ; IP address port (default: "no")
650 ;rtp_symmetric=no       ; Enforce that RTP must be symmetric (default: "no")
651 ;send_diversion=yes     ; Send the Diversion header conveying the diversion
652                         ; information to the called user agent (default: "yes")
653 ;send_pai=no    ; Send the P Asserted Identity header (default: "no")
654 ;send_rpid=no   ; Send the Remote Party ID header (default: "no")
655 ;rpid_immediate=no      ; Send connected line updates on unanswered incoming calls immediately. (default: "no")
656 ;timers_min_se=90       ; Minimum session timers expiration period (default:
657                         ; "90")
658 ;timers=yes     ; Session timers for SIP packets (default: "yes")
659 ;timers_sess_expires=1800       ; Maximum session timer expiration period
660                                 ; (default: "1800")
661 ;transport=     ; Desired transport configuration (default: "")
662 ;trust_id_inbound=no    ; Accept identification information received from this
663                         ; endpoint (default: "no")
664 ;trust_id_outbound=no   ; Send private identification details to the endpoint
665                         ; (default: "no")
666 ;type=  ; Must be of type endpoint (default: "")
667 ;use_ptime=no   ; Use Endpoint s requested packetisation interval (default:
668                 ; "no")
669 ;use_avpf=no    ; Determines whether res_pjsip will use and enforce usage of
670                 ; AVPF for this endpoint (default: "no")
671 ;media_encryption=no    ; Determines whether res_pjsip will use and enforce
672                         ; usage of media encryption for this endpoint (default:
673                         ; "no")
674 ;media_encryption_optimistic=no ; Use encryption if possible but don't fail the call
675                                 ; if not possible.
676 ;g726_non_standard=no   ; When set to "yes" and an endpoint negotiates g.726
677                         ; audio then g.726 for AAL2 packing order is used contrary
678                         ; to what is recommended in RFC3551. Note, 'g726aal2' also
679                         ; needs to be specified in the codec allow list
680                         ; (default: "no")
681 ;inband_progress=no     ; Determines whether chan_pjsip will indicate ringing
682                         ; using inband progress (default: "no")
683 ;call_group=    ; The numeric pickup groups for a channel (default: "")
684 ;pickup_group=  ; The numeric pickup groups that a channel can pickup (default:
685                 ; "")
686 ;named_call_group=      ; The named pickup groups for a channel (default: "")
687 ;named_pickup_group=    ; The named pickup groups that a channel can pickup
688                         ; (default: "")
689 ;device_state_busy_at=0 ; The number of in use channels which will cause busy
690                         ; to be returned as device state (default: "0")
691 ;t38_udptl=no   ; Whether T 38 UDPTL support is enabled or not (default: "no")
692 ;t38_udptl_ec=none      ; T 38 UDPTL error correction method (default: "none")
693 ;t38_udptl_maxdatagram=0        ; T 38 UDPTL maximum datagram size (default:
694                                 ; "0")
695 ;fax_detect=no  ; Whether CNG tone detection is enabled (default: "no")
696 ;fax_detect_timeout=30  ; How many seconds into a call before fax_detect is
697                         ; disabled for the call.
698                         ; Zero disables the timeout.
699                         ; (default: "0")
700 ;t38_udptl_nat=no       ; Whether NAT support is enabled on UDPTL sessions
701                         ; (default: "no")
702 ;tone_zone=     ; Set which country s indications to use for channels created
703                 ; for this endpoint (default: "")
704 ;language=      ; Set the default language to use for channels created for this
705                 ; endpoint (default: "")
706 ;one_touch_recording=no ; Determines whether one touch recording is allowed for
707                         ; this endpoint (default: "no")
708 ;record_on_feature=automixmon   ; The feature to enact when one touch recording
709                                 ; is turned on (default: "automixmon")
710 ;record_off_feature=automixmon  ; The feature to enact when one touch recording
711                                 ; is turned off (default: "automixmon")
712 ;rtp_engine=asterisk    ; Name of the RTP engine to use for channels created
713                         ; for this endpoint (default: "asterisk")
714 ;allow_transfer=yes     ; Determines whether SIP REFER transfers are allowed
715                         ; for this endpoint (default: "yes")
716 ;sdp_owner=-    ; String placed as the username portion of an SDP origin o line
717                 ; (default: "-")
718 ;sdp_session=Asterisk   ; String used for the SDP session s line (default:
719                         ; "Asterisk")
720 ;tos_audio=0    ; DSCP TOS bits for audio streams (default: "0")
721 ;tos_video=0    ; DSCP TOS bits for video streams (default: "0")
722 ;cos_audio=0    ; Priority for audio streams (default: "0")
723 ;cos_video=0    ; Priority for video streams (default: "0")
724 ;allow_subscribe=yes    ; Determines if endpoint is allowed to initiate
725                         ; subscriptions with Asterisk (default: "yes")
726 ;sub_min_expiry=0       ; The minimum allowed expiry time for subscriptions
727                         ; initiated by the endpoint (default: "0")
728 ;from_user=     ; Username to use in From header for requests to this endpoint
729                 ; (default: "")
730 ;mwi_from_user= ; Username to use in From header for unsolicited MWI NOTIFYs to
731                 ; this endpoint (default: "")
732 ;from_domain=   ; Domain to user in From header for requests to this endpoint
733                 ; (default: "")
734 ;dtls_verify=no ; Verify that the provided peer certificate is valid (default:
735                 ; "no")
736 ;dtls_rekey=0   ; Interval at which to renegotiate the TLS session and rekey
737                 ; the SRTP session (default: "0")
738 ;dtls_cert_file=        ; Path to certificate file to present to peer (default:
739                         ; "")
740 ;dtls_private_key=      ; Path to private key for certificate file (default:
741                         ; "")
742 ;dtls_cipher=   ; Cipher to use for DTLS negotiation (default: "")
743 ;dtls_ca_file=  ; Path to certificate authority certificate (default: "")
744 ;dtls_ca_path=  ; Path to a directory containing certificate authority
745                 ; certificates (default: "")
746 ;dtls_setup=    ; Whether we are willing to accept connections connect to the
747                 ; other party or both (default: "")
748 ;dtls_fingerprint= ; Hash to use for the fingerprint placed into SDP
749                    ; (default: "SHA-256")
750 ;srtp_tag_32=no ; Determines whether 32 byte tags should be used instead of 80
751                 ; byte tags (default: "no")
752 ;set_var=       ; Variable set on a channel involving the endpoint. For multiple
753                 ; channel variables specify multiple 'set_var'(s)
754 ;rtp_keepalive= ; Interval, in seconds, between comfort noise RTP packets if
755                 ; RTP is not flowing. This setting is useful for ensuring that
756                 ; holes in NATs and firewalls are kept open throughout a call.
757 ;rtp_timeout=      ; Hang up channel if RTP is not received for the specified
758                    ; number of seconds when the channel is off hold (default:
759                    ; "0" or not enabled)
760 ;rtp_timeout_hold= ; Hang up channel if RTP is not received for the specified
761                    ; number of seconds when the channel is on hold (default:
762                    ; "0" or not enabled)
763 ;contact_user= ; On outgoing requests, force the user portion of the Contact
764                ; header to this value (default: "")
765 ;preferred_codec_only=yes       ; Respond to a SIP invite with the single most preferred codec
766                                 ; rather than advertising all joint codec capabilities. This
767                                 ; limits the other side's codec choice to exactly what we prefer.
768                                 ; default is no.
769 ;asymmetric_rtp_codec= ; Allow the sending and receiving codec to differ and
770                        ; not be automatically matched (default: "no")
771
772 ;==========================AUTH SECTION OPTIONS=========================
773 ;[auth]
774 ;  SYNOPSIS: Authentication type
775 ;
776 ;  Note: Using the same auth section for inbound and outbound
777 ;  authentication is not recommended.  There is a difference in
778 ;  meaning for an empty realm setting between inbound and outbound
779 ;  authentication uses.  Look to the CLI config help
780 ;  "config show help res_pjsip auth realm" or on the wiki for the
781 ;  difference.
782 ;
783 ;auth_type=userpass     ; Authentication type (default: "userpass")
784 ;nonce_lifetime=32      ; Lifetime of a nonce associated with this
785                         ; authentication config (default: "32")
786 ;md5_cred=      ; MD5 Hash used for authentication (default: "")
787 ;password=      ; PlainText password used for authentication (default: "")
788 ;realm= ; SIP realm for endpoint (default: "")
789 ;type=  ; Must be auth (default: "")
790 ;username=      ; Username to use for account (default: "")
791
792
793 ;==========================DOMAIN_ALIAS SECTION OPTIONS=========================
794 ;[domain_alias]
795 ;  SYNOPSIS: Domain Alias
796 ;type=  ; Must be of type domain_alias (default: "")
797 ;domain=        ; Domain to be aliased (default: "")
798
799
800 ;==========================TRANSPORT SECTION OPTIONS=========================
801 ;[transport]
802 ;  SYNOPSIS: SIP Transport
803 ;async_operations=1     ; Number of simultaneous Asynchronous Operations
804                         ; (default: "1")
805 ;bind=  ; IP Address and optional port to bind to for this transport (default:
806         ; "")
807 ;ca_list_file=  ; File containing a list of certificates to read TLS ONLY
808                 ; (default: "")
809 ;ca_list_path=  ; Path to directory containing certificates to read TLS ONLY.
810                 ; PJProject version 2.4 or higher is required for this option to
811                 ; be used.
812                 ; (default: "")
813 ;cert_file=     ; Certificate file for endpoint TLS ONLY
814                 ; Will read .crt or .pem file but only uses cert,
815                 ; a .key file must be specified via priv_key_file.
816                 ; Since PJProject version 2.5: If the file name ends in _rsa,
817                 ; for example "asterisk_rsa.pem", the files "asterisk_dsa.pem"
818                 ; and/or "asterisk_ecc.pem" are loaded (certificate, inter-
819                 ; mediates, private key), to support multiple algorithms for
820                 ; server authentication (RSA, DSA, ECDSA). If the chains are
821                 ; different, at least OpenSSL 1.0.2 is required.
822                 ; (default: "")
823 ;cipher=        ; Preferred cryptography cipher names TLS ONLY (default: "")
824 ;domain=        ; Domain the transport comes from (default: "")
825 ;external_media_address=        ; External IP address to use in RTP handling
826                                 ; (default: "")
827 ;external_signaling_address=    ; External address for SIP signalling (default:
828                                 ; "")
829 ;external_signaling_port=0      ; External port for SIP signalling (default:
830                                 ; "0")
831 ;method=        ; Method of SSL transport TLS ONLY (default: "")
832 ;local_net=     ; Network to consider local used for NAT purposes (default: "")
833 ;password=      ; Password required for transport (default: "")
834 ;priv_key_file= ; Private key file TLS ONLY (default: "")
835 ;protocol=udp   ; Protocol to use for SIP traffic (default: "udp")
836 ;require_client_cert=   ; Require client certificate TLS ONLY (default: "")
837 ;type=  ; Must be of type transport (default: "")
838 ;verify_client= ; Require verification of client certificate TLS ONLY (default:
839                 ; "")
840 ;verify_server= ; Require verification of server certificate TLS ONLY (default:
841                 ; "")
842 ;tos=0  ; Enable TOS for the signalling sent over this transport (default: "0")
843 ;cos=0  ; Enable COS for the signalling sent over this transport (default: "0")
844 ;websocket_write_timeout=100    ; Default write timeout to set on websocket
845                                 ; transports. This value may need to be adjusted
846                                 ; for connections where Asterisk must write a
847                                 ; substantial amount of data and the receiving
848                                 ; clients are slow to process the received
849                                 ; information. Value is in milliseconds; default
850                                 ; is 100 ms.
851 ;allow_reload=no    ; Although transports can now be reloaded, that may not be
852                     ; desirable because of the slight possibility of dropped
853                     ; calls. To make sure there are no unintentional drops, if
854                     ; this option is set to 'no' (the default) changes to the
855                     ; particular transport will be ignored. If set to 'yes',
856                     ; changes (if any) will be applied.
857 ;symmetric_transport=no ; When a request from a dynamic contact comes in on a
858                         ; transport with this option set to 'yes', the transport
859                         ; name will be saved and used for subsequent outgoing
860                         ; requests like OPTIONS, NOTIFY and INVITE.  It's saved
861                         ; as a contact uri parameter named 'x-ast-txp' and will
862                         ; display with the contact uri in CLI, AMI, and ARI
863                         ; output.  On the outgoing request, if a transport
864                         ; wasn't explicitly set on the endpoint AND the request
865                         ; URI is not a hostname, the saved transport will be
866                         ; used and the 'x-ast-txp' parameter stripped from the
867                         ; outgoing packet.
868
869 ;==========================AOR SECTION OPTIONS=========================
870 ;[aor]
871 ;  SYNOPSIS: The configuration for a location of an endpoint
872 ;contact=       ; Permanent contacts assigned to AoR (default: "")
873 ;default_expiration=3600        ; Default expiration time in seconds for
874                                 ; contacts that are dynamically bound to an AoR
875                                 ; (default: "3600")
876 ;mailboxes=           ; Allow subscriptions for the specified mailbox(es)
877                       ; This option applies when an external entity subscribes to an AoR
878                       ; for Message Waiting Indications. (default: "")
879 ;voicemail_extension= ; The voicemail extension to send in the NOTIFY Message-Account header
880                       ; (default: global/default_voicemail_extension)
881 ;maximum_expiration=7200        ; Maximum time to keep an AoR (default: "7200")
882 ;max_contacts=0 ; Maximum number of contacts that can bind to an AoR (default:
883                 ; "0")
884 ;minimum_expiration=60  ; Minimum keep alive time for an AoR (default: "60")
885 ;remove_existing=no     ; Determines whether new contacts replace existing ones
886                         ; (default: "no")
887 ;type=  ; Must be of type aor (default: "")
888 ;qualify_frequency=0    ; Interval at which to qualify an AoR (default: "0")
889 ;qualify_timeout=3.0      ; Qualify timeout in fractional seconds (default: "3.0")
890 ;authenticate_qualify=no        ; Authenticates a qualify request if needed
891                                 ; (default: "no")
892 ;outbound_proxy=        ; Proxy through which to send OPTIONS requests, a full SIP URI
893                         ; must be provided (default: "")
894
895
896 ;==========================SYSTEM SECTION OPTIONS=========================
897 ;[system]
898 ;  SYNOPSIS: Options that apply to the SIP stack as well as other system-wide settings
899 ;timer_t1=500   ; Set transaction timer T1 value milliseconds (default: "500")
900 ;timer_b=32000  ; Set transaction timer B value milliseconds (default: "32000")
901 ;compact_headers=no     ; Use the short forms of common SIP header names
902                         ; (default: "no")
903 ;threadpool_initial_size=0      ; Initial number of threads in the res_pjsip
904                                 ; threadpool (default: "0")
905 ;threadpool_auto_increment=5    ; The amount by which the number of threads is
906                                 ; incremented when necessary (default: "5")
907 ;threadpool_idle_timeout=60     ; Number of seconds before an idle thread
908                                 ; should be disposed of (default: "60")
909 ;threadpool_max_size=0  ; Maximum number of threads in the res_pjsip threadpool
910                         ; A value of 0 indicates no maximum (default: "0")
911 ;disable_tcp_switch=yes ; Disable automatic switching from UDP to TCP transports
912                         ; if outgoing request is too large.
913                         ; See RFC 3261 section 18.1.1.
914                         ; Disabling this option has been known to cause interoperability
915                         ; issues, so disable at your own risk.
916                         ; (default: "yes")
917 ;type=  ; Must be of type system (default: "")
918
919 ;==========================GLOBAL SECTION OPTIONS=========================
920 ;[global]
921 ;  SYNOPSIS: Options that apply globally to all SIP communications
922 ;max_forwards=70        ; Value used in Max Forwards header for SIP requests
923                         ; (default: "70")
924 ;type=  ; Must be of type global (default: "")
925 ;user_agent=Asterisk PBX        ; Allows you to change the user agent string
926                                 ; The default user agent string also contains
927                                 ; the Asterisk version. If you don't want to
928                                 ; expose this, change the user_agent string.
929 ;default_outbound_endpoint=default_outbound_endpoint    ; Endpoint to use when
930                                                         ; sending an outbound
931                                                         ; request to a URI
932                                                         ; without a specified
933                                                         ; endpoint (default: "d
934                                                         ; efault_outbound_endpo
935                                                         ; int")
936 ;debug=no ; Enable/Disable SIP debug logging.  Valid options include yes|no
937           ; or a host address (default: "no")
938 ;keep_alive_interval=20 ; The interval (in seconds) at which to send keepalive
939                         ; messages on all active connection-oriented transports
940                         ; (default: "0")
941 ;contact_expiration_check_interval=30
942                         ; The interval (in seconds) to check for expired contacts.
943 ;disable_multi_domain=no
944             ; Disable Multi Domain support.
945             ; If disabled it can improve realtime performace by reducing
946             ; number of database requsts
947             ; (default: "no")
948 ;endpoint_identifier_order=ip,username,anonymous
949             ; The order by which endpoint identifiers are given priority.
950             ; Currently, "ip", "username", "auth_username" and "anonymous" are valid
951             ; identifiers as registered by the res_pjsip_endpoint_identifier_* modules.
952             ; Some modules like res_pjsip_endpoint_identifier_user register more than
953             ; one identifier. Use the CLI command "pjsip show identifiers" to see the
954             ; identifiers currently available.
955             ; (default: ip,username,anonymous)
956 ;max_initial_qualify_time=4 ; The maximum amount of time (in seconds) from
957                             ; startup that qualifies should be attempted on all
958                             ; contacts.  If greater than the qualify_frequency
959                             ; for an aor, qualify_frequency will be used instead.
960 ;regcontext=sipregistrations  ; If regcontext is specified, Asterisk will dynamically
961                               ; create and destroy a NoOp priority 1 extension for a
962                               ; given endpoint who registers or unregisters with us.
963                               ; The extension added is the name of the endpoint.
964 ;default_voicemail_extension=asterisk
965                    ; The voicemail extension to send in the NOTIFY Message-Account header
966                    ; if not set on endpoint or aor.
967                    ; (default: "")
968 ;
969 ; The following unidentified_request options are only used when "auth_username"
970 ; matching is enabled in "endpoint_identifier_order".
971 ;
972 ;unidentified_request_count=5   ; The number of unidentified requests that can be
973                                 ; received from a single IP address in
974                                 ; unidentified_request_period seconds before a security
975                                 ; event is generated. (default: 5)
976 ;unidentified_request_period=5  ; See above.  (default: 5 seconds)
977 ;unidentified_request_prune_interval=30
978                                 ; The interval at which unidentified requests
979                                 ; are check to see if they can be pruned.  If they're
980                                 ; older than twice the unidentified_request_period,
981                                 ; they're pruned.
982 ;
983 ;default_from_user=asterisk     ; When Asterisk generates an outgoing SIP request, the
984                                 ; From header username will be set to this value if
985                                 ; there is no better option (such as CallerID or
986                                 ; endpoint/from_user) to be used
987 ;default_realm=asterisk         ; When Asterisk generates a challenge, the digest realm
988                                 ; will be set to this value if there is no better option
989                                 ; (such as auth/realm) to be used.
990
991                     ; Asterisk Task Processor Queue Size
992                     ; On heavy loaded system with DB storage you may need to increase
993                     ; taskprocessor queue.
994                     ; If the taskprocessor queue size reached high water level,
995                     ; the alert is triggered.
996                     ; If the alert is set the pjsip distibutor stops processing incoming
997                     ; requests until the alert is cleared.
998                     ; The alert is cleared when taskprocessor queue size drops to the
999                     ; low water clear level.
1000                     ; The next options set taskprocessor queue levels for MWI.
1001 ;mwi_tps_queue_high=500 ; Taskprocessor high water alert trigger level.
1002 ;mwi_tps_queue_low=450  ; Taskprocessor low water clear alert level.
1003                     ; The default is -1 for 90% of high water level.
1004
1005                     ; Unsolicited MWI
1006                     ; If there are endpoints configured with unsolicited MWI
1007                     ; then res_pjsip_mwi module tries to send MWI to all endpoints on startup.
1008 ;mwi_disable_initial_unsolicited=no ; Disable sending unsolicited mwi to all endpoints on startup.
1009                     ; If disabled then unsolicited mwi will start processing
1010                     ; on the endpoint's next contact update.
1011
1012 ;ignore_uri_user_options=no ; Enable/Disable ignoring SIP URI user field options.
1013                     ; If you have this option enabled and there are semicolons
1014                     ; in the user field of a SIP URI then the field is truncated
1015                     ; at the first semicolon.  This effectively makes the semicolon
1016                     ; a non-usable character for PJSIP endpoint names, extensions,
1017                     ; and AORs.  This can be useful for improving compatability with
1018                     ; an ITSP that likes to use user options for whatever reason.
1019                     ; Example:
1020                     ; URI: "sip:1235557890;phone-context=national@x.x.x.x;user=phone"
1021                     ; The user field is "1235557890;phone-context=national"
1022                     ; Which becomes this: "1235557890"
1023                     ;
1024                     ; Note: The caller-id and redirecting number strings obtained
1025                     ; from incoming SIP URI user fields are always truncated at the
1026                     ; first semicolon.
1027
1028 ; MODULE PROVIDING BELOW SECTION(S): res_pjsip_acl
1029 ;==========================ACL SECTION OPTIONS=========================
1030 ;[acl]
1031 ;  SYNOPSIS: Access Control List
1032 ;acl=   ; List of IP ACL section names in acl conf (default: "")
1033 ;contact_acl=   ; List of Contact ACL section names in acl conf (default: "")
1034 ;contact_deny=  ; List of Contact header addresses to deny (default: "")
1035 ;contact_permit=        ; List of Contact header addresses to permit (default:
1036                         ; "")
1037 ;deny=  ; List of IP addresses to deny access from (default: "")
1038 ;permit=        ; List of IP addresses to permit access from (default: "")
1039 ;type=  ; Must be of type acl (default: "")
1040
1041
1042
1043
1044 ; MODULE PROVIDING BELOW SECTION(S): res_pjsip_outbound_registration
1045 ;==========================REGISTRATION SECTION OPTIONS=========================
1046 ;[registration]
1047 ;  SYNOPSIS: The configuration for outbound registration
1048 ;auth_rejection_permanent=yes   ; Determines whether failed authentication
1049                                 ; challenges are treated as permanent failures
1050                                 ; (default: "yes")
1051 ;client_uri=    ; Client SIP URI used when attemping outbound registration
1052                 ; (default: "")
1053 ;contact_user=  ; Contact User to use in request (default: "")
1054 ;expiration=3600        ; Expiration time for registrations in seconds
1055                         ; (default: "3600")
1056 ;max_retries=10 ; Maximum number of registration attempts (default: "10")
1057 ;outbound_auth= ; Authentication object to be used for outbound registrations
1058                 ; (default: "")
1059 ;outbound_proxy=        ; Proxy through which to send registrations, a full SIP URI
1060                         ; must be provided (default: "")
1061 ;retry_interval=60      ; Interval in seconds between retries if outbound
1062                         ; registration is unsuccessful (default: "60")
1063 ;forbidden_retry_interval=0     ; Interval used when receiving a 403 Forbidden
1064                                 ; response (default: "0")
1065 ;fatal_retry_interval=0 ; Interval used when receiving a fatal response.
1066                         ; (default: "0") A fatal response is any permanent
1067                         ; failure (non-temporary 4xx, 5xx, 6xx) response
1068                         ; received from the registrar. NOTE - if also set
1069                         ; the 'forbidden_retry_interval' takes precedence
1070                         ; over this one when a 403 is received. Also, if
1071                         ; 'auth_rejection_permanent' equals 'yes' a 401 and
1072                         ; 407 become subject to this retry interval.
1073 ;server_uri=    ; SIP URI of the server to register against (default: "")
1074 ;transport=     ; Transport used for outbound authentication (default: "")
1075 ;line=          ; When enabled this option will cause a 'line' parameter to be
1076                 ; added to the Contact header placed into the outgoing
1077                 ; registration request. If the remote server sends a call
1078                 ; this line parameter will be used to establish a relationship
1079                 ; to the outbound registration, ultimately causing the
1080                 ; configured endpoint to be used (default: "no")
1081 ;endpoint=      ; When line support is enabled this configured endpoint name
1082                 ; is used for incoming calls that are related to the outbound
1083                 ; registration (default: "")
1084 ;type=  ; Must be of type registration (default: "")
1085
1086
1087
1088
1089 ; MODULE PROVIDING BELOW SECTION(S): res_pjsip_endpoint_identifier_ip
1090 ;==========================IDENTIFY SECTION OPTIONS=========================
1091 ;[identify]
1092 ;  SYNOPSIS: Identifies endpoints via source IP address
1093 ;endpoint=      ; Name of Endpoint (default: "")
1094 ;match= ; IP addresses or networks to match against (default: "")
1095 ;type=  ; Must be of type identify (default: "")
1096
1097
1098
1099
1100 ;========================PHONEPROV_USER SECTION OPTIONS=======================
1101 ;[phoneprov]
1102 ;  SYNOPSIS: Contains variables for autoprovisioning each user
1103 ;endpoint=      ; The endpoint from which to gather username, secret, etc. (default: "")
1104 ;PROFILE=       ; The name of a profile configured in phoneprov.conf (default: "")
1105 ;MAC=           ; The mac address for this user (default: "")
1106 ;OTHERVAR=      ; Any other name value pair to be used in templates (default: "")
1107                 ; Common variables include LINE, LINEKEYS, etc.
1108                 ; See phoneprov.conf.sample for others.
1109 ;type=          ; Must be of type phoneprov (default: "")