Asterisk/UPGRADE.txt

===========================================================
===
=== Information for upgrading between Asterisk versions
===
=== These files document all the changes that MUST be taken
=== into account when upgrading between the Asterisk
=== versions listed below. These changes may require that
=== you modify your configuration files, dialplan or (in
=== some cases) source code if you have your own Asterisk
=== modules or patches. These files also include advance
=== notice of any functionality that has been marked as
=== 'deprecated' and may be removed in a future release,
=== along with the suggested replacement functionality.
===
=== UPGRADE-1.2.txt -- Upgrade info for 1.0 to 1.2
=== UPGRADE-1.4.txt -- Upgrade info for 1.2 to 1.4
=== UPGRADE-1.6.txt -- Upgrade info for 1.4 to 1.6
=== UPGRADE-1.8.txt -- Upgrade info for 1.6 to 1.8
=== UPGRADE-10.txt  -- Upgrade info for 1.8 to 10
=== UPGRADE-11.txt  -- Upgrade info for 10 to 11
=== UPGRADE-12.txt  -- Upgrade info for 11 to 12
===========================================================

From 13.23.1 to 13.24.0:

Core
------------------
 * ast_bt_get_symbols() now returns a vector of strings instead of an
   array of strings.  This must be freed with ast_bt_free_symbols.

From 13.20.0 to 13.21.0:

app_dial
------------------
 * The Dial application now supports early-media video (in addition to
   audio) on both the calling as well as the called party.
   Be aware that this is a change in behavior.

From 13.19.0 to 13.20.0:

app_confbridge
------------------
 * Made the AMI ConfbridgeList action's ConfbridgeList events output all
   the standard channel snapshot headers instead of a few hand-coded channel
   snapshot headers.  The benefit is that the CallerIDName gets disruptive
   characters like CR, LF, Tab, and a few others escaped.  However, an empty
   CallerIDName is now output as "<unknown>" instead of "<no name>".

res_pjsip
------------------
 * Users who are matching endpoints by SIP header need to reevaluate their
   global "endpoint_identifier_order" option in light of the "ip" endpoint
   identifier method split into the "ip" and "header" endpoint identifier
   methods.

 * The pjsip_transport_event feature introduced in 13.18.0 has been refactored.
   Any external modules that may have used that feature (highly unlikey) will
   need to be changed as the API has been altered slightly.

res_pjsip_endpoint_identifier_ip
------------------
 * The endpoint identifier "ip" method previously recognized endpoints either
   by IP address or a matching SIP header.  The "ip" endpoint identifier method
   is now split into the "ip" and "header" endpoint identifier methods.  The
   "ip" endpoint identifier method only matches by IP address and the "header"
   endpoint identifier method only matches by SIP header.  The split allows the
   user to control the relative priority of the IP address and the SIP header
   identification methods in the global "endpoint_identifier_order" option.
   e.g., If you have two type=identify sections where one matches by IP address
   for endpoint alice and the other matches by SIP header for endpoint bob then
   you can now predict which endpoint is matched when a request comes in that
   matches both.

res_pjsip_transport_management
------------------
 * Since res_pjsip_transport_management provides several attack
   mitigation features, its functionality moved to res_pjsip and
   this module has been removed.  This way the features will always
   be available if res_pjsip is loaded.

From 13.17.0 to 13.18.0:

Core:
 - ast_app_parse_timelen now returns an error if it encounters extra characters
   at the end of the string to be parsed.

From 13.15.0 to 13.16.0:

Core:
 - Support for embedded modules has been removed.  This has not worked in
   many years.  LOADABLE_MODULES menuselect option is also removed as
   loadable module support is now always enabled.

From 13.14.0 to 13.15.0:

res_rtp_asterisk:
 - The RTP layer of Asterisk now has support for RFC 5761: "Multiplexing RTP
   Data and Control Packets on a Single Port." For the PJSIP channel driver,
   chan_pjsip, you can set "rtcp_mux = yes" on a PJSIP endpoint in pjsip.conf
   to enable the feature. For chan_sip you can set "rtcp_mux = yes" either
   globally or on a per-peer basis in sip.conf.

From 13.8.0 to 13.9.0:

