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