menuselect: Add libxml2 support (Patch 3)
[asterisk/asterisk.git] / UPGRADE.txt
1 ===========================================================
2 ===
3 === Information for upgrading between Asterisk versions
4 ===
5 === These files document all the changes that MUST be taken
6 === into account when upgrading between the Asterisk
7 === versions listed below. These changes may require that
8 === you modify your configuration files, dialplan or (in
9 === some cases) source code if you have your own Asterisk
10 === modules or patches. These files also include advance
11 === notice of any functionality that has been marked as
12 === 'deprecated' and may be removed in a future release,
13 === along with the suggested replacement functionality.
14 ===
15 === UPGRADE-1.2.txt -- Upgrade info for 1.0 to 1.2
16 === UPGRADE-1.4.txt -- Upgrade info for 1.2 to 1.4
17 === UPGRADE-1.6.txt -- Upgrade info for 1.4 to 1.6
18 === UPGRADE-1.8.txt -- Upgrade info for 1.6 to 1.8
19 === UPGRADE-10.txt  -- Upgrade info for 1.8 to 10
20 === UPGRADE-11.txt  -- Upgrade info for 10 to 11
21 === UPGRADE-12.txt  -- Upgrade info for 11 to 12
22 ===========================================================
23
24 From 12 to 13:
25
26  - The menuselect utility has been pulled into the Asterisk repository. As a
27    result, the libxml2 library is now a required dependency for Asterisk.
28
29  - The asterisk command line -I option and the asterisk.conf internal_timing
30    option are removed and always enabled if any timing module is loaded.
31
32  - The per console verbose level feature as previously implemented caused a
33    large performance penalty.  The fix required some minor incompatibilities
34    if the new rasterisk is used to connect to an earlier version.  If the new
35    rasterisk connects to an older Asterisk version then the root console verbose
36    level is always affected by the "core set verbose" command of the remote
37    console even though it may appear to only affect the current console.  If
38    an older version of rasterisk connects to the new version then the
39    "core set verbose" command will have no effect.
40
41  - Added a new Compiler Flag, REF_DEBUG. When enabled, reference counted
42    objects will emit additional debug information to the refs log file located
43    in the standard Asterisk log file directory. This log file is useful in
44    tracking down object leaks and other reference counting issues. Prior to
45    this version, this option was only available by modifying the source code
46    directly. This change also includes a new script, refcounter.py, in the
47    contrib folder that will process the refs log file.
48
49  - The asterisk compatibility options in asterisk.conf have been removed.
50    These options enabled certain backwards compatibility features for
51    pbx_realtime, res_agi, and app_set that made their behaviour similar to
52    Asterisk 1.4. Users who used these backwards compatibility settings should
53    update their dialplans to use ',' instead of '|' as a delimiter, and should
54    use the Set dialplan application instead of the MSet dialplan application.
55
56 ARI:
57  - The ARI version has been changed from 1.0.0 to 1.1.0. This is to reflect
58    the backwards compatible changes listed below.
59
60  - Added a new ARI resource 'mailboxes' which allows the creation and
61    modification of mailboxes managed by external MWI. Modules res_mwi_external
62    and res_stasis_mailbox must be enabled to use this resource.
63
64  - Added new events for externally initiated transfers. The event
65    BridgeBlindTransfer is now raised when a channel initiates a blind transfer
66    of a bridge in the ARI controlled application to the dialplan; the
67    BridgeAttendedTransfer event is raised when a channel initiates an
68    attended transfer of a bridge in the ARI controlled application to the
69    dialplan.
70
71  - Channel variables may now be specified as a body parameter to the
72    POST /channels operation. The 'variables' key in the JSON is interpreted
73    as a sequence of key/value pairs that will be added to the created channel
74    as channel variables. Other parameters in the JSON body are treated as
75    query parameters of the same name.
76
77  - A bug fix in bridge creation has caused a behavioural change in how
78    subscriptions are created for bridges. A bridge created through ARI, does
79    not, by itself, have a subscription created for any particular Stasis
80    application. When a channel in a Stasis application joins a bridge, an
81    implicit event subscription is created for that bridge as well. Previously,
82    when a channel left such a bridge, the subscription was leaked; this allowed
83    for later bridge events to continue to be pushed to the subscribed
84    applications. That leak has been fixed; as a result, bridge events that were
85    delivered after a channel left the bridge are no longer delivered. An
86    application must subscribe to a bridge through the applications resource if
87    it wishes to receive all events related to a bridge.
88
89 AMI:
90  - The AMI version has been changed from 2.0.0 to 2.1.0. This is to reflect
91    the backwards compatible changes listed below.
92
93  - The DialStatus field in the DialEnd event can now have additional values.
94    This includes ABORT, CONTINUE, and GOTO.
95
96  - The res_mwi_external_ami module can, if loaded, provide additional AMI
97    actions and events that convey MWI state within Asterisk. This includes
98    the MWIGet, MWIUpdate, and MWIDelete actions, as well as the MWIGet and
99    MWIGetComplete events that occur in response to an MWIGet action.
100
101  - AMI now contains a new class authorization, 'security'. This is used with
102    the following new events: FailedACL, InvalidAccountID, SessionLimit,
103    MemoryLimit, LoadAverageLimit, RequestNotAllowed, AuthMethodNotAllowed,
104    RequestBadFormat, SuccessfulAuth, UnexpectedAddress, ChallengeResponseFailed,
105    InvalidPassword, ChallengeSent, and InvalidTransport.
106
107  - Bridge related events now have two additional fields: BridgeName and
108    BridgeCreator. BridgeName is a descriptive name for the bridge;
109    BridgeCreator is the name of the entity that created the bridge. This
110    affects the following events: ConfbridgeStart, ConfbridgeEnd,
111    ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
112    ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
113    AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave
114
115  - MixMonitor AMI actions now require users to have authorization classes.
116    * MixMonitor - system
117    * MixMonitorMute - call or system
118    * StopMixMonitor - call or system
119
120  - Removed the undocumented manager.conf block-sockets option.  It interferes with
121    TCP/TLS inactivity timeouts.
122
123  - The response to the PresenceState AMI action has historically contained two
124    Message keys. The first of these is used as an informative message regarding
125    the success/failure of the action; the second contains a Presence state
126    specific message. Having two keys with the same unique name in an AMI
127    message is cumbersome for some client; hence, the Presence specific Message
128    has been deprecated. The message will now contain a PresenceMessage key
129    for the presence specific information; the Message key containing presence
130    information will be removed in the next major version of AMI.
131
132 CDRs:
133  - The "endbeforehexten" setting now defaults to "yes", instead of "no".
134    When set to "no", yhis setting will cause a new CDR to be generated when a
135    channel enters into hangup logic (either the 'h' extension or a hangup
136    handler subroutine). In general, this is not the preferred default: this
137    causes extra CDRs to be generated for a channel in many common dialplans.
138
139  - The cdr_sqlite module was deprecated and has been removed. Users of this
140    module should use the cdr_sqlite3_custom module instead.
141
142 chan_dahdi:
143  - SS7 support now requires libss7 v2.0 or later.
144
145  - Added the inband_on_setup_ack compatibility option to chan_dahdi.conf to
146    deal with switches that don't send an inband progress indication in the
147    SETUP ACKNOWLEDGE message.
148    Default is now no.
149
150 chan_gtalk
151  - This module was deprecated and has been removed. Users of chan_gtalk
152    should use chan_motif.
153
154 chan_h323
155  - This module was deprecated and has been removed. Users of chan_h323
156    should use chan_ooh323.
157
158 chan_jingle
159  - This module was deprecated and has been removed. Users of chan_jingle
160    should use chan_motif.
161
162 chan_pjsip:
163  - Added a 'force_avp' option to chan_pjsip which will force the usage of
164    'RTP/AVP', 'RTP/AVPF', 'RTP/SAVP', or 'RTP/SAVPF' as the media transport type
165    in SDP offers depending on settings, even when DTLS is used for media
166    encryption.
167
168  - Added a 'media_use_received_transport' option to chan_pjsip which will
169    cause the SDP answer to use the media transport as received in the SDP
170    offer.
171
172 chan_sip:
173  - Made set SIPREFERREDBYHDR as inheritable for better chan_pjsip
174    interoperability.
175
176  - The SIPPEER dialplan function no longer supports using a colon as a
177    delimiter for parameters. The parameters for the function should be
178    delimited using a comma.
179
180  - The SIPCHANINFO dialplan function was deprecated and has been removed. Users
181    of the function should use the CHANNEL function instead.
182
183  - Added a 'force_avp' option for chan_sip. When enabled this option will
184    cause the media transport in the offer or answer SDP to be 'RTP/AVP',
185    'RTP/AVPF', 'RTP/SAVP', or 'RTP/SAVPF' even if a DTLS stream has been
186    configured. This option can be set to improve interoperability with WebRTC
187    clients that don't use the RFC defined transport for DTLS.
188
189  - The 'dtlsverify' option in chan_sip now has additional values besides
190    'yes' and 'no'. If 'yes' is specified both the certificate and fingerprint
191    will be verified. If 'no' is specified then neither the certificate or
192    fingerprint is verified. If 'certificate' is specified then only the
193    certificate is verified. If 'fingerprint' is specified then only the
194    fingerprint is verified.
195
196  - A 'dtlsfingerprint' option has been added to chan_sip which allows the
197    hash to be specified for the DTLS fingerprint placed in SDP. Supported
198    values are 'sha-1' and 'sha-256' with 'sha-256' being the default.
199
200 CLI commands:
201  - "core show settings" now lists the current console verbosity in addition
202    to the root console verbosity.
203
204  - "core set verbose" has not been able to support the by module verbose
205    logging levels since verbose logging levels were made per console.  That
206    syntax is now removed and a silence option added in its place.
207
208 ConfBridge:
209 - The sound_place_into_conference sound used in Confbridge is now deprecated
210   and is no longer functional since it has been broken since its inception
211   and the fix involved using a different method to achieve the same goal. The
212   new method to achieve this functionality is by using sound_begin to play
213   a sound to the conference when waitmarked users are moved into the conference.
214
215
216 Configuration Files:
217  - The 'verbose' setting in logger.conf still takes an optional argument,
218    specifying the verbosity level for each logging destination.  However,
219    the default is now to once again follow the current root console level.
220    As a result, using the AMI Command action with "core set verbose" could
221    again set the root console verbose level and affect the verbose level
222    logged.
223
224  - The manager.conf 'eventfilter' now takes an "extended" regular expression
225    instead of a "basic" one.
226
227  - The unistim.conf 'dateformat' has changed meaning of options values to conform
228    values used inside Unistim protocol
229
230 HTTP:
231  - Added http.conf session_inactivity timer option to close HTTP connections
232    that aren't doing anything.
233
234  - Added support for persistent HTTP connections.  To enable persistent
235    HTTP connections configure the keep alive time between HTTP requests.  The
236    keep alive time between HTTP requests is configured in http.conf with the
237    session_keep_alive parameter.
238
239 MusicOnHold
240  - The SetMusicOnHold dialplan application was deprecated and has been removed.
241    Users of the application should use the CHANNEL function's musicclass
242    setting instead.
243
244  - The WaitMusicOnHold dialplan application was deprecated and has been
245    removed. Users of the application should use MusicOnHold with a duration
246    parameter instead.
247
248 ODBC:
249 - The compatibility setting, allow_empty_string_in_nontext, has been removed.
250   Empty column values will be stored as empty strings during realtime updates.
251
252 Realtime Configuration:
253  - WARNING: The database migration script that adds the 'extensions' table for
254    realtime had to be modified due to an error when installing for MySQL.  The
255    'extensions' table's 'id' column was changed to be a primary key.  This could
256    potentially cause a migration problem.  If so, it may be necessary to
257    manually alter the affected table/column to bring it back in line with the
258    migration scripts.
259
260  - New columns have been added to realtime tables for 'support_path' on
261    ps_registrations and ps_aors and for 'path' on ps_contacts for the new
262    SIP Path support in chan_pjsip.
263
264  - The following new tables have been added for pjsip realtime: 'ps_systems',
265    'ps_globals', 'ps_tranports', 'ps_registrations'.
266
267  - The following columns were added to the 'ps_aors' realtime table:
268    'maximum_expiration', 'outbound_proxy', and 'support_path'.
269
270  - The following columns were added to the 'ps_contacts' realtime table:
271    'outbound_proxy', 'user_agent', and 'path'.
272
273  - New columns have been added to the ps_endpoints realtime table for the
274    'media_address', 'redirect_method' and 'set_var' options.  Also the
275    'mwi_fromuser' column was renamed to 'mwi_from_user'. A new column
276    'message_context' was added to let users configure how MESSAGE requests are
277    routed to the dialplan.
278
279  - A new column was added to the 'ps_globals' realtime table for the 'debug'
280    option.
281
282  - PJSIP endpoint columns 'tos_audio' and 'tos_video' have been changed from
283    yes/no enumerators to string values. 'cos_audio' and 'cos_video' have been
284    changed from yes/no enumerators to integer values. PJSIP transport column
285    'tos' has been changed from a yes/no enumerator to a string value. 'cos' has
286    been changed from a yes/no enumerator to an integer value.
287
288  - The 'queues' and 'queue_members' realtime tables have been added to the
289    config Alembic scripts.
290
291  - A new set of Alembic scripts has been added for CDR tables. This will create
292    a 'cdr' table with the default schema that Asterisk expects.
293
294 res_jabber:
295  - This module was deprecated and has been removed. Users of this module should
296    use res_xmpp instead.
297
298 safe_asterisk:
299  - The safe_asterisk script was previously not installed on top of an existing
300    version. This caused bug-fixes in that script not to be deployed. If your
301    safe_asterisk script is customized, be sure to keep your changes. Custom
302    values for variables should be created in *.sh file(s) inside
303    ASTETCDIR/startup.d/. See ASTERISK-21965.
304
305  - Changed a log message in safe_asterisk and the $NOTIFY mail subject. If
306    you use tools to parse either of them, update your parse functions
307    accordingly. The changed strings are:
308    - "Exited on signal $EXITSIGNAL" => "Asterisk exited on signal $EXITSIGNAL."
309    - "Asterisk Died" => "Asterisk on $MACHINE died (sig $EXITSIGNAL)"
310
311 Unistim:
312  - Added 'dtmf_duration' option with changing default operation to disable
313    receivied dtmf playback on unistim phone
314
315 Utilities:
316  - The refcounter program has been removed in favor of the refcounter.py script
317    in contrib/scripts.
318
319 WebSockets:
320  - Added a compatibility option to ari.conf, sip.conf, and pjsip.conf
321    'websocket_write_timeout'. When a websocket connection exists where Asterisk
322    writes a substantial amount of data to the connected client, and the connected
323    client is slow to process the received data, the socket may be disconnected.
324    In such cases, it may be necessary to adjust this value.
325    Default is 100 ms.
326
327 ===========================================================
328 ===========================================================