res_parking:
 - The dynamic parking lot creation channel variables PARKINGDYNAMIC,
   PARKINGDYNCONTEXT, PARKINGDYNEXTEN, and PARKINGDYNPOS are now looked
   for in the parker's channel instead of the parked channel.  This is only
   of significance if the parker uses blind transfer or the DTMF one-step
   parking feature.  You need to use the double underscore '__' inheritance
   for these variables.  The indefinite inheritance is also recommended
   for the PARKINGEXTEN variable.

From 13.7.0 to 13.8.0:

res_pjsip:
 - res_pjsip now depends on res_pjproject.  If autoload=no in modules.conf,
   res_pjproject must be explicitly loaded or res_pjsip and all of its
   dependents will fail to load.

REDIRECTING(reason):
 - See the CHANGES file for a description of the behavior change.

ODBC:
 - Connection pooling/sharing has been completely removed from Asterisk
   in favor of letting ODBC take care of it instead. It is strongly
   recommended that you enable connection pooling in unixODBC. As a result
   of this, the "pooling", "shared_connection", "limit", and "idlecheck"
   options in res_odbc.conf are deprecated and provide no function.

From 13.5.0 to 13.6.0:

ARI:
 - The version of ARI has been updated to 1.9.0 to reflect the backwards
   compatible changes outlined in the CHANGES file.

From 13.4.0 to 13.5.0:

AMI:
 - The version of AMI has been bumped to 2.8.0 to account for backwards
   compatible features included with this release.  See CHANGES for more
   information.

ARI:
 - The version of ARI has been updated to 1.8.0 to reflect the backwards
   compatible changes outlined in the CHANGES file.

From 13.3.0 to 13.4.0:

Source Control:
 - Asterisk has moved from Subversion to Git. As a result, several changes
   were required in functionality. These are listed individually in the
   notes below.

AMI:
 - The 'ModuleCheck' Action's Version key will now always report the
   current version of Asterisk.

ARI:
 - The version of ARI has been updated to 1.7.0 to reflect the backwards
   compatible changes outlined in the CHANGES file.

CLI:
 - The 'core show file version' command has been altered. In the past,
   this command would show the SVN revision of the source files compiled
   in Asterisk. However, when Asterisk moved to Git, the source control
   version support was removed. As a result, the version information shown
   by the CLI command is always the Asterisk version. This CLI command
   will be removed in Asterisk 14.

chan_dahdi:
 - Added the force_restart_unavailable_chans compatibility option.  When
   enabled it causes Asterisk to restart the ISDN B channel if an outgoing
   call receives cause 44 (Requested channel not available).  The new option
   is enabled by default in current release branches for backward
   compatibility.

res_pjsip:
 - The dtmf_mode now supports a new option, 'auto'. This mode will attempt to
   detect if the device supports RFC4733 DTMF. If so, it will choose that
   DTMF type; if not, it will choose 'inband' DTMF.

res_pjsip_dlg_options:
 - A new module, this handles OPTIONS requests sent in-dialog. This module
   should have no adverse effects for those upgrading; this note merely
   serves as an indication that a new module exists.

cdr_odbc:
 - Added support for post-1.8 CDR columns 'peeraccount', 'linkedid', and
   'sequence'. Support for the new columns can be enabled via the newcdrcolumns
   option in cdr_odbc.conf.

cdr_csv:
 - Added a new configuration option, "newcdrcolumns", which enables use of the
   post-1.8 CDR columns 'peeraccount', 'linkedid', and 'sequence'.

From 13.2.0 to 13.3.0:

chan_dahdi:
 - For users using the FXO port (FXS signaling) distinctive ring detection
   feature, you will need to adjust the dringX count values.  The count
   values now only record ring end events instead of any DAHDI event.  A
   ring-ring-ring pattern would exceed the pattern limits and stop
   Caller-ID detection.

From 13.1.0 to 13.2.0:

ARI:
 - The version of ARI has been bumped to 1.7.0 to account for backwards
   compatible features included with this release. See CHANGES for more
   information.

AMI:
 - The version of AMI has been bumped to 2.7.0 to account for backwards
   compatible features included with this release. See CHANGES for more
   information.

chan_dahdi:
 - The CALLERID(ani2) value for incoming calls is now populated in featdmf
   signaling mode.  The information was previously discarded.

