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