build_tools: Fix download_externals to handle certified branches
[asterisk/asterisk.git] / UPGRADE-13.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 General Asterisk Changes:
25  - The asterisk command line -I option and the asterisk.conf internal_timing
26    option are removed and always enabled if any timing module is loaded.
27
28  - The per console verbose level feature as previously implemented caused a
29    large performance penalty.  The fix required some minor incompatibilities
30    if the new rasterisk is used to connect to an earlier version.  If the new
31    rasterisk connects to an older Asterisk version then the root console verbose
32    level is always affected by the "core set verbose" command of the remote
33    console even though it may appear to only affect the current console.  If
34    an older version of rasterisk connects to the new version then the
35    "core set verbose" command will have no effect.
36
37  - The asterisk compatibility options in asterisk.conf have been removed.
38    These options enabled certain backwards compatibility features for
39    pbx_realtime, res_agi, and app_set that made their behaviour similar to
40    Asterisk 1.4. Users who used these backwards compatibility settings should
41    update their dialplans to use ',' instead of '|' as a delimiter, and should
42    use the Set dialplan application instead of the MSet dialplan application.
43
44 Build System:
45  - Sample config files have been moved from configs/ to a subfolder of that
46    directory, 'samples'.
47
48  - The menuselect utility has been pulled into the Asterisk repository. As a
49    result, the libxml2 development library is now a required dependency for
50    Asterisk.
51
52  - Added a new Compiler Flag, REF_DEBUG. When enabled, reference counted
53    objects will emit additional debug information to the refs log file located
54    in the standard Asterisk log file directory. This log file is useful in
55    tracking down object leaks and other reference counting issues. Prior to
56    this version, this option was only available by modifying the source code
57    directly. This change also includes a new script, refcounter.py, in the
58    contrib folder that will process the refs log file.
59
60 Applications:
61
62 ConfBridge:
63  - The sound_place_into_conference sound used in Confbridge is now deprecated
64    and is no longer functional since it has been broken since its inception
65    and the fix involved using a different method to achieve the same goal. The
66    new method to achieve this functionality is by using sound_begin to play
67    a sound to the conference when waitmarked users are moved into the conference.
68
69  - Added 'Admin' header to ConfbridgeJoin, ConfbridgeLeave, ConfbridgeMute,
70    ConfbridgeUnmute, and ConfbridgeTalking AMI events.
71
72 ControlPlayback:
73  - The ControlPlayback and 'control stream file' AGI command will no longer
74    implicitly answer the channel. If you do not answer the channel prior to
75    using either this application or AGI command, you must send Progress
76    first.
77
78 Queue:
79  - Queue rules provided in queuerules.conf can no longer be named "general".
80
81 SetMusicOnHold:
82  - The SetMusicOnHold dialplan application was deprecated and has been removed.
83    Users of the application should use the CHANNEL function's musicclass
84    setting instead.
85
86 WaitMusicOnHold:
87  - The WaitMusicOnHold dialplan application was deprecated and has been
88    removed. Users of the application should use MusicOnHold with a duration
89    parameter instead.
90
91 CDR Backends:
92  - The cdr_sqlite module was deprecated and has been removed. Users of this
93    module should use the cdr_sqlite3_custom module instead.
94
95 Channel Drivers:
96
97 chan_dahdi:
98  - SS7 support now requires libss7 v2.0 or later.
99
100  - Added the inband_on_setup_ack compatibility option to chan_dahdi.conf to
101    deal with switches that don't send an inband progress indication in the
102    SETUP ACKNOWLEDGE message.
103    Default is now no.
104
105 chan_gtalk
106  - This module was deprecated and has been removed. Users of chan_gtalk
107    should use chan_motif.
108
109 chan_h323
110  - This module was deprecated and has been removed. Users of chan_h323
111    should use chan_ooh323.
112
113 chan_jingle
114  - This module was deprecated and has been removed. Users of chan_jingle
115    should use chan_motif.
116
117 chan_pjsip:
118  - Added a 'force_avp' option to chan_pjsip which will force the usage of
119    'RTP/AVP', 'RTP/AVPF', 'RTP/SAVP', or 'RTP/SAVPF' as the media transport type
120    in SDP offers depending on settings, even when DTLS is used for media
121    encryption.
122
123  - Added a 'media_use_received_transport' option to chan_pjsip which will
124    cause the SDP answer to use the media transport as received in the SDP
125    offer.
126
127 chan_sip:
128  - Made set SIPREFERREDBYHDR as inheritable for better chan_pjsip
129    interoperability.
130
131  - The SIPPEER dialplan function no longer supports using a colon as a
132    delimiter for parameters. The parameters for the function should be
133    delimited using a comma.
134
135  - The SIPCHANINFO dialplan function was deprecated and has been removed. Users
136    of the function should use the CHANNEL function instead.
137
138  - Added a 'force_avp' option for chan_sip. When enabled this option will
139    cause the media transport in the offer or answer SDP to be 'RTP/AVP',
140    'RTP/AVPF', 'RTP/SAVP', or 'RTP/SAVPF' even if a DTLS stream has been
141    configured. This option can be set to improve interoperability with WebRTC
142    clients that don't use the RFC defined transport for DTLS.
143
144  - The 'dtlsverify' option in chan_sip now has additional values besides
145    'yes' and 'no'. If 'yes' is specified both the certificate and fingerprint
146    will be verified. If 'no' is specified then neither the certificate or
147    fingerprint is verified. If 'certificate' is specified then only the
148    certificate is verified. If 'fingerprint' is specified then only the
149    fingerprint is verified.
150
151  - A 'dtlsfingerprint' option has been added to chan_sip which allows the
152    hash to be specified for the DTLS fingerprint placed in SDP. Supported
153    values are 'sha-1' and 'sha-256' with 'sha-256' being the default.
154
155  - The 'progressinband=never' option is now more zealous in the persecution of
156    progress messages coming from Asterisk. Channels bridged with a SIP channel
157    that has 'progressinband=never' set will not be able to forward their
158    progress indications through to the SIP device. chan_sip will now turn such
159    progress indications into a 180 Ringing (if a 180 has not yet been
160    transmitted) if 'progressinband=never'.
161
162   - The codec preference order in an SDP during an offer is slightly different
163     than previous releases. Prior to Asterisk 13, the preference order of
164     codecs used to be:
165     (1) Our preferred codec
166     (2) Our configured codecs
167     (3) Any non-audio joint codecs
168
169     One of the ways the new media format architecture in Asterisk 13 improves
170     performance is by reference counting formats, such that they can be reused
171     in many places without additional allocation. To not require a large
172     amount of locking, an instance of a format is immutable by convention.
173     This works well except for formats with attributes. Since a media format
174     with an attribute is a different object than the same format without an
175     attribute, we have to carry over the formats with attributes from an
176     inbound offer so that the correct attributes are offered in an outgoing
177     INVITE request. This requires some subtle tweaks to the preference order
178     to ensure that the media format with attributes is offered to a remote
179     peer, as opposed to the same media format (but without attributes) that
180     may be stored in the peer object.
181
182     All of this means that our offer offer list will now be:
183     (1) Our preferred codec
184     (2) Any joint codecs offered by the inbound offer
185     (3) All other codecs that are not the preferred codec and not a joint
186         codec offered by the inbound offer
187
188 chan_unistim:
189  - The unistim.conf 'dateformat' has changed meaning of options values to conform
190    values used inside Unistim protocol
191
192  - Added 'dtmf_duration' option with changing default operation to disable
193    receivied dtmf playback on unistim phone
194
195 Core:
196
197 Account Codes:
198  - accountcode behavior changed somewhat to add functional peeraccount
199    support.  The main change is that local channels now cross accountcode
200    and peeraccount across the special bridge between the ;1 and ;2 channels
201    just like channels between normal bridges.  See the CHANGES file for
202    more information.
203
204 ARI:
205  - The ARI version has been changed to 1.5.0. This is to reflect backwards
206    compatible changes made since 12.0.0 was released.
207
208  - Added a new ARI resource 'mailboxes' which allows the creation and
209    modification of mailboxes managed by external MWI. Modules res_mwi_external
210    and res_stasis_mailbox must be enabled to use this resource.
211
212  - Added new events for externally initiated transfers. The event
213    BridgeBlindTransfer is now raised when a channel initiates a blind transfer
214    of a bridge in the ARI controlled application to the dialplan; the
215    BridgeAttendedTransfer event is raised when a channel initiates an
216    attended transfer of a bridge in the ARI controlled application to the
217    dialplan.
218
219  - Channel variables may now be specified as a body parameter to the
220    POST /channels operation. The 'variables' key in the JSON is interpreted
221    as a sequence of key/value pairs that will be added to the created channel
222    as channel variables. Other parameters in the JSON body are treated as
223    query parameters of the same name.
224
225  - A bug fix in bridge creation has caused a behavioural change in how
226    subscriptions are created for bridges. A bridge created through ARI, does
227    not, by itself, have a subscription created for any particular Stasis
228    application. When a channel in a Stasis application joins a bridge, an
229    implicit event subscription is created for that bridge as well. Previously,
230    when a channel left such a bridge, the subscription was leaked; this allowed
231    for later bridge events to continue to be pushed to the subscribed
232    applications. That leak has been fixed; as a result, bridge events that were
233    delivered after a channel left the bridge are no longer delivered. An
234    application must subscribe to a bridge through the applications resource if
235    it wishes to receive all events related to a bridge.
236
237 AMI:
238  - The AMI version has been changed to 2.5.0. This is to reflect backwards
239    compatible changes made since 12.0.0 was released.
240
241  - The DialStatus field in the DialEnd event can now have additional values.
242    This includes ABORT, CONTINUE, and GOTO.
243
244  - The res_mwi_external_ami module can, if loaded, provide additional AMI
245    actions and events that convey MWI state within Asterisk. This includes
246    the MWIGet, MWIUpdate, and MWIDelete actions, as well as the MWIGet and
247    MWIGetComplete events that occur in response to an MWIGet action.
248
249  - AMI now contains a new class authorization, 'security'. This is used with
250    the following new events: FailedACL, InvalidAccountID, SessionLimit,
251    MemoryLimit, LoadAverageLimit, RequestNotAllowed, AuthMethodNotAllowed,
252    RequestBadFormat, SuccessfulAuth, UnexpectedAddress, ChallengeResponseFailed,
253    InvalidPassword, ChallengeSent, and InvalidTransport.
254
255  - Bridge related events now have two additional fields: BridgeName and
256    BridgeCreator. BridgeName is a descriptive name for the bridge;
257    BridgeCreator is the name of the entity that created the bridge. This
258    affects the following events: ConfbridgeStart, ConfbridgeEnd,
259    ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
260    ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
261    AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave
262
263  - MixMonitor AMI actions now require users to have authorization classes.
264    * MixMonitor - system
265    * MixMonitorMute - call or system
266    * StopMixMonitor - call or system
267
268  - Removed the undocumented manager.conf block-sockets option.  It interferes with
269    TCP/TLS inactivity timeouts.
270
271  - The response to the PresenceState AMI action has historically contained two
272    Message keys. The first of these is used as an informative message regarding
273    the success/failure of the action; the second contains a Presence state
274    specific message. Having two keys with the same unique name in an AMI
275    message is cumbersome for some client; hence, the Presence specific Message
276    has been deprecated. The message will now contain a PresenceMessage key
277    for the presence specific information; the Message key containing presence
278    information will be removed in the next major version of AMI.
279
280  - The manager.conf 'eventfilter' now takes an "extended" regular expression
281    instead of a "basic" one.
282
283 CDRs:
284  - The "endbeforehexten" setting now defaults to "yes", instead of "no".
285    When set to "no", yhis setting will cause a new CDR to be generated when a
286    channel enters into hangup logic (either the 'h' extension or a hangup
287    handler subroutine). In general, this is not the preferred default: this
288    causes extra CDRs to be generated for a channel in many common dialplans.
289
290 CLI commands:
291  - "core show settings" now lists the current console verbosity in addition
292    to the root console verbosity.
293
294  - "core set verbose" has not been able to support the by module verbose
295    logging levels since verbose logging levels were made per console.  That
296    syntax is now removed and a silence option added in its place.
297
298 Logging:
299  - The 'verbose' setting in logger.conf still takes an optional argument,
300    specifying the verbosity level for each logging destination.  However,
301    the default is now to once again follow the current root console level.
302    As a result, using the AMI Command action with "core set verbose" could
303    again set the root console verbose level and affect the verbose level
304    logged.
305
306 HTTP:
307  - Added http.conf session_inactivity timer option to close HTTP connections
308    that aren't doing anything.
309
310  - Added support for persistent HTTP connections.  To enable persistent
311    HTTP connections configure the keep alive time between HTTP requests.  The
312    keep alive time between HTTP requests is configured in http.conf with the
313    session_keep_alive parameter.
314
315 Realtime Configuration:
316  - WARNING: The database migration script that adds the 'extensions' table for
317    realtime had to be modified due to an error when installing for MySQL.  The
318    'extensions' table's 'id' column was changed to be a primary key.  This could
319    potentially cause a migration problem.  If so, it may be necessary to
320    manually alter the affected table/column to bring it back in line with the
321    migration scripts.
322
323  - New columns have been added to realtime tables for 'support_path' on
324    ps_registrations and ps_aors and for 'path' on ps_contacts for the new
325    SIP Path support in chan_pjsip.
326
327  - The following new tables have been added for pjsip realtime: 'ps_systems',
328    'ps_globals', 'ps_tranports', 'ps_registrations'.
329
330  - The following columns were added to the 'ps_aors' realtime table:
331    'maximum_expiration', 'outbound_proxy', and 'support_path'.
332
333  - The following columns were added to the 'ps_contacts' realtime table:
334    'outbound_proxy', 'user_agent', and 'path'.
335
336  - New columns have been added to the ps_endpoints realtime table for the
337    'media_address', 'redirect_method' and 'set_var' options.  Also the
338    'mwi_fromuser' column was renamed to 'mwi_from_user'. A new column
339    'message_context' was added to let users configure how MESSAGE requests are
340    routed to the dialplan.
341
342  - A new column was added to the 'ps_globals' realtime table for the 'debug'
343    option.
344
345  - PJSIP endpoint columns 'tos_audio' and 'tos_video' have been changed from
346    yes/no enumerators to string values. 'cos_audio' and 'cos_video' have been
347    changed from yes/no enumerators to integer values. PJSIP transport column
348    'tos' has been changed from a yes/no enumerator to a string value. 'cos' has
349    been changed from a yes/no enumerator to an integer value.
350
351  - The 'queues' and 'queue_members' realtime tables have been added to the
352    config Alembic scripts.
353
354  - A new set of Alembic scripts has been added for CDR tables. This will create
355    a 'cdr' table with the default schema that Asterisk expects.
356
357  - A new upgrade script has been added that adds a 'queue_rules' table for
358    app_queue. Users of app_queue can store queue rules in a database. It is
359    important to note that app_queue only looks for this table on module load or
360    module reload; for more information, see the CHANGES file.
361
362 Resources:
363
364 res_odbc:
365 - The compatibility setting, allow_empty_string_in_nontext, has been removed.
366   Empty column values will be stored as empty strings during realtime updates.
367
368 res_jabber:
369  - This module was deprecated and has been removed. Users of this module should
370    use res_xmpp instead.
371
372 res_http_websocket:
373  - Added a compatibility option to ari.conf, sip.conf, and pjsip.conf
374    'websocket_write_timeout'. When a websocket connection exists where Asterisk
375    writes a substantial amount of data to the connected client, and the connected
376    client is slow to process the received data, the socket may be disconnected.
377    In such cases, it may be necessary to adjust this value.
378    Default is 100 ms.
379 Scripts:
380
381 safe_asterisk:
382  - The safe_asterisk script was previously not installed on top of an existing
383    version. This caused bug-fixes in that script not to be deployed. If your
384    safe_asterisk script is customized, be sure to keep your changes. Custom
385    values for variables should be created in *.sh file(s) inside
386    ASTETCDIR/startup.d/. See ASTERISK-21965.
387
388  - Changed a log message in safe_asterisk and the $NOTIFY mail subject. If
389    you use tools to parse either of them, update your parse functions
390    accordingly. The changed strings are:
391    - "Exited on signal $EXITSIGNAL" => "Asterisk exited on signal $EXITSIGNAL."
392    - "Asterisk Died" => "Asterisk on $MACHINE died (sig $EXITSIGNAL)"
393
394 Utilities:
395  - The refcounter program has been removed in favor of the refcounter.py script
396    in contrib/scripts.
397
398 ===========================================================
399 ===========================================================