chan_iax2:
 - The iax.conf forcejitterbuffer option has been removed.  It is now always
   forced if you set iax.conf jitterbuffer=yes.  If you put a jitter buffer
   on a channel it will be on the channel.

From 13.0.0 to 13.1.0:

ARI:
 - The version of ARI has been bumped to 1.6.0 to account for backwards
   compatible features included with this release. See CHANGES for more
   information.

AMI:
 - The version of AMI has been bumped to 2.6.0 to account for backwards
   compatible features included with this release. See CHANGES for more
   information.

Core:
 - The core of Asterisk uses a message bus called "Stasis" to distribute
   information to internal components. For performance reasons, the message
   distribution was modified to make use of a thread pool instead of a
   dedicated thread per consumer in certain cases. The initial settings for
   the thread pool can now be configured in 'stasis.conf'.

PJSIP:
 - Added the pjsip.conf system type disable_tcp_switch option.  The option
   allows the user to disable switching from UDP to TCP transports described
   by RFC 3261 section 18.1.1.

From 12 to 13:
General Asterisk Changes:
 - The asterisk command line -I option and the asterisk.conf internal_timing
   option are removed and always enabled if any timing module is loaded.

 - The per console verbose level feature as previously implemented caused a
   large performance penalty.  The fix required some minor incompatibilities
   if the new rasterisk is used to connect to an earlier version.  If the new
   rasterisk connects to an older Asterisk version then the root console verbose
   level is always affected by the "core set verbose" command of the remote
   console even though it may appear to only affect the current console.  If
   an older version of rasterisk connects to the new version then the
   "core set verbose" command will have no effect.

 - The asterisk compatibility options in asterisk.conf have been removed.
   These options enabled certain backwards compatibility features for
   pbx_realtime, res_agi, and app_set that made their behaviour similar to
   Asterisk 1.4. Users who used these backwards compatibility settings should
   update their dialplans to use ',' instead of '|' as a delimiter, and should
   use the Set dialplan application instead of the MSet dialplan application.

Build System:
 - Sample config files have been moved from configs/ to a subfolder of that
   directory, 'samples'.

 - The menuselect utility has been pulled into the Asterisk repository. As a
   result, the libxml2 development library is now a required dependency for
   Asterisk.

 - Added a new Compiler Flag, REF_DEBUG. When enabled, reference counted
   objects will emit additional debug information to the refs log file located
   in the standard Asterisk log file directory. This log file is useful in
   tracking down object leaks and other reference counting issues. Prior to
   this version, this option was only available by modifying the source code
   directly. This change also includes a new script, refcounter.py, in the
   contrib folder that will process the refs log file.

Applications:

ConfBridge:
 - The sound_place_into_conference sound used in Confbridge is now deprecated
   and is no longer functional since it has been broken since its inception
   and the fix involved using a different method to achieve the same goal. The
   new method to achieve this functionality is by using sound_begin to play
   a sound to the conference when waitmarked users are moved into the conference.

 - Added 'Admin' header to ConfbridgeJoin, ConfbridgeLeave, ConfbridgeMute,
   ConfbridgeUnmute, and ConfbridgeTalking AMI events.

ControlPlayback:
 - The ControlPlayback and 'control stream file' AGI command will no longer
   implicitly answer the channel. If you do not answer the channel prior to
   using either this application or AGI command, you must send Progress
   first.

Queue:
 - Queue rules provided in queuerules.conf can no longer be named "general".

SetMusicOnHold:
 - The SetMusicOnHold dialplan application was deprecated and has been removed.
   Users of the application should use the CHANNEL function's musicclass
   setting instead.

WaitMusicOnHold:
 - The WaitMusicOnHold dialplan application was deprecated and has been
   removed. Users of the application should use MusicOnHold with a duration
   parameter instead.

CDR Backends:
 - The cdr_sqlite module was deprecated and has been removed. Users of this
   module should use the cdr_sqlite3_custom module instead.

Channel Drivers:

chan_dahdi:
 - SS7 support now requires libss7 v2.0 or later.

 - Added the inband_on_setup_ack compatibility option to chan_dahdi.conf to
   deal with switches that don't send an inband progress indication in the
   SETUP ACKNOWLEDGE message.
   Default is now no.

