codecs.conf.sample: update codec opus docs
[asterisk/asterisk.git] / configs / samples / pjsip_wizard.conf.sample
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
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_config_wizard", then you can drill down through
26 ; the various sections and their options.
27 ;
28
29
30 ;============EXAMPLE WIZARD CONFIGURATION FOR A PHONE=======================
31
32 ; This config would create an endpoint, aor with dynamic contact, inbound
33 ; auth, a phoneprov object and a dialplan hint for extension 1000.
34
35 ;[myphone]
36 ;type = wizard
37 ;accepts_auth = yes
38 ;accepts_registrations = yes
39 ;has_phoneprov = yes
40 ;transport = ipv4
41 ;has_hint = yes
42 ;hint_exten = 1000
43 ;inbound_auth/username = testname
44 ;inbound_auth/password = test password
45 ;endpoint/allow = ulaw
46 ;endpoint/context = default
47 ;phoneprov/MAC = 001122aa4455
48 ;phoneprov/PROFILE = profile1
49
50
51 ;============EXAMPLE WIZARD CONFIGURATION FOR AN ITSP TRUNK=================
52
53 ; This ITSP has 2 servers available and requires registration.
54
55 ; This config would create an endpoint, an aor with 2 static contacts, an
56 ; outbound auth, an identify with 2 matches, and 2 registrations.
57
58 ;[mytrunk]
59 ;type = wizard
60 ;sends_auth = yes
61 ;sends_registrations = yes
62 ;transport = ipv4
63 ;remote_hosts = sip1.myitsp.com:5060,sip2.myitsp.com:5060
64 ;outbound_auth/username = testname
65 ;outbound_auth/password = test password
66 ;endpoint/allow = ulaw
67 ;endpoint/context = default
68
69
70 ;========================WIZARD SECTION OPTIONS===============================
71 ;[wizard]
72 ;  SYNOPSIS: Provides configuration wizard for common scenarios.
73 ;sends_auth=    ; Will create an outbound auth object for the endpoint and
74                 ; registration.
75                 ; If yes, outbound/username must be specified.
76                 ; (default = "no")
77
78 ;accepts_auth=  ; Will create an inbound auth object for the endpoint.
79                 ; If yes, inbound/username must be specified.
80                 ; (default = "no")
81
82 ;sends_registrations=    ; Will create an outbound registration object and an
83                          ; identify match for each host in remote_hosts (which
84                          ; must be specified).
85                          ; sends_auth must also be specified.
86                          ; (default: "no")
87
88 ;sends_line_with_registrations=  ; Setting this to true will cause the wizard to
89                          ; skip the creation of an identify object to match
90                          ; incoming requests to the endpoint and instead add the
91                          ; line and endpoint parameters to the outbound
92                          ; registration object.
93                          ; (default: "no")
94
95 ;accepts_registrations=  ; Will create an aor with dynamic contacts which will
96                          ; accept registrations.
97                          ; accepts_auth must also be specified.
98                          ; (default: "no")
99
100 ;remote_hosts=   ; A comma separated list of remote hosts in the form of
101                  ; <ipaddress | hostname>[:port] [,<ipaddress | hostname>[:port] ] ...
102                  ; If specified, a static contact for each host will be created
103                  ; in the aor.  If accepts_registrations is no, an identify
104                  ; object is also created with a match line for each remote host.
105                  ; If an aor/contact or match/identify is explicitly supplied,
106                  ; remote_hosts will not be used to automatically create contacts
107                  ; or matches respectively.
108                  ; (default: "")
109
110 ;outbound_proxy= ; Setting this is a shortcut for setting
111                  ; endpoint/outbound_proxy
112                  ; aor/outbound_proxy
113                  ; registration/outbound_proxy
114
115 ;transport=      ; The transport to use for the endpoint and registrations
116                  ; (default: the pjsip default)
117
118 ;server_uri_pattern= ; The pattern used to construct the registration
119                      ; server_uri. The replaceable parameter ${REMOTE_HOST} isa
120                      ; available for use.
121                      ; (default: "sip:${REMOTE_HOST}")
122
123 ;client_uri_pattern= ; The pattern used to construct the registration client_uri.
124                      ; The replaceable parameters ${REMOTE_HOST} and ${USERNAME}
125                      ; are available for use.
126                      ; (default: "sip:${USERNAME}@${REMOTE_HOST}")
127
128 ;contact_pattern=    ; The pattern used to construct the aor contact.
129                      ; The replaceable parameter ${REMOTE_HOST} is available
130                      ; for use.
131                      ; (default: "sip:${REMOTE_HOST}")
132
133 ;has_phoneprov=      ; Will create a phoneprov object.
134                      ; If yes, phoneprov/MAC must be specified.
135                      ; (default: "no")
136
137 ;has_hint=           ; Create hint and optionally a default application.
138                      ; (default: "no")
139
140 ;hint_context        ; Any hints created for this wizard will be placed in this
141                      ; context.
142                      ; (default: endpoint/context)
143
144 ;hint_exten          ; If specified, a PJSIP/<wizard_id> hint will be created
145                      ; for this extension in 'hint_context'.
146                      ; context.
147                      ; (default: none)
148
149 ;hint_application    ; If specified, an extension will be placed in 'hint_context'
150                      ; at priority 1 that calls this application.  Could be any
151                      ; valid dialplan expression like
152                      ; "Gosub(stdexten,${EXTEN},1(${HINT}))"
153                      ; (default: "Dial(${HINT})")
154
155 ;endpoint/<param>      ; Any parameters to be passed directly to and validated
156 ;aor/<param>           ; by their respective objects.
157 ;inbound_auth/<param>
158 ;outbound_auth/<param>
159 ;identify/<param>
160 ;registration/<param>
161 ;phoneprov/<param>
162
163 ;type=          ; Must be of type wizard (default: "")