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