chan_gtalk
 - This module was deprecated and has been removed. Users of chan_gtalk
   should use chan_motif.

chan_h323
 - This module was deprecated and has been removed. Users of chan_h323
   should use chan_ooh323.

chan_jingle
 - This module was deprecated and has been removed. Users of chan_jingle
   should use chan_motif.

chan_pjsip:
 - Added a 'force_avp' option to chan_pjsip which will force the usage of
   'RTP/AVP', 'RTP/AVPF', 'RTP/SAVP', or 'RTP/SAVPF' as the media transport type
   in SDP offers depending on settings, even when DTLS is used for media
   encryption.

 - Added a 'media_use_received_transport' option to chan_pjsip which will
   cause the SDP answer to use the media transport as received in the SDP
   offer.

chan_sip:
 - Made set SIPREFERREDBYHDR as inheritable for better chan_pjsip
   interoperability.

 - The SIPPEER dialplan function no longer supports using a colon as a
   delimiter for parameters. The parameters for the function should be
   delimited using a comma.

 - The SIPCHANINFO dialplan function was deprecated and has been removed. Users
   of the function should use the CHANNEL function instead.

 - Added a 'force_avp' option for chan_sip. When enabled this option will
   cause the media transport in the offer or answer SDP to be 'RTP/AVP',
   'RTP/AVPF', 'RTP/SAVP', or 'RTP/SAVPF' even if a DTLS stream has been
   configured. This option can be set to improve interoperability with WebRTC
   clients that don't use the RFC defined transport for DTLS.

 - The 'dtlsverify' option in chan_sip now has additional values besides
   'yes' and 'no'. If 'yes' is specified both the certificate and fingerprint
   will be verified. If 'no' is specified then neither the certificate or
   fingerprint is verified. If 'certificate' is specified then only the
   certificate is verified. If 'fingerprint' is specified then only the
   fingerprint is verified.

 - A 'dtlsfingerprint' option has been added to chan_sip which allows the
   hash to be specified for the DTLS fingerprint placed in SDP. Supported
   values are 'sha-1' and 'sha-256' with 'sha-256' being the default.

 - The 'progressinband=never' option is now more zealous in the persecution of
   progress messages coming from Asterisk. Channels bridged with a SIP channel
   that has 'progressinband=never' set will not be able to forward their
   progress indications through to the SIP device. chan_sip will now turn such
   progress indications into a 180 Ringing (if a 180 has not yet been
   transmitted) if 'progressinband=never'.

  - The codec preference order in an SDP during an offer is slightly different
    than previous releases. Prior to Asterisk 13, the preference order of
    codecs used to be:
    (1) Our preferred codec
    (2) Our configured codecs
    (3) Any non-audio joint codecs

    One of the ways the new media format architecture in Asterisk 13 improves
    performance is by reference counting formats, such that they can be reused
    in many places without additional allocation. To not require a large
    amount of locking, an instance of a format is immutable by convention.
    This works well except for formats with attributes. Since a media format
    with an attribute is a different object than the same format without an
    attribute, we have to carry over the formats with attributes from an
    inbound offer so that the correct attributes are offered in an outgoing
    INVITE request. This requires some subtle tweaks to the preference order
    to ensure that the media format with attributes is offered to a remote
    peer, as opposed to the same media format (but without attributes) that
    may be stored in the peer object.

    All of this means that our offer offer list will now be:
    (1) Our preferred codec
    (2) Any joint codecs offered by the inbound offer
    (3) All other codecs that are not the preferred codec and not a joint
        codec offered by the inbound offer

chan_unistim:
 - The unistim.conf 'dateformat' has changed meaning of options values to conform
   values used inside Unistim protocol

 - Added 'dtmf_duration' option with changing default operation to disable
   receivied dtmf playback on unistim phone

Core:

Account Codes:
 - accountcode behavior changed somewhat to add functional peeraccount
   support.  The main change is that local channels now cross accountcode
   and peeraccount across the special bridge between the ;1 and ;2 channels
   just like channels between normal bridges.  See the CHANGES file for
   more information.

