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