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