ARI:
 - The ARI version has been changed to 1.5.0. This is to reflect backwards
   compatible changes made since 12.0.0 was released.

 - Added a new ARI resource 'mailboxes' which allows the creation and
   modification of mailboxes managed by external MWI. Modules res_mwi_external
   and res_stasis_mailbox must be enabled to use this resource.

 - Added new events for externally initiated transfers. The event
   BridgeBlindTransfer is now raised when a channel initiates a blind transfer
   of a bridge in the ARI controlled application to the dialplan; the
   BridgeAttendedTransfer event is raised when a channel initiates an
   attended transfer of a bridge in the ARI controlled application to the
   dialplan.

 - Channel variables may now be specified as a body parameter to the
   POST /channels operation. The 'variables' key in the JSON is interpreted
   as a sequence of key/value pairs that will be added to the created channel
   as channel variables. Other parameters in the JSON body are treated as
   query parameters of the same name.

 - A bug fix in bridge creation has caused a behavioural change in how
   subscriptions are created for bridges. A bridge created through ARI, does
   not, by itself, have a subscription created for any particular Stasis
   application. When a channel in a Stasis application joins a bridge, an
   implicit event subscription is created for that bridge as well. Previously,
   when a channel left such a bridge, the subscription was leaked; this allowed
   for later bridge events to continue to be pushed to the subscribed
   applications. That leak has been fixed; as a result, bridge events that were
   delivered after a channel left the bridge are no longer delivered. An
   application must subscribe to a bridge through the applications resource if
   it wishes to receive all events related to a bridge.

AMI:
 - The AMI version has been changed to 2.5.0. This is to reflect backwards
   compatible changes made since 12.0.0 was released.

 - The DialStatus field in the DialEnd event can now have additional values.
   This includes ABORT, CONTINUE, and GOTO.

 - The res_mwi_external_ami module can, if loaded, provide additional AMI
   actions and events that convey MWI state within Asterisk. This includes
   the MWIGet, MWIUpdate, and MWIDelete actions, as well as the MWIGet and
   MWIGetComplete events that occur in response to an MWIGet action.

 - AMI now contains a new class authorization, 'security'. This is used with
   the following new events: FailedACL, InvalidAccountID, SessionLimit,
   MemoryLimit, LoadAverageLimit, RequestNotAllowed, AuthMethodNotAllowed,
   RequestBadFormat, SuccessfulAuth, UnexpectedAddress, ChallengeResponseFailed,
   InvalidPassword, ChallengeSent, and InvalidTransport.

 - Bridge related events now have two additional fields: BridgeName and
   BridgeCreator. BridgeName is a descriptive name for the bridge;
   BridgeCreator is the name of the entity that created the bridge. This
   affects the following events: ConfbridgeStart, ConfbridgeEnd,
   ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
   ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
   AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave

 - MixMonitor AMI actions now require users to have authorization classes.
   * MixMonitor - system
   * MixMonitorMute - call or system
   * StopMixMonitor - call or system

 - Removed the undocumented manager.conf block-sockets option.  It interferes with
   TCP/TLS inactivity timeouts.

 - The response to the PresenceState AMI action has historically contained two
   Message keys. The first of these is used as an informative message regarding
   the success/failure of the action; the second contains a Presence state
   specific message. Having two keys with the same unique name in an AMI
   message is cumbersome for some client; hence, the Presence specific Message
   has been deprecated. The message will now contain a PresenceMessage key
   for the presence specific information; the Message key containing presence
   information will be removed in the next major version of AMI.

 - The manager.conf 'eventfilter' now takes an "extended" regular expression
   instead of a "basic" one.

CDRs:
 - The "endbeforehexten" setting now defaults to "yes", instead of "no".
   When set to "no", yhis setting will cause a new CDR to be generated when a
   channel enters into hangup logic (either the 'h' extension or a hangup
   handler subroutine). In general, this is not the preferred default: this
   causes extra CDRs to be generated for a channel in many common dialplans.

CLI commands:
 - "core show settings" now lists the current console verbosity in addition
   to the root console verbosity.

 - "core set verbose" has not been able to support the by module verbose
   logging levels since verbose logging levels were made per console.  That
   syntax is now removed and a silence option added in its place.

