main/astobj2: Make REF_DEBUG a menuselect item; improve REF_DEBUG output
[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 ARI:
39  - The ARI version has been changed from 1.0.0 to 1.1.0. This is to reflect
40    the backwards compatible changes listed below.
41
42  - Added a new ARI resource 'mailboxes' which allows the creation and
43    modification of mailboxes managed by external MWI. Modules res_mwi_external
44    and res_stasis_mailbox must be enabled to use this resource.
45
46  - Added new events for externally initiated transfers. The event
47    BridgeBlindTransfer is now raised when a channel initiates a blind transfer
48    of a bridge in the ARI controlled application to the dialplan; the
49    BridgeAttendedTransfer event is raised when a channel initiates an
50    attended transfer of a bridge in the ARI controlled application to the
51    dialplan.
52
53  - Channel variables may now be specified as a body parameter to the
54    POST /channels operation. The 'variables' key in the JSON is interpreted
55    as a sequence of key/value pairs that will be added to the created channel
56    as channel variables. Other parameters in the JSON body are treated as
57    query parameters of the same name.
58
59  - A bug fix in bridge creation has caused a behavioural change in how
60    subscriptions are created for bridges. A bridge created through ARI, does
61    not, by itself, have a subscription created for any particular Stasis
62    application. When a channel in a Stasis application joins a bridge, an
63    implicit event subscription is created for that bridge as well. Previously,
64    when a channel left such a bridge, the subscription was leaked; this allowed
65    for later bridge events to continue to be pushed to the subscribed
66    applications. That leak has been fixed; as a result, bridge events that were
67    delivered after a channel left the bridge are no longer delivered. An
68    application must subscribe to a bridge through the applications resource if
69    it wishes to receive all events related to a bridge.
70
71 AMI:
72  - The AMI version has been changed from 2.0.0 to 2.1.0. This is to reflect
73    the backwards compatible changes listed below.
74
75  - The DialStatus field in the DialEnd event can now have additional values.
76    This includes ABORT, CONTINUE, and GOTO.
77
78  - The res_mwi_external_ami module can, if loaded, provide additional AMI
79    actions and events that convey MWI state within Asterisk. This includes
80    the MWIGet, MWIUpdate, and MWIDelete actions, as well as the MWIGet and
81    MWIGetComplete events that occur in response to an MWIGet action.
82
83  - AMI now contains a new class authorization, 'security'. This is used with
84    the following new events: FailedACL, InvalidAccountID, SessionLimit,
85    MemoryLimit, LoadAverageLimit, RequestNotAllowed, AuthMethodNotAllowed,
86    RequestBadFormat, SuccessfulAuth, UnexpectedAddress, ChallengeResponseFailed,
87    InvalidPassword, ChallengeSent, and InvalidTransport.
88
89  - Bridge related events now have two additional fields: BridgeName and
90    BridgeCreator. BridgeName is a descriptive name for the bridge;
91    BridgeCreator is the name of the entity that created the bridge. This
92    affects the following events: ConfbridgeStart, ConfbridgeEnd,
93    ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
94    ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
95    AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave
96
97 CDRs:
98  - The "endbeforehexten" setting now defaults to "yes", instead of "no".
99    When set to "no", yhis setting will cause a new CDR to be generated when a
100    channel enters into hangup logic (either the 'h' extension or a hangup
101    handler subroutine). In general, this is not the preferred default: this
102    causes extra CDRs to be generated for a channel in many common dialplans.
103
104 CLI commands:
105  - "core show settings" now lists the current console verbosity in addition
106    to the root console verbosity.
107
108  - "core set verbose" has not been able to support the by module verbose
109    logging levels since verbose logging levels were made per console.  That
110    syntax is now removed and a silence option added in its place.
111
112 ConfBridge:
113 - The sound_place_into_conference sound used in Confbridge is now deprecated
114   and is no longer functional since it has been broken since its inception
115   and the fix involved using a different method to achieve the same goal. The
116   new method to achieve this functionality is by using sound_begin to play
117   a sound to the conference when waitmarked users are moved into the conference.
118
119
120 Configuration Files:
121  - The 'verbose' setting in logger.conf still takes an optional argument,
122    specifying the verbosity level for each logging destination.  However,
123    the default is now to once again follow the current root console level.
124    As a result, using the AMI Command action with "core set verbose" could
125    again set the root console verbose level and affect the verbose level
126    logged.
127
128  - The manager.conf 'eventfilter' now takes an "extended" regular expression
129    instead of a "basic" one.
130
131 ODBC:
132 - The compatibility setting, allow_empty_string_in_nontext, has been removed.
133   Empty column values will be stored as empty strings during realtime updates.
134
135 Realtime Configuration:
136  - WARNING: The database migration script that adds the 'extensions' table for
137    realtime had to be modified due to an error when installing for MySQL.  The
138    'extensions' table's 'id' column was changed to be a primary key.  This could
139    potentially cause a migration problem.  If so, it may be necessary to
140    manually alter the affected table/column to bring it back in line with the
141    migration scripts.
142
143  - New columns have been added to realtime tables for 'support_path' on
144    ps_registrations and ps_aors and for 'path' on ps_contacts for the new
145    SIP Path support in chan_pjsip.
146
147  - The following new tables have been added for pjsip realtime: 'ps_systems',
148    'ps_globals', 'ps_tranports', 'ps_registrations'.
149
150  - The following columns were added to the 'ps_aors' realtime table:
151    'maximum_expiration', 'outbound_proxy', and 'support_path'.
152
153  - The following columns were added to the 'ps_contacts' realtime table:
154    'outbound_proxy', 'user_agent', and 'path'.
155
156  - New columns have been added to the ps_endpoints realtime table for the
157    'media_address', 'redirect_method' and 'set_var' options.  Also the
158    'mwi_fromuser' column was renamed to 'mwi_from_user'. A new column
159    'message_context' was added to let users configure how MESSAGE requests are
160    routed to the dialplan.
161
162  - A new column was added to the 'ps_globals' realtime table for the 'debug'
163    option.
164
165  - PJSIP endpoint columns 'tos_audio' and 'tos_video' have been changed from
166    yes/no enumerators to string values. 'cos_audio' and 'cos_video' have been
167    changed from yes/no enumerators to integer values. PJSIP transport column
168    'tos' has been changed from a yes/no enumerator to a string value. 'cos' has
169    been changed from a yes/no enumerator to an integer value.
170
171  - The 'queues' and 'queue_members' realtime tables have been added to the
172    config Alembic scripts.
173
174  - A new set of Alembic scripts has been added for CDR tables. This will create
175    a 'cdr' table with the default schema that Asterisk expects.
176
177 Utilities:
178  - The refcounter program has been removed in favor of the refcounter.py script
179    in contrib/scripts.
180
181 ===========================================================
182 ===========================================================