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