Logging:
 - The 'verbose' setting in logger.conf still takes an optional argument,
   specifying the verbosity level for each logging destination.  However,
   the default is now to once again follow the current root console level.
   As a result, using the AMI Command action with "core set verbose" could
   again set the root console verbose level and affect the verbose level
   logged.

HTTP:
 - Added http.conf session_inactivity timer option to close HTTP connections
   that aren't doing anything.

 - Added support for persistent HTTP connections.  To enable persistent
   HTTP connections configure the keep alive time between HTTP requests.  The
   keep alive time between HTTP requests is configured in http.conf with the
   session_keep_alive parameter.

Realtime Configuration:
 - WARNING: The database migration script that adds the 'extensions' table for
   realtime had to be modified due to an error when installing for MySQL.  The
   'extensions' table's 'id' column was changed to be a primary key.  This could
   potentially cause a migration problem.  If so, it may be necessary to
   manually alter the affected table/column to bring it back in line with the
   migration scripts.

 - New columns have been added to realtime tables for 'support_path' on
   ps_registrations and ps_aors and for 'path' on ps_contacts for the new
   SIP Path support in chan_pjsip.

 - The following new tables have been added for pjsip realtime: 'ps_systems',
   'ps_globals', 'ps_tranports', 'ps_registrations'.

 - The following columns were added to the 'ps_aors' realtime table:
   'maximum_expiration', 'outbound_proxy', and 'support_path'.

 - The following columns were added to the 'ps_contacts' realtime table:
   'outbound_proxy', 'user_agent', and 'path'.

 - New columns have been added to the ps_endpoints realtime table for the
   'media_address', 'redirect_method' and 'set_var' options.  Also the
   'mwi_fromuser' column was renamed to 'mwi_from_user'. A new column
   'message_context' was added to let users configure how MESSAGE requests are
   routed to the dialplan.

 - A new column was added to the 'ps_globals' realtime table for the 'debug'
   option.

 - PJSIP endpoint columns 'tos_audio' and 'tos_video' have been changed from
   yes/no enumerators to string values. 'cos_audio' and 'cos_video' have been
   changed from yes/no enumerators to integer values. PJSIP transport column
   'tos' has been changed from a yes/no enumerator to a string value. 'cos' has
   been changed from a yes/no enumerator to an integer value.

 - The 'queues' and 'queue_members' realtime tables have been added to the
   config Alembic scripts.

 - A new set of Alembic scripts has been added for CDR tables. This will create
   a 'cdr' table with the default schema that Asterisk expects.

 - A new upgrade script has been added that adds a 'queue_rules' table for
   app_queue. Users of app_queue can store queue rules in a database. It is
   important to note that app_queue only looks for this table on module load or
   module reload; for more information, see the CHANGES file.

Resources:

res_odbc:
- The compatibility setting, allow_empty_string_in_nontext, has been removed.
  Empty column values will be stored as empty strings during realtime updates.

res_jabber:
 - This module was deprecated and has been removed. Users of this module should
   use res_xmpp instead.

res_http_websocket:
 - Added a compatibility option to ari.conf, sip.conf, and pjsip.conf
   'websocket_write_timeout'. When a websocket connection exists where Asterisk
   writes a substantial amount of data to the connected client, and the connected
   client is slow to process the received data, the socket may be disconnected.
   In such cases, it may be necessary to adjust this value.
   Default is 100 ms.

Scripts:

safe_asterisk:
 - The safe_asterisk script was previously not installed on top of an existing
   version. This caused bug-fixes in that script not to be deployed. If your
   safe_asterisk script is customized, be sure to keep your changes. Custom
   values for variables should be created in *.sh file(s) inside
   ASTETCDIR/startup.d/. See ASTERISK-21965.

 - Changed a log message in safe_asterisk and the $NOTIFY mail subject. If
   you use tools to parse either of them, update your parse functions
   accordingly. The changed strings are:
   - "Exited on signal $EXITSIGNAL" => "Asterisk exited on signal $EXITSIGNAL."
   - "Asterisk Died" => "Asterisk on $MACHINE died (sig $EXITSIGNAL)"

Utilities:
 - The refcounter program has been removed in favor of the refcounter.py script
   in contrib/scripts.

===========================================================
===========================================================