pjsip_wizard.conf.sample 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. ; PJSIP Wizard 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. ; Documentation
  15. ;
  16. ; The official documentation is at http://wiki.asterisk.org
  17. ; You can read the XML configuration help via Asterisk command line with
  18. ; "config show help res_pjsip_config_wizard", then you can drill down through
  19. ; the various sections and their options.
  20. ;
  21. ;============EXAMPLE WIZARD CONFIGURATION FOR A PHONE=======================
  22. ; This config would create an endpoint, aor with dynamic contact, inbound
  23. ; auth, a phoneprov object and a dialplan hint for extension 1000.
  24. ;[myphone]
  25. ;type = wizard
  26. ;accepts_auth = yes
  27. ;accepts_registrations = yes
  28. ;has_phoneprov = yes
  29. ;transport = ipv4
  30. ;has_hint = yes
  31. ;hint_exten = 1000
  32. ;inbound_auth/username = testname
  33. ;inbound_auth/password = test password
  34. ;endpoint/allow = ulaw
  35. ;endpoint/context = default
  36. ;phoneprov/MAC = 001122aa4455
  37. ;phoneprov/PROFILE = profile1
  38. ;============EXAMPLE WIZARD CONFIGURATION FOR AN ITSP TRUNK=================
  39. ; This ITSP has 2 servers available and requires registration.
  40. ; This config would create an endpoint, an aor with 2 static contacts, an
  41. ; outbound auth, an identify with 2 matches, and 2 registrations.
  42. ;[mytrunk]
  43. ;type = wizard
  44. ;sends_auth = yes
  45. ;sends_registrations = yes
  46. ;transport = ipv4
  47. ;remote_hosts = sip1.myitsp.com:5060,sip2.myitsp.com:5060
  48. ;outbound_auth/username = testname
  49. ;outbound_auth/password = test password
  50. ;endpoint/allow = ulaw
  51. ;endpoint/context = default
  52. ;========================WIZARD SECTION OPTIONS===============================
  53. ;[wizard]
  54. ; SYNOPSIS: Provides configuration wizard for common scenarios.
  55. ;sends_auth= ; Will create an outbound auth object for the endpoint and
  56. ; registration.
  57. ; If yes, outbound/username must be specified.
  58. ; (default = "no")
  59. ;accepts_auth= ; Will create an inbound auth object for the endpoint.
  60. ; If yes, inbound/username must be specified.
  61. ; (default = "no")
  62. ;sends_registrations= ; Will create an outbound registration object and an
  63. ; identify match for each host in remote_hosts (which
  64. ; must be specified).
  65. ; sends_auth must also be specified.
  66. ; (default: "no")
  67. ;accepts_registrations= ; Will create an aor with dynamic contacts which will
  68. ; accept registrations.
  69. ; accepts_auth must also be specified.
  70. ; (default: "no")
  71. ;remote_hosts= ; A comma separated list of remote hosts in the form of
  72. ; <ipaddress | hostname>[:port] [,<ipaddress | hostname>[:port] ] ...
  73. ; If specified, a static contact for each host will be created
  74. ; in the aor. If accepts_registrations is no, an identify
  75. ; object is also created with a match line for each remote host.
  76. ; If an aor/contact or match/identify is explicitly supplied,
  77. ; remote_hosts will not be used to automatically create contacts
  78. ; or matches respectively.
  79. ; Hostnames must resolve to A, AAAA or CNAME records.
  80. ; SRV records are not currently supported.
  81. ; (default: "")
  82. ;transport= ; The transport to use for the endpoint and registrations
  83. ; (default: the pjsip default)
  84. ;server_uri_pattern= ; The pattern used to construct the registration
  85. ; server_uri. The replaceable parameter ${REMOTE_HOST} isa
  86. ; available for use.
  87. ; (default: "sip:${REMOTE_HOST}")
  88. ;client_uri_pattern= ; The pattern used to construct the registration client_uri.
  89. ; The replaceable parameters ${REMOTE_HOST} and ${USERNAME}
  90. ; are available for use.
  91. ; (default: "sip:${USERNAME}@${REMOTE_HOST}")
  92. ;contact_pattern= ; The pattern used to construct the aor contact.
  93. ; The replaceable parameter ${REMOTE_HOST} is available
  94. ; for use.
  95. ; (default: "sip:${REMOTE_HOST}")
  96. ;has_phoneprov= ; Will create a phoneprov object.
  97. ; If yes, phoneprov/MAC must be specified.
  98. ; (default: "no")
  99. ;has_hint= ; Create hint and optionally a default application.
  100. ; (default: "no")
  101. ;hint_context ; Any hints created for this wizard will be placed in this
  102. ; context.
  103. ; (default: endpoint/context)
  104. ;hint_exten ; If specified, a PJSIP/<wizard_id> hint will be created
  105. ; for this extension in 'hint_context'.
  106. ; context.
  107. ; (default: none)
  108. ;hint_application ; If specified, an extension will be placed in 'hint_context'
  109. ; at priority 1 that calls this application. Could be any
  110. ; valid dialplan expression like
  111. ; "Gosub(stdexten,${EXTEN},1(${HINT}))"
  112. ; (default: "Dial(${HINT})")
  113. ;endpoint/<param> ; Any parameters to be passed directly to and validated
  114. ;aor/<param> ; by their respective objects.
  115. ;inbound_auth/<param>
  116. ;outbound_auth/<param>
  117. ;identify/<param>
  118. ;registration/<param>
  119. ;phoneprov/<param>
  120. ;type= ; Must be of type wizard (default: "")