a3e808c7f71849fd79eca23a220ab2595b18b63a
[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 From 12.1.0 to 12.2.0:
24 PJSIP:
25  - The PJSIP registrar now stores the contents of the User-Agent header of incoming
26    REGISTER requests for each contact that is registered. If using realtime for
27    PJSIP contacts, this means that the schema has been updated to add a user_agent
28    column. An alembic revision has been added to facilitate this update.
29
30 Realtime Configuration:
31  - PJSIP endpoint columns 'tos_audio' and 'tos_video' have been changed from yes/no
32    enumerators to string values. 'cos_audio' and 'cos_video' have been changed from
33    yes/no enumerators to integer values. PJSIP transport column 'tos' has been
34    changed from a yes/no enumerator to a string value. 'cos' has been changed from
35    a yes/no enumerator to an integer value.
36
37 From 12.0.0 to 12.1.0:
38 * The sound_place_into_conference sound used in Confbridge is now deprecated
39   and is no longer functional since it has been broken since its inception
40   and the fix involved using a different method to achieve the same goal. The
41   new method to achieve this functionality is by using sound_begin to play
42   a sound to the conference when waitmarked users are moved into the conference.
43
44 From 12 to 13:
45
46 - The per console verbose level feature as previously implemented caused a
47   large performance penalty.  The fix required some minor incompatibilities
48   if the new rasterisk is used to connect to an earlier version.  If the new
49   rasterisk connects to an older Asterisk version then the root console verbose
50   level is always affected by the "core set verbose" command of the remote
51   console even though it may appear to only affect the current console.  If
52   an older version of rasterisk connects to the new version then the
53   "core set verbose" command will have no effect.
54
55 ARI:
56  - The ARI version has been changed from 1.0.0 to 1.1.0. This is to reflect
57    the backwards compatible changes listed below.
58
59  - Added a new ARI resource 'mailboxes' which allows the creation and
60    modification of mailboxes managed by external MWI. Modules res_mwi_external
61    and res_stasis_mailbox must be enabled to use this resource.
62
63  - Added new events for externally initiated transfers. The event
64    BridgeBlindTransfer is now raised when a channel initiates a blind transfer
65    of a bridge in the ARI controlled application to the dialplan; the
66    BridgeAttendedTransfer event is raised when a channel initiates an
67    attended transfer of a bridge in the ARI controlled application to the
68    dialplan.
69
70  - Channel variables may now be specified as a body parameter to the
71    POST /channels operation. The 'variables' key in the JSON is interpreted
72    as a sequence of key/value pairs that will be added to the created channel
73    as channel variables. Other parameters in the JSON body are treated as
74    query parameters of the same name.
75
76 AMI:
77  - The AMI version has been changed from 2.0.0 to 2.1.0. This is to reflect
78    the backwards compatible changes listed below.
79
80  - The DialStatus field in the DialEnd event can now have additional values.
81    This includes ABORT, CONTINUE, and GOTO.
82
83  - The res_mwi_external_ami module can, if loaded, provide additional AMI
84    actions and events that convey MWI state within Asterisk. This includes
85    the MWIGet, MWIUpdate, and MWIDelete actions, as well as the MWIGet and
86    MWIGetComplete events that occur in response to an MWIGet action.
87
88  - AMI now contains a new class authorization, 'security'. This is used with
89    the following new events: FailedACL, InvalidAccountID, SessionLimit,
90    MemoryLimit, LoadAverageLimit, RequestNotAllowed, AuthMethodNotAllowed,
91    RequestBadFormat, SuccessfulAuth, UnexpectedAddress, ChallengeResponseFailed,
92    InvalidPassword, ChallengeSent, and InvalidTransport.
93
94  - Bridge related events now have two additional fields: BridgeName and
95    BridgeCreator. BridgeName is a descriptive name for the bridge;
96    BridgeCreator is the name of the entity that created the bridge. This
97    affects the following events: ConfbridgeStart, ConfbridgeEnd,
98    ConfbridgeJoin, ConfbridgeLeave, ConfbridgeRecord, ConfbridgeStopRecord,
99    ConfbridgeMute, ConfbridgeUnmute, ConfbridgeTalking, BlindTransfer,
100    AttendedTransfer, BridgeCreate, BridgeDestroy, BridgeEnter, BridgeLeave
101
102 CDRs:
103  - The "endbeforehexten" setting now defaults to "yes", instead of "no".
104    When set to "no", yhis setting will cause a new CDR to be generated when a
105    channel enters into hangup logic (either the 'h' extension or a hangup
106    handler subroutine). In general, this is not the preferred default: this
107    causes extra CDRs to be generated for a channel in many common dialplans.
108
109 CLI commands:
110  - "core show settings" now lists the current console verbosity in addition
111    to the root console verbosity.
112
113  - "core set verbose" has not been able to support the by module verbose
114    logging levels since verbose logging levels were made per console.  That
115    syntax is now removed and a silence option added in its place.
116
117 Configuration Files:
118  - The 'verbose' setting in logger.conf still takes an optional argument,
119    specifying the verbosity level for each logging destination.  However,
120    the default is now to once again follow the current root console level.
121    As a result, using the AMI Command action with "core set verbose" could
122    again set the root console verbose level and affect the verbose level
123    logged.
124
125  - The manager.conf 'eventfilter' now takes an "extended" regular expression
126    instead of a "basic" one.
127
128 Realtime Configuration:
129  - WARNING: The database migration script that adds the 'extensions' table for
130    realtime had to be modified due to an error when installing for MySQL.  The
131    'extensions' table's 'id' column was changed to be a primary key.  This could
132    potentially cause a migration problem.  If so, it may be necessary to
133    manually alter the affected table/column to bring it back in line with the
134    migration scripts.
135
136  - New columns have been added to realtime tables for 'support_path' on
137    ps_registrations and ps_aors and for 'path' on ps_contacts for the new
138    SIP Path support in chan_pjsip.
139
140  - The following new tables have been added for pjsip realtime: 'ps_systems',
141    'ps_globals', 'ps_tranports', 'ps_registrations'.
142
143  - The following columns were added to the 'ps_aors' realtime table:
144    'maximum_expiration', 'outbound_proxy', and 'support_path'.
145
146  - The following columns were added to the 'ps_contacts' realtime table:
147    'outbound_proxy' and 'path'.
148
149  - New columns have been added to the ps_endpoints realtime table for the
150    'media_address', 'redirect_method' and 'set_var' options.  Also the
151    'mwi_fromuser' column was renamed to 'mwi_from_user'.
152
153  - A new column was added to the 'ps_globals' realtime table for the 'debug'
154    option.
155
156
157 ===========================================================
158 ===========================================================