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