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