Documentation: Updates for info about NAT-related settings and fixes for pjsip.conf...
[asterisk/asterisk.git] / configs / 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 ; Documentation
16 ;
17 ; The official documentation is at http://wiki.asterisk.org
18 ; You can read the XML configuration help via Asterisk command line with
19 ; "config show help res_pjsip", then you can drill down through the various
20 ; sections and their options.
21 ;
22
23 ;========!!!!!!!!!!!!!!!!!!!  SECURITY NOTICE  !!!!!!!!!!!!!!!!!!!!===========
24 ;
25 ; At a minimum please read the file "README-SERIOUSLY.bestpractices.txt",
26 ; located in the Asterisk source directory before starting Asterisk.
27 ; Otherwise you risk allowing the security of the Asterisk system to be
28 ; compromised. Beyond that please visit and read the security information on
29 ; the wiki at: https://wiki.asterisk.org/wiki/x/EwFB
30 ;
31 ; A few basics to pay attention to:
32 ;
33 ; Anonymous Calls
34 ;
35 ; By default anonymous inbound calls via PJSIP are not allowed. If you want to
36 ; route anonymous calls you'll need to define an endpoint named "anonymous".
37 ; res_pjsip_endpoint_identifier_anonymous.so handles that functionality so it
38 ; must be loaded. It is not recommended to accept anonymous calls.
39 ;
40 ; Access Control Lists
41 ;
42 ; See the example ACL configuration in this file. Read the configuration help
43 ; for the section and all of its options. Look over the samples in acl.conf
44 ; and documentation at https://wiki.asterisk.org/wiki/x/uA80AQ
45 ; If possible, restrict access to only networks and addresses you trust.
46 ;
47 ; Dialplan Contexts
48 ;
49 ; When defining configuration (such as an endpoint) that links into
50 ; dialplan configuration, be aware of what that dialplan does. It's easy to
51 ; accidentally provide access to internal or outbound dialing extensions which
52 ; could cost you severely. The "context=" line in endpoint configuration
53 ; determines which dialplan context inbound calls will enter into.
54 ;
55 ;=============================================================================
56
57 ; Overview of Configuration Section Types Used in the Examples
58 ;
59 ; * Transport "transport"
60 ;   * Configures res_pjsip transport layer interaction.
61 ; * Endpoint "endpoint"
62 ;   * Configures core SIP functionality related to SIP endpoints.
63 ; * Authentication "auth"
64 ;   * Stores inbound or outbound authentication credentials for use by trunks,
65 ;     endpoints, registrations.
66 ; * Address of Record "aor"
67 ;   * Stores contact information for use by endpoints.
68 ; * Endpoint Identification "identify"
69 ;   * Maps a host directly to an endpoint
70 ; * Access Control List "acl"
71 ;   * Defines a permission list or references one stored in acl.conf
72 ; * Registration "registration"
73 ;   * Contains information about an outbound SIP registration
74
75 ; The following sections show example configurations for various scenarios.
76 ; Most require a couple or more configuration types configured in concert.
77
78 ;===============EXAMPLE TRANSPORTS============================================
79 ;
80 ; A few examples for potential transport options.
81 ;
82 ; For the NAT transport example, be aware that the options starting with
83 ; the prefix "external_" will only apply to communication with addresses
84 ; outside the range set with "local_net=".
85 ;
86 ; IPv6: For endpoints using IPv6, remember to set "rtp_ipv6=yes" so that the RTP
87 ; engine will also be able to bind to an IPv6 address.
88 ;
89 ; You can have more than one of any type of transport, as long as it doesn't
90 ; use the same resources (bind address, port, etc) as the others.
91
92 ; Basic UDP transport
93 ;
94 ;[transport-udp]
95 ;type=transport
96 ;protocol=udp    ;udp,tcp,tls,ws,wss
97 ;bind=0.0.0.0
98
99 ; UDP transport behind NAT
100 ;
101 ;[transport-udp-nat]
102 ;type=transport
103 ;protocol=udp
104 ;bind=0.0.0.0
105 ;local_net=192.0.2.0/24
106 ;external_media_address=203.0.113.1
107 ;external_signaling_address=203.0.113.1
108
109 ; Basic IPv6 UDP transport
110 ;
111 ;[transport-udp-ipv6]
112 ;type=transport
113 ;protocol=udp
114 ;bind=::
115
116 ; Example IPv4 TLS transport
117 ;
118 ;[transport-tls]
119 ;type=transport
120 ;protocol=tls
121 ;bind=0.0.0.0
122 ;cert_file=/path/mycert.crt
123 ;privkey_file=/path/mykey.key
124 ;cipher=ALL
125 ;method=tlsv1
126
127
128 ;===============OUTBOUND REGISTRATION WITH OUTBOUND AUTHENTICATION============
129 ;
130 ; This is a simple registration that works with some SIP trunking providers.
131 ; You'll need to set up the auth example "mytrunk_auth" below to enable outbound
132 ; authentication. Note that we "outbound_auth=" use for outbound authentication
133 ; instead of "auth=", which is for inbound authentication.
134 ;
135 ; If you are registering to a server from behind NAT, be sure you assign a transport
136 ; that is appropriately configured with NAT related settings. See the NAT transport example.
137 ;
138 ; "contact_user=" sets the SIP contact header's user portion of the SIP URI
139 ; this will affect the extension reached in dialplan when the far end calls you at this
140 ; registration. The default is 's'.
141
142 ;[mytrunk]
143 ;type=registration
144 ;transport=transport-udp
145 ;outbound_auth=mytrunk_auth
146 ;server_uri=sip:sip.example.com
147 ;client_uri=sip:1234567890@sip.example.com
148 ;contact_user=1234567890
149 ;retry_interval=60
150 ;forbidden_retry_interval=600
151 ;expiration=3600
152
153 ;[mytrunk_auth]
154 ;type=auth
155 ;auth_type=userpass
156 ;password=1234567890
157 ;username=1234567890
158 ;realm=sip.example.com
159
160 ;===============ENDPOINT CONFIGURED AS A TRUNK, OUTBOUND AUTHENTICATION=======
161 ;
162 ; This is one way to configure an endpoint as a trunk. It is set up with
163 ; "outbound_auth=" to enable authentication when dialing out through this
164 ; endpoint. There is no inbound authentication set up since a provider will
165 ; not normally authenticate when calling you.
166 ;
167 ; The identify configuration enables IP address matching against this endpoint.
168 ; For calls from a trunking provider, the From user may be different every time,
169 ; so we want to match against IP address instead of From user.
170 ;
171 ; If you want the provider of your trunk to know where to send your calls
172 ; you'll need to use an outbound registration as in the example above this
173 ; section.
174 ;
175 ; NAT
176 ;
177 ; At a basic level configure the endpoint with a transport that is set up
178 ; with the appropriate NAT settings. There may be some additional settings you
179 ; need here based on your NAT/Firewall scenario. Look to the CLI config help
180 ; "config show help res_pjsip endpoint" or on the wiki for other NAT related
181 ; options and configuration. We've included a few below.
182 ;
183 ; AOR
184 ;
185 ; Endpoints use one or more AOR sections to store their contact details.
186 ; You can define multiple contact addresses in SIP URI format in multiple
187 ; "contact=" entries.
188 ;
189 ; Section Naming
190 ;
191 ; Sections can have the same name as long as their "type="
192 ; options are set to different values.
193
194 ;[mytrunk]
195 ;type=endpoint
196 ;transport=transport-udp
197 ;context=from-external
198 ;disallow=all
199 ;allow=ulaw
200 ;outbound_auth=mytrunk_auth
201 ;aors=mytrunk
202 ;                   ;A few NAT relevant options that may come in handy.
203 ;force_rport=yes    ;It's a good idea to read the configuration help for each
204 ;direct_media=no    ;of these options.
205 ;ice_support=yes
206
207 ;[mytrunk]
208 ;type=aor
209 ;contact=sip:198.51.100.1:5060
210 ;contact=sip:198.51.100.2:5060
211
212 ;[mytrunk]
213 ;type=identify
214 ;endpoint=mytrunk
215 ;match=198.51.100.1
216 ;match=198.51.100.2
217
218
219 ;=============ENDPOINT CONFIGURED AS A TRUNK, INBOUND AUTH AND REGISTRATION===
220 ;
221 ; Here we are allowing a remote device to register to Asterisk and requiring
222 ; that they authenticate for registration and calls.
223 ; You'll note that this configuration is essentially the same as configuring
224 ; an endpoint for use with a SIP phone.
225
226
227 ;[7000]
228 ;type=endpoint
229 ;context=from-external
230 ;disallow=all
231 ;allow=ulaw
232 ;transport=transport-udp
233 ;auth=7000
234 ;aors=7000
235
236 ;[7000]
237 ;type=auth
238 ;auth_type=userpass
239 ;password=7000
240 ;username=7000
241
242 ;[7000]
243 ;type=aor
244 ;max_contacts=1
245
246
247 ;===============ENDPOINT CONFIGURED FOR USE WITH A SIP PHONE==================
248 ;
249 ; This example includes the endpoint, auth and aor configurations. It
250 ; requires inbound authentication and allows registration, as well as references
251 ; a transport that you'll need to uncomment from the previous examples.
252 ;
253 ; Uncomment one of the transport lines to choose which transport you want. If
254 ; not specified then the default transport chosen is the first defined transport
255 ; in the configuration file.
256 ;
257 ; Modify the "max_contacts=" line to change how many unique registrations to allow.
258 ;
259 ; Use the "contact=" line instead of max_contacts= if you want to statically
260 ; define the location of the device.
261 ;
262 ; If using the TLS enabled transport, you may want the "media_encryption=yes"
263 ; option to additionally enable SRTP, though they are not mutually inclusive.
264 ;
265 ; Use the "rtp_ipv6=yes" option if you want to utilize RTP over an ipv6 transport.
266 ;
267 ; If this endpoint were remote, and it was using a transport configured for NAT
268 ; then you likely want to use "direct_media=no" to prevent audio issues.
269
270
271 ;[6001]
272 ;type=endpoint
273 ;transport=transport-udp
274 ;context=from-internal
275 ;disallow=all
276 ;allow=ulaw
277 ;allow=gsm
278 ;auth=6001
279 ;aors=6001
280 ;
281 ; A few more transports to pick from, and some related options below them.
282 ;
283 ;transport=transport-tls
284 ;media_encryption=yes
285 ;transport=transport-udp-ipv6
286 ;rtp_ipv6=yes
287 ;transport=transport-udp-nat
288 ;direct_media=no
289 ;
290 ; MWI related options
291
292 ;aggregate_mwi=yes
293 ;mailboxes=6001@default,7001@default
294 ;mwi_from_user=6001
295 ;
296 ; Extension and Device state options
297 ;
298 ;device_state_busy_at=1
299 ;allow_subscribe=yes
300 ;sub_min_expiry=30
301
302 ;[6001]
303 ;type=auth
304 ;auth_type=userpass
305 ;password=6001
306 ;username=6001
307
308 ;[6001]
309 ;type=aor
310 ;max_contacts=1
311 ;contact=sip:6001@192.0.2.1:5060
312
313 ;===============ENDPOINT BEHIND NAT OR FIREWALL===============================
314 ;
315 ; This example assumes your transport is configured with a public IP and the
316 ; endpoint itself is behind NAT and maybe a firewall, rather than having
317 ; Asterisk behind NAT. For the sake of simplicity, we'll assume a typical
318 ; VOIP phone. The most important settings to configure are:
319 ;
320 ;  * direct_media, to ensure Asterisk stays in the media path
321 ;  * rtp_symmetric and force_rport options to help the far-end NAT/firewall
322 ;
323 ; Depending on the settings of your remote SIP device or NAT/firewall device
324 ; you may have to experiment with a combination of these settings.
325 ;
326 ; If both Asterisk and the remote phones are a behind NAT/firewall then you'll
327 ; have to make sure to use a transport with appropriate settings (as in the
328 ; transport-udp-nat example).
329 ;
330 ;[6002]
331 ;type=endpoint
332 ;transport=transport-udp
333 ;context=from-internal
334 ;disallow=all
335 ;allow=ulaw
336 ;auth=6002
337 ;aors=6002
338 ;direct_media=no
339 ;rtp_symmetric=yes
340 ;force_rport=yes
341 ;ice_support=yes   ;This is specific to clients that support NAT traversal
342                    ;for media via ICE,STUN,TURN. See the wiki at:
343                    ;https://wiki.asterisk.org/wiki/x/D4FHAQ
344                    ;for a deeper explanation of this topic.
345
346 ;[6002]
347 ;type=auth
348 ;auth_type=userpass
349 ;password=6002
350 ;username=6002
351
352 ;[6002]
353 ;type=aor
354 ;max_contacts=2
355
356
357 ;============EXAMPLE ACL CONFIGURATION==========================================
358 ;
359 ; The ACL or Access Control List section defines a set of permissions to permit
360 ; or deny access to various address or addresses. Alternatively it references an
361 ; ACL configuration already set in acl.conf.
362 ;
363 ; The ACL configuration is independent of individual endpoint configuration and
364 ; operates on all inbound SIP communication using res_pjsip.
365
366 ; Reference an ACL defined in acl.conf.
367 ;
368 ;[acl]
369 ;type=acl
370 ;acl=example_named_acl1
371
372 ; Reference a contactacl specifically.
373 ;
374 ;[acl]
375 ;type=acl
376 ;contact_acl=example_contact_acl1
377
378 ; Define your own ACL here in pjsip.conf and
379 ; permit or deny by IP address or range.
380 ;
381 ;[acl]
382 ;type=acl
383 ;deny=0.0.0.0/0.0.0.0
384 ;permit=209.16.236.0/24
385 ;deny=209.16.236.1
386
387 ; Restrict based on Contact Headers rather than IP.
388 ; Define options multiple times for various addresses or use a comma-delimited string.
389 ;
390 ;[acl]
391 ;type=acl
392 ;contact_deny=0.0.0.0/0.0.0.0
393 ;contact_permit=209.16.236.0/24
394 ;contact_permit=209.16.236.1
395 ;contact_permit=209.16.236.2,209.16.236.3
396
397 ; Restrict based on Contact Headers rather than IP and use
398 ; advanced syntax. Note the bang symbol used for "NOT", so we can deny
399 ; 209.16.236.12/32 within the permit= statement.
400 ;
401 ;[acl]
402 ;type=acl
403 ;contact_deny=0.0.0.0/0.0.0.0
404 ;contact_permit=209.16.236.0
405 ;permit=209.16.236.0/24, !209.16.236.12/32
406
407
408
409 ; MODULE PROVIDING BELOW SECTION(S): res_pjsip
410 ;==========================ENDPOINT SECTION OPTIONS=========================
411 ;[endpoint]
412 ;  SYNOPSIS: Endpoint
413 ;100rel=yes     ; Allow support for RFC3262 provisional ACK tags (default:
414                 ; "yes")
415 ;aggregate_mwi=yes      ;  (default: "yes")
416 ;allow= ; Media Codec s to allow (default: "")
417 ;aors=  ; AoR s to be used with the endpoint (default: "")
418 ;auth=  ; Authentication Object s associated with the endpoint (default: "")
419 ;callerid=      ; CallerID information for the endpoint (default: "")
420 ;callerid_privacy=      ; Default privacy level (default: "")
421 ;callerid_tag=  ; Internal id_tag for the endpoint (default: "")
422 ;context=default        ; Dialplan context for inbound sessions (default:
423                         ; "default")
424 ;direct_media_glare_mitigation=none     ; Mitigation of direct media re INVITE
425                                         ; glare (default: "none")
426 ;direct_media_method=invite     ; Direct Media method type (default: "invite")
427 ;connected_line_method=invite   ; Connected line method type (default:
428                                 ; "invite")
429 ;direct_media=yes       ; Determines whether media may flow directly between
430                         ; endpoints (default: "yes")
431 ;disable_direct_media_on_nat=no ; Disable direct media session refreshes when
432                                 ; NAT obstructs the media session (default:
433                                 ; "no")
434 ;disallow=      ; Media Codec s to disallow (default: "")
435 ;dtmf_mode=rfc4733      ; DTMF mode (default: "rfc4733")
436 ;media_address=         ; IP address used in SDP for media handling (default: "")
437 ;force_rport=yes        ; Force use of return port (default: "yes")
438 ;ice_support=no ; Enable the ICE mechanism to help traverse NAT (default: "no")
439 ;identify_by=username   ; Way s for Endpoint to be identified (default:
440                         ; "username")
441 ;redirect_method=user   ; How redirects received from an endpoint are handled
442                         ; (default: "user")
443 ;mailboxes=     ; Mailbox es to be associated with (default: "")
444 ;moh_suggest=default    ; Default Music On Hold class (default: "default")
445 ;outbound_auth= ; Authentication object used for outbound requests (default:
446                 ; "")
447 ;outbound_proxy=        ; Proxy through which to send requests a full SIP URI
448                         ; must be provided (default: "")
449 ;rewrite_contact=no     ; Allow Contact header to be rewritten with the source
450                         ; IP address port (default: "no")
451 ;rtp_ipv6=no    ; Allow use of IPv6 for RTP traffic (default: "no")
452 ;rtp_symmetric=no       ; Enforce that RTP must be symmetric (default: "no")
453 ;send_diversion=yes     ; Send the Diversion header conveying the diversion
454                         ; information to the called user agent (default: "yes")
455 ;send_pai=no    ; Send the P Asserted Identity header (default: "no")
456 ;send_rpid=no   ; Send the Remote Party ID header (default: "no")
457 ;timers_min_se=90       ; Minimum session timers expiration period (default:
458                         ; "90")
459 ;timers=yes     ; Session timers for SIP packets (default: "yes")
460 ;timers_sess_expires=1800       ; Maximum session timer expiration period
461                                 ; (default: "1800")
462 ;transport=     ; Desired transport configuration (default: "")
463 ;trust_id_inbound=no    ; Accept identification information received from this
464                         ; endpoint (default: "no")
465 ;trust_id_outbound=no   ; Send private identification details to the endpoint
466                         ; (default: "no")
467 ;type=  ; Must be of type endpoint (default: "")
468 ;use_ptime=no   ; Use Endpoint s requested packetisation interval (default:
469                 ; "no")
470 ;use_avpf=no    ; Determines whether res_pjsip will use and enforce usage of
471                 ; AVPF for this endpoint (default: "no")
472 ;media_encryption=no    ; Determines whether res_pjsip will use and enforce
473                         ; usage of media encryption for this endpoint (default:
474                         ; "no")
475 ;inband_progress=no     ; Determines whether chan_pjsip will indicate ringing
476                         ; using inband progress (default: "no")
477 ;call_group=    ; The numeric pickup groups for a channel (default: "")
478 ;pickup_group=  ; The numeric pickup groups that a channel can pickup (default:
479                 ; "")
480 ;named_call_group=      ; The named pickup groups for a channel (default: "")
481 ;named_pickup_group=    ; The named pickup groups that a channel can pickup
482                         ; (default: "")
483 ;device_state_busy_at=0 ; The number of in use channels which will cause busy
484                         ; to be returned as device state (default: "0")
485 ;t38_udptl=no   ; Whether T 38 UDPTL support is enabled or not (default: "no")
486 ;t38_udptl_ec=none      ; T 38 UDPTL error correction method (default: "none")
487 ;t38_udptl_maxdatagram=0        ; T 38 UDPTL maximum datagram size (default:
488                                 ; "0")
489 ;fax_detect=no  ; Whether CNG tone detection is enabled (default: "no")
490 ;t38_udptl_nat=no       ; Whether NAT support is enabled on UDPTL sessions
491                         ; (default: "no")
492 ;t38_udptl_ipv6=no      ; Whether IPv6 is used for UDPTL Sessions (default:
493                         ; "no")
494 ;tone_zone=     ; Set which country s indications to use for channels created
495                 ; for this endpoint (default: "")
496 ;language=      ; Set the default language to use for channels created for this
497                 ; endpoint (default: "")
498 ;one_touch_recording=no ; Determines whether one touch recording is allowed for
499                         ; this endpoint (default: "no")
500 ;record_on_feature=automixmon   ; The feature to enact when one touch recording
501                                 ; is turned on (default: "automixmon")
502 ;record_off_feature=automixmon  ; The feature to enact when one touch recording
503                                 ; is turned off (default: "automixmon")
504 ;rtp_engine=asterisk    ; Name of the RTP engine to use for channels created
505                         ; for this endpoint (default: "asterisk")
506 ;allow_transfer=yes     ; Determines whether SIP REFER transfers are allowed
507                         ; for this endpoint (default: "yes")
508 ;sdp_owner=-    ; String placed as the username portion of an SDP origin o line
509                 ; (default: "-")
510 ;sdp_session=Asterisk   ; String used for the SDP session s line (default:
511                         ; "Asterisk")
512 ;tos_audio=0    ; DSCP TOS bits for audio streams (default: "0")
513 ;tos_video=0    ; DSCP TOS bits for video streams (default: "0")
514 ;cos_audio=0    ; Priority for audio streams (default: "0")
515 ;cos_video=0    ; Priority for video streams (default: "0")
516 ;allow_subscribe=yes    ; Determines if endpoint is allowed to initiate
517                         ; subscriptions with Asterisk (default: "yes")
518 ;sub_min_expiry=0       ; The minimum allowed expiry time for subscriptions
519                         ; initiated by the endpoint (default: "0")
520 ;from_user=     ; Username to use in From header for requests to this endpoint
521                 ; (default: "")
522 ;mwi_from_user= ; Username to use in From header for unsolicited MWI NOTIFYs to
523                 ; this endpoint (default: "")
524 ;from_domain=   ; Domain to user in From header for requests to this endpoint
525                 ; (default: "")
526 ;dtls_verify=   ; Verify that the provided peer certificate is valid (default:
527                 ; "")
528 ;dtls_rekey=    ; Interval at which to renegotiate the TLS session and rekey
529                 ; the SRTP session (default: "")
530 ;dtls_cert_file=        ; Path to certificate file to present to peer (default:
531                         ; "")
532 ;dtls_private_key=      ; Path to private key for certificate file (default:
533                         ; "")
534 ;dtls_cipher=   ; Cipher to use for DTLS negotiation (default: "")
535 ;dtls_ca_file=  ; Path to certificate authority certificate (default: "")
536 ;dtls_ca_path=  ; Path to a directory containing certificate authority
537                 ; certificates (default: "")
538 ;dtls_setup=    ; Whether we are willing to accept connections connect to the
539                 ; other party or both (default: "")
540 ;srtp_tag_32=no ; Determines whether 32 byte tags should be used instead of 80
541                 ; byte tags (default: "no")
542
543
544 ;==========================AUTH SECTION OPTIONS=========================
545 ;[auth]
546 ;  SYNOPSIS: Authentication type
547 ;auth_type=userpass     ; Authentication type (default: "userpass")
548 ;nonce_lifetime=32      ; Lifetime of a nonce associated with this
549                         ; authentication config (default: "32")
550 ;md5_cred=      ; MD5 Hash used for authentication (default: "")
551 ;password=      ; PlainText password used for authentication (default: "")
552 ;realm= ; SIP realm for endpoint (default: "")
553 ;type=  ; Must be auth (default: "")
554 ;username=      ; Username to use for account (default: "")
555
556
557 ;==========================DOMAIN_ALIAS SECTION OPTIONS=========================
558 ;[domain_alias]
559 ;  SYNOPSIS: Domain Alias
560 ;type=  ; Must be of type domain_alias (default: "")
561 ;domain=        ; Domain to be aliased (default: "")
562
563
564 ;==========================TRANSPORT SECTION OPTIONS=========================
565 ;[transport]
566 ;  SYNOPSIS: SIP Transport
567 ;async_operations=1     ; Number of simultaneous Asynchronous Operations
568                         ; (default: "1")
569 ;bind=  ; IP Address and optional port to bind to for this transport (default:
570         ; "")
571 ;ca_list_file=  ; File containing a list of certificates to read TLS ONLY
572                 ; (default: "")
573 ;cert_file=     ; Certificate file for endpoint TLS ONLY (default: "")
574 ;cipher=        ; Preferred Cryptography Cipher TLS ONLY (default: "")
575 ;domain=        ; Domain the transport comes from (default: "")
576 ;external_media_address=        ; External IP address to use in RTP handling
577                                 ; (default: "")
578 ;external_signaling_address=    ; External address for SIP signalling (default:
579                                 ; "")
580 ;external_signaling_port=0      ; External port for SIP signalling (default:
581                                 ; "0")
582 ;method=        ; Method of SSL transport TLS ONLY (default: "")
583 ;local_net=     ; Network to consider local used for NAT purposes (default: "")
584 ;password=      ; Password required for transport (default: "")
585 ;priv_key_file= ; Private key file TLS ONLY (default: "")
586 ;protocol=udp   ; Protocol to use for SIP traffic (default: "udp")
587 ;require_client_cert=   ; Require client certificate TLS ONLY (default: "")
588 ;type=  ; Must be of type transport (default: "")
589 ;verify_client= ; Require verification of client certificate TLS ONLY (default:
590                 ; "")
591 ;verify_server= ; Require verification of server certificate TLS ONLY (default:
592                 ; "")
593 ;tos=0  ; Enable TOS for the signalling sent over this transport (default: "0")
594 ;cos=0  ; Enable COS for the signalling sent over this transport (default: "0")
595
596
597 ;==========================CONTACT SECTION OPTIONS=========================
598 ;[contact]
599 ;  SYNOPSIS: A way of creating an aliased name to a SIP URI
600 ;type=  ; Must be of type contact (default: "")
601 ;uri=   ; SIP URI to contact peer (default: "")
602 ;expiration_time=       ; Time to keep alive a contact (default: "")
603 ;qualify_frequency=0    ; Interval at which to qualify a contact (default: "0")
604 ;outbound_proxy=        ; Outbound proxy used when sending OPTIONS request
605                         ; (default: "")
606
607
608 ;==========================AOR SECTION OPTIONS=========================
609 ;[aor]
610 ;  SYNOPSIS: The configuration for a location of an endpoint
611 ;contact=       ; Permanent contacts assigned to AoR (default: "")
612 ;default_expiration=3600        ; Default expiration time in seconds for
613                                 ; contacts that are dynamically bound to an AoR
614                                 ; (default: "3600")
615 ;mailboxes=     ; Mailbox es to be associated with (default: "")
616 ;maximum_expiration=7200        ; Maximum time to keep an AoR (default: "7200")
617 ;max_contacts=0 ; Maximum number of contacts that can bind to an AoR (default:
618                 ; "0")
619 ;minimum_expiration=60  ; Minimum keep alive time for an AoR (default: "60")
620 ;remove_existing=no     ; Determines whether new contacts replace existing ones
621                         ; (default: "no")
622 ;type=  ; Must be of type aor (default: "")
623 ;qualify_frequency=0    ; Interval at which to qualify an AoR (default: "0")
624 ;authenticate_qualify=no        ; Authenticates a qualify request if needed
625                                 ; (default: "no")
626 ;outbound_proxy=        ; Outbound proxy used when sending OPTIONS request
627                         ; (default: "")
628
629
630 ;==========================SYSTEM SECTION OPTIONS=========================
631 ;[system]
632 ;  SYNOPSIS: Options that apply to the SIP stack as well as other system-wide settings
633 ;timer_t1=500   ; Set transaction timer T1 value milliseconds (default: "500")
634 ;timer_b=32000  ; Set transaction timer B value milliseconds (default: "32000")
635 ;compact_headers=no     ; Use the short forms of common SIP header names
636                         ; (default: "no")
637 ;threadpool_initial_size=0      ; Initial number of threads in the res_pjsip
638                                 ; threadpool (default: "0")
639 ;threadpool_auto_increment=5    ; The amount by which the number of threads is
640                                 ; incremented when necessary (default: "5")
641 ;threadpool_idle_timeout=60     ; Number of seconds before an idle thread
642                                 ; should be disposed of (default: "60")
643 ;threadpool_max_size=0  ; Maximum number of threads in the res_pjsip threadpool
644                         ; A value of 0 indicates no maximum (default: "0")
645 ;type=  ; Must be of type system (default: "")
646
647
648 ;==========================GLOBAL SECTION OPTIONS=========================
649 ;[global]
650 ;  SYNOPSIS: Options that apply globally to all SIP communications
651 ;max_forwards=70        ; Value used in Max Forwards header for SIP requests
652                         ; (default: "70")
653 ;type=  ; Must be of type global (default: "")
654 ;user_agent=Asterisk PBX SVN-branch-12-r404375  ; Value used in User Agent
655                                                 ; header for SIP requests and
656                                                 ; Server header for SIP
657                                                 ; responses (default: "Asterisk
658                                                 ; PBX SVN-branch-12-r404375")
659 ;default_outbound_endpoint=default_outbound_endpoint    ; Endpoint to use when
660                                                         ; sending an outbound
661                                                         ; request to a URI
662                                                         ; without a specified
663                                                         ; endpoint (default: "d
664                                                         ; efault_outbound_endpo
665                                                         ; int")
666
667
668
669
670 ; MODULE PROVIDING BELOW SECTION(S): res_pjsip_acl
671 ;==========================ACL SECTION OPTIONS=========================
672 ;[acl]
673 ;  SYNOPSIS: Access Control List
674 ;acl=   ; List of IP ACL section names in acl conf (default: "")
675 ;contact_acl=   ; List of Contact ACL section names in acl conf (default: "")
676 ;contact_deny=  ; List of Contact header addresses to deny (default: "")
677 ;contact_permit=        ; List of Contact header addresses to permit (default:
678                         ; "")
679 ;deny=  ; List of IP addresses to deny access from (default: "")
680 ;permit=        ; List of IP addresses to permit access from (default: "")
681 ;type=  ; Must be of type acl (default: "")
682
683
684
685
686 ; MODULE PROVIDING BELOW SECTION(S): res_pjsip_outbound_registration
687 ;==========================REGISTRATION SECTION OPTIONS=========================
688 ;[registration]
689 ;  SYNOPSIS: The configuration for outbound registration
690 ;auth_rejection_permanent=yes   ; Determines whether failed authentication
691                                 ; challenges are treated as permanent failures
692                                 ; (default: "yes")
693 ;client_uri=    ; Client SIP URI used when attemping outbound registration
694                 ; (default: "")
695 ;contact_user=  ; Contact User to use in request (default: "")
696 ;expiration=3600        ; Expiration time for registrations in seconds
697                         ; (default: "3600")
698 ;max_retries=10 ; Maximum number of registration attempts (default: "10")
699 ;outbound_auth= ; Authentication object to be used for outbound registrations
700                 ; (default: "")
701 ;outbound_proxy=        ; Outbound Proxy used to send registrations (default:
702                         ; "")
703 ;retry_interval=60      ; Interval in seconds between retries if outbound
704                         ; registration is unsuccessful (default: "60")
705 ;forbidden_retry_interval=0     ; Interval used when receiving a 403 Forbidden
706                                 ; response (default: "0")
707 ;server_uri=    ; SIP URI of the server to register against (default: "")
708 ;transport=     ; Transport used for outbound authentication (default: "")
709 ;type=  ; Must be of type registration (default: "")
710
711
712
713
714 ; MODULE PROVIDING BELOW SECTION(S): res_pjsip_endpoint_identifier_ip
715 ;==========================IDENTIFY SECTION OPTIONS=========================
716 ;[identify]
717 ;  SYNOPSIS: Identifies endpoints via source IP address
718 ;endpoint=      ; Name of Endpoint (default: "")
719 ;match= ; IP addresses or networks to match against (default: "")
720 ;type=  ; Must be of type identify (default: "")