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