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