Merged revisions 379021,379023 via svnmerge from
[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 ===
22 ===========================================================
23
24 From 11 to 12:
25
26 AMI:
27  - The SIP SIPqualifypeer action now sends a response indicating it will qualify
28    a peer once a peer has been found to qualify.  Once the qualify has been
29    completed it will now issue a SIPqualifypeerdone event.
30  - Version 1.4 - The details of what happens to a channel when a masquerade
31    happens (transfers, parking, etc) have changed.
32    - The Masquerade event now includes the Uniqueid's of the clone and original
33      channels.
34    - Channels no longer swap Uniqueid's as a result of the masquerade.
35    - Instead of a shell game of renames, there's now a single rename, appending
36      <ZOMBIE> to the name of the original channel.
37
38 CEL:
39  - The Uniqueid field for a channel is now a stable identifier, and will not
40    change due to transfers, parking, etc.
41
42 Queues:
43  - Queue logging for PAUSEALL/UNPAUSEALL now only occurs if the interface this is
44    performed on is a member of at least one queue.
45  - Queue strategy rrmemory now has a predictable order similar to strategy
46    rrordered. Members will be called in the order that they are added to the
47    queue.
48  - CDR behavior in app_queue has been modified slightly.  The CDR record will
49    now only record a disposition of BUSY if all Queue members were actually
50    busy on a call or some Queue members were busy or paused.  Previously, any
51    Queue member being paused would result in a disposition of BUSY.
52  - Removed the queues.conf check_state_unknown option.  It is no longer
53    necessary.
54
55 Dial:
56  - Now recognizes 'W' to pause sending DTMF for one second in addition to
57    the previously existing 'w' that paused sending DTMF for half a second.
58
59 ExternalIVR:
60  - Now recognizes 'W' to pause sending DTMF for one second in addition to
61    the previously existing 'w' that paused sending DTMF for half a second.
62
63 SendDTMF:
64  - Now recognizes 'W' to pause sending DTMF for one second in addition to
65    the previously existing 'w' that paused sending DTMF for half a second.
66
67 chan_dahdi:
68  - Analog port dialing and deferred DTMF dialing for PRI now distinguishes
69    between 'w' and 'W'.  The 'w' pauses dialing for half a second.  The 'W'
70    pauses dialing for one second.
71
72 Dialplan:
73  - All channel and global variable names are evaluated in a case-sensitive manner.
74    In previous versions of Asterisk, variables created and evaluated in the
75    dialplan were evaluated case-insensitively, but built-in variables and variable
76    evaluation done internally within Asterisk was done case-sensitively.
77  - Asterisk has always had code to ignore dash '-' characters that are not
78    part of a character set in the dialplan extensions.  The code now
79    consistently ignores these characters when matching dialplan extensions.
80  - BRIDGE_FEATURES channel variable is now casesensitive for feature letter codes.
81    Uppercase variants apply them to the calling party while lowercase variants
82    apply them to the called party.
83
84 From 10 to 11:
85
86 Voicemail:
87  - All voicemails now have a "msg_id" which uniquely identifies a message. For
88    users of filesystem and IMAP storage of voicemail, this should be transparent.
89    For users of ODBC, you will need to add a "msg_id" column to your voice mail
90    messages table. This should be a string capable of holding at least 32 characters.
91    All messages created in old Asterisk installations will have a msg_id added to
92    them when required. This operation should be transparent as well.
93
94 Parking:
95  - The comebacktoorigin setting must now be set per parking lot. The setting in
96    the general section will not be applied automatically to each parking lot.
97  - The BLINDTRANSFER channel variable is deleted from a channel when it is
98    bridged to prevent subtle bugs in the parking feature.  The channel
99    variable is used by Asterisk internally for the Park application to work
100    properly.  If you were using it for your own purposes, copy it to your
101    own channel variable before the channel is bridged.
102
103 res_ais:
104  - Users of res_ais in versions of Asterisk prior to Asterisk 11 must change
105    to use the res_corosync module, instead.  OpenAIS is deprecated, but
106    Corosync is still actively developed and maintained.  Corosync came out of
107    the OpenAIS project.
108
109 Dialplan Functions:
110  - MAILBOX_EXISTS has been deprecated. Use VM_INFO with the 'exists' parameter
111    instead.
112  - Macro has been deprecated in favor of GoSub.  For redirecting and connected
113    line purposes use the following variables instead of their macro equivalents:
114    REDIRECTING_SEND_SUB, REDIRECTING_SEND_SUB_ARGS,
115    CONNECTED_LINE_SEND_SUB, CONNECTED_LINE_SEND_SUB_ARGS.
116  - The REDIRECTING function now supports the redirecting original party id
117    and reason.
118  - The HANGUPCAUSE and HANGUPCAUSE_KEYS functions have been introduced to
119    provide a replacement for the SIP_CAUSE hash. The HangupCauseClear
120    application has also been introduced to remove this data from the channel
121    when necessary.
122
123
124 func_enum:
125  - ENUM query functions now return a count of -1 on lookup error to
126    differentiate between a failed query and a successful query with 0 results
127    matching the specified type.
128
129 CDR:
130  - cdr_adaptive_odbc now supports specifying a schema so that Asterisk can
131    connect to databases that use schemas.
132
133 Configuration Files:
134  - Files listed below have been updated to be more consistent with how Asterisk
135    parses configuration files.  This makes configuration files more consistent
136    with what is expected across modules.
137
138    - cdr.conf: [general] and [csv] sections
139    - dnsmgr.conf
140    - dsp.conf
141
142  - The 'verbose' setting in logger.conf now takes an optional argument,
143    specifying the verbosity level for each logging destination.  The default,
144    if not otherwise specified, is a verbosity of 3.
145
146 AMI:
147   - DBDelTree now correctly returns an error when 0 rows are deleted just as
148     the DBDel action does.
149   - The IAX2 PeerStatus event now sends a 'Port' header.  In Asterisk 10, this was
150     erroneously being sent as a 'Post' header.
151
152 CCSS:
153  - Macro is deprecated. Use cc_callback_sub instead of cc_callback_macro
154    in channel configurations.
155
156 app_meetme:
157   - The 'c' option (announce user count) will now work even if the 'q' (quiet)
158     option is enabled.
159
160 app_followme:
161  - Answered outgoing calls no longer get cut off when the next step is started.
162    You now have until the last step times out to decide if you want to accept
163    the call or not before being disconnected.
164
165 chan_gtalk:
166  - chan_gtalk has been deprecated in favor of the chan_motif channel driver. It is recommended
167    that users switch to using it as it is a core supported module.
168
169 chan_jingle:
170  - chan_jingle has been deprecated in favor of the chan_motif channel driver. It is recommended
171    that users switch to using it as it is a core supported module.
172
173 SIP
174 ===
175  - A new option "tonezone" for setting default tonezone for the channel driver
176    or individual devices
177  - A new manager event, "SessionTimeout" has been added and is triggered when
178    a call is terminated due to RTP stream inactivity or SIP session timer
179    expiration.
180  - SIP_CAUSE is now deprecated.  It has been modified to use the same
181    mechanism as the HANGUPCAUSE function.  Behavior should not change, but
182    performance should be vastly improved.  The HANGUPCAUSE function should now
183    be used instead of SIP_CAUSE. Because of this, the storesipcause option in
184    sip.conf is also deprecated.
185  - The sip paramater for Originating Line Information (oli, isup-oli, and
186    ss7-oli) is now parsed out of the From header and copied into the channel's
187    ANI2 information field.  This is readable from the CALLERID(ani2) dialplan
188    function.
189  - ICE support has been added and is enabled by default. Some endpoints may have
190    problems with the ICE candidates within the SDP. If this is the case ICE support
191    can be disabled globally or on a per-endpoint basis using the icesupport
192    configuration option. Symptoms of this include one way media or no media flow.
193
194 chan_unistim
195  - Due to massive update in chan_unistim phone keys functions and on-screen 
196    information changed.
197
198 users.conf:
199  - A defined user with hasvoicemail=yes now finally uses a Gosub to stdexten
200    as documented in extensions.conf.sample since v1.6.0 instead of a Macro as
201    documented in v1.4.  Set the asterisk.conf stdexten=macro parameter to
202    invoke the stdexten the old way.
203
204 res_jabber
205  - This module has been deprecated in favor of the res_xmpp module. The res_xmpp
206    module is backwards compatible with the res_jabber configuration file, dialplan
207    functions, and AMI actions. The old CLI commands can also be made available using
208    the res_clialiases template for Asterisk 11.
209
210 From 1.8 to 10:
211
212 cel_pgsql:
213  - This module now expects an 'extra' column in the database for data added
214    using the CELGenUserEvent() application.
215
216 ConfBridge
217  - ConfBridge's dialplan arguments have changed and are not
218    backwards compatible.
219
220 File Interpreters
221  - The format interpreter formats/format_sln16.c for the file extension
222    '.sln16' has been removed. The '.sln16' file interpreter now exists
223    in the formats/format_sln.c module along with new support for sln12,
224    sln24, sln32, sln44, sln48, sln96, and sln192 file extensions.
225
226 HTTP:
227  - A bindaddr must be specified in order for the HTTP server
228    to run. Previous versions would default to 0.0.0.0 if no
229    bindaddr was specified.
230
231 Gtalk:
232  - The default value for 'context' and 'parkinglots' in gtalk.conf has
233    been changed to 'default', previously they were empty.
234
235 chan_dahdi:
236  - The mohinterpret=passthrough setting is deprecated in favor of
237    moh_signaling=notify.
238
239 pbx_lua:
240  - Execution no longer continues after applications that do dialplan jumps
241    (such as app.goto).  Now when an application such as app.goto() is called,
242    control is returned back to the pbx engine and the current extension
243    function stops executing.
244  - the autoservice now defaults to being on by default
245  - autoservice_start() and autoservice_start() no longer return a value.
246
247 Queue:
248  - Mark QUEUE_MEMBER_PENALTY Deprecated it never worked for realtime members
249  - QUEUE_MEMBER is now R/W supporting setting paused, ignorebusy and penalty.
250
251 Asterisk Database:
252  - The internal Asterisk database has been switched from Berkeley DB 1.86 to
253    SQLite 3. An existing Berkeley astdb file can be converted with the astdb2sqlite3
254    utility in the UTILS section of menuselect. If an existing astdb is found and no
255    astdb.sqlite3 exists, astdb2sqlite3 will be compiled automatically. Asterisk will
256    convert an existing astdb to the SQLite3 version automatically at runtime. If
257    moving back from Asterisk 10 to Asterisk 1.8, the astdb2bdb utility can be used
258    to create a Berkeley DB copy of the SQLite3 astdb that Asterisk 10 uses.
259
260 Manager:
261  - The AMI protocol version was incremented to 1.2 as a result of changing two
262    instances of the Unlink event to Bridge events. This change was documented
263    as part of the AMI 1.1 update, but two Unlink events were inadvertently left
264    unchanged.
265
266 Module Support Level
267  - All modules in the addons, apps, bridge, cdr, cel, channels, codecs, 
268    formats, funcs, pbx, and res have been updated to include MODULEINFO data
269    that includes <support_level> tags with a value of core, extended, or deprecated.
270    More information is available on the Asterisk wiki at 
271    https://wiki.asterisk.org/wiki/display/AST/Asterisk+Module+Support+States
272
273    Deprecated modules are now marked to not build by default and must be explicitly
274    enabled in menuselect.
275
276 chan_sip:
277  - Setting of HASH(SIP_CAUSE,<slave-channel-name>) on channels is now disabled
278    by default. It can be enabled using the 'storesipcause' option. This feature
279    has a significant performance penalty.
280  - In order to improve compliance with RFC 3261, SIP usernames are now properly
281    escaped when encoding reserved characters. Prior to this change, the use of
282    these characters in certain SIP settings affecting usernames could cause
283    injections of these characters in their raw form into SIP headers which could
284    in turn cause all sorts of nasty behaviors. All characters that are not
285    alphanumeric or are not contained in the the following lists specified by
286    RFC 3261 section 25.1 will be escaped as %XX when encoding a SIP username:
287     * mark: "-" / "_" / "." / "!" / "~" / "*" / "'" / "(" / ")"
288     * user-unreserved: "&" / "=" / "+" / "$" / "," / ";" / "?" / "/"
289
290 UDPTL:
291  - The default UDPTL port range in udptl.conf.sample differed from the defaults
292    in the source. If you didn't have a config file, you got 4500 to 4599. Now the
293    default is 4000 to 4999.
294
295 ===========================================================
296 ===========================================================